MODIFY_UC_OBJECT

Fonction de script : Modifie l'attribut d'un objet activé.

Syntaxe

MODIFY_UC_OBJECT (RUN#, Attribute, Value)

Syntaxe	Description / format
RunID	Numéro d'exécution (RunID) de l'objet activé Format : littéral de script, nombre ou variable de script Notez que l'attribut EARLIEST_STARTTIME indique le RunID du Workflow auquel la tâche appartient (et non celui de la tâche).
Attribute	Attribut qui doit être modifié. Format : Nom AE ou variable de script
Value	Valeur qui doit être définie Format : Nom AE, littéral de script, nombre ou variable de script.

Syntaxe

Description / format

RunID

Numéro d'exécution (RunID) de l'objet activé
Format : littéral de script, nombre ou variable de script

Notez que l'attribut EARLIEST_STARTTIME indique le RunID du Workflow auquel la tâche appartient (et non celui de la tâche).

Attribute

Attribut qui doit être modifié.
Format : Nom AE ou variable de script

Value

Valeur qui doit être définie
Format : Nom AE, littéral de script, nombre ou variable de script.

Code retour
"0" : la modification de l'attribut est réussie. "20342" : cet attribut n'est pris en charge. Les codes retour de l'attribut IGNORE_SYNC sont : "11191" : le RunID n'a pas été trouvé. Les codes retour de PRIORITY sont : "20591" : le RunID n'a pas été trouvé. "20587" : la valeur de l'attribut n'est pas dans la plage 0-255. Les codes retour de l'attribut RELEASE sont : "11016" : le Workflow à modifier n'existe pas. "11510" : le Workflow n'est pas actif. "20540" : le RunID n'a pas été trouvé. Les codes retour de l'attribut RESPONSE sont : "20539" : la notification avec ce RunID n'existe pas. "20538" : la valeur n'est pas correcte. "11151" : la valeur de l'attribut RESPONSE ne correspond pas au type de notification (Message, Requête, Alerte). "11060" : la paire notification et valeur n'est pas prise en charge. "11061" : la notification a déjà été acceptée par un autre utilisateur. "11062" : la notification a été acquitée par un utilisateur qui n'est pas disponible dans la notification. "11064" : la notification a été rejetée par un uilisateur qui n'est pas disponible dans la notification. "20859" : la réaction à la notification vient d'un utilisateur qui est disponible dans l'objet notification mais qui est inactif. Les codes retour de l'attribut GR_MAX_PAR_JOBS sont "11121" : le RunID n'a pas été trouvé. "20460" : la valeur de l'attribut n'est pas dans la plage 1-999. Les codes retour des attributs GOIMM, EARLIEST_STARTTIME et REMOVE_DEPENDENCY sont : "20378" : le Workflow n'a pas été trouvé. "20840" : il existe plusieurs instances de cette tâche dans le Workflow. "20841" : cette tâche n'existe pas dans le Workflow. Pour les attributs GAP : 20534 : la valeur "0" n'est pas autorisée 20591 : le RunID n'a pas été trouvé. 20860 : ce n'est pas une tâche périodique 20861 : l'option "Avec un intervalle de :..." n'a pas été sélectionnée dans la tâche périodique.

Code retour

"0" : la modification de l'attribut est réussie.
"20342" : cet attribut n'est pris en charge.

Les codes retour de l'attribut IGNORE_SYNC sont :
"11191" : le RunID n'a pas été trouvé.

Les codes retour de PRIORITY sont :
"20591" : le RunID n'a pas été trouvé.
"20587" : la valeur de l'attribut n'est pas dans la plage 0-255.

Les codes retour de l'attribut RELEASE sont :
"11016" : le Workflow à modifier n'existe pas.
"11510" : le Workflow n'est pas actif.
"20540" : le RunID n'a pas été trouvé.

Les codes retour de l'attribut RESPONSE sont :
"20539" : la notification avec ce RunID n'existe pas.
"20538" : la valeur n'est pas correcte.
"11151" : la valeur de l'attribut RESPONSE ne correspond pas au type de notification (Message, Requête, Alerte).
"11060" : la paire notification et valeur n'est pas prise en charge.
"11061" : la notification a déjà été acceptée par un autre utilisateur.
"11062" : la notification a été acquitée par un utilisateur qui n'est pas disponible dans la notification.
"11064" : la notification a été rejetée par un uilisateur qui n'est pas disponible dans la notification.
"20859" : la réaction à la notification vient d'un utilisateur qui est disponible dans l'objet notification mais qui est inactif.

Les codes retour de l'attribut GR_MAX_PAR_JOBS sont
"11121" : le RunID n'a pas été trouvé.
"20460" : la valeur de l'attribut n'est pas dans la plage 1-999.

Les codes retour des attributs GOIMM, EARLIEST_STARTTIME et REMOVE_DEPENDENCY sont :
"20378" : le Workflow n'a pas été trouvé.
"20840" : il existe plusieurs instances de cette tâche dans le Workflow.
"20841" : cette tâche n'existe pas dans le Workflow.

Pour les attributs GAP :
20534 : la valeur "0" n'est pas autorisée
20591 : le RunID n'a pas été trouvé.
20860 : ce n'est pas une tâche périodique
20861 : l'option "Avec un intervalle de :..." n'a pas été sélectionnée dans la tâche périodique.

Les attributs des objets activés affichés dans le tableau ci-dessous peuvent être modifiés. Les nouvelles valeurs ne s'appliquent qu'à l'exécution courante de la tâche et ne sont pas enregistrées dans l'objet.

Type d'objet	Attribut	Valeur
CALL	RESPONSE Réaction à une notification.	"OK" : acquitter la notification (message). "YES" : répondre positivement à la notification (Requête). "NO" : répondre négativement à la notification (Requête). "ACCEPT" : accepter la notification (Alerte). "REJECT" : rejeter la notification (Alerte). "DONE" : traiter la notification (Alerte)
JOBG	GR_MAX_PAR_JOBS Nombre maximum de tâches exécutées en parallèle dans un groupe.	1 à 999 tâches exécutées en parallèle.
JOBP	RELEASE Libération d'un Workflow bloqué.	Numéro d'exécution (RunID) de la tâche bloquée dans le Workflow.
	Pour les trois attributs suivants, la tâche à modifier doit avoir le statut "Attente de pré-condition".
	GOIMM La tâche d'un Workflow démarre immédiatement	Nom de la tâche qui ne doit pas être utilisé plus d'une fois dans le Workflow.
	EARLIEST_STARTTIME Modifier l'heure de début au plus tôt d'une tâche dans un Workflow	Indiquez l'heure de début au plus tôt ou le mot clé "OFF". Dans les deux cas, la fonction de script requiert le nom de la tâche. Syntaxe du paramètre Valeur : Nom de la tâche, [format de l'heure;]heure ou Nom de la tâche, OFF L'heure de début est attribuée à la tâche ou remplace l'heure exsitante. La fonction de script attend l'heure au format "HHMMSS" si aucun format n'a été défini. Le mot clé "OFF" supprime une heure de début existante.
	REMOVE_DEPENDENCY Suppression de la dépendance avec le prédécesseur direct	La tâche ignore le statut de fin attendu (onglet Heure & dépendances) du prédécesseur indiqué. Par conséquent, le traitement de cette tâche se poursuit si tous les autres prédécesseurs sont déjà terminés. Syntaxe du paramètre Valeur : Nom de la tâche [, nom du prédécesseur] Lorsque vous n'indiquez pas de prédécesseur, tous les prédécesseurs sont ignorés et la tâche démarre immédiatement.
