uip pm apps data-model, uip pm apps model

Syntaxe et options de modification du modèle de données structurées et du modèle sémantique d'une application Process Mining — tables, champs, tableaux de bord et mesures — avec `uip pm apps data-model` et `uip pm apps model`.

Une partie de l'outil uip pm . Cette page couvre les deux interfaces de modification de modèle sur une application de processus:

• apps data-model — le graphique structurel des tables: quelles tables existent, leurs clés primaires et externes et comment elles sont jointes à Cases
• apps model — le modèle sémantique: champs et leurs types de données, champs calculés, tableaux de bord et mesures. Inclut fields, dashboards et metrics sous-groupes pour les modifications ciblées, plus get/update pour l'ensemble du document.
• apps data-mapping — le mappage des données d'entrée de l'application: quelle table/colonne source alimente quel champ cible. Distinctif du modèle de données ci-dessus (il s’agit du graphique de table interrogeable après le mappage).

Chaque écriture ici est protégée par ETag - voir Concepts sur la page parente.

Synthèse

uip pm apps data-model get <app-id> [--stage dev|published] [--destination <file>]
uip pm apps data-model add-table <app-id> --file <json-file> [--stage dev|published]

uip pm apps model get <app-id> [--stage dev|published] [--destination <file>]
uip pm apps model update <app-id> --file <json-file> --etag <etag>

uip pm apps model fields list <app-id> [--stage dev|published]
uip pm apps model fields set <app-id> <field-id> [--kind <kind>] [--display-name <text>] [--expression <json>] [--table <table-id>]
uip pm apps model fields remove <app-id> <field-id>

uip pm apps model dashboards list <app-id> [--stage dev|published]
uip pm apps model dashboards get <app-id> [--dashboard <id-or-name>] [--stage dev|published] [--destination <file>]
uip pm apps model dashboards update <app-id> [--file <json-file>] [--metrics <json-file>] --etag <etag> [--dashboard <id-or-name>]

uip pm apps model metrics list <app-id> [--stage dev|published]

uip pm apps data-mapping get <app-id> [--stage dev] [--destination <file>]
uip pm apps data-mapping update <app-id> --file <json-file> --etag <etag> [--stage dev]

uip pm apps data-model obtenir

Obtenez le modèle de données structurées de l'application (tableaux avec clés primaires et externes et rôles de colonne). Renvoie l'ETag du modèle pour référence; add-table lui-même ne prend pas de --etag, car il lit et fusionne sa propre modification.

Arguments

Nom	Requis	Objectif
<app-id>	oui	ID de l'application de processus.

Options

Long	Valeur (Value)	Default	Description
--stage <stage>	dev | published	dev	Étape de l’application.
--destination <local-file>	Chemin d'accès	—	Écrivez le modèle JSON dans ce fichier au lieu de l'enveloppe de sortie.

Format des données (--sortie json)

{ "Code": "PmAppsDataModelGet", "Data": { "AppId": "9c46289e", "ETag": "W/\"3\"", "Model": {} } }

Destination remplace Model lorsque --destination est défini.

uip pm apps data-model add-table

Enregistrez un modèle dbt personnalisé en tant que table de modèle de données interrogeable. Process Mining est centré sur les cas: une table interrogeable doit être la racine Cases ou un lien vers celle-ci - donnez à la table une colonne Case_ID avec une clé externe à Cases pour lier librement une table analytique autonome. Ré-ingérez-les par la suite pour les matérialiser. Ne prend pas --etag: il lit le modèle de données actuel et le fusionne exactement dans ce document, de sorte qu'une écriture se trouvant entre toujours en conflit et la commande se réexécute simplement.

Arguments

Nom	Requis	Objectif
<app-id>	oui	ID de l'application de processus.

Options

Long	Valeur (Value)	Requis	Description
--file <json-file>	Chemin d'accès	oui	JSON avec la ou les tables à ajouter — une seule table de modèle de données, un tableau ou un objet { tables }. Chaque: { name, primaryKey, foreignKeys: [{ table: "Cases", column: "Case_ID" }] } (type est défini par défaut sur "Object").
--stage <stage>	dev | published	non	Par défaut dev.

