modelo de datos de uip pm apps, modelo de uip pm apps

Sintaxis y opciones para editar el modelo de datos estructurales y el modelo semántico de una aplicación de Process Mining (tablas, campos, paneles y métricas) con `uip pm apps data-model` y `uip pm apps model`.

Parte de la herramienta uip pm . Esta página cubre las dos superficies de edición de modelos en una aplicación de proceso:

• apps data-model — el gráfico de tabla estructural: qué tablas existen, sus claves primarias/foráneas y cómo se unen a Cases.
• apps model — el modelo semántico: campos y sus tipos de datos, campos calculados, paneles y métricas. Incluye los subgrupos fields, dashboards y metrics para ediciones específicas, más get/update para todo el documento.
• la asignación deapps data-mapping datos de entrada de la aplicación: tabla/columna de origen alimenta qué campo de destino. Distinto del modelo de datos anterior (ese es el gráfico de tabla consultable después de la asignación).

Cada escritura aquí está protegida por ETag: consulta Conceptos en la página principal.

Sinopsis

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 get

Obtenga el modelo de datos estructurales de la aplicación (tablas con claves primarias/foráneas y roles de columna). Devuelve la ETag del modelo como referencia; add-table en sí no toma --etag porque vuelve a leer y fusiona su propio cambio.

Argumentos

Nombre	Obligatorio	Propósito
<app-id>	Sí	ID de la aplicación de proceso.

Opciones

Largo	Valor	Predeterminado	Descripción
--stage <stage>	dev | published	dev	Etapa de la aplicación.
--destination <local-file>	Ruta	—	Escribe el modelo JSON en este archivo en lugar del sobre de salida.

Forma de datos (--json de salida)

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

Destination reemplaza a Model cuando se pasa --destination.

UIP pm apps modelo de datos añadir tabla

Registra un modelo dbt personalizado como tabla de modelo de datos consultable. Process Mining se centra en los casos: una tabla consultable debe ser la raíz Cases o estar vinculada a ella. Dale a la tabla una columna Case_ID (anulable) con una clave externa a Cases para vincular libremente una tabla analítica independiente. Vuelve a ingerirlo después para materializarlo. No requiere --etag: lee el propio modelo de datos actual y lo fusiona exactamente en ese documento, por lo que una escritura intermedia sigue en conflicto y el comando simplemente se vuelve a ejecutar.

Argumentos

Nombre	Obligatorio	Propósito
<app-id>	Sí	ID de la aplicación de proceso.

Opciones

Largo	Valor	Obligatorio	Descripción
--file <json-file>	Ruta	Sí	JSON con las tablas que se van a añadir: una tabla de modelo de datos único, una matriz o un objeto { tables }. Cada uno: { name, primaryKey, foreignKeys: [{ table: "Cases", column: "Case_ID" }] } (type es el valor predeterminado "Object").
--stage <stage>	dev | published	No	Predeterminado dev.

Una tabla coincide con name: se reemplaza una entrada existente y se anexa una nueva.

Ejemplo

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

Forma de datos (--json de salida)

{
  "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."
  }
}

Falla con un rechazo de estilo UserError_TableIsDeleteden la capa de consulta si la tabla no tiene ruta a Cases. Una entrada de tabla sin nombre, o un archivo sin tabla utilizable, falla en el lado del cliente antes de cualquier escritura.

obtención del modelo de aplicaciones uip pm

Obtener el modelo semántico de la aplicación (campos con tipos de datos, campos calculados, métricas y la vista de paneles): la forma que toma update. Devuelve la ETag del modelo, que model update requiere como --etag.

Argumentos

Nombre	Obligatorio	Propósito
<app-id>	Sí	ID de la aplicación de proceso.

Opciones

Largo	Valor	Predeterminado	Descripción
--stage <stage>	dev | published	dev	Etapa de la aplicación.
--destination <local-file>	Ruta	—	Escribe el modelo JSON en este archivo en lugar del sobre de salida.

