Árvore de páginas

Descrição dos métodos para Workflow na classe TWFProcess

Produto:

Microsiga Protheus 

Ocorrência:

 Descrição dos métodos para Workflow na classe TWFProcess

Passo a passo:

A classe TWFProcess é responsável pela criação e gerenciamento do processo. Como toda e qualquer classe,  a TWFProcess é dividida em métodos e propriedades. Veremos alguns dos principais métodos e propriedades que iremos usar para a criação de um processo.

  • Métodos:

:New(<cCodProc>,<cDescr>,<cProcID>)
O método New() é responsavel pela criação e inicialização da classe WFProcess.

:NewTask(<cDescr>,<cArqHtml>,<lCopiar>)
Este método é responsável por criar a seqüência de tarefas a serem executadas e identificar qual html será utilizado pelo processo.

:AttachFile(<cArquivo>)
Este método é responsável pela inclusão de arquivos anexos à mensagem. Os arquivos anexos deverão estar abaixo do root path do Protheus.

:Start(<cHtmlCopiarPara>) -> cProcessKey
Este método é responsável por construir todo o processo, gravar os registros nas tabelas do Workflow e enviar a mensagem para os destinatários. O valor de retorno é uma chave composta pela codificação ProcessID + TaskID e números aleatórios no total de 17 algarismos em hexadecimal.

:Finish()
Este método é responsável por finalizar o Processo. Após a finalização, este não estará mais disponível para execuções do tipo retorno e timeout.

:Track(<cCodStatus>,<cDescr>,<cUsuario>)
Este método é responsável por incluir as descrições dos passos seguidos pelo fluxo do processo e apresentá-los na consulta da rastreabilidade.

:cTo,  :cCC e :cBCC
Estas propriedades definem o endereço dos destinatários. Poderá ser informado mais que um destinatário ao mesmo tempo. Basta incluir um ponto-e-vírgula (;) entre eles. Se for informada uma palavra qualquer que não seja um endereço de e-mail válido, o Workflow considera que se trata de um diretório onde o html gerado deverá ser gravado. É possível ainda mesclar os tipos.

:cSubject
Esta propriedade define o assunto da mensagem.

:cBody
Esta propriedade armazena um texto que permanece no corpo da mensagem. Caso seja utilizado, o html irá como anexo da mensagem.

:bReturn
Esta propriedade contém o nome da função que será executada no momento em que o Workflow recebe a mensagem de resposta de um dos destinatários via e-mail ou serviço http.

:bTimeOut
Esta propriedade recebe um array de timeouts contendo nomes das funções e tempo de espera. Caso o tempo seja alcançado, será executada a função mencionada no 1º item do array. Poderá especificar mais que 1 array de timeouts.

:fProcessID
Esta propriedade fornece o número ID do processo.

:fTaskID
Esta propriedade fornece o número ID da tarefa criada para um determinado processo por meio do método :NewTask().

:oHTML
Esta propriedade é responsável pelo tratamento das palavras chaves no html mencionado no método :NewTask(). Este objeto é uma referência da classe TWFHtml() e disponibiliza dois dos métodos mais importantes: RetByName() e ValByName().

:oHTML:RetByName( <cNome da macro> )
Esta propriedade tem como objetivo obter o conteúdo da macro quando as respostas retornarem para o Workflow. Este método somente deverá ser usado na função de retorno.

:oHTML:ValByName(<cMacro>,<uConteudo>)
Este método tem por objetivo atribuir ou obter um valor à uma macro existente no html. Este deverá ser usado somente no momento em que estiver assinalando valores ao html ou na função de timeouts. Na função de timeouts o uso é necessário por motivo de não ter recebido nenhuma resposta.

Observações: