Services UI prédéfinis
EBX® inclut des services UI prédéfinis. Ces services peuvent être utilisés :
Cette page référence tous les services UI prédéfinis et leurs paramètres.
Related information
Accéder à des données (service par défaut)
Par défaut, un workflow considère automatiquement ce service comme terminé. Le bouton "Accepter" est donc toujours disponible.
Ce service est utilisé par défaut si aucun service n'est spécifié.
Paramètres en entrée
| Paramètre | Libellé | Description |
|---|---|---|
branch |
Espace de données | Identifiant de l'espace de données concerné - Un espace de données est obligatoire pour ce service. |
disableAutoComplete |
Désactiver Accepter au démarrage | Par défaut, l'interaction associée à ce service est directement considérée comme terminée. Par conséquent, le bouton Accepter est automatiquement affiché à l'ouverture du bon de travail. Ce paramètre est utile pour désactiver ce comportement. Si la valeur est "true", le développeur a la charge de terminer l'interaction en utilisant SessionInteraction dans un service UI ou un trigger, par exemple. La valeur par défaut est "false". Les perspectives n'utilisent pas ce paramètre. |
firstCallDisplay |
Mode d'affichage du premier appel | Définit le mode d'affichage qui doit être utilisé lorsqu'une table filtrée ou un enregistrement est affiché lors du premier appel. Défaut (valeur = 'auto') : l'affichage est défini automatiquement en fonction de la sélection. Vue (valeur = 'view') : force l'affichage de la vue tabulaire ou hiérarchique. Enregistrement (valeur = 'record') : si le prédicat a au moins un enregistrement, force l'affichage du formulaire de l'enregistrement. |
instance |
Jeu de données | La valeur saisie doit être une référence vers un jeu de données qui existe dans l'espace de données saisi. |
scope |
Périmètre | Définit le périmètre de la navigation utilisateur pour ce service, c'est-à-dire les entités que l'utilisateur peut sélectionner dans sa session. Si non renseignée, la valeur utilisée sera celle par défaut. Pour les perspectives, la valeur par défaut est toujours 'node'. Pour les workflows, la valeur par défaut dépend des entités ou du service sélectionnés. |
trackingInfo |
Informations de suivi | Les informations de suivi sont enregistrées dans les logs 'historique'. Ces informations peuvent également être utilisées dans d'autres buts comme le contrôle d'accès ou une mise à disposition d'informations supplémentaires. |
version |
Image | Identifiant de l'image concernée - Un espace de données est obligatoire pour ce service. |
viewPublication |
Vue | Le nom de publication de la vue à afficher. La vue doit être configurée pour la table sélectionnée. |
xpath |
Noeud du jeu de données (XPath) | La valeur saisie doit être un chemin absolu d'un noeud dans le jeu de données saisi. La notation doit être conforme à la convention XPath, sous sa forme abrégée. |
Créer un nouvel enregistrement
Pour un workflow, le service creation est considéré terminé après la première soumission sans erreur (enregistrement créé). Si ce service est appelé alors qu'il est déjà terminé, l'enregistrement créé est affiché en mode modification ou lecture seule (selon les droits de l'utilisateur).
Paramètre d'appel du service :
service=@creation
Paramètres en entrée
| Paramètre | Libellé | Description |
|---|---|---|
branch |
Espace de données | Identifiant de l'espace de données concerné - Ce champ est obligatoire pour ce service. |
instance |
Jeu de données | La valeur saisie doit être une référence vers un jeu de données qui existe dans l'espace de données saisi - Ce champ est obligatoire pour ce service. |
scope |
Périmètre | Définit le périmètre de la navigation utilisateur pour ce service, c'est-à-dire les entités que l'utilisateur peut sélectionner dans sa session. Si non renseignée, la valeur utilisée sera celle par défaut. Pour les perspectives, la valeur par défaut est toujours 'node'. Pour les workflows, la valeur par défaut dépend des entités ou du service sélectionnés. |
trackingInfo |
Informations de suivi | Les informations de suivi sont enregistrées dans les logs 'historique'. Ces informations peuvent également être utilisées dans d'autres buts comme le contrôle d'accès ou une mise à disposition d'informations supplémentaires. |
xpath |
Table du jeu de données (XPath) | La valeur saisie doit être un chemin absolu d'une table dans le jeu de données saisi. La notation doit être conforme à la convention XPath, sous sa forme abrégée - Ce champ est obligatoire pour ce service. |
Paramètres en sortie
| Paramètre | Libellé | Description |
|---|---|---|
created |
Enregistrement créé | Contient le xPath de l'enregistrement créé. |
Dupliquer un enregistrement
Pour un workflow, le service duplicate est considéré terminé après la première soumission sans erreur (enregistrement créé). Si ce service est appelé alors qu'il est déjà terminé, l'enregistrement créé est affiché en mode modification ou lecture seule (selon les droits de l'utilisateur).
Paramètre d'appel du service :
service=@duplicate
Paramètres en entrée
| Paramètre | Libellé | Description |
|---|---|---|
branch |
Espace de données | Identifiant de l'espace de données concerné - Ce champ est obligatoire pour ce service. |
instance |
Jeu de données | La valeur saisie doit être une référence vers un jeu de données qui existe dans l'espace de données saisi - Ce champ est obligatoire pour ce service. |
scope |
Périmètre | Définit le périmètre de la navigation utilisateur pour ce service, c'est-à-dire les entités que l'utilisateur peut sélectionner dans sa session. Si non renseignée, la valeur utilisée sera celle par défaut. Pour les perspectives, la valeur par défaut est toujours 'node'. Pour les workflows, la valeur par défaut dépend des entités ou du service sélectionnés. |
trackingInfo |
Informations de suivi | Les informations de suivi sont enregistrées dans les logs 'historique'. Ces informations peuvent également être utilisées dans d'autres buts comme le contrôle d'accès ou une mise à disposition d'informations supplémentaires. |
xpath |
Enregistrement à dupliquer (XPath) | La valeur saisie doit être un chemin absolu d'un enregistrement existant. La notation doit être conforme à la convention XPath, sous sa forme abrégée - Ce champ est obligatoire pour ce service. |
Paramètres en sortie
| Paramètre | Libellé | Description |
|---|---|---|
created |
Enregistrement créé | Contient le xPath de l'enregistrement créé. |
Exporter les données depuis une table au format XML
Le service exportToXML est considéré terminé une fois l'export terminé et le fichier téléchargé.
Paramètre d'appel du service :
service=@exportToXML
Paramètres en entrée
| Paramètre | Libellé | Description |
|---|---|---|
branch |
Espace de données | Identifiant de l'espace de données concerné - Un espace de données est obligatoire pour ce service. |
instance |
Jeu de données | La valeur saisie doit être une référence vers un jeu de données qui existe dans l'espace de données saisi - Ce champ doit être renseigné pour ce service. |
scope |
Périmètre | Définit le périmètre de la navigation utilisateur pour ce service, c'est-à-dire les entités que l'utilisateur peut sélectionner dans sa session. Si non renseignée, la valeur utilisée sera celle par défaut. Pour les perspectives, la valeur par défaut est toujours 'node'. Pour les workflows, la valeur par défaut dépend des entités ou du service sélectionnés. |
trackingInfo |
Informations de suivi | Les informations de suivi sont enregistrées dans les logs 'historique'. Ces informations peuvent également être utilisées dans d'autres buts comme le contrôle d'accès ou une mise à disposition d'informations supplémentaires. |
version |
Image | Identifiant de l'image concernée - Un espace de données est obligatoire pour ce service. |
xpath |
Table du jeu de données à exporter (XPath) | La valeur saisie doit être un chemin absolu d'une table dans le jeu de données saisi. La notation doit être conforme à la convention XPath, sous sa forme abrégée - Ce champ est obligatoire pour ce service. |
Exporter les données depuis une table au format CSV
Un workflow considère automatiquement le service exportToCSV comme terminé une fois l'export achevé et le fichier téléchargé.
Paramètre d'appel du service :
service=@exportToCSV
Paramètres en entrée
| Paramètre | Libellé | Description |
|---|---|---|
branch |
Espace de données | Identifiant de l'espace de données concerné - Un espace de données est obligatoire pour ce service. |
instance |
Jeu de données | La valeur saisie doit être une référence vers un jeu de données qui existe dans l'espace de données saisi - Ce champ doit être renseigné pour ce service. |
scope |
Périmètre | Définit le périmètre de la navigation utilisateur pour ce service, c'est-à-dire les entités que l'utilisateur peut sélectionner dans sa session. Si non renseignée, la valeur utilisée sera celle par défaut. Pour les perspectives, la valeur par défaut est toujours 'node'. Pour les workflows, la valeur par défaut dépend des entités ou du service sélectionnés. |
trackingInfo |
Informations de suivi | Les informations de suivi sont enregistrées dans les logs 'historique'. Ces informations peuvent également être utilisées dans d'autres buts comme le contrôle d'accès ou une mise à disposition d'informations supplémentaires. |
version |
Image | Identifiant de l'image concernée - Un espace de données est obligatoire pour ce service. |
xpath |
Table du jeu de données à exporter (XPath) | La valeur saisie doit être un chemin absolu d'une table dans le jeu de données saisi. La notation doit être conforme à la convention XPath, sous sa forme abrégée - Ce champ est obligatoire pour ce service. |
Importer les données dans une table depuis un fichier XML
Un workflow considère le service importFromXML comme terminé une fois l'import réussi.
Paramètre d'appel du service :
service=@importFromXML
Paramètres en entrée
| Paramètre | Libellé | Description |
|---|---|---|
branch |
Espace de données | Identifiant de l'espace de données concerné - Un espace de données est obligatoire pour ce service. |
instance |
Jeu de données | La valeur saisie doit être une référence vers un jeu de données qui existe dans l'espace de données saisi - Ce champ doit être renseigné pour ce service. |
scope |
Périmètre | Définit le périmètre de la navigation utilisateur pour ce service, c'est-à-dire les entités que l'utilisateur peut sélectionner dans sa session. Si non renseignée, la valeur utilisée sera celle par défaut. Pour les perspectives, la valeur par défaut est toujours 'node'. Pour les workflows, la valeur par défaut dépend des entités ou du service sélectionnés. |
trackingInfo |
Informations de suivi | Les informations de suivi sont enregistrées dans les logs 'historique'. Ces informations peuvent également être utilisées dans d'autres buts comme le contrôle d'accès ou une mise à disposition d'informations supplémentaires. |
xpath |
Table du jeu de données dans laquelle importer (XPath) | La valeur saisie doit être un chemin absolu d'une table dans le jeu de données saisi. La notation doit être conforme à la convention XPath, sous sa forme abrégée - Ce champ est obligatoire pour ce service. |
Importer les données dans une table depuis un fichier CSV
Un workflow considère le service importFromCSV comme terminé une fois l'import réussi.
Paramètre d'appel du service :
service=@importFromCSV
Paramètres en entrée
| Paramètre | Libellé | Description |
|---|---|---|
branch |
Espace de données | Identifiant de l'espace de données concerné - Un espace de données est obligatoire pour ce service. |
instance |
Jeu de données | La valeur saisie doit être une référence vers un jeu de données qui existe dans l'espace de données saisi - Ce champ doit être renseigné pour ce service. |
scope |
Périmètre | Définit le périmètre de la navigation utilisateur pour ce service, c'est-à-dire les entités que l'utilisateur peut sélectionner dans sa session. Si non renseignée, la valeur utilisée sera celle par défaut. Pour les perspectives, la valeur par défaut est toujours 'node'. Pour les workflows, la valeur par défaut dépend des entités ou du service sélectionnés. |
trackingInfo |
Informations de suivi | Les informations de suivi sont enregistrées dans les logs 'historique'. Ces informations peuvent également être utilisées dans d'autres buts comme le contrôle d'accès ou une mise à disposition d'informations supplémentaires. |
xpath |
Table du jeu de données dans laquelle importer (XPath) | La valeur saisie doit être un chemin absolu d'une table dans le jeu de données saisi. La notation doit être conforme à la convention XPath, sous sa forme abrégée - Ce champ est obligatoire pour ce service. |
Accéder à un espace de données
Un workflow considère automatiquement le service de sélection d'espace de données comme terminé.
Paramètre d'appel du service :
service=@selectDataSpace
Paramètres en entrée
| Paramètre | Libellé | Description |
|---|---|---|
branch |
Espace de données | Identifiant de l'espace de données concerné - Un espace de données est obligatoire pour ce service. |
scope |
Périmètre | Définit le périmètre de la navigation utilisateur pour ce service, c'est-à-dire les entités que l'utilisateur peut sélectionner dans sa session. Si non renseignée, la valeur utilisée sera celle par défaut. Pour les perspectives, la valeur par défaut est toujours 'node'. Pour les workflows, la valeur par défaut dépend des entités ou du service sélectionnés. |
trackingInfo |
Informations de suivi | Les informations de suivi sont enregistrées dans les logs 'historique'. Ces informations peuvent également être utilisées dans d'autres buts comme le contrôle d'accès ou une mise à disposition d'informations supplémentaires. |
version |
Image | Identifiant de l'image concernée - Un espace de données est obligatoire pour ce service. |
Valider un espace de données, une image ou un jeu de données
Un workflow considère automatiquement le service validation comme terminé.
Paramètre d'appel du service :
service=@validation
Paramètres en entrée
| Paramètre | Libellé | Description |
|---|---|---|
branch |
Espace de données | Identifiant de l'espace de données concerné - Un espace de données ou une image est obligatoire pour ce service. |
instance |
Jeu de données | La valeur saisie doit être une référence vers un jeu de données qui existe dans l'espace de données saisi. |
scope |
Périmètre | Définit le périmètre de la navigation utilisateur pour ce service, c'est-à-dire les entités que l'utilisateur peut sélectionner dans sa session. Si non renseignée, la valeur utilisée sera celle par défaut. Pour les perspectives, la valeur par défaut est toujours 'node'. Pour les workflows, la valeur par défaut dépend des entités ou du service sélectionnés. |
trackingInfo |
Informations de suivi | Les informations de suivi sont enregistrées dans les logs 'historique'. Ces informations peuvent également être utilisées dans d'autres buts comme le contrôle d'accès ou une mise à disposition d'informations supplémentaires. |
version |
Image | Identifiant de l'image concernée - Un espace de données ou une image est obligatoire pour ce service. |
Paramètres en sortie
| Paramètre | Libellé | Description |
|---|---|---|
hasError |
Erreurs trouvées | Contient 'true' si la validation a généré des erreurs. |
hasFatal |
Erreurs fatales trouvées | Contient 'true' si la validation a généré des erreurs fatales. |
hasInfo |
Informations trouvées | Contient 'true' si la validation a généré des informations. |
hasWarning |
Avertissements trouvées | Contient 'true' si la validation a généré des avertissements. |
Fusionner un espace de données
Un workflow considère le service merge comme terminé une fois la fusion effectuée et l'espace de données fermé.
Paramètre d'appel du service :
service=@merge
Paramètres en entrée
| Paramètre | Libellé | Description |
|---|---|---|
branch |
Espace de données | Identifiant de l'espace de données concerné - Ce champ est obligatoire pour ce service. |
scope |
Périmètre | Définit le périmètre de la navigation utilisateur pour ce service, c'est-à-dire les entités que l'utilisateur peut sélectionner dans sa session. Si non renseignée, la valeur utilisée sera celle par défaut. Pour les perspectives, la valeur par défaut est toujours 'node'. Pour les workflows, la valeur par défaut dépend des entités ou du service sélectionnés. |
trackingInfo |
Informations de suivi | Les informations de suivi sont enregistrées dans les logs 'historique'. Ces informations peuvent également être utilisées dans d'autres buts comme le contrôle d'accès ou une mise à disposition d'informations supplémentaires. |
Paramètres en sortie
| Paramètre | Libellé | Description |
|---|---|---|
mergeResult |
Réussite de la fusion | Contient 'true' si la fusion a réussi, 'false' sinon. |
mergeState |
État de la fusion | Contient le code de retour de la fusion. Il est fortement recommandé de parser cette valeur en utilisant le classe UIHttpManagerComponentReturnCode. |
Accéder à l'interface de fusion des espace de données
Le service merge.view est automatiquement considéré comme terminé.
Paramètre d'appel du service :
service=@merge.view
Paramètres en entrée
| Paramètre | Libellé | Description |
|---|---|---|
branch |
Espace de données | Identifiant de l'espace de données concerné - Ce champ est obligatoire pour ce service. |
scope |
Périmètre | Définit le périmètre de la navigation utilisateur pour ce service, c'est-à-dire les entités que l'utilisateur peut sélectionner dans sa session. Si non renseignée, la valeur utilisée sera celle par défaut. Pour les perspectives, la valeur par défaut est toujours 'node'. Pour les workflows, la valeur par défaut dépend des entités ou du service sélectionnés. |
trackingInfo |
Informations de suivi | Les informations de suivi sont enregistrées dans les logs 'historique'. Ces informations peuvent également être utilisées dans d'autres buts comme le contrôle d'accès ou une mise à disposition d'informations supplémentaires. |
Comparer deux contenus
Un workflow considère automatiquement le service compare comme terminé.
Paramètre d'appel du service :
service=@compare
Paramètres en entrée
| Paramètre | Libellé | Description |
|---|---|---|
branch |
Espace de données | Identifiant de l'espace de données concerné - Un espace de données ou une image, et un espace de données ou une image à comparer sont obligatoires pour ce service. |
compare.branch |
Espace de données à comparer | Identifiant de l'espace de données à comparer - Un espace de données et un espace de données à comparer sont obligatoires pour ce service. |
compare.filter |
Filtre de comparaison | Pour ignorer l'héritage et les champs de valeurs calculées lors de la comparaison (désactiver le mode résolu), le filtre "persistedValuesOnly" doit être spécifié. Par défaut, lorsqu'aucun filtre n'est défini, la comparaison utilise le mode résolu. |
compare.instance |
Jeu de données à comparer | La valeur saisie doit être une référence vers un jeu de données qui existe dans l'espace de données à comparer saisi. |
compare.version |
Image à comparer | Identifiant de l'image à comparer - Un espace de données et un espace de données à comparer sont obligatoires pour ce service. |
compare.xpath |
Table ou enregistrement à comparer (XPath) | La valeur saisie doit être un chemin absolu d'une table ou d'un enregistrement dans le jeu de données à comparer saisi. La notation doit être conforme à la convention XPath, sous sa forme abrégée. |
instance |
Jeu de données | La valeur saisie doit être une référence vers un jeu de données qui existe dans l'espace de données saisi. |
scope |
Périmètre | Définit le périmètre de la navigation utilisateur pour ce service, c'est-à-dire les entités que l'utilisateur peut sélectionner dans sa session. Si non renseignée, la valeur utilisée sera celle par défaut. Pour les perspectives, la valeur par défaut est toujours 'node'. Pour les workflows, la valeur par défaut dépend des entités ou du service sélectionnés. |
trackingInfo |
Informations de suivi | Les informations de suivi sont enregistrées dans les logs 'historique'. Ces informations peuvent également être utilisées dans d'autres buts comme le contrôle d'accès ou une mise à disposition d'informations supplémentaires. |
version |
Image | Identifiant de l'image concernée - Un espace de données ou une image, et un espace de données ou une image à comparer sont obligatoires pour ce service. |
xpath |
Table ou enregistrement (XPath) | La valeur saisie doit être un chemin absolu d'une table ou d'un enregistrement dans le jeu de données saisi. La notation doit être conforme à la convention XPath, sous sa forme abrégée. |
Workflows de données
Ce service fournit un accès aux interfaces utilisateurs des workflows de données.
Paramètre d'appel du service :
service=@workflow
Note:
Ce service est destiné aux perspectives uniquement.