CALL, JOBF, JOBP, JOBS, JSCH, SCRI	PRIORITY Priorité de la tâche	Valeurs autorisées : 0 à 255
Tâches de Workflow	IGNORE_CONDITIONS	Démarre immédiatement une tâche de Workflow qui se trouve dans le statut "En attente des Pré-conditions". La valeur du paramètre n'est pas requise. Voir Onglets Précondition et Postcondition
Tâches de Workflow	CHECK_CONDITIONS	Démarre la vérification des conditions/actions d'une tâche de Workflow qui se trouve dans le statut "En attente des Pré-conditions". La valeur du paramètre n'est pas requise.
CALL, EVNT, JOBF, JOBG, JOBP, JOBQ,JOBS, JSCH, SCRI	IGNORE_QUEUE	Démarre immédiatement une tâche se trouvant dans un statut d'attente en raison du manque de slots de queue. La valeur du paramètre n'est pas requise.
Tous les objets activables	IGNORE_SYNC	Les paramètres de l'objet Sync sont ignorés. Ce paramètre doit être spécifié mais sa valeur est sans importance. Exemple MODIFY_UC_OBJECT( &RUNNR#, IGNORE_SYNC, "")
Tâches périodiques	GAP	Modifie l'intervalle de temps entre les exécutions d'une tâche périodique. Valeur en minutes
Tous les objets activables	SET_EXPRESS	Démarre immédiatement une tâche qui se trouve dans le statut "En attente de ressources" (JOBS, JOBF et JOBD). Valeurs autorisées : "ON" et "OFF"

