API script d'une instance (bp)

De Wiki1000

Valeurs de retour des activités

La valeur de retour de l’exécution détermine la séquence qui sera enchaînée .

bprOK La séquence Succès sera enchaînée
bprNOK La séquence Echec sera enchaînée
bprWAIT L’instance reste dans l’état courant et l’activité sera ré exécutée au prochain cycle.
bprHALT L’instance est interrompue.
bprERR L’instance est interrompue. (TODO)

Une erreur de compilation est équivalente à un retour bprOK.

Attributs spécifiques aux processus métiers

Propriété Usage
Instance Référence sur l’objet métier rattaché à l’instance du processus
ProcessId Identifiant du processus
InstanceId Identifiant de l’instance du processus

Cet identifiant est unique pour une exécution du processus, si le processus est placé dans plusieurs machines l’unicité n’est pas garantie.

InstanceGUID GUID de l’instance du processus.

Cet identifiant est un GUID tiré par le système et garanti unique.

HostName Nom du Serveur exécutant le processus
HostServiceName Nom du Service exécutant le processus
HostBaseURL Base de l’URL du serveur exécutant le processus.
HostBaseRESTURL Base de l’URL des services REST du serveur, égale à

(BaseHostURL)rpc.l1000/rest/

PublicFolder Répertoire publique du serveur
InstanceFolder Un répertoire réservé à l’instance du processus
InstanceDatabaseURL L’Url de la base de données associée à l’instance du processus.

Opérations spécifiques aux processus métiers

function Get(const iPrefixedParameter :string) :Variant ;
function GetParameter(const iPrefix:string; const iName:string):Variant;
Ces méthodes retournent la valeur d’un paramètre.
function GetPublicFolder(const aSubFolder:string):string;
Cette méthode retourne un chemin de repertoire dans la zone publique du serveur.
procedure Set(const iPrefixedParameter :string; const value:Variant);
procedure AddParameter(const iPrefix:string; const iName:string; const value:Variant);
Ces méthodes positionnent la valeur d’un attribut, si celui-ci n’existe pas il est créé.
function uniqueID(const aPrefixedParameter :string) :variant ;
Positionne la valeur d’un attribut avec un identifiant unique. Si celui-ci n’existe pas il est créé. Un identifiant unique est un GUID (Global Unique Identifier) et invisible pour l’utilisateur, tiré sur la machine exécutant le processus.
Procedure setInstance(const iOID :TOID) ;
Cette méthode définit l’instance d’objet métier associé à l’instance du processus métier.
Procedure AddMessage(const imsg :string) ;
Cette méthode ajoute un message dans la liste des messages de l’instance du processus métier.
Outils personnels