TOTVS Fluig

Atalhos

Árvore de páginas

Versões comparadas

Versão antiga 15

changes.mady.by.user Usuário desconhecido (jessica.mariana)

Gravado em

comparado com

Nova versão Atual

changes.mady.by.user Marcos Jahn

Gravado em

Chave

  • Esta linha foi adicionada.
  • Esta linha foi removida.
  • A formatação mudou.

Índice
maxLevel4
outlinetrue
exclude.*ndice
stylenone


Objetivo

...

O objetivo deste guia é demonstrar o procedimento que deve ser seguido as formas de importar um processo, utilizando APIs, para que o Fluig exiba corretamente a imagem de um processo corretamentedo fluxo do processo.


Falando da imagem do processo no Fluig

...

A imagem do fluxo do processo que é exibida na movimentação de solicitações não é gerada pelo back-end do Fluig. Os nossos modeladores web e do eclipse pluginFluig Studio, ao gravarem liberarem uma nova versão do processo enviam também a imagem usando o padrão no formato SVG (Scalable Vector Graphics).

Caso seja usada uma de nossas APIs a importação de um processo seja realizado sem o envio da imagem, o Fluig exibirá a mensagem “Não foi possível exibir o fluxo do processo” na página de movimentação de processos. 

Pré-requisitos

...

Para executar os passos desse guia, é necessário:


• O Fluig Plataforma deve estar na atualização 1.7.0-200608 ou superior;
• Ter o Fluig Studio instalado;
• Ser um usuário administrador;
• Obter o arquivo XML do processo;
• Obter o arquivo SVG com o fluxo do processo.


Obtendo o arquivo XML  e o SVG do processo

...

O XML e a imagem SVG do processo ficam disponíveis na pasta “\workflow\.resources”, na workspace do Fluig Studio. Para que a imagem SVG seja gerada automaticamente a cada alteração no processo, é necessário alterar as configurações do Fluig Studio. Para isso, siga os passos a seguir:

Deck of Cards
idPasso 1
Card
labelPasso 1
  • Acesse Window, em seguida clique na opção Preferences:

Card
labelPasso 2
    • Localize o agrupador Fluig, expanda as configurações de salvamento e clique em Save: 

Card
labelPasso 3
    • Após concluir o passo 2, marque a opção Automaticamente salvar para o formato SVG quando salvar o diagrama: 



Card
labelPasso 4
    • Reinicie o Fluig Studio.
Card
labelPasso 5
    • Após reiniciar o Fluig Studio, ao alterar e salvar um processo no mesmo, o arquivo SVG estará disponível na pasta .resources, além do arquivo XML:



Enviando o fluxo do processo no caso da API pública

...

A imagem do fluxo do processo pode ser enviada de duas formas utilizando API REST:

  • Enviar o SVG separadamente - , após importação do processo (recomendado);
  • Adicionar o SVG no XML do processo (avançado).

...

Observe abaixo os passos para cada uma delas:

Painel

Enviar o SVG separadamente (recomendado)

Esse método é mais simples e não requer manipulação do arquivo XML do processo. Para isso siga os passos a seguir:

01. Efetue a importação do processo utilizando a API /v2/processes/import/xml, informando corretamente os parâmetros necessários segundo o Swagger;
02. Após a importação com sucesso do processo desejado, envie a imagem SVG utilizando a API /v2/processes/{processId}/process-ersionsversions/{processVersion}/diagram seguindo os parâmetros detalhados no Swagger.

Adicionar o SVG no XML do processo (avançado)

 Nesse método, é necessário incluir o conteúdo do arquivo SVG do fluxo no XML do processo. Para isso siga os passos a seguir:

01. Abra o arquivo XML do processo no editor de texto de sua preferência; 
02. Antes do fechamento da tag “ProcessDefinitionVersion”, inclua a tag “processDiagram”:

Observe o exemplo: 

Bloco de código
	<processDiagram>

 	</processDiagram>
 </ProcessDefinitionVersion>

03. Na tag “processDiagram” deve ser informado o conteúdo do arquivo SVG. Para isso, basta abrir o arquivo SVG no editor de texto de sua preferência e copiar todo o conteúdo. 

Observe o exemplo: 

Bloco de código
	<processDiagram> 

&lt;?xml version=&quot;1.0&quot; encoding=&quot;UTF-8&quot;?&gt;
 
&lt;svg xmlns=&quot;http://www.w3.org/2000/svg&quot; style=&quot;s
 
...
 
&lt;/svg&gt;
   
</processDiagram>
 </ProcessDefinitionVersion>
Nota
titleAtenção!

Ao utilizar esse método são necessários alguns cuidados:

  • Realizar o processo de escape do conteúdo do arquivo SVG antes de incluir na tag “processDiagram” do XML do processo;
  • Após a inclusão da tag, garantir que o arquivo XML é um XML válido (evitar tags abertas, XML mal formado, etc);
  • No editor de texto utilizado, verificar se a codificação está configurada para UTF-8. Caso seja utilizada outra codificação, o processo importado não exibirá corretamente caracteres especiais, por exemplo, acentuação, etc.


No SOAP

...

No SOAP /webdesk/ECMWorkflowEngineService?wsdl, pode ser usado um dos métodos importProcess  (seja somente o processo ou com formulário) passando o svg como um dos attachments informando a imagem no formato SVG na tag attachments, marcando como anexo e como não principal.

...

Bloco de código
<attachments>
  <item>
     <attach>true</attach>
     <principal>false</principal>
     <filecontent>svgaqui</filecontent>
  </item>
</attachments>
Nota
titleAtenção!

O conteúdo do arquivo SVG deve ser enviado em bytes.

Gerar a imagem através do Painel de Controle

...

Veja o vídeo

Essa é a forma mais simples, porém, é limitada à processos que também possam ser editados pela web. É recomendada para processos antigos ou que foram migrados a partir do TOTVS ECM 3.0. Para isso siga os passos a seguir:

...

Informações

Fique atento!

Esta documentação é válida a partir da atualização 1.7.0-200608 ou superior- Lake. Se você utiliza uma atualização anterior, ela pode conter informações diferentes das quais você vê na sua plataforma.