DELETE_FORECAST

Utilisez la fonction de script DELETE_FORECAST pour supprimer une ou plusieurs simulations enregistrées dans la base de données Automation Engine. Cette fonction de script supprime n'importe quel type de simulation :

• Simulation automatique
• Simulation d'objets
• Simulations de tâches

Syntaxe

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

Paramètres

• DELETE_FORECAST
  Supprime une ou plusieurs simulations
• FC_TITLE
  Titre de la simulation à supprimer
  Remarque : Vous pouvez utiliser le caractères générique *.
  Format : chaîne de caractères
  Important : DELETE_FORECAST utilise le titre de la simulation pour sélectionner les simulations à supprimer, et non le nom de l'objet.
  
• DAYS
  (Optionnel) Âge (heure de début) de la simulation
  Format : littéral de script, nombre sans guillemets ou variable de script
  Défaut : Aucune sélection par heure de début logique (âge) de la simulation.
  Remarque : Pour définit la date de début logique de la simulation à aujourd'hui (todays_date) (23:59:59), saisissez 0 pour le paramètre DAYS.
  Conseil : Tenez compte des règles de fuseaux horaires lorsque vous définissez le paramètre DAYS. Pour plus d'informations, voir Date logique et date réelle.
• FORCED
  (Optionnel) Supprime toutes les simulations sans vérification
  Remarques :
  • L'utilisation de ce paramètre provoque des erreurs indéterminées si des simulations sont en cours d'exécution.
  • Sans ce paramètre, le système vérifie si la simulation est exécutée et ne supprime que les simulations actuellement non exécutées.

Remarque : Les paramètres FC_TITLE et DAYS sont logiquement combinés par un opérateur ET. La fonction de script supprime les simulations ayant le titre spécifié et commençant au jour spécifié.

Codes retour

• 0
  Les simulations ont été supprimées avec succès
• Nombre supérieur à 0
  Nombre de simulations qui n'ont pas pu être supprimées

Le nombre de simulations supprimées s'affiche dans le message numéro 20824 du rapport de l'objet exécutable qui appelle le script.

Exemples

Les exemples suivant montrent les différents résultats obtenus avec DELETE_FORECAST :

• : SET &ret# = DELETE_FORECAST ("*", ,)
  Supprime toutes les simulations qui ne sont pas en cours d'exécution

• : SET &ret# = DELETE_FORECAST ("*")
  Supprime toutes les simulations ayant le statut ENDED_OK

• : SET &ret# = DELETE_FORECAST ("MyFC", , FORCED)
  Supprime toutes les simulations dont le titre est MyFC, et arrête celles qui sont en cours d'exécution

• : SET &ret# = DELETE_FORECAST ("FC_*", "2")
  Supprime toutes les simulations dont le titre commence par "FC_", qui ont plus de deux jours et dont le statut est ENDED_OK

• : SET &ret# = DELETE_FORECAST ("FC_*", "2","FORCED")Supprime toutes les simulations dont le titre commence par "FC_" et qui ont plus de deux jours

• : SET &ret# = DELETE_FORECAST ("FC_*",0, "FORCED"
  Supprime toutes les simulations dont le titre commence par "FC_" et dont la date de début logique est aujourd'hui (23:59:59)

• : SET &ret# = DELETE_FORECAST ("FC_*",0)
  Supprime toutes les simulations dont le titre commence par "FC_", dont la date de début logique est aujourd'hui et dont le statut est ENDED_OK

Voir aussi :