Une table correspond à name: une entrée existante est remplacée, une nouvelle est ajoutée.

Exemple

uip pm apps data-model add-table 9c46289e --file ./Workload_weekly.table.json

Format des données (--sortie json)

{
  "Code": "PmAppsDataModelAddTable",
  "Data": {
    "AppId": "9c46289e",
    "AddedTables": ["Workload_weekly"],
    "IngestionNeeded": true,
    "Instructions": "Re-ingest to materialize the table(s): uip pm ingestions create 9c46289e --wait — then query them. Run 'uip pm apps publish 9c46289e' to push to dashboards."
  }
}

Échoue avec le rejet de style UserError_TableIsDeletedau niveau de la couche de requête si la table n'a pas de chemin vers Cases. Une entrée de table sans nom, ou un fichier sans table utilisable, échoue côté client avant toute écriture.

uip pm - modèle d'applications obtenir

Obtenez le modèle sémantique de l'application (champs avec des types de données, des champs calculés, des métriques et la vue des tableaux de bord) — la forme que prend update. Renvoie l'ETag du modèle, qui model update requiert la valeur --etag.

Arguments

Nom	Requis	Objectif
<app-id>	oui	ID de l'application de processus.

Options

Long	Valeur (Value)	Default	Description
--stage <stage>	dev | published	dev	Étape de l’application.
--destination <local-file>	Chemin d'accès	—	Écrivez le modèle JSON dans ce fichier au lieu de l'enveloppe de sortie.

Format des données (--sortie json)

{ "Code": "PmAppsModelGet", "Data": { "AppId": "9c46289e", "ETag": "W/\"3\"", "Model": {} } }

mise à jour du modèle d'applications uip pm

Remplacez l'ensemble du modèle d'application par un fichier JSON local. S’applique uniquement au développement. Pour un seul champ, préférez apps model fields set, qui se modifie en place; un remplacement complet doit porter l'ETag du model get à partir duquel il a été écrit - l'extraction d'un nouvel ETag ici invaliderait la vérification de la simultanéité.

Arguments

Nom	Requis	Objectif
<app-id>	oui	ID de l'application de processus.

Options

Long	Valeur (Value)	Requis	Description
--file <json-file>	Chemin d'accès	oui	Fichier JSON local avec le modèle complet (tel que renvoyé par model get).
--etag <etag>	string	oui	ETag du modèle sur lequel cette modification est basée.

Format des données (--sortie json)

{ "Code": "PmAppsModelUpdate", "Data": { "AppId": "9c46289e", "Versions": [4], "Instructions": "Model saved on dev. Run 'uip pm apps publish 9c46289e' to push it to the dashboards; if a field's data kind changed, re-ingest so the data matches: uip pm ingestions create 9c46289e --wait." } }

Une version --etag obsolète échoue avec un conflit — relecture via model get, refaire la modification et réessayer. Une erreur UnsupportedOperatorArgumentDataKind signifie qu'un filtre de tableau de bord, un champ calculé ou un seuil de métrique compare toujours un champ à une constante de son ancien type de données - corrigez ou supprimez cette comparaison avant de modifier le type.

liste des champs du modèle d'applications uip pm

Répertoriez chaque champ dans les tables de l’application avec son type de données et s’il s’agit d’une colonne mappée ou d’un champ calculé.

Arguments

Nom	Requis	Objectif
<app-id>	oui	ID de l'application de processus.

Options

Long	Valeur (Value)	Default	Description
--stage <stage>	dev | published	dev	Étape de l’application.

Format des données (--sortie json)

{ "Code": "PmAppsFieldsList", "Data": [{ "Table": "Cases", "Id": "Case_status", "Display": "Status", "Kind": "nominal", "Type": "column" }] }

Type est "column" (mappé) ou "calculated".

ensemble de champs du modèle d'applications uip pm

Créez ou modifiez un champ (sécurisé pour ETag en interne — lit et fusionne sa propre base). Modifiez son type de données, renommez-le ou transformez-le en champ calculé.

Arguments

Nom	Requis	Objectif
<app-id>	oui	ID de l'application de processus.
<field-id>	oui	ID de champ.

