Utilisation de DurationCalculator pour calculer une date d’échéance
À l’aide de l’include de script DurationCalculator, vous pouvez calculer une date d’échéance en utilisant une durée simple ou une durée relative basée sur les calendriers.
Le script suivant montre comment utiliser l’API globale DurationCalculator pour calculer une date d’échéance. La première partie du script illustre comment définir une date/heure de début à l’aide de la méthode setStartDateTime(), puis utiliser la méthode calcDuration() pour déterminer une date d’échéance qui est « x » quantité de temps continu (secondes) à partir de la date/heure de début spécifiée. La deuxième moitié du texte illustre comment utiliser DurationCalculator pour calculer une date d’échéance en fonction d’une planification. Les calendriers vous permettent d’appliquer un « filtre » sur le temps futur, par exemple en incluant uniquement les jours d’une semaine de travail dans le calcul. Par exemple, si vous appliquez un calendrier « jours de la semaine » (qui inclut uniquement du lundi au vendredi) à votre calcul de durée, et que la date/l’heure de début est le vendredi à 17h00, lorsque vous ajoutez une durée de deux jours, votre date d’échéance sera le mardi à 17h00. Si vous n’avez pas utilisé d’horaire, votre date d’accouchement sera le dimanche à 17h00. Pour plus d’informations sur les calendriers, voir Création et utilisation de calendriers.
/**
* Demonstrate the use of DurationCalculator to compute a due date.
*
* You must have a start date and a duration. Then you can compute a
* due date using the constraints of a schedule.
*/
gs.include('DurationCalculator');
executeSample();
/**
* Function to house the sample script.
*/
function executeSample(){
// First we need a DurationCalculator object.
var dc = new DurationCalculator();
// --------------- No schedule examples ------------------
// Simple computation of a due date without using a schedule. Seconds
// are added to the start date continuously to get to a due date.
var gdt = new GlideDateTime("2012-05-01 00:00:00");
dc.setStartDateTime(gdt);
if(!dc.calcDuration(2*24*3600)){ // 2 days
gs.log("*** Error calculating duration");
return;
}
gs.log("calcDuration no schedule: " + dc.getEndDateTime()); // "2012-05-03 00:00:00" two days later
// Start in the middle of the night (2:00 am) and compute a due date 1 hour in the future
// Without a schedule this yields 3:00 am.
var gdt = new GlideDateTime("2012-05-03 02:00:00");
dc.setStartDateTime(gdt);
if(!dc.calcDuration(3600)){
gs.log("*** Error calculating duration");
return;
}
gs.log("Middle of night + 1 hour (no schedule): "+ dc.getEndDateTime()); // No scheduled start date, just add 1 hour
// -------------- Add a schedule to the date calculator ---------------------
addSchedule(dc);
// Start in the middle of the night and compute a due date 1 hour in the future.
// Since we start at 2:00 am the computation adds the 1 hour from the start
// of the day, 8:00am to get to 9:00am
var gdt = new GlideDateTime("2012-05-03 02:00:00");
dc.setStartDateTime(gdt);
if(!dc.calcDuration(3600)){
gs.log("*** Error calculating duration");
return;
}
gs.log("Middle of night + 1 hour (with 8-5 schedule): " + dc.getEndDateTime()); // 9:00 am
// Start in the afternoon and add hours beyond quiting time. Our schedule says the work day
// ends at 5:00pm, if the duration extends beyond that, we roll over to the next work day.
// In this example we are adding 4 hours to 3:00pm which gives us 10:00 am the next day.
var gdt = new GlideDateTime("2012-05-03 15:00:00");
dc.setStartDateTime(gdt);
if(!dc.calcDuration(4*3600)){
gs.log("*** Error calculating duration");
return;}
gs.log("Afternoon + 4 hour (with 8-5 schedule): " + dc.getEndDateTime()); // 10:00 am.
// This is a demo of adding 2 hours repeatedly and examine the result. This
// is a good way to visualize the result of a due date calculation.
var gdt = new GlideDateTime("2012-05-03 15:00:00");
dc.setStartDateTime(gdt);
for(var i=2; i<24; i+=1){
if(!dc.calcDuration(i*3600)){
gs.log("*** Error calculating duration");
return;
}
gs.log("add "+ i +" hours gives due date: " + dc.getEndDateTime());
}
// Setting the timezone causes the schedule to be interpreted in the specified timezone.
// Run the same code as above with different timezone. Note that the 8 to 5 workday is
// offset by the two hours as specified in our timezone.
dc.setTimeZone("GMT-2");
var gdt = new GlideDateTime("2012-05-03 15:00:00");
dc.setStartDateTime(gdt);
for(var i=2; i<24; i+=1){
if(!dc.calcDuration(i*3600)){
gs.log("*** Error calculating duration");
return;
}
gs.log("add "+ i +" hours gives due date (GMT-2): " + dc.getEndDateTime());
}
}
/**
* Add a specific schedule to the DurationCalculator object.
*
* @param durationCalculator An instance of DurationCalculator
*/
function addSchedule(durationCalculator){
// Load the "8-5 weekdays excluding holidays" schedule into our duration calculator.
var scheduleName = "8-5 weekdays excluding holidays";
var grSched = new GlideRecord('cmn_schedule');
grSched.addQuery('name', scheduleName);
grSched.query();
if(!grSched.next()){
gs.log('*** Could not find schedule "'+ scheduleName +'"');
return;
}
durationCalculator.setSchedule(grSched.getUniqueValue(),"GMT");
}Utilisation de DurationCalculator pour calculer une durée simple
Une durée simple est le nombre de secondes entre deux dates et heures.
Si aucun calendrier n’est utilisé, il s’agit d’une simple soustraction d’heure et de date. Si un calendrier est utilisé, le calendrier est consulté pour supprimer les heures non travaillées du calcul. Supposons que l’horaire « 8h00-17h00 en semaine excluant les jours fériés » soit utilisé. Dans ce cas, le nombre d’heures de travail du lundi midi au mardi midi est de neuf heures. Pour calculer une durée simple, initialisez l’API globale DurationCalculator et appelez la méthode calcScheduleDuration().
/**
* Sample script demonstrating use of DurationCalculator to compute simple durations
*
*/
gs.include('DurationCalculator');
executeSample();
/**
* Function to house the sample script.
*/
function executeSample(){
// First we need a DurationCalculator object.
var dc = new DurationCalculator();
// Compute a simple duration without any schedule. The arguments
// can also be of type GlideDateTime, such as fields from a GlideRecord.
var dur = dc.calcScheduleDuration("2012-05-01", "2012-05-02");
gs.log("calcScheduleDuration no schedule: " + dur); // 86400 seconds (24 hours)
// The above sample is useful in limited cases. We almost always want to
// use some schedule in a duration computation, let's load a schedule.
addSchedule(dc);
// Compute a duration using the schedule. The schedule
// specifies a nine hour work day. The output of this is 32400 seconds, or
// a nine hour span.
dur = dc.calcScheduleDuration("2012-05-23 12:00:00","2012-05-24 12:00:00");
gs.log("calcScheduleDuration with schedule: " + dur); // 32400 seconds (9 hours)
// Compute a duration that spans a weekend and holiday. Even though this
// spans three days, it only spans 9 work hours based on the schedule.
dur = dc.calcScheduleDuration("2012-05-25 12:00:00", "2012-05-29 12:00:00");
gs.log("calcScheduleDuration with schedule spaning holiday: " + dur); // 32400 seconds (9 hours)
// Use the current date time in a calculation. The output of this is
// dependent on when you run it.
var now = new Date();
dur = dc.calcScheduleDuration("2012-05-15", new GlideDateTime());
gs.log("calcScheduleDuration with schedule to now: " + dur); // Different on every run.
}
/**
* Add a specific schedule to the DurationCalculator object.
*
* @param durationCalculator An instance of DurationCalculator
*/
function addSchedule(durationCalculator){
// Load the "8-5 weekdays excluding holidays" schedule into our duration calculator.
var scheduleName = "8-5 weekdays excluding holidays";
var grSched = new GlideRecord('cmn_schedule');
grSched.addQuery('name', scheduleName);
grSched.query();
if(!grSched.next()){
gs.log('*** Could not find schedule "'+ scheduleName +'"');
return;
}
durationCalculator.setSchedule(grSched.getUniqueValue());
}Utilisation de la durée relative
La durée relative est très similaire à la durée simple, sauf qu’un morceau de script est utilisé pour déterminer les parties d’une journée à supprimer du calcul de la différence.
Ce script est stocké dans la table cmn_relative_duration et peut être examiné en accédant à . Il existe des exemples de scripts de durée relative dans l’instance prête à l’emploi.
Une sys_id de durée relative est transmise à la méthode calcRelativeDuration() de la classe DurationCalculator de l’API globale après l’initialisation. Lorsque cette méthode est appelée, l’objet DurationCalculator est transmis au script de durée relative (stocké dans la table cmn_relative_duration) en tant que calculateur de variables. Ainsi, le script de durée relative que vous écrivez et stockez dans cmn_relative_duration a accès à l’exécution de DurationCalculator via le calculateur de variables.
/**
* Sample use of relative duration calculation.
*
*/
gs.include('DurationCalculator');
executeSample();
/**
* Function to house the sample script.
*/
function executeSample(){
// First we need a DurationCalculator object. We will also use
// the out-of-box relative duration "2 bus days by 4pm"
var dc = new DurationCalculator();
var relDur = "3bf802c20a0a0b52008e2859cd8abcf2"; // 2 bus days by 4pm if before 10am
addSchedule(dc);
// Since our start date is before 10:00am our result is two days from// now at 4:00pm.
var gdt = new GlideDateTime("2012-05-01 09:00:00");
dc.setStartDateTime(gdt);
if(!dc.calcRelativeDuration(relDur)){
gs.log("*** calcRelativeDuration failed");
return;
}
gs.log("Two days later 4:00pm: "+ dc.getEndDateTime());
// Since our start date is after 10:00am our result is three days from
// now at 4:00pm.
var gdt = new GlideDateTime("2012-05-01 11:00:00");
dc.setStartDateTime(gdt);
if(!dc.calcRelativeDuration(relDur)){
gs.log("*** calcRelativeDuration failed");
return;
}
gs.log("Three days later 4:00pm: "+ dc.getEndDateTime());}
/**
* Add a specific schedule to the DurationCalculator object.
*
* @param durationCalculator An instance of DurationCalculator
*/
function addSchedule(durationCalculator){
// Load the "8-5 weekdays excluding holidays" schedule into our duration calculator.
var scheduleName ="8-5 weekdays excluding holidays";
var grSched =new GlideRecord('cmn_schedule');
grSched.addQuery('name', scheduleName);
grSched.query();
if(!grSched.next()){
gs.log('*** Could not find schedule "'+ scheduleName +'"');
return;}
durationCalculator.setSchedule(grSched.getUniqueValue(),"GMT");}