...

Falando de componente Atividade de serviço...Image Modified

...

O componente Atividade de serviço representa um ponto do processo onde será feita uma consulta aos dados de um serviço externo repassando esses dados para o processo.

...

Esse componente permite utilizar dois tipos de execução da consulta aos dados do serviço externo: a execução Automatizada e a execução Imediata, que são detalhadas a seguir.

** imagem**Image Added

function servicetask9(attempt, message) {
	
	//Variáveis globais com os dados do formulário
	var FOLDER_NAME = hAPI.getCardValue("txtFolderName");
	var PARENT_FOLDER_CODE = hAPI.getCardValue("txtFolderCode");
	var GROUP_CODE = hAPI.getCardValue("txtGroupCode");
	var INHERIT_SECURITY = hAPI.getCardValue("cbxInheritSecurity") == "true";
	
	//Tipo de documento pasta
	var DOCUMENT_TYPE_FOLDER = "1";
	
	//Usuário logado
	var USER_LOGGED = getValue("WKUser");
	
	//Número da solicitação para comentário uso na descrição da pasta criada
	var REQUEST_NUMBER = getValue("WKNumProces");
	
	// Descrição da pasta criada
	var ADDITIONAL_COMMENTS = "This folder was created automatically from fluig BPM - request ";
	
	//Atribuições de segurança
	var USER_ATTRIBUTION_TYPE = 1;
	var GROUP_ATTRIBUTION_TYPE = 2;
	var ALL_USER_ATTRIBUTION_TYPE = 3; 
	
	//Níveis de segurança
	var READING = 0;
	var RECORDING = 1;
	var MODIFICATION = 2;
	var ALL = 3;
	
    try {
    	
    	//Instancia um novo documento e define as propriedades básicas
    	var dto = docAPI.newDocumentDto();
        dto.setDocumentDescription(FOLDER_NAME);
        dto.setAdditionalComments(ADDITIONAL_COMMENTS + REQUEST_NUMBER);
        dto.setDocumentType(DOCUMENT_TYPE_FOLDER);
        dto.setParentDocumentId(parseInt(PARENT_FOLDER_CODE));
        dto.setInheritSecurity(INHERIT_SECURITY);
        
        /*
         Como é possível definir várias permissões, é necessário criar um array com todas as permissões
         que serão aplicadas. Cada item do array é uma permissão ou restrição
        */
        var dtosSecurity = new Array();
        
        //Definindo permissão total para grupo
        var dtoGroupSecurity = docAPI.newDocumentSecurityConfigDto();
        dtoGroupSecurity.setAttributionType(GROUP_ATTRIBUTION_TYPE);
        dtoGroupSecurity.setAttributionValue(GROUP_CODE);
        dtoGroupSecurity.setPermission(true);
        dtoGroupSecurity.setShowContent(true);
        dtoGroupSecurity.setSecurityLevel(ALL);

        //Definindo permissão total para usuário
        var dtoUserSecurity = docAPI.newDocumentSecurityConfigDto();
        dtoUserSecurity.setAttributionType(USER_ATTRIBUTION_TYPE);
        dtoUserSecurity.setAttributionValue(USER_LOGGED);
        dtoUserSecurity.setPermission(true);
        dtoUserSecurity.setShowContent(true);
        dtoUserSecurity.setSecurityLevel(ALL);
        
      //Definindo permissão de modificação para todos os usuários
        var dtoAllUsersSecurity = docAPI.newDocumentSecurityConfigDto();
        dtoAllUsersSecurity.setAttributionType(ALL_USER_ATTRIBUTION_TYPE);
        dtoAllUsersSecurity.setAttributionValue(""); //Para todos os usuários deve-se passar vazio 
        dtoAllUsersSecurity.setPermission(true);
        dtoAllUsersSecurity.setShowContent(true);
        dtoAllUsersSecurity.setSecurityLevel(MODIFICATION);

      //Definindo restrição para usuário
        var dtoGroupRestrictionSecurity = docAPI.newDocumentSecurityConfigDto();
        dtoGroupRestrictionSecurity.setAttributionType(GROUP_ATTRIBUTION_TYPE);
        dtoGroupRestrictionSecurity.setAttributionValue(GROUP_CODE);
        dtoGroupRestrictionSecurity.setPermission(false);
        dtoGroupRestrictionSecurity.setShowContent(true);
        dtoGroupRestrictionSecurity.setSecurityLevel(MODIFICATION);
        
        //Definindo restrição para todos os usuários
        var dtoAllUsersRestrictionSecurity = docAPI.newDocumentSecurityConfigDto();
        dtoAllUsersRestrictionSecurity.setAttributionType(ALL_USER_ATTRIBUTION_TYPE);
        dtoAllUsersRestrictionSecurity.setAttributionValue("");
        dtoAllUsersRestrictionSecurity.setPermission(true);
        dtoAllUsersRestrictionSecurity.setShowContent(true);
        dtoAllUsersRestrictionSecurity.setSecurityLevel(RECORDING);
        
        //Adicionando permissões no array de segurança
        dtosSecurity.push(dtoGroupSecurity);        
        dtosSecurity.push(dtoUserSecurity);
        dtosSecurity.push(dtoAllUsersSecurity);

        //Adicionando restrições no array de segurança
        dtosSecurity.push(dtoGroupRestrictionSecurity);
        dtosSecurity.push(dtoAllUsersRestrictionSecurity);
       
        var FOLDER = docAPI.createFolder(dto, dtosSecurity, null);
        log.info("Folder successfully createad: ID :" + FOLDER.getDocumentId());
        
    } catch (e) {
        log.error("Could not create folder: \n" + e);
    }	
}