Options

Long	Valeur (Value)	Description
--kind <kind>	ordinal|nominal|numeric|datetime|boolean|percentage|currency|duration	Type de données. (id/ref sont structurés et non configurables.)
--display-name <text>	string	Nom d'affichage.
--expression <json>	JSON (inline ou @file.json)	Nœud d'expression de champ calculé. Le fait de fournir transforme le champ en champ calculé.
--table <table-id>	string	Table cible — requise uniquement lors de la création d’un nouveau champ.

Au moins une des --kind/--display-name/--expression est requise. La création d'un champ nécessite --table, --expression et --kind; les colonnes mappées ne peuvent pas être créées de cette façon (elles proviennent de données ingérées). Le paramètre --expression basé sur une colonne mappée existante est rejeté; créez plutôt un nouveau champ calculé avec un ID différent. Une création dont l'ID correspond à un champ d'une table différente est rejetée plutôt que de modifier ce champ en mode silencieux.

Exemple

uip pm apps model fields set 9c46289e Case_status --kind ordinal

Format des données (--sortie json)

{ "Code": "PmAppsFieldsSet", "Data": { "AppId": "9c46289e", "Field": "Case_status", "Action": "updated", "Table": "Cases", "Versions": [4], "Instructions": "Model saved on dev. Run 'uip pm apps publish 9c46289e' to push it to the dashboards; if a field's data kind changed, re-ingest so the data matches: uip pm ingestions create 9c46289e --wait." } }

Action est "created" ou "updated".

champs du modèle d'applications uip pm - Supprimer

Supprimez un champ du modèle.

Arguments

Nom	Requis	Objectif
<app-id>	oui	ID de l'application de processus.
<field-id>	oui	ID de champ.

Format des données (--sortie json)

{ "Code": "PmAppsFieldsRemove", "Data": { "AppId": "9c46289e", "Field": "Case_status", "Table": "Cases", "Versions": [4], "Instructions": "..." } }

tableaux de bord des modèles d'applications uip pm

La vue sous forme de tableau de bord du même document de modèle model get/update aller-retour — list/get/update fonctionne sur view.dashboards.

Liste des tableaux de bord du modèle d'applications uip pm

Répertoriez les tableaux de bord d'une application de processus.

Nom/Option	Requis	Objectif
<app-id>	oui	ID de l'application de processus.
--stage <stage>	non	dev | published, par défaut dev.

{ "Code": "PmAppsDashboardsList", "Data": [{ "Id": "overview", "Name": "Overview", "Layout": "three-left-one-right", "Charts": 4, "Metrics": 5, "IsVisible": true }] }

Charts correspond au nombre aplati de la matrice de graphiques du tableau de bord.

Les tableaux de bord du modèle d'applications uip pm obtenir

Obtenez les tableaux de bord d'une application de processus, avec les besoins ETag update.

Long	Valeur (Value)	Description
--stage <stage>	dev|published	Par défaut dev.
--dashboard <id-or-name>	string	Renvoyez uniquement ce tableau de bord au lieu de la section view entière. Correspondance par ID d'abord, puis par nom exact - un nom ambigu (plus d'un tableau de bord le partageant) échoue, vous demandant de sélectionner par ID.
--destination <local-file>	Chemin d'accès	Écrivez JSON dans ce fichier au lieu de l'enveloppe.

uip pm apps model dashboards get 9c46289e --dashboard 'Overview' --destination ./dashboard.json

{ "Code": "PmAppsDashboardsGet", "Data": { "Dashboard": "Overview", "ETag": "W/\"3\"", "Destination": "./dashboard.json" } }

mise à jour des tableaux de bord du modèle d'applications uip pm

Mettez à jour les tableaux de bord d'une application de processus à partir d'un fichier JSON local. Étape de développement uniquement.

