API script d'une instance (bp)

De Wiki1000
(Différences entre les versions)
(Page créée avec « ====Valeurs de retour des activités==== La valeur de retour de l’exécution détermine la séquence qui sera enchaînée . {| class="wikitable" |- |bprOK |La séquence Su… »)
 
(→Attributs spécifiques aux processus métiers)
 
(4 révisions intermédiaires par un utilisateur sont masquées)
Ligne 25 : Ligne 25 :
 
{| class="wikitable"
 
{| class="wikitable"
 
|-
 
|-
−
|Instance
+
!Propriété
−
|Référence
+
!Usage
 +
|-
 +
|[[Instance (bp instance)|Instance]]
 
|Référence sur l’objet métier rattaché à l’instance du processus
 
|Référence sur l’objet métier rattaché à l’instance du processus
 
|-
 
|-
−
|ProcessId
+
|[[Parameters (bp instance)|Parameters]]
−
|Chaîne
+
|L'objet gérant les paramètres de l’instance du processus
 +
|-
 +
|[[ProcessId (bp instance)|ProcessId]]
 
|Identifiant du processus
 
|Identifiant du processus
 
|-
 
|-
−
|InstanceId
+
|[[InstanceId (bp instance)|InstanceId]]
−
|Chaîne
+
 
|Identifiant de l’instance du processus
 
|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
+
|[[InstanceGUID (bp instance)|InstanceGUID]]
−
|Chaîne
+
 
|GUID de l’instance du processus.
 
|GUID de l’instance du processus.
−
 
−
Cet identifiant est un GUID tiré par le système et garanti unique.
 
 
|-
 
|-
−
|HostName
+
|[[HostName (bp instance)|HostName]]
−
|Chaîne
+
 
|Nom du Serveur exécutant le processus
 
|Nom du Serveur exécutant le processus
 
|-
 
|-
−
|HostServiceName
+
|[[HostServiceName (bp instance)|HostServiceName]]
−
|Chaîne
+
 
|Nom du Service exécutant le processus
 
|Nom du Service exécutant le processus
 
|-
 
|-
−
|HostBaseURL
+
|[[HostBaseURL (bp instance)|HostBaseURL]]
−
|Chaîne
+
 
|Base de l’URL du serveur exécutant le processus.
 
|Base de l’URL du serveur exécutant le processus.
 
|-
 
|-
−
|HostBaseRESTURL
+
|[[URLHostName (bp instance)|URLHostName]]
−
|Chaîne
+
|Nom du Serveur dans l'URL de ce Service.
 +
|-
 +
|[[URLProtocol (bp instance)|URLProtocol]]
 +
|Nom du protocole dans l'URL de ce Service.
 +
|-
 +
|[[HostBaseRESTURL (bp instance)|HostBaseRESTURL]]
 
|Base de l’URL des services REST du serveur, égale à
 
|Base de l’URL des services REST du serveur, égale à
−
 
−
(BaseHostURL)rpc.l1000/rest/
 
 
|-
 
|-
−
|PublicFolder
+
|[[PublicFolder (bp instance)|PublicFolder]]
−
|Chaîne
+
 
|Répertoire publique du serveur
 
|Répertoire publique du serveur
 
|-
 
|-
−
|InstanceFolder
+
|[[InstanceFolder (bp instance)|InstanceFolder]]
−
|Chaîne
+
 
|Un répertoire réservé à l’instance du processus
 
|Un répertoire réservé à l’instance du processus
 
|-
 
|-
−
|InstanceDatabaseURL
+
|[[InstanceDatabaseURL (bp instance)|InstanceDatabaseURL]]
−
|Chaîne
+
 
|L’Url de la base de données associée à l’instance du processus.
 
|L’Url de la base de données associée à l’instance du processus.
 
|}
 
|}
Ligne 79 : Ligne 74 :
 
{|class="wikitable"
 
{|class="wikitable"
 
|-
 
|-
−
|<source lang='delphi'>function Get(const iPrefixedParameter :string) :Variant ;</source>
+
|[[Get (bp instance)|Get]]
−
|
+
|Retrouve la valeur d'un paramètre.
 
|-
 
|-
−
|<source lang='delphi'>function GetParameter(const iPrefix:string; const iName:string):Variant;</source>
+
|[[Set (bp instance)|Set]]
−
|Ces méthodes retournent la valeur d’un paramètre.
+
|Définit la valeur d'un paramètre.
 
|-
 
|-
−
|<source lang='delphi'>function GetPublicFolder(const aSubFolder:string):string;</source>
+
|[[GetParameter (bp instance)|GetParameter]]
−
|Cette méthode retourne un chemin de repertoire dans la zone publique du serveur.
+
|Retrouve la valeur d'un paramètre.
 
|-
 
|-
−
|<source lang='delphi'>procedure Set(const iPrefixedParameter :string; const value:Variant);</source>
+
|[[AddParameter (bp instance)|AddParameter]]
−
|
+
|Définit la valeur d'un paramètre.
 
|-
 
|-
−
|<source lang='delphi'>procedure AddParameter(const iPrefix:string; const iName:string; const value:Variant);</source>
+
|[[GetPublicFolder (bp instance)|GetPublicFolder]]
−
|Ces méthodes positionnent la valeur d’un attribut, si celui-ci n’existe pas il est créé.
+
|Retourne un chemin de répertoire dans la zone publique du serveur.
 
|-
 
|-
−
|<source lang='delphi'>function uniqueID(const aPrefixedParameter :string) :variant ;</source>
+
|[[UniqueID (bp instance)|UniqueID]]
−
|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.
+
|Retourne ou définit un paramètre de valeur unique
 
|-
 
|-
−
|<source lang='delphi'>Procedure setInstance(const iOID :TOID) ;</source>
+
|[[SetInstance (bp instance)|SetInstance]]
−
|Cette méthode définit l’instance d’objet métier associé à l’instance du processus métier.
+
|Définit l’instance d’objet métier associée à l’instance du processus métier.
 
|-
 
|-
−
|<source lang='delphi'>Procedure AddMessage(const imsg :string) ;</source>
+
|[[AddMessage (bp instance)|AddMessage]]
−
|Cette méthode ajoute un message dans la liste des messages de l’instance du processus métier.
+
|Ajoute un message dans la liste des messages de l’instance du processus métier.
 
|}
 
|}
  
 
[[category:Processus Métiers]]
 
[[category:Processus Métiers]]

Version actuelle en date du 15 novembre 2011 à 17:17

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
Parameters L'objet gérant les paramètres de l’instance du processus
ProcessId Identifiant du processus
InstanceId Identifiant de l’instance du processus
InstanceGUID GUID de l’instance du processus.
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.
URLHostName Nom du Serveur dans l'URL de ce Service.
URLProtocol Nom du protocole dans l'URL de ce Service.
HostBaseRESTURL Base de l’URL des services REST du serveur, égale à
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

Get Retrouve la valeur d'un paramètre.
Set Définit la valeur d'un paramètre.
GetParameter Retrouve la valeur d'un paramètre.
AddParameter Définit la valeur d'un paramètre.
GetPublicFolder Retourne un chemin de répertoire dans la zone publique du serveur.
UniqueID Retourne ou définit un paramètre de valeur unique
SetInstance Définit l’instance d’objet métier associée à l’instance du processus métier.
AddMessage Ajoute un message dans la liste des messages de l’instance du processus métier.
Récupérée de « https://frp.sage.fr/wiki1000/index.php?title=API_script_d%27une_instance_(bp)&oldid=6053 »
Outils personnels