Execução automatizada

...

A execução automatizada determina que a execução do script será feita de forma assíncrona e sem a necessidade de uma interação manual de uma pessoa. Nesse tipo de execução, é possível definir o número de tentativas de execução e uma mensagem de sucesso que será exibida quando a execução for concluída sem inconsistências.

...

O fluxo de contingência é criado anexando um evento intermediário de captura de erro à atividade de serviço (o evento deve ser colocado em cima da atividade). Esse fluxo de saída será utilizando quando todas as tentativas de integração falharem.

Execução imediata

...

A execução imediata determina que a execução do script será feita de forma síncrona, logo depois do evento afterStateEntry do processo em questão, ou seja, será executado no momento em que a solicitação chegar na atividade de serviço.

...

Headers 

Âncora
headers headers

...

No contexto do componente Atividade de serviço, os headers (cabeçalhos) representam informações adicionais ou metadados que são enviados junto com a requisição de um serviço. Eles são usados para fornecer contexto ou parâmetros extras que o serviço ou a operação que está sendo chamada pode precisar para processar a requisição.

...

• Autenticação e autorização: pode ser um token de autenticação, uma chave de API ou credenciais de um usuário.

  Painel
  borderColor #ebecf0
  Estado subtle true title Exemplo Chave: Authorization Valor: Bearer token_de_acesso

• Informações de rastreio: dados sobre a requisição que podem ser usados para monitoramento ou rastreamento da chamada do serviço.

  Painel
  borderColor #ebecf0
  Estado subtle true title Exemplo Chave: X-Request-ID Valor: 12345

• Informações de contexto: dados que definem o contexto da requisição, tais como o idioma, a localidade ou a versão da API.

  Painel
  borderColor #ebecf0
  Estado subtle true title Exemplo Chave: Accept-Language Valor: pt-BR

• Formato dos dados: definição sobre como os dados devem ser interpretados ou enviados, como o tipo de conteúdo (Content-Type) ou a versão da API.

  Painel
  borderColor #ebecf0
  Estado subtle true title Exemplo Chave: Content-Type Valor: application/json

Parâmetros

Âncora
parametros parametros

...

No contexto do componente Atividade de serviço, os parâmetros são valores ou variáveis que o método/operação precisa receber para funcionar corretamente. Cada método/operação de um serviço geralmente tem uma lista de parâmetros que precisam ser fornecidos para que a execução da ação seja bem-sucedida. Sendo assim, o objetivo de configurar esses parâmetros é fornecer as informações necessárias para que o método/operação seja executado.

...

Por isso, a configuração dos parâmetros do método/operação é essencial para a correta execução da ação e comunicação entre os sistemas envolvidos.

Retorno

Âncora
retorno retorno

...

No contexto do componente Atividade de serviço, o retorno são os dados que a operação retorna depois de ser executada. Ao chamar um método/operação dentro de uma atividade de serviço, em muitos casos, a operação não só executa uma ação, mas também retorna um ou mais valores que podem ser usados em outras partes do processo. Esse retorno pode ser uma resposta simples – como um código de status ou uma mensagem – ou dados mais complexos – como um objeto JSON, uma lista ou um valor calculado.

