Services et services fonctionnels utiles
La section suivante présente certains services fonctionnels et services fournis par le produit qui peuvent être utiles aux implémentations.
Service Explorateur de données
Le système fournit un mécanisme permettant d'exécuter une instruction SELECT SQL, utilisable dans des scripts, des plug-ins Java ou via un appel de service Web. Pour ce faire, une zone utilisant l'un des types de zone d'explorateur de données où le SQL est défini doit être créée. Ensuite, un service fonctionnel utilisant le service Explorateur de données (FWLZDEXP) doit être créé.
Les points ci-dessous indiquent comment créer son propre service fonctionnel pour ce service. A noter qu'en général, un service fonctionnel distinct existe pour chaque zone.
- Entrez un code de service fonctionnel et une description. Il est conseillé de définir pour le service fonctionnel un code correspondant à celui de la zone afin qu'il soit plus facile de savoir quel service fonctionnel appelle quelle zone.
- Sélectionnez le nom de service FWLZDEXP.
- Dans l'onglet Schéma, sous le noeud <schema>, entrez le mapping des champs requis pour le service Explorateur de données :
- La zone doit être mappée dans le champ de service ZONE_CD. Définissez le code de zone comme valeur par défaut.
- Pour chaque filtre utilisateur défini dans la zone, créez un mapping de schéma dans le champ de service Fx_VALUE, où "x" est le numéro du filtre (provenant des paramètres de la zone).
- Pour chaque filtre masqué défini dans la zone, créez un mapping dans le champ de service Fx_VALUE, où "x" est le numéro du filtre (provenant des paramètres de la zone).
- Les résultats de la recherche sont renvoyés sous forme de liste par le service d'explorateur de données. Chaque valeur de colonne figure dans le champ de service COL_VALUE avec le numéro de séquence approprié (SEQNO). Les résultats peuvent être mis à plat d'après le numéro de séquence, ce qui permet de définir le nom d'un élément logique.
- Un autre champ utile est ROW_CNT, qui indique le nombre de lignes ramené par la recherche.
Ci-dessous figure un exemple de schéma pour un service fonctionnel qui reçoit un code d'objet métier et renvoie une liste de valeurs d'état avec leurs descriptions afin que les motifs des états puissent être définis.
<schema>
<zone mapField="ZONE_CD" default="F1-BOSTSLST"/>
<bo mapField="H1_VALUE" />>
<rowCount mapField="ROW_CNT"/>>
<results type="list" mapList="DE">>
<status dataType="string" mapField="COL_VALUE">
<row mapList="DE_VAL">>
<SEQNO is="1" />>
</row>>
</status>>
<description dataType="string" mapField="COL_VALUE">
<row mapList="DE_VAL">>
<SEQNO is="2" />>
</row>>
</description>>
</results>>
</schema>
Service Journal d'objet de maintenance
De nombreux objets de maintenance prennent en charge une table journal avec des noms de colonne et un fonctionnement sur le même modèle. Le système fournit un service appelé Service Journal d'objet de maintenance générique (F1MOLOGP) qui est utilisable pour réaliser des fonctions courantes liées aux entrées de journal :
-
Lire les entrées de journal. Si vous lui transmettez un certain objet de maintenance, une clé primaire et un numéro de séquence de journal, le service renvoie les détails de l'entrée de journal correspondante. Le produit comporte un service fonctionnel générique utilisable à cet effet : Objet métier générique - Extraire les détails du journal (F1–ReadMOLog). Autrement, il est possible de créer un service fonctionnel pour un objet de maintenance donné avec le code d'objet de maintenance affecté à l'élément d'objet de maintenance à l'aide de la syntaxe par défaut. Une fonctionnalité spécifique de cet objet de maintenance peut ainsi utiliser le service fonctionnel spécifique.
-
Ajouter un journal. Le service peut être utilisé pour ajouter une entrée de journal. Si un journal utilisateur est ajouté, les commentaires de l'utilisateur sont placés dans la description détaillée. Les entrées de journal générées par le système comportent généralement une catégorie de message/un numéro de message ainsi que d'autres informations telles que l'état, un type de journal particulier et, éventuellement, une référence d'objet lié (via une caractéristique). Le produit comporte un service fonctionnel générique utilisable à cet effet : Ajout de journal d'objet de maintenance générique (F1–AddMOLog). Autrement, il est possible de créer un service fonctionnel pour un objet de maintenance donné avec le code d'objet de maintenance affecté à l'élément d'objet de maintenance à l'aide de la syntaxe par défaut. Une fonctionnalité spécifique de cet objet de maintenance peut ainsi utiliser le service fonctionnel spécifique.
Services fonctionnels de base
Le tableau ci-dessous présente certains services fonctionnels fournis par le produit qui peuvent être utiles pour la logique personnalisée d'une implémentation.
Services liés aux objets métier
| Nom du service fonctionnel | Description |
|---|---|
| F1-AutoTransitionBO | Exécute les algorithmes de surveillance associés à l'état actuel d'une instance d'objet métier donnée (ce qui peut entraîner le passage à un état suivant). |
| F1-CompareBusinessObjectData | Compare deux versions d'une instance d'objet métier donnée. |
| F1-DetermineBo | Détermine l'objet métier d'une instance donnée d'un objet de maintenance en exécutant la logique Déterminer l'objet métier de l'objet de maintenance. |
| F1-GetRequiredFieldsForBOState | Renvoie les champs requis pour un état d'objet métier donné. |
| F1-RetrieveBOOption | Renvoie les valeurs d'option d'objet métier pour un objet métier et un type d'option donnés. |
| F1-RetrieveBOStatusOption | Renvoie les valeurs d'option d'objet métier pour un objet métier, un état et un type d'option donnés. |
| F1-RetrieveBOStatusOption | Extrait la liste des objets métier pour un objet de maintenance donné, qui sont accessibles pour l'utilisateur actuel. |
| F1-RetrieveBoStatusDescription | Renvoie la description d'un état d'objet métier donné. |
| F1-RetrieveBusinessObjectLabel | Renvoie l'étiquette appropriée pour un chemin donné (par exemple élément) dans un schéma d'objet métier. |
| F1-RetrieveNextStates | Renvoie la liste des états suivants possibles d'après les valeurs entrées : un objet de maintenance et sa clé primaire ou un objet métier et l'un de ses états. |
Services liés à l'email
| Nom du service fonctionnel | Description |
|---|---|
| F1-EmailService | Envoie un email en temps réel. |
| F1-RetrieveEmailAddress | Extrait les adresses électroniques des utilisateurs appartenant à un rôle de tâche. |
| F1-RetrieveEnvironmentURL | Extrait l'URL de l'environnement actuel pour l'installation. |
Outils pour les matrices et les scripts
| Nom du service fonctionnel | Description |
|---|---|
| F1-AddWarning | Ce service fonctionnel peut être utilisé pour consigner un avertissement en fournissant les détails du message. Le système collecte tous les avertissements et les affiche à l'utilisateur en une seule fois. |
| F1-CheckOnlineConnection | Vérifie si la connexion est en ligne ou via un batch. |
| F1-CheckWarning | Utilisé pour vérifier si des avertissements ont été cumulés. Si des avertissements ont été cumulés, toute logique qui ne peut pas être annulée (lorsque les avertissements sont affichés) ne doit pas être exécutée. |
| F1-DateMath | Effectue divers calculs mathématiques sur les dates et les heures. Pour plus de détails, voir la description du service fonctionnel. |
| F1-DateTimeFormattingService | Formate une date/heure donnée selon les paramètres du profil d'affichage de l'utilisateur. |
| F1-ExecuteScriptInNewSession | Exécute un script de service dans une nouvelle session/transaction de traitement. |
| F1-GetFieldLabel | Extrait l'étiquette d'un champ donné. |
| F1-GetForeignKeyReference | Renvoie les informations de référence de clé étrangère pour une référence de clé étrangère et une clé primaire données : description des informations, option de navigation, menu contextuel, etc. |
| F1-GetFKReferenceDetails | Renvoie les informations de référence de clé étrangère pour un objet de maintenance et une clé primaire donnés : code de référence de clé étrangère, description des informations, option de navigation, zone de recherche, menu contextuel, etc. |
| F1-GetLookupDescription | Renvoie la description d'une valeur de champ de consultation d'après un nom de champ de consultation donné. |
| F1-GetExtLookUpVal | Renvoie la liste de valeurs d'un objet métier de consultation avancée donné. |
| F1-GetMonthInYearAbbreviation | Renvoie l'abréviation du mois sur 3 caractères pour une date entrée au format système. |
| F1-NumberAmountFormatter | Formate un montant ou un nombre donné selon les paramètres du profil d'affichage de l'utilisateur. Peut également recevoir des entrées pour ajuster l'échelle et éventuellement appliquer des paramètres de devise. |
| F1-OutmsgDispatcher | Diffuse un message en temps réel en donnant à l'utilisateur la possibilité de le rendre persistant dans la base de données et d'intercepter les erreurs pouvant se produire durant l'appel. Voir aussi Messages en temps réel. |
| F1-OutmsgMediator | Utilisable à la place de F1-OutmsgDispatcher, cette fonction peut être préférable si l'émetteur n'a pas besoin qu'un enregistrement de message sortant soit instancié. Voir aussi Messages en temps réel. |
| F1-RethrowError | Emet une erreur d'application en utilisant les catégorie/numéro/paramètres de message entrés. |
| F1-RetrieveMODescription | Extrait la description d'un objet de maintenance. |
| F1-ReturnMessage | Renvoie le message développé d'après une catégorie, un numéro, des paramètres et des types de paramètre de message. |
| F1-SavePointDispatcher | Permet l'exécution d'un script de service avec interception des erreurs et restauration de la transaction à un point de sauvegarde défini avant l'exécution du script. |
Service liés à l'utilisateur
| Nom du service fonctionnel | Commentaires |
|---|---|
| F1-CheckApplicationSecurity | Vérifie la sécurité d'un utilisateur pour un service applicatif/mode d'accès donné. |
| F1-CheckUserAuthorization | Détermine si un utilisateur donné dispose d'une autorisation d'accès d'après le service applicatif, le code de sécurité et le niveau d'autorisation entrés. |
| F1-DetermineIfUserCanApproveTD | Détermine si l'utilisateur actuel peut approuver une entrée de tâche donnée. |