CRONTAB

Icône du lien vers le conceptVoir également Icône du lien vers le conceptExemple

Activation, modification d'actions horodatées dans le séquenceur.

Support WebVue - Oui.

Mode

Mnémonique

Syntaxe

1 ADDPROG 1
2 DELPROG 1
3 ADDVAR 2
4 DELVAR 2
6 DELALL 3
7 TABLE_STATUS 4
8 TABLE_ELAPSED 4
9 TABLE_REMAINING 4
11 NETWORKBROADCAST 5
12 SAVE 3
13 TRACE 6
15 ADDPROG_EX 1
16 DELPROG_EX 1
17 EXECUTE_TABLE 7
18 EXECUTE_ALLTABLES 3

Syntaxe 1

IntVal = CRONTAB(Mode, CRONTYPE, Date, Time, Program, Branch, Function [, Farg [, ActivBit] ]);

Type de retour : INTEGER.

Argument

Définition

CRONTYPE

Type d'horodate de l'événement :

1

ONCE

2

EACH_HOUR

3

EACH_DAY

4

EACH_WEEK

5

EACH_MONTH

Date

Chaîne représentant la date ou le jour selon le type d'événement spécifié par CRONTYPE.

 

Une date est spécifiée au format dd/mm/yy ou au format dd/mm/yyyy, par exemple 05/08/2003.

 

Si le jour est spécifié, le nom du jour est donné.

 

"monday" ou "mon"

 

"tuesday" ou "tue"

 

"wednesday" ou "wed"

 

"thursday" ou "thu"

 

"saturday" ou "sat"

 

"sunday" ou "sun"

Time

Représente l'heure (hh:mm) ou la minute (mm) selon le type d'événement CRONTYPE. "17:38" ou "38". Type STR.

Program

Le nom de la fonction à exécuter. Type STR.

Branch

La branche du programme. Type STR.

Function

Le nom du programme contenant la fonction à exécuter. Type STR.

Farg

Optionnel. Chaîne de 2 047 caractères maximum, contenant de 1 à 8 arguments séparés par des , (virgule).

Ces arguments sont récupérables dans la fonction à exécuter par le verbe GETARG.

ActivBit

Optionnel. Nom complet de la variable état ou alarme d'activation de l'événement.

Exécution

Mode

Mnémonique

Action

1

ADDPROG

Création d'un événement de type exécution d'un programme, ou modification s'il existe déjà.

 

 

L'événement ainsi créé est dit temporaire. Il n'est pas possible de modifier un événement permanent créé par la configuration.

2

DELPROG

Suppression d'un événement de type exécution de programme.

 

 

Il n'est pas possible de supprimer un événement permanent.

15 ADDPROG_EX Création d'un événement de type exécution d'un programme, ou modification s'il existe déjà.
    Similaire au mode 1, sauf que les arguments Farg et ActivBit peuvent être utilisés pour distinguer des événements qui seraient par ailleurs identiques.
16 DELPROG_EX Suppression d'un événement de type exécution de programme.
    Similaire au mode 2, sauf que les arguments Farg et ActivBit peuvent être utilisés pour distinguer des événements qui seraient par ailleurs identiques.
    Retour : 1 si OK, 0 sinon.

Le programme doit être préchargé (PRELOAD) pour être exécuté. Une fonction cyclique ne peut être modifiée une fois démarrée. Elle doit être stoppée et reprogrammée.

L'utilisation d'une instruction de type DELAY dans une fonction peut produire des résultats imprévisibles et doit être évitée.

Le format de la date utilisant le mode ONCE peut être soit dd/mm/yy ou dd/mm/yyyy.

Syntaxe 2

IntVal =CRONTAB(Mode, TYPE, Date, Time, Variable, Send_Mode, Delay [, "", ActivBit] );

Type de retour : INTEGER.

Argument

Définition

TYPE

Type d'horodate de l'événement :

 

ONCE 1

 

EACH_HOUR 2

 

EACH_DAY 3

 

EACH_WEEK 4

 

EACH_MONTH 5

Date

Chaîne représentant la date ou le jour selon le type d'événement spécifié par CRONTYPE.

 

Une date est spécifiée au format dd/mm/yy ou au format dd/mm/yyyy, par exemple 05/08/2003.

 

Si le jour est spécifié, le nom du jour est donné.

 

"monday" ou "mon"

 

"tuesday" ou "tue"

 

"wednesday" ou "wed"

 

"thursday" ou "thu"

 

"saturday" ou "sat"

 

"sunday" ou "sun"

Time

Représente l'heure (hh:mm) ou la minute (mm) selon l'événement TYPE. "17:38" ou "38". Type STR.

Variable

Nom complet en absolu de la variable à forcer (Etat ou Alarme uniquement)

S_Mode

0 : forçage à 0

 

1 : forçage à 1

 

2 : forçage à l'état inverse

Delay