Quando o método/operação é chamado, ele processa os dados de entrada, que são os parâmetros. Durante sua execução, o método/operação pode realizar cálculos, consultas a um banco de dados ou algum outro processamento de dados. Depois de processar os parâmetros e realizar suas funções internas, o serviço gera um retorno. Esse retorno pode ser algo simples – como um código de sucesso – ou pode ser um conjunto de dados mais complexo – como o resultado de uma busca ou a confirmação de que uma ação foi realizada.

...

Dessa forma, o retorno de uma operação é essencial para capturar os resultados de um serviço e usá-los de maneira eficaz dentro do fluxo do processo. Ele pode ser utilizado para tomar decisões, realizar ações subsequentes ou simplesmente para fornecer informações úteis para a continuação do processo.

Configurar componente Atividade de serviço –

...

REST

Âncora
rest rest

...

01. No diagrama do processo, clique no componente Atividade de serviço que deseja configurar com um serviço do tipo RestREST.

...

...

04. Na aba Geral, defina as informações solicitadas para configurar a execução do serviço. 

...

06. Informe os dados necessários para cada header.

07. Clique na aba Parâmetros para configurar os parâmetros do método/operação do serviço. 

08. Na coluna Origem do valor de cada parâmetro, selecione de onde será obtido o valor que será passado para esse parâmetro do método/operação.

...

14. Ao finalizar a configuração dos parâmetros da lista, clique em Salvar, para voltar para a aba Parâmetros.

...

21. Clique na aba Retorno para configurar o destino dos dados retornados pelo método/operação. 

22. Na coluna Atribuição de cada retorno, selecione para onde o dado retornado pelo método/operação deve ser enviado ou armazenado para ser usado no processo.

23. Na coluna Valor de cada retorno, defina onde o dado retornado deve ser armazenado ou utilizado, de acordo com o destino selecionado.

24. Se um dos parâmetros de retorno for do tipo complexo, como objeto ou lista, na coluna Ação, clique em Editar objeto para configurar o destino dos valores de retorno.

...

25. Ao finalizar a configuração dos parâmetros do objeto retornado, clique em Salvar, para voltar para a aba Retorno.

26. Clique em Salvar para salvar todas as configurações feitas para o serviço, operação, parâmetros e retorno.

27. Clique em Salvar rascunho – localizado no lado direito da barra superior – para salvar as configurações feitas no componente Atividade de serviço.

28. Na mensagem exibida, clique em Ok, entendi.

...

Configurar componente Atividade de serviço – SOAP

Âncora
soap soap

...

01. No diagrama do processo, clique no componente Atividade de serviço para o qual deseja configurar a execução automatizada.

02. Clique em Image Removed Adicionar condição.

03. Em Nome da condição, insira um nome para identificar a condição simples depois de criada.

04. Selecione o tipo Condição simples.

05. Xxxxxxx que deseja configurar com um serviço do tipo SOAP.

02. Na aba Geral, defina as informações gerais para o componente que representa a execução de um serviço externo06. Clique em Salvar.

07. Ao concluir a inclusão de todas as condições simples desejadas, clique em FecharImage Removed– localizado no canto superior direito.

...

...

03. Clique em Configurar integração.

04. Na aba Geral, defina as informações solicitadas para configurar a execução do serviço. 

05. Em Header, clique em Adicionar header para adicionar informações adicionais à requisição do serviço.

06. Informe os dados necessários para cada header.

07. Na coluna Valor de cada propriedade do objeto, insira o valor que será enviado para essa propriedade na requisição do serviço.

08. Ao finalizar a configuração das propriedades do objeto do header, clique em Salvar.

09. Clique na aba Parâmetros para configurar os parâmetros do método/operação do serviço. 

10. Na coluna Origem do valor de cada parâmetro, selecione de onde será obtido o valor que será passado para esse parâmetro do método/operação.

11. Na coluna Valor de cada parâmetro, selecione ou insira o valor que será passado de acordo com a origem selecionada.

12. Se um dos parâmetros for do tipo objeto, na coluna Ação, clique em Editar objeto Image Added para configurar os parâmetros do objeto.

13. Ao finalizar a configuração dos parâmetros do objeto, clique em Salvar, para voltar para a aba Parâmetros.

14. Se um dos parâmetros for do tipo lista, na coluna Ação, clique em Adicionar via lista Image Added para adicionar os valores para os parâmetros da lista.

15. Clique em Adicionar valor Image Added.

