Manuel des Scripts Automation Engine > Organisation fonctionnelle > Date et heure > SUB_DAYS

SUB_DAYS

Fonction de script : Soustrait des jours à une date indiquée

Syntaxe

SUB_DAYS(Date, Days, [[Calendar], [Calendar Keyword]])

Elément de syntaxe

Description/format

Date

Saisie d'une date au format "AAMMJJ" ou "AAAAMMJJ".

Format : littéral de script ou variable de script

Il est aussi possible d’indiquer la date dans un autre format de date. Pour cela, saisissez le format de date souhaité suivi d’un séparateur (: ou ;) puis la date. Le format de la date est facultatif.

Jours

Une valeur spécifiant un nombre de jours.
Format : littéral de script, nombre sans guillemets ou variable de script

Calendrier

Nom du calendrier à prendre en compte pour le calcul.
Format : nom AE, littéral de script ou variable de script

Règle de calendrier

Nom de la règle de calendrier à prendre en compte.
Format : Nom AE, littéral de script ou variable de script


Littéral de script ou variable de script

Date au format indiqué
"0" : aucun jour n'a été attribué à cette règle de calendrier ou bien la date calculée est en dehors du calendrier.
"20327" : l'objet calendrier n'existe pas.
"20328" : la règle de calendrier n'existe pas dans l'objet calendrier.

Remarques

La fonction de script soustrait des jours d'une date indiquée. Vous pouvez aussi exécuter ces calculs en fonction d'un calendrier ou d'une règle de calendrier. Dans ce cas, seuls les jours qui sont valides dans le calendrier sont pris en compte.

Si on indique un format de date spécifique, la date sera renvoyée dans ce format. Si le format de date n'est pas spécifié, utilisez les formats "AAMMJJ" ou "AAAAMMJJ", la date sera renvoyée au même format. Deux points ou un point-virgule sont autorisés comme séparateur entre le format de date et la date.

Il est également possible de définir un nombre de jours égal à zéro. Lorsque la date indiquée est valide dans le calendrier, cette date est renvoyée, sinon c'est la date valide précédente qui est retournée.

Pour le calcul de la date, on tient compte de l'intervalle du calendrier indiqué. Cet intervalle dépend des paramètres configurés par l'administrateur dans la variable UC_CLIENT_SETTINGS dans les clés NOW_MINUS et NOW_PLUS. Si la date calculée est en dehors du calendrier, la fonction de script renvoie la valeur "0".

Exemples

Le premier exemple soustrait deux jours d'une date indiquée. Le résultat ("000330") est affiché dans le protocole d'activation.

:SET &DATE# = SUB_DAYS("000401", 2)
:
PRINT &DATE#

Dans le deuxième exemple, une instruction de script demande à l'utilisateur le nombre de jours à enregistrer. Cette fonction permet de soustraire ce nombre de la date du jour courant et de l'enregistrer dans une variable de script. Comme aucun format de date n'est indiqué, chaque date utilise le format par défaut "AAMMJJ".

:SET &CURDATE# = SYS_DATE()  
:
READ &NUMBER#,"00","Store how many days?","08",N
:
SET &RETDATE# = SUB_DAYS(&CURRENTDATE#, &NUMBER#)

Le troisième exemple calcule la date courante. Deux jours sont ensuite retirés de cette date. Comme il n'est pas récupéré dans le format par défaut, le format de la date demandée doit également être indiqué dans la variable de script.

:SET &CURDATE# = SYS_DATE("DD.MM.YY")
:
SET &PWRKDAY# = SUB_DAYS("DD.MM.YY:&CURDATE#", 2)

 

Rubriques connexes :

Eléments de script - Date et heure

Formats de date, d'heure et de période

Généralités sur les scripts
Eléments de script - Liste alphabétique

Eléments de script - Répartition fonctionnelle