modelo de dados do uip pm apps, modelo do uip pm apps

Sintaxe e opções para editar o modelo de dados estrutural e o modelo semântico de um app do Process Mining — tabelas, campos, painéis e métricas — com "uip pm apps data-model" e "uip pm apps model".

Parte da ferramenta uip pm . Esta página abrange as duas superfície de edição de modelos em um aplicativo de processo:

• apps data-model o gráfico de tabela estrutural: quais tabelas existem, suas chaves primárias/externas e como elas se une a Cases.
• apps model o modelo semântico: campos e seus tipos de dados, campos calculados, painéis e métricas. Inclui subgrupos fields, dashboards e metrics para edições direcionadas, mais get/update para o documento inteiro.
• apps data-mapping o mapeamento de dados de entrada do aplicativo: qual tabela/coluna de origem feeds qual campo de destino. Diferente do modelo de dados acima (que é o gráfico de tabela que pode ser consultado após o mapeamento).

Cada gravação aqui é protegida por ETag — consulte Conceitos na página principal.

Resumo

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]

modelo de dados de aplicativos uip pm obter

Obtenha o modelo de dados estrutural do aplicativo (tabelas com chaves primárias/externa e funções de coluna). Retorna a ETag do modelo para referência; a própria add-table não aceita --etag porque rele e mescla sua própria alteração.

Argumentos

Name	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.

Opções

Long	Valor	Padrão	Description
--stage <stage>	dev | published	dev	Estágio de aplicativo.
--destination <local-file>	Path	—	Grave o modelo JSON para este arquivo em vez do envelope de saída.

Formato dos dados (--output json)

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

Destination substitui Model quando --destination é passado.

modelo de dados do uip pm apps adicionar-tabela

Registre um modelo dbt personalizado como uma tabela de modelo de dados consultados. O Process Mining é centrado em casos: uma tabela consultada deve ser a raiz Cases ou vincular a ela — dê à tabela uma coluna Case_ID (nulável) com uma chave externa para Cases para vincular de forma flexível uma tabela analítica independente. Faça novamente depois para materializá-lo. Não leva --etag: ele lê o próprio modelo de dados atual e mescla exatamente nesse documento, então um alvo de gravação entre ainda entra em conflito e o comando simplesmente será executado novamente.

Argumentos

Name	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.

Opções

Long	Valor	Required	Description
--file <json-file>	Path	sim	JSON com a(s) tabela(s) a adicionar — uma única tabela de modelo de dados, um array ou um objeto { tables }. Cada: { name, primaryKey, foreignKeys: [{ table: "Cases", column: "Case_ID" }] } (type volta a "Object").
--stage <stage>	dev | published	não	devPadrão.

Uma tabela é correspondente por name: uma entrada existente é substituída, uma nova é anexada.

Exemplo

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

Formato dos dados (--output 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."
  }
}

Falha com rejeição estilo UserError_TableIsDeletedna camada de consulta se a tabela não tiver caminho para Cases. Uma entrada de tabela sem nome ou um arquivo sem tabela utilizável falha no lado do cliente antes de qualquer gravação.

modelo de apps uip pm obter

Obtenha o modelo semântico do aplicativo (campos com tipos de dados, campos calculados, métricas e a visualização de painéis) — a forma que update assume. Retorna a ETag do modelo, que model update requer como --etag.

Argumentos

Name	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.

Opções

Long	Valor	Padrão	Description
--stage <stage>	dev | published	dev	Estágio de aplicativo.
--destination <local-file>	Path	—	Grave o modelo JSON para este arquivo em vez do envelope de saída.

Formato dos dados (--output json)

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

atualização do modelo de apps uip pm

Substitua todo o modelo de aplicativo de um arquivo JSON local. Aplica-se apenas ao desenvolvedor. Para um único campo prefira apps model fields set, que edita no local; uma substituição completa deve carregar a ETag do model get de onde foi escrita — buscar uma ETag nova aqui anularia a verificação de simultaneidade.

Argumentos

Name	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.

Opções

Long	Valor	Required	Description
--file <json-file>	Path	sim	Arquivo JSON local com o modelo completo (conforme retornado por model get).
--etag <etag>	String	sim	ETag do modelo no qual esta edição é baseada.