16. Ao finalizar a configuração dos parâmetros da lista, clique em Salvar, para voltar para a aba Parâmetros.

17. Para os tipos de parâmetros Objeto ou Map, é possível adicionar atributos clicando em Adicionar atributos Image Added – localizado ao lado do parâmetro.

18. Clique em Adicionar atributos Image Added.

19. Na coluna Chave, insira uma chave para identificar o atributo.

20. Na coluna Atribuição, selecione como será a atribuição de valor para o atributo.

21. Na coluna Valor, selecione ou insira o valor para o atributo de acordo com a origem selecionada.

22. Ao finalizar a configuração dos atributos, clique em Salvar até voltar para a aba Parâmetros.

23. Clique na aba Retorno para configurar o destino dos dados retornados pelo método/operação. 

24. Na coluna Atribuição de cada retorno, selecione para onde o dado retornado pelo método/operação deve ser enviado ou armazenado para ser usado no processo.

25. Na coluna Valor de cada retorno, defina onde o dado retornado deve ser armazenado ou utilizado, de acordo com o destino selecionado.

26. Se um dos parâmetros de retorno for do tipo complexo, como objeto ou lista, na coluna Ação, clique em Editar objeto Image Added para configurar o destino dos valores de retorno.

27. Ao finalizar a configuração dos parâmetros do objeto retornado, clique em Salvar, para voltar para a aba Retorno.

28. Clique em Salvar para salvar todas as configurações feitas para o serviço, operação, parâmetros e retorno.

29. Clique em Salvar rascunho – localizado no lado direito da barra superior – para salvar as configurações feitas no componente Atividade de serviço.

30. Na mensagem exibida, clique em Ok, entendi.

Configurar integração

...

01. No diagrama do processo, clique no componente Atividade de serviço Image Added para o qual deseja configurar a integração depois de selecionar o serviço desejado.

02. Clique em Configurar integração.

03. Defina as configurações desejadas para a integração nas abas Geral, Parâmetros e Retorno, de acordo com o tipo de serviço selecionado.

04. Depois de definir todas as configurações desejadas em cada aba, clique em Salvar.

05. Clique em Salvar rascunho – localizado no lado direito da barra superior – para salvar as alterações feitas no componente Atividade de serviço.

06. Na mensagem exibida, clique em Ok, entendi.

Editar integração

...

01. No diagrama do processo, clique no componente Atividade de serviço Image Added para o qual deseja editar as configurações da integração.

02. Clique em Editar Image Added – localizado no quadro da integração configurada.

03. Edite as configurações desejadas para a integração nas abas Geral, Parâmetros e Retorno, de acordo com o tipo de serviço selecionado.

04. Depois de editar todas as configurações desejadas em cada aba, clique em Salvar.

05. Clique em Salvar rascunho – localizado no lado direito da barra superior – para salvar as alterações feitas no componente Atividade de serviço.

06. Na mensagem exibida, clique em Ok, entendi.

Excluir integração

...

01. No diagrama do processo, clique no componente Atividade de serviço Image Added do qual deseja excluir a integração configurada.

02. Clique em Excluir Image Added – localizado no quadro da integração configurada.

03. Na mensagem exibida, clique em Excluir para confirmar a exclusão da integração.

04. Clique em Salvar rascunho – localizado no lado direito da barra superior – para salvar as alterações feitas no componente Atividade de serviço.

05. Na mensagem exibida, clique em Ok, entendi.

Dúvidas frequentes

...

Confira aqui algumas dúvidas frequentes sobre o componente Atividade de serviço.

<script>
    (function() {
        function toggleAreas(isExpand, $parent) {
            var $items = $parent.find('.panel');

            $.each($items, function(idx, el) {
                var $arrow = $(el).find('span.cloakToggle').find('span');
                var $content = $(el).find('span.cloak');
                if (isExpand) {
                    $arrow.removeClass('cloakDefaultOpen').addClass('cloakDefaultClose');
                    $content.show();
                } else {
                    $arrow.addClass('cloakDefaultOpen').removeClass('cloakDefaultClose');
                    $content.hide();
                }
            });
        }

        $(document).on('click', '#toggleAll-3', function(ev) {
            ev.preventDefault();
            var isExpand = $(this).data('expand');
            var $parent = $(this).nextAll('.sectionColumnWrapper').first();
            toggleAreas(isExpand, $parent);
            $(this).data('expand', !isExpand);
        });
    })();