Forma de datos (--json de salida)

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

actualización del modelo de aplicaciones uip pm

Reemplace todo el modelo de aplicación desde un archivo JSON local. Se aplica solo en dev. Para un solo campo, prefiere apps model fields set, que se edita en el lugar; un reemplazo completo debe llevar la ETag del model get desde el que se escribió: obtener una ETag nueva aquí anularía la comprobación de concurrencia.

Argumentos

Nombre	Obligatorio	Propósito
<app-id>	Sí	ID de la aplicación de proceso.

Opciones

Largo	Valor	Obligatorio	Descripción
--file <json-file>	Ruta	Sí	Archivo JSON local con el modelo completo (como lo devuelve model get).
--etag <etag>	String	Sí	ETag del modelo en el que se basa esta edición.

Forma de datos (--json de salida)

{ "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." } }

Un --etag obsoleto falla con un conflicto: vuelve a leer a través de model get, rehace la edición y vuelve a intentarlo. Un error UnsupportedOperatorArgumentDataKind significa que un filtro del panel, un campo calculado o un umbral de métrica aún compara un campo con una constante de su tipo de datos antiguo: corrija o elimine esa comparación antes de cambiar el tipo.

lista de campos del modelo de uip pm apps

Enumera cada campo en las tablas de la aplicación con su tipo de datos y si se trata de una columna asignada o de un campo calculado.

Argumentos

Nombre	Obligatorio	Propósito
<app-id>	Sí	ID de la aplicación de proceso.

Opciones

Largo	Valor	Predeterminado	Descripción
--stage <stage>	dev | published	dev	Etapa de la aplicación.

Forma de datos (--json de salida)

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

Type es "column" (asignado) o "calculated".

conjuntos de campos del modelo de aplicaciones uip pm

Crear o editar un campo (ETag-safe internamente: lee y fusiona su propia base). Cambie su tipo de datos, cámbiele el nombre o conviértalo en un campo calculado.

Argumentos

Nombre	Obligatorio	Propósito
<app-id>	Sí	ID de la aplicación de proceso.
<field-id>	Sí	ID de campo.

Opciones

Largo	Valor	Descripción
--kind <kind>	ordinal|nominal|numeric|datetime|boolean|percentage|currency|duration	Tipo de datos. (id/ref son estructurales y no configurables).
--display-name <text>	String	Nombre para mostrar.
--expression <json>	JSON (en línea o @file.json)	Nodo de expresión de campo calculado. Siempre que convierta el campo en un campo calculado.
--table <table-id>	String	Tabla de destino: solo se requiere al crear un nuevo campo.

Se requiere al menos uno de --kind/--display-name/--expression. La creación de un campo requiere --table, --expression y --kind; las columnas asignadas no se pueden crear de esta manera (provienen de datos ingeridos). Se rechaza la configuración --expression en una columna asignada existente: cree un nuevo campo calculado con un ID diferente en su lugar. Una creación cuyo ID colisiona con un campo en una tabla diferente se rechaza en lugar de editar silenciosamente ese campo.

Ejemplo

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

Forma de datos (--json de salida)

