PDAutomationProvider - com escopo, global

  • Versão de lançamento: Washingtondc
  • Atualizado 1 de fev. de 2024
  • 6 min. de leitura
  • A API PDAutomationProvider permite inserir uma atividade opcional em um processo enquanto ele está sendo executado.

    Esta API faz parte do plug-in Playbooks (com.glide.pad.core) e é executada no namespace sn_pad.

    Chamar scripts com esta API requer pelo menos um dos seguintes:
    • O solicitante deve estar no mesmo escopo em que o gatilho de atividade opcional foi criado.
    • Privilégios de administrador.

    Um processo é uma série de atividades ordenadas por raias. Uma atividade opcional é predefinida durante o design do processo. As atividades não estão programadas para serem executadas em um horário preciso. Uma atividade pode ser atribuída a uma raia e disponibilizada para execução durante a execução da raia. Uma atividade pode ser atribuída a um processo e disponibilizada para execução durante a execução da raia.

    Para criar uma atividade opcional, ela deve ter a Regra de início definida como Manual na tabela Atividades [sys_pd_activity]. Playbooks atualmente não oferece suporte à criação de atividades manuais.

    Um agente adiciona a atividade opcional a uma raia ou atividade em relação a outra atividade. O processo deve estar em execução para inserir uma atividade opcional.

    PDAutomationProvider – addOptionalActivityRelativeToActivityContext(cadeia de caracteres contextID, cadeia de caracteres activityId, cadeia de caracteres em que, cadeia de caracteres relativeToId)

    Adiciona uma atividade opcional especificada a um processo a ser executado em relação a outra atividade durante a execução do processo.

    Um contexto de atividade é criado para cada atividade quando um processo é executado. O contexto também lida com a forma como a atividade lida com a execução. Para obter informações, consulte Raias e atividades do Process Automation Designer.

    Tabela 1. Parâmetros
    Nome Tipo Descrição
    contextID Cadeia de caracteres Sys_id da execução da atividade à qual adicionar a atividade opcional. Para acessar, clique no processo listado na tabela Execuções de processo [sys_pd_context]. A execução selecionada deve estar no estado Em andamento.
    activityId Cadeia de caracteres Sys_id da atividade opcional listada na tabela Atividades [sys_pd_activity].
    Nota:
    Para criar uma atividade opcional, ela deve ter a Regra de início definida como Manual na tabela Atividades [sys_pd_activity].
    onde Cadeia de caracteres Indica onde colocar a atividade no processo.
    Valores válidos:
    • DEPOIS – execute esta atividade após a atividade relativa contexto.
    • COM: execute a atividade ao mesmo tempo que outra atividade relativa contexto.
    RelativeToId Cadeia de caracteres ID do contexto de atividade relativa após o qual a atividade opcional será executada ou com. Listado na tabela Contexto de atividade [sys_pd_activity_context].
    Tabela 2. Retorna
    Tipo Descrição
    Booliano Sinalizador que indica se a atividade foi programada para ser executada com sucesso.
    Valores válidos:
    • verdadeiro: a atividade foi programada para ser executada com sucesso. A saída é uma cadeia de caracteres informando sucesso.
    • falso: a atividade não está programada para ser executada com sucesso. A saída é uma matriz de uma ou mais mensagens de erro.

    Em caso de erros, lista de uma ou mais mensagens de erro. Mensagem informando Matriz de 0 ou mais elementos.

    Matriz Em caso de erros, lista de uma ou mais mensagens de erro. Mensagem informando Matriz de 0 ou mais elementos.
    Possíveis mensagens de erro:
    • ID de atividade opcional inválido – o sys_id fornecido para o parâmetro activityId é inválido.
    • ID decontexto de PD inválido : o sys_id do Designer de processo (PD) fornecido no parâmetro contextID é inválido.
    • Tipo de posição inválido: o tipo de posição fornecido é inválido. Consulte a descrição do parâmetro where para obter tipos válidos.
    • ID relativo a inválido – o sys_id fornecido para o parâmetro relativeToId é inválido.
    • Atividade opcional não encontrada – o sys_id fornecido para o parâmetro activityId não foi encontrado.
    • O processo ainda deve estar ativo – O processo que contém esta atividade deve estar ativo para executar a atividade opcional.
    • Contexto de atividade relativa não encontrado : o sys_id fornecido para o parâmetro relativeToId não foi encontrado.

    O exemplo a seguir mostra como executar uma atividade opcional simultaneamente com o contexto de atividade relativa.

    var contextId = '<context_id>';
    var optionalActivityId = '<optional_activity_id>';
    var where = 'WITH'; // options AFTER, WITH
    var relativeToId = '<relative_activity_context_id>'; // relative activity context ID
    
    var response = sn_pad.PDAutomationProvider.addOptionalActivityRelativeToActivityContext(contextId, optionalActivityId, where, relativeToId);
    
    gs.info(JSUtil.describeObject(response));
    Saída (sucesso):
    success: boolean = true
    errors: Array of 0 elements

    PDAutomationProvider – addOptionalActivityRelativeToLaneContext(cadeia de caracteres contextID, cadeia de caracteres activityId, cadeia de caracteres em que, cadeia de caracteres relativeToId)

    Atribui uma atividade opcional a uma raia para executar durante o contexto de execução dessa raia.

    Um contexto de raia é criado para cada raia quando um processo é executado. O contexto também lida com a forma como a raia lida com a execução. Para obter informações, consulte Raias e atividades do Process Automation Designer.

    Tabela 3. Parâmetros
    Nome Tipo Descrição
    contextID Cadeia de caracteres Sys_id da execução da atividade à qual adicionar a atividade opcional. Para acessar, clique no processo listado na tabela Execuções de processo [sys_pd_context]. A execução selecionada deve estar no estado Em andamento.
    activityId Cadeia de caracteres Sys_id da atividade opcional listada na tabela Atividades [sys_pd_activity].
    Nota:
    Para criar uma atividade opcional, ela deve ter a Regra de início definida como Manual na tabela Atividades [sys_pd_activity].
    onde Cadeia de caracteres Indica onde colocar a atividade no processo.
    Valores válidos:
    • LAST – Executar como a atividade final em uma raia contexto.
    • PRÓXIMO: executa na próxima atividade em uma raia contexto.
    RelativeToId Cadeia de caracteres ID do contexto da raia relativa no qual a atividade opcional será executada. Listado na tabela Contexto da raia [sys_pd_lane_context].
    Tabela 4. Retorna
    Tipo Descrição
    Booliano Sinalizador que indica se a atividade foi programada para ser executada com sucesso.
    Valores válidos:
    • verdadeiro: a atividade foi programada para ser executada com sucesso. A saída é uma cadeia de caracteres informando sucesso.
    • falso: a atividade não está programada para ser executada com sucesso. A saída é uma matriz de uma ou mais mensagens de erro.
    Matriz Em caso de erros, lista de uma ou mais mensagens de erro. Mensagem informando Matriz de 0 ou mais elementos.
    Possíveis mensagens de erro:
    • ID de atividade opcional inválido – o sys_id fornecido para o parâmetro activityId é inválido.
    • ID decontexto de PD inválido : o sys_id do Designer de processo (PD) fornecido no parâmetro contextID é inválido.
    • Tipo de posição inválido: o tipo de posição fornecido é inválido. Consulte a descrição do parâmetro where para obter tipos válidos.
    • ID relativo a inválido – o sys_id fornecido para o parâmetro relativeToId é inválido.
    • A atividade opcional não pode ser adicionada à raia – A atividade opcional fornecida no parâmetro activityId não pode ser adicionada em relação à raia fornecida no parâmetro relativeToId. Certifique-se de que a Execução de Atividade selecionada esteja no estado Em Andamento.
    • Atividade opcional não encontrada – o sys_id fornecido para o parâmetro activityId não foi encontrado.
    • O processo ainda deve estar ativo – O processo que contém esta atividade deve estar ativo para executar a atividade opcional.
    • Contexto de raia relativa não encontrado : o sys_id fornecido para o parâmetro relativeToId não foi encontrado.

    O exemplo a seguir mostra como executar uma atividade opcional como a atividade final em um contexto de raia.

    var contextId = '<context_id>';
    var optionalActivityId = '<optional_activity_id>';
    var where = 'LAST'; // options LAST, NEXT
    var relativeToId = '<relative_lane_context_id>'; // relative lane context ID
    
    var response = sn_pad.PDAutomationProvider.addOptionalActivityRelativeToLaneContext(contextId, optionalActivityId, where, relativeToId);
    
    gs.info(JSUtil.describeObject(response));
    Saída (sucesso):
    success: boolean = true
    errors: Array of 0 elements