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

FIRST_OF_PERIOD

Fonction de script : Détermine le premier jour de la période pour une date donnée.

Syntaxe

FIRST_OF_PERIOD (Date, Period Format, [Output Format, [[Calendar], [Calendar Keyword]])

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.

Format de période

Format prédéfini pour la période.

Format de sortie

Format prédéfini de la date déterminée.
Format : littéral de script ou variable de script
Valeur par défaut : AAMMJJ  

Calendrier

Nom du calendrier devant être pris en compte pour le début de la période.
Format : Nom AE, littéral de script ou variable de script

Règle de calendrier

Nom de la règle de calendrier devant être prise en compte pour le début de la période.
Format : Nom AE, littéral de script ou variable de script  


Codes retour

Date du début de la période au format indiqué.
"20327" : l'objet calendrier n'existe pas.
"20328" : la règle de calendrier n'existe pas dans l'objet calendrier.
"20456" : la date de début de la période ne figure pas dans la règle de calendrier.

Remarques

La fonction de script détermine le premier jour de la période pour la date indiquée. La valeur retournée est une date.

La fonction de script récupère une date. L'indication du format de date est facultative. Les formats de date pardéfaut à utiliser sont "AAMMJJ" ou "AAAAMMJJ". Deux points ou un point-virgule sont autorisés comme séparateur entre le format de date et la date.

Le type de période (année, trimestre, mois ou semaine) est défini par le format de période.
Remarque :
Le format de période spécial "WS" s'applique à cette fonction. Il indique que le dimanche est le premier jour de la semaine. "WW" au contraire indique que le lundi est le premier jour de la semaine.

Le format de sortie est facultatif. Si le format de sortie n'est pas utilisé, la fonction de script renvoie une date au format "AAMMJJ" par défaut. Notez : Si vous spécifiez des calendriers et des règles de calendriers, pensez à les séparer par des virgules si aucun format de sortie n'est utilisé.

Si vous utilisez des calendriers et des règles de calendriers, la fonction de script renvoie le jour calendaire correct de la période. Si aucun jour n'est valide pour cette période, le résultat est une date nulle au format de date courant (par ex. 0000-00-00).

L'instruction de script :ON_ERROR permet de définir la réaction à cette erreur. Comme indiqué auparavant, vous pouvez l'analyser avec les fonctions de script pour le traitement des erreurs. Le traitement du script se poursuit. Toutefois, vous avez également la possibilité de l'interrompre.

Exemples

Le premier exemple détermine le premier jour de la semaine pour le 29.03.2000. Le résultat 27.03.00 (lundi) est affiché dans le rapport.

:SET &DATE# = FIRST_OF_PERIOD ("000329","WW","DD.MM.YY")
:
PRINT &DATE#

Lorsque le format de période spécial "WS" est utilisé, 26.03.00 (dimanche) apparaît comme résultat dans le protocole d'activation.

:SET &DATE# = FIRST_OF_PERIOD ("DD.MM.YY:29.03.00","WS","DD.MM.YY")
:
PRINT &DATE#

Dans le troisième exemple, le premier jour correct d'un trimestre est déterminé. Le format de sortie n'est pas pris en compte.

:SET &DATE# = FIRST_OF_PERIOD ("000329", "Q", , READINESS, WEEKDAY)
:
PRINT &DATE#

 

Rubriques connexes :

Elément de script Description

LAST_OF_PERIOD

Détermine le dernier jour de la période pour une date donnée.

:ON_ERROR

Détermine la réaction à certaines erreurs ou messages d'éléments de script.

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