{ "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 es "created" o "updated".

eliminar campos del modelo de uip pm apps

Eliminar un campo del modelo.

Argumentos

Nombre	Obligatorio	Propósito
<app-id>	Sí	ID de la aplicación de proceso.
<field-id>	Sí	ID de campo.

Forma de datos (--json de salida)

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

Paneles del modelo de aplicaciones uip pm

La vista en forma de panel del mismo documento modelo model get/update ida y vuelta — list/get/update trabajo en view.dashboards.

lista de paneles del modelo de aplicaciones uip pm

Enumera los paneles de una aplicación de proceso.

Nombre/Opción	Obligatorio	Propósito
<app-id>	Sí	ID de la aplicación de proceso.
--stage <stage>	No	dev | published, predeterminado dev.

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

Charts es el recuento aplanado de la matriz de ID de gráfico del panel.

uip pm apps model Dashboards get

Obtén los paneles de una aplicación de proceso, con las necesidades de ETag update.

Largo	Valor	Descripción
--stage <stage>	dev|published	Predeterminado dev.
--dashboard <id-or-name>	String	Devuelve solo este panel en lugar de toda la sección view. Coincidencia primero por ID, luego por nombre exacto: un nombre ambiguo (más de un panel que lo comparte) falla y te pide que selecciones por ID.
--destination <local-file>	Ruta	Escribe JSON en este archivo en lugar del sobre.

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

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

actualización de los paneles del modelo de aplicaciones uip pm

Actualiza los paneles de una aplicación de proceso desde un archivo JSON local. Solo etapa de desarrollo.

Largo	Valor	Obligatorio	Descripción
--file <local-file>	Ruta	No*	Un panel cuando se proporciona --dashboard, de lo contrario, toda la sección view.
--metrics <local-file>	Ruta	No*	Matriz JSON de definiciones de métricas para añadir o reemplazar por ID: escrita en la misma solicitud que --file, por lo que un gráfico que introduce puede hacer referencia a una métrica añadida en la misma escritura.
--etag <etag>	String	Sí	ETag del modelo en el que se basa esta edición.
--dashboard <id-or-name>	String	No	Qué panel sustituye a --file: requiere --file; pasarlo sin --file se rechaza.

* Se requiere al menos uno de --file/--metrics.

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'." } }

lista de métricas del modelo de aplicaciones uip pm

Enumera las métricas a las que puede hacer referencia un gráfico, desde el modelo de datos de la aplicación. Añade o reemplaza uno por dashboards update --metrics.

Nombre/Opción	Obligatorio	Propósito
<app-id>	Sí	ID de la aplicación de proceso.
--stage <stage>	No	dev|published, predeterminado dev.

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

uip pm apps asignación de datos get

Obtén la asignación de datos de entrada de la aplicación: la misma forma que toma apps create --data-mapping, para que pueda editarse y retroceder con data-mapping update. Devuelve la ETag de la asignación, que esa actualización requiere como --etag.

Largo	Valor	Predeterminado	Descripción
--stage <stage>	dev | published	dev	Etapa de la aplicación para leer.
--destination <local-file>	Ruta	—	Escribe el JSON de asignación en este archivo en lugar del sobre de salida.

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

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

actualización de la asignación de datos de las aplicaciones de uip pm

Reemplaza la asignación de datos de entrada de la aplicación desde un archivo JSON local (ETag-safe): corrige una asignación incorrecta en lugar de volver a crear la aplicación. Se aplica en la siguiente ingestión; a diferencia de una corrección de transformación, un cambio de asignación rige la forma en que se analiza el archivo sin procesar, por lo que transformations apply no puede aplicarlo retroactivamente.

Opciones

Largo	Valor	Obligatorio	Descripción
--file <json-file>	Ruta	Sí	Asignación completa de datos de entrada ({ "Tables": [...] }): reemplaza la asignación almacenada por completo. Los mismos valores predeterminados por campo que apps create --data-mapping.
--etag <etag>	String	Sí	ETag de la asignación en la que se basa esta edición.
--stage <stage>	dev	No	Solo se puede escribir en dev: el backend sirve GET en ambas etapas, pero solo acepta la escritura en dev.

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." } }

Un --etag obsoleto falla con un conflicto: vuelve a leer a través de data-mapping get, rehace la edición y vuelve a intentarlo. Un archivo de asignación sin tablas falla en el lado del cliente en lugar de borrar la asignación de la aplicación.

Relacionado

• uip pm : descripción general y apps CRUD.
• ingestions y transformations : materializar un cambio de modelo de datos o de campo.
• conformance, deviations y query : analiza los datos resultantes.

Ver también

• Opciones globales
• Códigos de salida