Si différent de 0, le forçage est impulsionnel avec une durée en secondes. La durée est spécifiée en secondes.

"" Paramètre inutilisé. A inclure seulement lors de l'utilisation du paramètre facultatif ActivBit. Type STR.

ActivBit

Facultatif. Nom complet de la variable état ou alarme d'activation de l'événement.

Exécution

Mode

Mnémonique

Action

3

ADDVAR

Création (ou modification s'il existe) d'un événement de type forçage de variable.

L'événement ainsi créé est dit temporaire.

Il n'est pas possible de modifier un événement permanent.

4

DELVAR

Suppression de tous les événements temporaires existants.

Il n'est pas possible de supprimer un événement permanent.

 

 

Retour : 1 si Ok, 0 sinon.

Syntaxe 3

IntVal = CRONTAB(Mode);

Type de retour: INTEGER.

Exécution

Mode

Mnémonique

Action

6

DELALL

Suppression de tous les événements temporaires existants.

 

 

Retour : Toujours 1.

12

SAVE

Sauvegarde les actions horodatées du séquenceur dans le fichier CRON.DAT

 

 

Retour : Toujours 0.

18 EXECUTE_ALLTABLES

Exécute toutes les tables horaires. Les actions sont exécutées immédiatement, en ignorant la configuration des tables horaires.

Retour : Toujours 0.

Syntaxe 4

LongVal = CRONTAB(Mode, TableName);

Type de retour : LONG.

Argument

Définition

TableName

Nom d'une table. Type STR.

Exécution

Mode

Mnémonique

Action

7 TABLE_STATUS

Teste si une plage horaire est en cours pour la table horaire TableName.

Retour : 0 (hors occupation), 1 (en occupation) ou -1 si la table n'existe pas.

8 TABLE_ELAPSED

Renvoie le temps restant, en secondes, avant la prochaine transition. Une transition est un début ou une fin de plage horaire.

Retour : -1 si la table n'existe pas ou si calcul impossible (aucune plage horaire définie).

9 TABLE_REMAINING

Renvoie le temps écoulé, en secondes, depuis la dernière transition. Une transition est un début ou une fin de plage horaire.

Retour : -1 si la table n'existe pas ou si calcul impossible (aucune plage horaire définie).

Syntaxe 5

IntVal =CRONTAB(Mode, List, HStatus, EventVar, LocalRemote);

Type de retour : INTEGER.

Argument

Définition

List

Nom de la liste des postes de l'architecture multipostes destinataires des modifications (créée à partir du menu Configuration.Communication.Multipostes). Type STR.

La liste doit être de type Liste de clients de modification.

HStatus

Handle du buffer alloué par ALLOC_BUFFER. Après l'exécution de l'instruction, le buffer contenant la liste des postes et leur statut de mise-à-jour suivant le format :

StaNum,Status,...;

StaNum est le numéro du poste et Status est à 1 si OK, 0 sinon. Type de retour : LONG.

EventVar

Nom de la variable état positionnée à 1 après exécution de l'instruction. Type STR.

LocalRemote

Détermine l'emplacement de la modification du fichier de configuration du séquenceur CRON.DAT :

1 : Tous les postes (y compris le poste local).

0 : Seulement les postes déportés. (Par défaut )

Exécution

Mode

Mnémonique

Action

11

NETWORKBROADCAST

Envoie le fichier de configuration du séquenceur CRON.DAT vers tous les postes dans la liste de modifications clients.

 

 

Retour : 0 si Ok, sinon 1.

Syntaxe 6

IntVal =CRONTAB(Mode, SubMode);

Type de retour : INTEGER.

Argument

Définition

SubMode

"ON" ou "OFF". Type STR.

Exécution

Mode

Mnémonique

Action

13 TRACE

Active ("ON") ou désactive ("OFF") les traces de diagnostic. Des messages trace apparaissent dans l'observateur d'événements (F7).
Retour : 1 si Ok, 0 sinon (SubMode incorrect).

Syntaxe 7

IntVal = CRONTAB(Mode, TableName);

Type de retour : INTEGER.

Argument

Définition

TableName

Nom d'une table. Type STR.

Exécution

Mode

Mnémonique

Action

17 EXECUTE_TABLE

Exécute la table horaire spécifiée. L'action est exécutée immédiatement, en ignorant la configuration de la table horaire.

Retour : 1 si 0K, 0 sinon.

Exemple de message de trace

[SV.Scheduler] The traces are activated

[SV.UI.Scheduler]<Each hour at minute [30]> Adding or Modifying Agenda Frequency Function to execute: Program [test_crontab.svb], Branch [], Function [Hello], Arguments []

[SV.UI.Scheduler] Deleting Agenda Frequency [Each hour at minute [30]] Function to execute: Program [test_crontab.svb], Branch [], Function [Hello], Arguments []

Exemple

Pour un exemple, sélectionnez le lien Exemple ci-dessus.