Formato dos dados (--output 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." } }

Um --etag obsoleto falha com um conflito — leia novamente por meio de model get, refaça a edição e tente novamente. Um erro UnsupportedOperatorArgumentDataKind significa que um filtro do painel, campo calculado ou limite de métrica ainda compara um campo a uma constante de seu tipo de dados antigo — corrija ou remova essa comparação antes de alterar o tipo.

lista de campos do modelo de aplicativos uip pm

Liste cada campo nas tabelas do aplicativo com seu tipo de dados e se é uma coluna mapeada ou um campo calculado.

Argumentos

Name	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.

Opções

Long	Valor	Padrão	Description
--stage <stage>	dev | published	dev	Estágio de aplicativo.

Formato dos dados (--output json)

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

Type é "column" (mapeado) ou "calculated".

campos do modelo de aplicativos uiip pm definidos

Crie ou edite um campo (ETag-safe internamente — lê e mescla sua própria base). Altere seu tipo de dados, renomeie-o ou transforme-o em um campo calculado.

Argumentos

Name	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.
<field-id>	sim	ID do campo.

Opções

Long	Valor	Description
--kind <kind>	ordinal|nominal|numeric|datetime|boolean|percentage|currency|duration	Tipo de dados. (id/ref são estrutural e não depuráveis.)
--display-name <text>	String	Nome de exibição.
--expression <json>	JSON (em linha ou @file.json)	Nó de expressão de campo calculado. Fornecê-lo transforma o campo em um campo calculado.
--table <table-id>	String	Tabela de destino — necessária apenas ao criar um novo campo.

Pelo menos --kind/--display-name/--expression é necessário. A criação de um campo requer --table, --expression e --kind; as colunas mapeadas não podem ser criadas dessa maneira (Elas vêm de dados ingeridos). A configuração de --expression em uma coluna mapeada existente é rejeitada — crie um novo campo calculado com um ID diferente. Uma criação cujo ID encontra um campo em uma tabela diferente é rejeitada em vez de editar silenciosamente esse campo.

Exemplo

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

Formato dos dados (--output 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 é "created" "updated"ou.

remover campos do modelo de aplicativos uip pm remover

Remova um campo do modelo.

Argumentos

Name	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.
<field-id>	sim	ID do campo.

Formato dos dados (--output json)

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

painéis de modelo de aplicativos uip pm

A visualização em forma de painel do mesmo documento de modelo model get/update ida e volta — list/get/update funciona em view.dashboards.

lista de painéis de modelo de apps do uip pm

Lista os painéis de um aplicativo de processo.

Nome/Opção	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.
--stage <stage>	não	dev | published, padrão dev.

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

Charts é a contagem mesclada da matriz de IDs de gráfico do painel.

painéis de modelo de apps do uiip pm obter

Obtenha os painéis de um aplicativo de processo, com as update necessidades da ETag.

Long	Valor	Description
--stage <stage>	dev|published	devPadrão.
--dashboard <id-or-name>	String	Retorne apenas este painel em vez de toda a seção view. Correspondente por ID primeiro, depois pelo nome exato — um nome ambíguo (mais de um painel compartilhando-o) falha, pedindo que você selecione por ID.
--destination <local-file>	Path	Grave JSON para este arquivo em vez do envelope.

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

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

atualização de painéis do modelo uip pm apps

Atualize os painéis de um aplicativo de processo a partir de um arquivo JSON local. Apenas o estágio de desenvolvimento.

Long	Valor	Required	Description
--file <local-file>	Path	não*	Um painel quando --dashboard é fornecido, caso contrário, toda a seção view.
--metrics <local-file>	Path	não*	Matriz JSON de definições de métrica para adicionar ou substituir por ID — escrito na mesma solicitação que --file, para que um gráfico que ele introduz possa fazer referência a uma métrica adicionada na mesma gravação.
--etag <etag>	String	sim	ETag do modelo no qual esta edição é baseada.
--dashboard <id-or-name>	String	não	Qual painel --file substitui — requer --file; passá-lo sem --file é rejeitado.

* Pelo menos um dos --file/--metrics é necessário.

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 do modelo de apps do uip pm

Liste as métricas que um gráfico pode referenciar, do modelo de dados do app. Adicione ou substitua um por dashboards update --metrics.

Nome/Opção	Required	Finalidade
<app-id>	sim	ID do aplicativo de processo.
--stage <stage>	não	dev|published, padrão dev.

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

mapeamento de dados de aplicativos uiip pm obter

Obtenha o mapeamento de dados de entrada do aplicativo — o mesmo formato apps create --data-mapping tem, para que possa ser editado e enviado de volta com data-mapping update. Retorna o ETag do mapeamento, que essa atualização requer como --etag.

Long	Valor	Padrão	Description
--stage <stage>	dev | published	dev	Estágio do aplicativo a ser lido.
--destination <local-file>	Path	—	Grave o JSON de mapeamento para este arquivo em vez do envelope de saída.

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

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

atualização de mapeamento de dados de aplicativos uip pm

Substitua o mapeamento de dados de entrada do aplicativo de um arquivo JSON local (ETag-safe) — corrija um mapeamento errado em vez de recriar o aplicativo. Aplica-se na próxima ingestão; ao contrário de uma correção de transformação, uma alteração de mapeamento rege como o arquivo bruto é analisado, portanto, transformations apply não pode aplicá-la retroativamente.

Opções

Long	Valor	Required	Description
--file <json-file>	Path	sim	Mapeamento completo de dados de entrada ({ "Tables": [...] }) — substitui o mapeamento armazenado diretamente. Mesmo padrão por campo que apps create --data-mapping.
--etag <etag>	String	sim	ETag do mapeamento no qual esta edição se baseia.
--stage <stage>	dev	não	Apenas dev é gravável — o backend atende GET em ambos os estágios, mas aceita apenas a gravação no 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." } }

Um --etag obsoleto falha com um conflito — leia novamente por meio de data-mapping get, refaça a edição e tente novamente. Um arquivo de mapeamento sem tabelas falha no lado do cliente em vez de limpar o mapeamento do aplicativo.

Relacionado

• uip pm — visão geral e CRUD apps .
• ingestions e transformations — materializar uma alteração no modelo de dados ou campo.
• conformance, deviations e query — analise os dados resultantes.

Veja também

• Opções globais
• Códigos de saída