Long	Valeur (Value)	Requis	Description
--file <local-file>	Chemin d'accès	non*	Un tableau de bord où --dashboard est indiqué, sinon l'ensemble de la section view.
--metrics <local-file>	Chemin d'accès	non*	Tableau JSON de définitions de métriques à ajouter ou à remplacer par ID — écrit dans la même requête que --file, de sorte qu'un graphique qu'il introduit peut référencer une métrique ajoutée dans la même écriture.
--etag <etag>	string	oui	ETag du modèle sur lequel cette modification est basée.
--dashboard <id-or-name>	string	non	Quel tableau de bord --file remplace — nécessite --file; le transmettre sans --file est rejeté.

* Au moins un de --file/--metrics est requis.

uip pm apps model dashboards update 9c46289e --dashboard 'Overview' --file ./dashboard.json --etag 'W/"3"'

{ "Code": "PmAppsDashboardsUpdate", "Data": { "Dashboard": "Overview", "Versions": [4], "Instructions": "Saved on dev. Run 'uip pm apps publish 9c46289e' to push the change to the dashboards; if the publish reports IngestionNeeded, re-ingest with 'uip pm ingestions create 9c46289e --wait'." } }

liste des métriques du modèle d’applications uip pm

Répertoriez les mesures qu'un graphique peut référencer à partir du modèle de données de l'application. Ajoutez ou remplacez-en une par dashboards update --metrics.

Nom/Option	Requis	Objectif
<app-id>	oui	ID de l'application de processus.
--stage <stage>	non	dev|published, par défaut dev.

{ "Code": "PmAppsMetricsList", "Data": [{ "Id": "avg_throughput", "Display": "Avg. throughput", "Aggregation": "AVERAGE", "Argument": "Case_throughput_time" }] }

mappage des données des applications uip pm - obtenir

Récupérez le mappage des données d'entrée de l'application - la même forme que apps create --data-mapping, afin qu'elle puisse être modifiée et renvoyée avec data-mapping update. Renvoie l'ETag du mappage, que cette mise à jour requiert en tant que --etag.

Long	Valeur (Value)	Default	Description
--stage <stage>	dev | published	dev	Étape de l'application à lire.
--destination <local-file>	Chemin d'accès	—	Écrivez le mappage JSON dans ce fichier au lieu de l'enveloppe de sortie.

uip pm apps data-mapping get 9c46289e --destination ./mapping.json

{ "Code": "PmAppsDataMappingGet", "Data": { "AppId": "9c46289e", "ETag": "W/\"639204059477096903\"", "Destination": "./mapping.json" } }

mise à jour du mappage des données des applications uip pm

Remplacez le mappage des données d'entrée de l'application à partir d'un fichier JSON local (sécurisé ETag) — corrigez un mappage incorrect en place au lieu de recréer l'application. S’applique lors de la prochaine ingestion; contrairement à un correctif de transformation, un changement de mappage régit la façon dont le fichier brut est analysé, c’est pourquoi transformations apply ne peut pas l’appliquer rétroactivement.

Options

Long	Valeur (Value)	Requis	Description
--file <json-file>	Chemin d'accès	oui	Mappage complet des données d'entrée ({ "Tables": [...] }): remplace le mappage stocké. Même valeur par défaut par champ que apps create --data-mapping.
--etag <etag>	string	oui	ETag du mappage sur lequel cette modification est basée.
--stage <stage>	dev	non	Seul dev est inscriptible - le backend sert GET aux deux étapes, mais n’accepte l’écriture que lors du développement.

uip pm apps data-mapping update 9c46289e --file ./mapping.json --etag 'W/"639204059477096903"'

{ "Code": "PmAppsDataMappingUpdate", "Data": { "AppId": "9c46289e", "Tables": ["Event_log"], "IngestionNeeded": true, "Instructions": "Re-ingest for the new mapping to take effect: uip pm ingestions create 9c46289e --wait. Re-upload first (uip pm files upload) only if the source columns changed." } }

Une version --etag obsolète échoue avec un conflit — relecture via data-mapping get, refaire la modification et réessayer. Un fichier de mappage sans tables à l'intérieur échoue côté client plutôt que d'effacer le mappage de l'application.

Associé

• uip pm — vue d'ensemble et apps CRUD.
• ingestions et transformations — matérialiser un modèle de données ou une modification de champ.
• conformance, deviations et query — analysent les données résultantes.

Voir également

• Options globales
• Codes de sortie