Manuel des Scripts Automation Engine > Organisation fonctionnelle > Activation d'objets > DELETE_FORECAST

DELETE_FORECAST

Fonction de script : supprime toute nombre de prévisions stockées dans la base de données Automation Engine.

Syntaxe

DELETE_FORECAST(FC_TITLE, [DAYS], [FORCED])

Syntaxe	Description / format
FC_TITLE	Le titre de la simulation peut être supprimé. (obligatoire) Vous pouvez utiliser des caractères génériques: "*" Sera logiquement combiné avec le paramètre "DAYS" par l'opérateur ET. Format : string
DAYS	Heure de Début de la simulation (facultatif) Sera logiquement combiné avec le paramètre "FC_TITLE" par l'opérateur ET. Format : hh:mm:ss Si ce paramètre est configuré à "0", la valeur de la date de début logique de la simulation est réglée à la date d'aujourd'hui (todays_date): 23:59:59
FORCED	Valeur fixe : "FORCED" (facultatif) Si ce paramètre est configuré, toutes les simulations seront supprimées sans vérification et les simulations en cours d'exécution seraient arrêtées avec des erreurs non définies. Si ce paramètre n'est pas configuré, une vérification sera effectuée sur l'état en cours d'exécution de la simulation et seulement les simulations qui ne sont pas en cours d'exécution seront supprimées.

Syntaxe

Description / format

FC_TITLE

Le titre de la simulation peut être supprimé. (obligatoire) Vous pouvez utiliser des caractères génériques: "*"

Sera logiquement combiné avec le paramètre "DAYS" par l'opérateur ET.

Format : string

DAYS

Heure de Début de la simulation (facultatif)

Sera logiquement combiné avec le paramètre "FC_TITLE" par l'opérateur ET.

Format : hh:mm:ss

Si ce paramètre est configuré à "0", la valeur de la date de début logique de la simulation est réglée à la date d'aujourd'hui (todays_date): 23:59:59

FORCED

Valeur fixe : "FORCED" (facultatif)

Si ce paramètre est configuré, toutes les simulations seront supprimées sans vérification et les simulations en cours d'exécution seraient arrêtées avec des erreurs non définies.

Si ce paramètre n'est pas configuré, une vérification sera effectuée sur l'état en cours d'exécution de la simulation et seulement les simulations qui ne sont pas en cours d'exécution seront supprimées.

Code retour
"0" - La simulation a été supprimée avec succès.
Un numéro > "0" - Les simulations avec les paramètres stipulés n'ont pas toutes été supprimées.

Dans le rapport de l'objet activable, vous verrez un message (N° 20824) qui contient le nombre exact de simulations supprimées.

Remarques

Les simulations ne peuvent être supprimées qu'en utilisant leur titre. Vous ne pouvez pas utiliser leur nom avec cette fonction de script.

Pour le paramètre "DAYS", veuillez aussi garder les règles fuseaux horaires du Automation Engine système à l'esprit.

Utiliser cette fonction de script avec tout type de simulation entrainera une suppression, ce qui peut être des objets, des tâches ou des simulations automatiques.

Exemples

Les exemples suivants vous montrent comment utiliser DELETE_FORECAST:

Supprimez toutes les simulations qui ne sont pas en cours d'exécution:

:SET &ret# = DELETE_FORECAST ("*", ,)

Supprimez toutes les simulations avec l'état ENDED_OK:

:SET &ret# = DELETE_FORECAST ("*")

Supprimez toutes les simulations avec le titre "MyFC", forcé:

:SET &ret# = DELETE_FORECAST ("MyFC", , FORCED)

Supprimer toutes les simulations dont le titre commence par "FC_" qui sont plus vieilles que deux jours ET qui ont l'état ENDED_OK:

:SET &ret# = DELETE_FORECAST ("FC_*", "2")

Supprimer toutes les simulations dont le titre commence par "FC_" ET qui sont plus vieilles que deux jours:

:SET &ret# = DELETE_FORECAST ("FC_*", "2","FORCED")

Supprimer toutes les simulations dont le titre commence par "FC_" et dont le début logique est < (la date d'aujourd'hui):23:59:59 et dont l'état est ENDED_OK:

:SET &ret# = DELETE_FORECAST ("FC_*",0)

Supprimer toutes les simulations dont le titre commence par "FC_" et dont le début logique est < (la date d'aujourd'hui):23:59:59

:SET &ret# = DELETE_FORECAST ("FC_*",0, "FORCED") ->

Rubriques connexes :

Elément de script	Description
AUTOFORECAST	Calcule les données de simulation pour des activités futures.
FORECAST_TASK	Crée une simulation pour la tâche indiquée.

Eléments de script - Activation d'objets

Simulation
Détermination de la durée d'exécution

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