Vous pouvez modifier cette tâche avec cette fonction de script, si elle est déjà créée mais qu'elle se trouve encore en statut d'attente. L'option Générer à l'exécution ne doit pas avoir été définie. Utilisez l'instruction de script :PUT_ATT pour modifier une tâche lors de sa génération.

Conseil : Utilisez l'instruction de script :ON_ERROR pour définir l'action à entreprendre si la modification n'a pas lieu. Pour plus d'informations, voir Éléments de script pour la gestion des erreurs.

L'instruction de script écrit toutes les transactions ouvertes du script dans la base de données AE. Pour plus d'informations, voir Traitement du script.

Exemples

Le premier exemple montre comment acquitter une notification (requête). Dans une première étape, le numéro d'exécution (RunID) doit être déterminé et enregistré dans la variable de script "&RUNNR#".

:SET &RUNNR# = ACTIVATE_UC_OBJECT("Nightshift")
!...
:SET &MODOBJ# = MODIFY_UC_OBJECT(&RUNNR#, RESPONSE, OK)

Dans le deuxième exemple, un groupe est activé et le numéro d'exécution (RunID) est enregistré dans une variable de script. Le nombre de tâches exécutées en parallèle dans le groupe est défini à "1". Les tâches sélectionnées sont traitées une par une.

:SET &RUNNR# = ACTIVATE_UC_OBJECT("GRP7")
:SET &MODOBJ# = MODIFY_UC_OBJECT( &RUNNR#, GR_MAX_PAR_JOBS, 1)

Les exemples suivants montrent des modifications de tâches exécutées dans un Workflow :

!The job "MM.CLOSING" should start immediately.
:SET &RUNNR# = GET_UC_OBJECT_NR(MM.DAY)
:SET &MODOBJ# = MODIFY_UC_OBJECT(&RUNNR#, GOIMM, "MM.CLOSING")

!The job "MM.CLOSING" should not run earlier than 3pm.
:SET &RUNNR# = GET_UC_OBJECT_NR(MM.DAY)
:SET &MODOBJ# = MODIFY_UC_OBJECT(&RUNNR#, EARLIEST_STARTTIME, "MM.CLOSING","150000")

!The job "MM.CLOSING" should ignore the earliest start time.
:SET &RUNNR# = GET_UC_OBJECT_NR(MM.DAY)
:SET &MODOBJ# = MODIFY_UC_OBJECT(&RUNNR#, EARLIEST_STARTTIME, "MM.CLOSING", OFF)

!The job "MM.CLOSING" should ignore the dependency to the predecessor "MM.DAY_END".
:SET &RUNNR# = GET_UC_OBJECT_NR(MAWI.TAG)
:SET &MODOBJ# = MODIFY_UC_OBJECT(&RUNNR#, REMOVE_DEPENDENCY, "MM.CLOSING", "MM.DAY_END")

Voir aussi :

Éléments de script associés