</script>
<a id="toggleAll-3" href="#" data-expand="true">Abrir/fechar todas as dúvidas</a>

...

09. Na mensagem exibida, clique em Ok, entendi.

** Editar integração

01. No diagrama do processo, clique no componente Exclusivo Image Removed do qual deseja editar uma condição simples.

02. Em Condições criadas, localize a condição que deseja editar e clique em AçõesImage Removed– localizado no seu lado direito.

03. Clique em Editar.

04. Xxxxxxxxxx.

09. Clique em Salvar rascunho – localizado no lado direito da barra superior – para salvar as alterações feitas no componente Atividade de serviço.

10. Na mensagem exibida, clique em Ok, entendi.

Dúvidas frequentes

...

<script>
    (function() {
        function toggleAreas(isExpand, $parent) {
            var $items = $parent.find('.panel');

            $.each($items, function(idx, el) {
                var $arrow = $(el).find('span.cloakToggle').find('span');
                var $content = $(el).find('span.cloak');
                if (isExpand) {
                    $arrow.removeClass('cloakDefaultOpen').addClass('cloakDefaultClose');
                    $content.show();
                } else {
                    $arrow.addClass('cloakDefaultOpen').removeClass('cloakDefaultClose');
                    $content.hide();
                }
            });
        }

        $(document).on('click', '#toggleAll-3', function(ev) {
            ev.preventDefault();
            var isExpand = $(this).data('expand');
            var $parent = $(this).nextAll('.sectionColumnWrapper').first();
            toggleAreas(isExpand, $parent);
            $(this).data('expand', !isExpand);
        });
    })();
</script>
<a id="toggleAll-3" href="#" data-expand="true">Abrir/fechar todas as dúvidas</a>

A atividade de serviço é indicada quando o processo depende de dados externos oriundos de uma ação automatizada que pode ser executada sem a necessidade de interação direta de uma pessoa, tais como uma consulta a um banco de dados, uma chamada a uma API externa ou um cálculo automatizado.

Toggle Cloak
id @saiba-mais-2

Qual é a diferença da atividade de serviço e o evento de mensagem?

A principal diferença entre esses dois componentes é o papel de cada um. Enquanto a atividade de serviço executa uma ação específica – como uma consulta a um sistema externos – o evento de mensagem envia ou recebe uma mensagem durante o andamento do processo, o que pode desencadear uma ação em outro processo ou sistema.

Sendo assim, pode-se dizer que o evento de mensagem é mais voltado para a comunicação entre processos ou sistemas e a atividade de serviço tem como objetivo automatizar uma ação dentro do processo.

Toggle Cloak
id @saiba-mais-3

 O que acontece se uma atividade de serviço falhar ou gerar um erro?

Se a atividade de serviço foi configurada com a execução automatizada, é obrigatório que ela contenha um evento intermediário de captura de erro e um fluxo alternativo para onde a solicitação será direcionada em caso de falhas. Desta forma, quando a execução da atividade de serviço falhar, a solicitação será direcionada para o evento de captura de erro e, posteriormente, para o fluxo alternativo que direciona para uma etapa de tratamento da falha. Depois que a falha for solucionada, a solicitação volta para a atividade de serviço de origem e, assim que ela for executada com sucesso, segue o fluxo principal de saída.

Se a atividade de serviço foi configurada com a execução imediata, quando o script for executado com sucesso, a solicitação é enviada imediatamente da atividade de serviço para a próxima etapa, dando continuidade ao fluxo de saída padrão. Porém, se ocorrer alguma inconsistência, ela apenas retornará a inconsistência encontrada, mantendo a solicitação parada até que uma pessoa interaja na solicitação para averiguar e corrigir as inconsistências que ocorreram.

Toggle Cloak
id @saiba-mais-4

Xxxxxxxxxxxx?

Xxxxxxxxxxxx

Toggle Cloak
id @saiba-mais-5

 Xxxxxxxxxxxx?

Xxxxxxxxxxxxxx

Toggle Cloak
id @saiba-mais-6

 Xxxxxxxxxxxxx?

Xxxxxxxxxxxxxxx

Toggle Cloak
id @saiba-mais-7

Xxxxxxxxxxxx?

Xxxxxxxxxxxxx

Esta documentação é válida a partir da atualização 9.9.9 – Xxxxxxx Voyager (2.0). Se você utiliza uma atualização anterior, ela pode conter informações diferentes das quais você vê na sua plataforma.

...