ProcessMiningIntegrationAPI - Com escopo

  • Versão de lançamento: Zurich
  • Atualizado 31 de jul. de 2025
  • 16 min. de leitura

    • . ProcessMiningIntegrationAPI a inclusão de script fornece métodos para gerenciar projetos de mineração de processos e recuperar descobertas e detalhamentos.

    Esta inclusão de script requer o plug-in Core de mineração de processos (com.sn_process_optimization). Para obter mais informações, consulte Process Mining.

    O usuário chamador deve ter a função sn_process_optimization_analyst ou sn_process_optimization_power_user.

    As propriedades do sistema a seguir podem ser usadas para gerenciar a funcionalidade da API.
    promin.limit.api.project_creation
    Limita o número de projetos que podem ser criados diariamente usando APIs.

    Padrão: 25.

    promin.limit.api.max_daily_minings
    Limita o número de minerações que podem ser programadas diariamente usando APIs.

    Padrão: 25.

    promin.limit.api.max_daily_minings_per_project
    Limita o número de minerações Que podem ser programados diariamente por projeto usando APIs.

    Padrão: 1.

    promin.api.allow_no_role_mining
    Permite que os projetos sejam minerados por usuários sem a função sn_process_optimization_analyst.

    Padrão: Falso.

    promin.api.auto_share_project_with_creator
    Compartilha automaticamente o projeto com o criador do projeto.

    Padrão: Falso.

    ProcessMiningIntegrationAPI - createProject(Tabela de cadeia de caracteres, atividades de matriz, detalhamentos de matriz, cadeia de caracteres encodedQuery, cadeia de caracteres templateType, permissões de objeto, Retiração automática booliana)

    Cria um projeto de mineração de processos.

    Um projeto atua como um plano gráfico para operações de Mineração de processos. Ele seleciona o processo em que a mineração é feita e quais atributos do processo são considerados durante a mineração.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    tabela Cadeia de caracteres Nome da tabela que contém os dados a serem analisados.
    atividades Matriz Definições de atividade para o projeto.

    Uma definição de atividade é um atributo do processo a ser considerado durante a mineração, como estado ou grupo de atribuição. Deve ser uma coluna da tabela especificada em tableparâmetro. Pelo menos uma definição de atividade é necessária para minerar um projeto. Para obter mais informações sobre definições de atividade, consulte Set activity definitions.

    Nota:
    As definições de atividade também estão incluídas no modelo de projeto especificado em templateTypeparâmetro. Use activitiesparâmetro para especificar atividades adicionais não incluídas no modelo.
    ["<column_name>"]
    detalhamentos Matriz Definições de detalhamento do projeto.

    Uma definição de detalhamento permite filtrar registros e analisar um mapa de processo por categorias, como prioridade ou categoria de negócio. Deve ser uma coluna da tabela especificada em tableparâmetro. As definições de detalhamento não são necessárias para minerar um projeto. Para obter mais informações sobre definições de detalhamento, consulte Set breakdown definitions.

    Nota:
    As definições de detalhamento também estão incluídas no modelo de projeto especificado em templateTypeparâmetro. Use breakdownsparâmetro para especificar detalhamentos adicionais não incluídos no modelo.
    ["<column_name>"]
    encodedQuery Cadeia de caracteres Consulta codificada para selecionar os dados a serem analisados. Isso permite limitar os dados que são analisados, por exemplo, selecionando dados somente de um período de tempo especificado.

    Para incluir todos os dados na tabela, você pode passar uma cadeia de caracteres vazia.
    templateType Cadeia de caracteres Tipo de modelo a ser usado para o projeto.
    Valores válidos:
    • Padrão
    • Gestão de portfólios digitais
    • Gestão de fornecedores
    • WFO

    Para um projeto que não faz parte do WFO, Gestão de fornecedores ou Gestão de portfólios digitais, escolha Padrão. Por exemplo, para criar um projeto do Performance Analytics, selecione Padrão.
    permissões Objeto Mapa de grupos, funções e usuários com os quais compartilhar o projeto, em que a chave é um sys_id e o valor especifica o tipo (grupo, função ou usuário).

    Todos os usuários com os quais o projeto é compartilhado podem exibir o modelo analisado e exibir as configurações do projeto. Somente usuários com sn_process_optimization_analyst ou sn_process_optimization_power_user podem minerar o projeto.

    {
   "<user_sys_id>":"user",
   "<role_sys_id>":"role",
   "<group_sys_id>":"group"
}
    AutoRetirir Booliano

    Opcional. Sinalizador que indica se o projeto deve ser descontinuado automaticamente.

    Valores válidos:
    • Verdadeiro: O projeto é descontinuado automaticamente sete dias após a criação.
    • Falso: O projeto não foi descontinuado automaticamente.

    Padrão: Falso
    Tabela 2. Retornos
    Tipo Descrição
    Objeto Objeto que contém informações sobre o projeto.
    {
   "entity": {Object},
   "findingDefinitionKPIMap": {Object},
   "id": "String",
   "lastMined": String",
   "miningState": "String",
   "name": "String",
   "permissions": [Array],
   "retiredDate": "String"
}
    <Object>.entity Objeto que contém informações sobre os dados analisados no projeto.

    Tipo de dados: Objeto

    {
   "activityDefinitions": [Array],
   "breakdownDefinitions": [Array],
   "condition": "String,"
   "table": "String"
}
    <Object>.Entity.activityDefinitions Definições de atividade para o projeto.

    Tipo de dados: Matriz

    [
   {
      "activityOfInterest":Boolean,
      "field":"String",
      "type":"String"      
   }
]
    <Object>.Entity.activityDefinitions.activityOfInteint

    Sinalizador que indica se as mudanças de campo aparecem no workbench do analista.

    Valores válidos:
    • Verdadeiro: As mudanças de campo aparecem no workbench do analista.
    • Falso: As mudanças de campo não aparecem no workbench do analista, mas ainda podem ser usadas em condições contextuais em transições ou descobertas.
    <Object>.Entity.activityDefinitions.field Campo que contém os dados a serem analisados. O campo deve ser da tabela especificada em tableparâmetro.
    <Object>.Entity.activityDefinitions.type O tipo de valores a serem minerados.
    Valores válidos:
    • Valores de campo (padrão): Esta é a seleção padrão. Esta opção está disponível sempre que você cria uma definição de atividade.
    • Data e hora: Usa o valor de data e hora do registro real em vez do histórico de auditoria e é exibido como um nó agrupado no mapa do processo.
    • Composto: Um nó ou gráfico de processo que representa mudança no valor de vários campos do registro real em vez do histórico de auditoria.
    • Secundário anexado: Esta opção está disponível quando você seleciona duas tabelas para configuração de tabela e define um relacionamento secundário-primário. Esta opção está disponível somente para a configuração da tabela primária. Na visualização, você verá quando o secundário foi anexado no processo.
    • Primário anexado: Esta opção cria um nó no processo secundário que representa quando um registro primário foi anexado a um secundário.
    <Object>.entity.breakdownDefinitions Definições de detalhamento do projeto.

    Tipo de dados: Matriz

    [
 {
   "field":"String",
   "fieldLabel":"String"
 }
]
    <Object>.entity.breakdownDefinitions.field Nome do campo usado no detalhamento.

    Tipo de dados: Cadeia de caracteres
    <Object>.entity.breakdownDefinitions.fieldLabel Rótulo do campo usado no detalhamento.

    Tipo de dados: Cadeia de caracteres
    <Object>.entity.condition Consulta codificada para selecionar os dados a serem analisados.

    Tipo de dados: Cadeia de caracteres
    <Object>.entity.table Nome da tabela que contém os dados a serem analisados.

    Tipo de dados: Cadeia de caracteres
    <Object>.FindingDefinitionKPIMap Mapa de definições de descoberta e principais indicadores de desempenho (KPIs), em que a chave é uma definição de descoberta sys_id e o valor é uma matriz de sys_ids dos KPIs afetados pela definição da descoberta.

    As definições de descoberta estão localizadas nas tabelas Definição de descoberta [promin_finding_def] e Definição de descoberta automatizada [promin_automated_finding]. Os KPIs estão localizados na tabela Indicador [pa_indicators].

    Para obter mais informações sobre definições de descoberta e KPIs, consulte Working with finding definitions e. Viewing business insights.

    Tipo de dados: Objeto

    {
   "<finding_def_sys_id":[
      "<kpi_sys_id>"
   ]
}
    <Object>.id Sys_id do projeto.

    Definição do projeto [promin_project]

    Tipo de dados: Cadeia de caracteres
    <Object>.LastMined Data em que o projeto foi minerado pela última vez.

    Tipo de dados: Cadeia de caracteres
    <Object>.MiningState Estado de mineração do projeto.

    Para obter descrições dos estados de mineração, consulte Mine states.

    Tipo de dados: Cadeia de caracteres
    <Object>.name Nome do projeto.

    Tipo de dados: Cadeia de caracteres
    <Object>.permissões Grupo, função e permissões de usuário para o projeto.

    Tipo de dados: Objeto

    [
   {
      "type":"String",
      "value":"String"      
   }
]
    <Object>.permissions.type Tipo de permissão.
    Valores válidos:
    • grupo
    • função
    • usuário

    Tipo de dados: Cadeia de caracteres
    <Object>.permissions.value Sys_id do grupo, função ou usuário para conceder permissão.

    Tipo de dados: Cadeia de caracteres
    <Object>.RetiredDate Data em que o projeto será descontinuado.

    Tipo de dados: Cadeia de caracteres

    Este exemplo cria um projeto usando dados de incidentes criados no mês passado.

    SNC.ProcessMiningIntegrationAPI
.createProject(
"incident", // table name
["state"], // activity definitions
["priority"], // breakdown definitions
"sys_created_onONLast month@javascript:gs.beginningOfLastMonth()@javascript:gs.endOfLastMonth()", // incident created on last month
"DEFAULT", // template type
{"02acf036b3120010ed7fc9c316a8dc0c":"user"}, // map of permissions "sys_id":"type"
true // auto retire project
);

    Saída:

    {
   "entity":{
      "table":"incident",
      "condition":"sys_created_onONLast month@javascript:gs.beginningOfLastMonth()@javascript:gs.endOfLastMonth()",
      "activityDefinitions":[
         {
            "field":"assignment_group",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"business_service",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"category",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"priority",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"state",
            "type":"DEFAULT",
            "activityOfInterest":false
         }
      ],
      "breakdownDefinitions":[
         {
            "field":"contact_type",
            "fieldLabel":"Channel"
         },
         {
            "field":"assignment_group",
            "fieldLabel":"Assignment group"
         },
         {
            "field":"location",
            "fieldLabel":"Location"
         },
         {
            "field":"priority",
            "fieldLabel":"Priority"
         },
         {
            "field":"category",
            "fieldLabel":"Category"
         }
      ]
   },
   "name":"Incident Process",
   "permissions":[
      {
         "value":"62826bf03710200044e0bfc8bcbe5df1",
         "type":"user"
      },
      {
         "value":"02acf036b3120010ed7fc9c316a8dc0c",
         "type":"user"
      }
   ],
   "id":"a4286c4f4f831210c98b8a4a91ce0bf5",
   "miningState":"NEW",
   "findingDefinitionKPIMap":{
      "f23c20c34fc31210c98b8a4a91ce0bac":[
         "002d65c3d7131100b96d45a3ce6103e2"
      ]
   },
   "retiredDate":null,
   "lastMined":null
}

    ProcessMiningIntegrationAPI - deleteProject(cadeia de caracteres projectID)

    Exclui um projeto de mineração de processos.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    projectId Cadeia de caracteres Sys_id do projeto.

    Definição do projeto [promin_project]
    Tabela 4. Retornos
    Tipo Descrição
    Nenhum(a)

    Este exemplo exclui um projeto de mineração de processos.

    SNC.ProcessMiningIntegrationAPI.deleteProject("a4286c4f4f831210c98b8a4a91ce0bf5");

    ProcessMiningIntegrationAPI - getBreakDownStats(cadeia de caracteres projectID)

    Obtém estatísticas de detalhamento de um projeto de mineração de processos.

    Os detalhamentos permitem filtrar registros e analisar um processo por categorias, como prioridade ou categoria de negócio.

    Tabela 5. Parâmetros
    Nome Tipo Descrição
    projectId Cadeia de caracteres Sys_id do projeto.

    Definição do projeto [promin_project]
    Tabela 6. Retornos
    Tipo Descrição
    Matriz Matriz de objetos de detalhamento. Cada objeto contém estatísticas para o detalhamento.
    [
   {
      "caseCount": Number,
      "field": "String",
      "fieldValue": "String",
      "performanceStats": {Object},
      "tableName": "String",
      "variantCount": Number     
   }
]
    . Matriz>.caseCount Número de casos da tabela Registro de caso [promin_case_record] que fazem parte deste detalhamento.

    Tipo de dados: Número
    Campo.<Array> Campo usado para o detalhamento.

    Tipo de dados: Cadeia de caracteres
    ValorCampo.<Array> Valor do campo usado para o detalhamento.

    Tipo de dados: Cadeia de caracteres
    <Array>.performaceStats Estatísticas de desempenho para o detalhamento.
    {
   "max": Number,
   "mean": Number,
   "median": Number, 
   "min": Number,  
   "n": Number, 
   "q1": Number, 
   "q3": Number, 
   "q4": Number, 
   "stdDeviation": Number, 
   "sum": Number, 
   "total": Number, 
   "trimmedAverage": Number, 
   "trimmedPercentage": Number
}

    Tipo de dados: Objeto
    PerformaceStats.max <Array> Maior tempo que um registro levou para concluir uma rota.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.Mean <Array> Tempo médio que os registros levaram para concluir uma rota, desde o tempo em que os registros foram abertos até o encerramento.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.Mediano <Array> Valor intermediário da duração ou média de dois valores intermediários.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.min <Array> Menor tempo que um registro levou para concluir uma rota.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.n <Array> Número de registros que fazem parte deste detalhamento.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.q1 <Array> Valor do primeiro quartil da duração.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.q3 <Array> Valor do terceiro quartil da duração.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.q4 <Array> Valor do quarto quartil da duração (máximo).

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.stdDeviation <Array> Variação do valor médio de duração da rota.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.Sum <Array> Soma total de todos os tempos de duração, do primeiro ao último evento, para todos os registros que seguem uma rota.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.Total <Array> Soma total de todos os tempos de duração, do primeiro ao último evento, para todos os registros que seguem uma rota.

    Tipo de dados: Número

    Unidade: Milissegundos
    <Array>.performaceStats.trimmedMédia Tempo médio que os registros levaram para concluir uma rota, calculado após a remoção de uma porcentagem dos menores e maiores valores.

    Tipo de dados: Número

    Unidade: Milissegundos
    <Array>.performaceStats.trimmedPercentage Percentual usado para calcular trimmedAveragevalor.

    Tipo de dados: Número
    Nome.tablename <Array> Tabela usada para o detalhamento.

    Tipo de dados: Cadeia de caracteres
    Contagem.<Array> Contagem de variantes (uma sequência exclusiva de atividades realizadas em um processo) correspondentes a este detalhamento.

    Tipo de dados: Número

    Este exemplo obtém estatísticas de detalhamento de um projeto.

    SNC.ProcessMiningIntegrationAPI.getBreakDownStats("a4286c4f4f831210c98b8a4a91ce0bf5");

    Saída:

    [
   {
      "fieldValue":"1",
      "field":"priority",
      "tableName":"incident",
      "variantCount":21,
      "caseCount":33,
      "performanceStats":{
         "sum":6.4945381E7,
         "min":0.0,
         "max":5.2334704E7,
         "n":33,
         "median":0.0,
         "mean":0.0,
         "total":64945381,
         "stdDeviation":9144841.0,
         "trimmedAverage":165594.0,
         "trimmedPercentage":-1.0,
         "q1":0.0,
         "q3":313333.0,
         "q4":5.2334704E7
      }
   }
]

    ProcessMiningIntegrationAPI - getFindings (cadeia de caracteres projectID)

    Obtém descobertas de um projeto de mineração de processos.

    Tabela 7. Parâmetros
    Nome Tipo Descrição
    projectId Cadeia de caracteres Sys_id do projeto.

    Definição do projeto [promin_project]
    Tabela 8. Retornos
    Tipo Descrição
    Matriz Matriz de objetos de descobertas.
    [
   {
      "caseIds":[],  
      "category": "String",
      "categoryDescription": "String",
      "categoryLabel": "String",
      "createdOn": Number, 
      "findingDefId": "String", 
      "id": "String",
      "impactedKpis": [],
      "matchingRecords": Number,
      "message": "String",
      "performanceStats": {},
      "shortMessage": "String",
      "tableName": "String",
      "totalRecords": Number,
      "type": "String",
      "typeLabel": "String",    
      "versionId": "String"  
   }
]
    . Matriz>.caseIds Lista de ids de casos que correspondem ao padrão de descoberta. Localizado na coluna ID do caso da tabela Registro de caso [promin_case_record].

    Tipo de dados: Matriz
    <Array>.category Categoria da descoberta.
    Valores possíveis:
    • AUTOMAÇÃO
    • CONFORMIDADE
    • CONFORMIDADE
    • CUSTO
    • DESEMPENHO
    • QUALIDADE
    • VELOCIDADE

    Tipo de dados: Cadeia de caracteres
    CategoryDescription.categoryDescription <Array> Descrição da categoria de descoberta.

    Tipo de dados: Cadeia de caracteres
    Rótulo.category <Array> Rótulo da categoria de descoberta.

    Tipo de dados: Cadeia de caracteres
    CriadoAtivado <Array> Data de criação da descoberta.

    Tipo de dados: Número
    DefId.finding <Array> Sys_id da definição da descoberta.

    As definições de descoberta estão localizadas nas tabelas Definição de descoberta [promin_finding_def] e Definição de descoberta automatizada [promin_automated_finding].

    Tipo de dados: Cadeia de caracteres
    <Array>.id Sys_id da descoberta. Localizado na tabela Descoberta [promin_finding].

    Tipo de dados: Cadeia de caracteres
    KPis impactedKPis <Array> Lista de sys_ids de KPIs afetados pela descoberta. Localizado na tabela Indicador [pa_indicators].

    Tipo de dados: Matriz
    MatchingRecords <Array> Número de IDs de caso da tabela Registro de caso [promin_case_record] que correspondem ao padrão de descoberta.

    Tipo de dados: Número
    <Array>.message Mensagem da definição da descoberta.

    Tipo de dados: Cadeia de caracteres
    <Array>.performaceStats Estatísticas de desempenho da descoberta.
    {
   "max": Number,
   "mean": Number,
   "median": Number, 
   "min": Number,  
   "n": Number, 
   "q1": Number, 
   "q3": Number, 
   "q4": Number, 
   "stdDeviation": Number, 
   "sum": Number, 
   "total": Number, 
   "trimmedAverage": Number, 
   "trimmedPercentage": Number
}

    Tipo de dados: Objeto
    PerformaceStats.max <Array> Maior tempo que um registro levou para concluir uma rota.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.Mean <Array> Tempo médio que os registros levaram para concluir uma rota, desde o tempo em que os registros foram abertos até o encerramento.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.Mediano <Array> Valor intermediário da duração ou média de dois valores intermediários.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.min <Array> Menor tempo que um registro levou para concluir uma rota.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.n <Array> Número de registros que fazem parte desta descoberta.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.q1 <Array> Valor do primeiro quartil da duração.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.q3 <Array> Valor do terceiro quartil da duração.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.q4 <Array> Valor do quarto quartil da duração (máximo).

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.stdDeviation <Array> Variação do valor médio de duração da rota.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.Sum <Array> Soma total de todos os tempos de duração, do primeiro ao último evento, para todos os registros que seguem uma rota.

    Tipo de dados: Número

    Unidade: Milissegundos
    PerformaceStats.Total <Array> Soma total de todos os tempos de duração, do primeiro ao último evento, para todos os registros que seguem uma rota.

    Tipo de dados: Número

    Unidade: Milissegundos
    <Array>.performaceStats.trimmedMédia Tempo médio que os registros levaram para concluir uma rota, calculado após a remoção de uma porcentagem dos menores e maiores valores.

    Tipo de dados: Número

    Unidade: Milissegundos
    <Array>.performaceStats.trimmedPercentage Percentual usado para calcular trimmedAveragevalor.

    Tipo de dados: Número
    <Array>.shortMessage Mensagem resumida da definição da descoberta.

    Tipo de dados: Cadeia de caracteres
    Nome.tablename <Array> Nome da tabela usada na descoberta.

    Tipo de dados: Cadeia de caracteres
    TotalRegistros <Array> Número total de registros analisados na mineração.

    Tipo de dados: Número
    <Array>.type Tipo de definição de descoberta.
    Valores possíveis:
    • EXTRA_STEP
    • EXTREME_DURATION
    • EXTREME_REPETION
    • OUTRO
    • PADRÃO
    • PERFORMANCE_OUTLIER
    • PINGPONG
    • RETRABALHO

    Para obter mais informações, consulte Automated improvement opportunities.
    Rótulo.TypeRótulo <Array> Rótulo do tipo de definição de descoberta.

    Tipo de dados: Cadeia de caracteres
    Id.versionId <Array> Sys_id da versão do projeto. Localizado na tabela Versão de definição do projeto [promin_model_def_version].

    Tipo de dados: Cadeia de caracteres

    Este exemplo obtém descobertas de um projeto.

    SNC.ProcessMiningIntegrationAPI.getFindings("a4286c4f4f831210c98b8a4a91ce0bf5");

    Saída:

    [
   {
      "message":"Rework on Closed",
      "id":"0ef09b2e1c6cf0d98045e6ba1c3c9edb",
      "type":"REWORK",
      "createdOn":1727036052.000000000,
      "category":"AUTOMATION",
      "tableName":"incident",
      "categoryLabel":"Automation",
      "matchingRecords":111,
      "versionId":"9a2f187177b412102f7a1b56ba5a99e2",
      "totalRecords":19758,
      "findingDefId":"791f587177b412102f7a1b56ba5a99eb",
      "categoryDescription":"Category that groups all opportunities that are subject to automation.",
      "impactedKpis":[
         
      ],
      "performanceStats":{
         "sum":2.09532828E8,
         "min":1.0,
         "max":6563078.0,
         "n":111,
         "median":1036715.0,
         "mean":1.0,
         "total":209532828,
         "stdDeviation":1855944.0,
         "trimmedAverage":1716904.0,
         "trimmedPercentage":-1.0,
         "q1":776859.0,
         "q3":2246368.0,
         "q4":6563078.0
      },
      "typeLabel":"Automation",
      "shortMessage":"Closed",
      "caseIds":[
         "119e4a569397fd14849bbcd74dba1018",
         "b16b355f47197190498cc044846d43b0",
         "cf9bca7597fe7d90ef889504a253af9e",
      ]
   }
]

    ProcessMiningIntegrationAPI - getMiningStatus(cadeia de caracteres projectID)

    Obtém o status de mineração de um projeto de mineração de processos.

    Tabela 9. Parâmetros
    Nome Tipo Descrição
    projectId Cadeia de caracteres Sys_id do projeto.

    Definição do projeto [promin_project]
    Tabela 10. Retornos
    Tipo Descrição
    Objeto Objeto que contém o sys_id do projeto e um rastreador. 
    {
   "projectId":"String",
   "trackerId":"String"  
}
    <Object>.ProjectID Sys_id do projeto.

    Definição do projeto [promin_project]

    Tipo de dados: Cadeia de caracteres
    <Object>.TrackerId Sys_id do rastreador que monitora o andamento da mineração do projeto.

    Tabela: Rastreador de execução [sys_execution_tracker]

    Tipo de dados: Cadeia de caracteres

    Este exemplo obtém o status de mineração de um projeto.

    SNC.ProcessMiningIntegrationAPI.getMiningStatus("c0b91f0cff01121047cae835f2cb14bc");

    Saída:

    {
   "trackerId":"aec9530cff01121047cae835f2cb147e",
   "projectId":"c0b91f0cff01121047cae835f2cb14bc"
}

    ProcessMiningIntegrationAPI - getProject(cadeia de caracteres projectID)

    Recupera um projeto de mineração de processos.

    Tabela 11. Parâmetros
    Nome Tipo Descrição
    projectId Cadeia de caracteres Sys_id do projeto.

    Definição do projeto [promin_project]
    Tabela 12. Retornos
    Tipo Descrição
    Objeto Objeto que contém informações sobre o projeto.
    {
   "entity": {Object},
   "findingDefinitionKPIMap": {Object},
   "id": "String",
   "lastMined": String",
   "miningState": "String",
   "name": "String",
   "permissions": [Array],
   "retiredDate": "String"
}
    <Object>.entity Objeto que contém informações sobre os dados analisados no projeto.

    Tipo de dados: Objeto

    {
   "activityDefinitions": [Array],
   "breakdownDefinitions": [Array],
   "condition": "String,"
   "table": "String"
}
    <Object>.Entity.activityDefinitions Definições de atividade para o projeto.

    Tipo de dados: Matriz

    [
   {
      "activityOfInterest":Boolean,
      "field":"String",
      "type":"String"      
   }
]
    <Object>.Entity.activityDefinitions.activityOfInteint

    Sinalizador que indica se as mudanças de campo aparecem no workbench do analista.

    Valores válidos:
    • Verdadeiro: As mudanças de campo aparecem no workbench do analista.
    • Falso: As mudanças de campo não aparecem no workbench do analista, mas ainda podem ser usadas em condições contextuais em transições ou descobertas.
    <Object>.Entity.activityDefinitions.field Campo que contém os dados a serem analisados. O campo deve ser da tabela especificada em tableparâmetro.
    <Object>.Entity.activityDefinitions.type O tipo de valores a serem minerados.
    Valores válidos:
    • Valores de campo (padrão): Esta é a seleção padrão. Esta opção está disponível sempre que você cria uma definição de atividade.
    • Data e hora: Usa o valor de data e hora do registro real em vez do histórico de auditoria e é exibido como um nó agrupado no mapa do processo.
    • Composto: Um nó ou gráfico de processo que representa mudança no valor de vários campos do registro real em vez do histórico de auditoria.
    • Secundário anexado: Esta opção está disponível quando você seleciona duas tabelas para configuração de tabela e define um relacionamento secundário-primário. Esta opção está disponível somente para a configuração da tabela primária. Na visualização, você verá quando o secundário foi anexado no processo.
    • Primário anexado: Esta opção cria um nó no processo secundário que representa quando um registro primário foi anexado a um secundário.
    <Object>.entity.breakdownDefinitions Definições de detalhamento do projeto.

    Tipo de dados: Matriz

    [
 {
   "field":"String",
   "fieldLabel":"String"
 }
]
    <Object>.entity.breakdownDefinitions.field Nome do campo usado no detalhamento.

    Tipo de dados: Cadeia de caracteres
    <Object>.entity.breakdownDefinitions.fieldLabel Rótulo do campo usado no detalhamento.

    Tipo de dados: Cadeia de caracteres
    <Object>.entity.condition Consulta codificada para selecionar os dados a serem analisados.

    Tipo de dados: Cadeia de caracteres
    <Object>.entity.table Nome da tabela que contém os dados a serem analisados.

    Tipo de dados: Cadeia de caracteres
    <Object>.FindingDefinitionKPIMap Mapa de definições de descoberta e principais indicadores de desempenho (KPIs), em que a chave é uma definição de descoberta sys_id e o valor é uma matriz de sys_ids dos KPIs afetados pela definição da descoberta.

    As definições de descoberta estão localizadas nas tabelas Definição de descoberta [promin_finding_def] e Definição de descoberta automatizada [promin_automated_finding]. Os KPIs estão localizados na tabela Indicador [pa_indicators].

    Para obter mais informações sobre definições de descoberta e KPIs, consulte Working with finding definitions e. Viewing business insights.

    Tipo de dados: Objeto

    {
   "<finding_def_sys_id":[
      "<kpi_sys_id>"
   ]
}
    <Object>.id Sys_id do projeto.

    Definição do projeto [promin_project]

    Tipo de dados: Cadeia de caracteres
    <Object>.LastMined Data em que o projeto foi minerado pela última vez.

    Tipo de dados: Cadeia de caracteres
    <Object>.MiningState Estado de mineração do projeto.

    Para obter descrições dos estados de mineração, consulte Mine states.

    Tipo de dados: Cadeia de caracteres
    <Object>.name Nome do projeto.

    Tipo de dados: Cadeia de caracteres
    <Object>.permissões Grupo, função e permissões de usuário para o projeto.

    Tipo de dados: Objeto

    [
   {
      "type":"String",
      "value":"String"      
   }
]
    <Object>.permissions.type Tipo de permissão.
    Valores válidos:
    • grupo
    • função
    • usuário

    Tipo de dados: Cadeia de caracteres
    <Object>.permissions.value Sys_id do grupo, função ou usuário para conceder permissão.

    Tipo de dados: Cadeia de caracteres
    <Object>.RetiredDate Data em que o projeto será descontinuado.

    Tipo de dados: Cadeia de caracteres

    Este exemplo recupera um projeto de mineração de processos.

    SNC.ProcessMiningIntegrationAPI.getProject("fa465748ff01121047cae835f2cb1473");

    Saída:

    {
   "entity":{
      "table":"incident",
      "activityDefinitions":[
         {
            "field":"assignment_group",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"business_service",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"state",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"category",
            "type":"DEFAULT",
            "activityOfInterest":false
         },
         {
            "field":"priority",
            "type":"DEFAULT",
            "activityOfInterest":false
         }
      ],
      "condition":"",
      "breakdownDefinitions":[
         {
            "field":"contact_type",
            "fieldLabel":"Channel"
         },
         {
            "field":"close_code",
            "fieldLabel":"Resolution code"
         },
         {
            "field":"assignment_group",
            "fieldLabel":"Assignment group"
         },
         {
            "field":"location",
            "fieldLabel":"Location"
         },
         {
            "field":"priority",
            "fieldLabel":"Priority"
         },
         {
            "field":"category",
            "fieldLabel":"Category"
         }
      ]
   },
   "name":"Incident Process",
   "permissions":[
      {
         "value":"some_group_sys_id",
         "type":"group"
      },
      {
         "value":"some_role_sys_id",
         "type":"role"
      },
      {
         "value":"some_user_sys_id",
         "type":"user"
      }
   ],
   "id":"fa465748ff01121047cae835f2cb1473",
   "miningState":"NEW",
   "findingDefinitionKPIMap":{
      
   },
   "retiredDate":1728292672.622894000,
   "lastMined":null
}

    ProcessMiningIntegrationAPI - scheduleMining (cadeia de caracteres projectID)

    Envia um projeto de mineração de processos para mineração.

    Tabela 13. Parâmetros
    Nome Tipo Descrição
    projectId Cadeia de caracteres Sys_id do projeto.

    Definição do projeto [promin_project]
    Tabela 14. Retornos
    Tipo Descrição
    Objeto Objeto que contém o sys_id do projeto e um rastreador. 
    {
   "projectId":"String",
   "trackerId":"String"  
}
    <Object>.ProjectID Sys_id do projeto.

    Definição do projeto [promin_project]

    Tipo de dados: Cadeia de caracteres
    <Object>.TrackerId Sys_id do rastreador que monitora o andamento da mineração do projeto.

    Tabela: Rastreador de execução [sys_execution_tracker]

    Tipo de dados: Cadeia de caracteres

    Este exemplo envia um projeto para mineração.

    SNC.ProcessMiningIntegrationAPI.scheduleMining("c0b91f0cff01121047cae835f2cb14bc");

    Saída:

    {
   "trackerId":"aec9530cff01121047cae835f2cb147e",
   "projectId":"c0b91f0cff01121047cae835f2cb14bc"
}