Manuais
PHC GO BPM - Desenho de Workflow
 
Passamos agora a explicar os passos necessários. para desenhar o workflow

Para desenhar um tipo de workflow aceda ao ecrã de Tipos de workflow em menu Menu> settingsDefinições>BPM>Tipos de workflow.

Passo 1

Selecione o tipo de workflow pretendido e nas ações de registo selecione Desenhe diagrama O ecrã é aberto em modo de desenho e stá pronto para desenhar o tipo de workflow.

Com o ecrã em modo desenho são exibidos os elementos necessários para criar o respetivo desenho do workflow, que passamos de imediato a explicar.

Elemento Descrição
Elemento manual. Este elemento serve para arrastar o desenho dentro da área definida.
Elemento de laço. Este elemento permite selecionar uma area do desenho. Por exemplo permite selecionar de uma só vez todos os elementos do desenho.
Elemento para criar ou remover espaços. Este elemento serve para aumentar ou diminuir espaços entre os elementos do desenho.
Elemento para criar caminhos. Este elemento serve para efetuar a ligação entre elementos.
Elemento de inicio. Elemento imprescindível no desenho do workflow e que serve como elemento de arranque do workflow.
Elemento de fim. Elemento imprescindível no desenho do workflow e que serve como elemento de finalização do workflow.|
Elemento para ponto de decisão. Este elemento serve para que o workflow possa seguir circuitos diferentes mediante a decisão tomada pelo utilizador.
Elemento para criar tarefa de utilizador. Este elemento serve para que se possa configurar de que forma pretendemos que sejam criadas as tarefas que irão ser atribuídas aos utilizadores.
Elemento para criar script. Este elemento serve para criar o código necessario para que a aplicação proceda da forma desejada.
Elemento para chamar outro workflow. Este elemento serve para que a partir de um workflow seja possível chamar outro workflow.


Passo 2 - Inserir elementos na Área de desenho

Com o rato clique no elemento pretendido e araste-o para a área de desenho. Os elementos de inicio e de fim são imprescindíveis para disponibilizar o tipo de workflow.

Passo 3 - Configuração de cada elemento

Após o elemento estar na area de desenho podemos passar à configuração do mesmo, para isso basta clicar no elemento pretendido e clicar na roda dentada settings disponibilizada pelo elemento.

Elemento para criar caminhos




O cabeçalho deste elemento é constituído pelos seguintes campos:

  • Tipo de elemento - Campo indicativo do tipo de elemento. Este campo é preenchido automaticamente pela aplicação.

  • Código do caminho - Campo que serve para indicar um código associado ao elemento. Este campo deve ser preenchido pelo utilizador.

    Detalhes

    Abrir/Fechar
    Esta secção é constituída pelos seguintes campos:

    • Descrição - Serve para inserir em texto livre uma descrição acerca de elemento.

    • Elemento de origem - Código identificativo do elemento de origem.

    • Elemento de destino - Corresponde à descrição do elemento de destino mais o código da ação do elemento de destino.

    Filtro de ativação

    Abrir/Fechar
    Esta secção é constituída pelos seguintes campos:

    • Variável - Campo para selecionar uma das variáveis definidas no workflow.

    • Condição - Campo para selecionar a condição pretendida para a variável.

    • Valor da condição - Valor a considerar para a variável e condição definidas.

    • Adicione critério
      - Botão que serve para adicionar um critério ao filtro.

    • Remova critérios
      - Botão que serve para remover critérios ao filtro.

    • Utiliza qualquer um dos filtros - Ao ativar este campo significa que, qualquer um dos filtros definidos acima, será utilizado para extrair a informação da entidade escolhida para a listagem.

    Código ao iniciar

    Abrir/Fechar
    É o primeiro código a correr no elemento, é a altura ideal para definir valores para as variáveis, ou alterar outras configurações do workflow ou da atividade que está a ser processada, a sequencia de execução do código dos diversos eventos que o elemento suporta é a seguinte ´Inicialização - Ativação - Estado - Fim´, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código o caminho é ignorado e o processamento do workflow continua a funcionar á procura de outros caminhos válidos, todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()
    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()
    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código de ativação

    Abrir/Fechar
    Caso o caminho seja proveniente de um ponto de decisão, pode ter sido ativado nesse elemento de origem, e nesse caso este código não é executado, caso contrário, neste código devemos retornar um valor lógico de verdadeiro para ativar o caminho.

    Retorno
    Este código não retorna mensagens, se for necessário registrar informação no log do workflow deve ser utilizado SDKBPM.AddTrace(New MsgInfo(´Informação A´)) ou SDKBPM.AddTrace(New MsgError(´Erro B´))

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Exemplo de regra de ativação
    If SDKBPM.GetVar(Of String)(´Cod02´).ToLower() = ´tudo ok´ Return True End If If SDKBPM.GetVar(Of String)(´Cod02´).EqualsWithIgnoreCase(´Tudo Ok´) Return True End If

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código do estado

    Abrir/Fechar
    Código para definir o valor do estado a ser aplicado ao workflow e á atividade que está a ser processada, este código só é executado se o caminho for ativado e corre após essa ativação, de notar que caso o caminho não seja proveniente de um ponto de decisão, é considerado como ativo, e por isso este código é sempre executado nessa situação, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código a alteração do valor do estado é cancelada mas o workflow continua em execução, todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Definir o valor de estado
    • SDKBPM.SetStatus("Em Aprovação")

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código ao finalizar

    Abrir/Fechar
    É o último código a correr no elemento, este código só é executado se o caminho ter sido ativado, de notar que caso o caminho não seja proveniente de um ponto de decisão, é considerado como ativo, e por isso este código é sempre executado nessa situação, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Qualquer retorno de mensagens ou erro de execução é ignorado pois não é possivel cancelar o fim da execução de um caminho, no entanto todas as mensagens retornadas são registradas no log do workflow.

    Payload

    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String


    Elemento de inicio


    O cabeçalho deste elemento é constituído pelos seguintes campos:

  • Tipo de elemento - Campo indicativo do tipo de elemento. Este campo é preenchido automaticamente pela aplicação.

  • Tipo de evento - Campo que serve para indicar o tipo de evento associado ao elemento. Este campo é preenchido pela aplicação.

  • Código do evento - Código que identifica o evento associado ao elemento. Este campo deve ser preenchido pelo utilizador.

    Detalhes

    Abrir/Fechar
    A secção dos detalhes é composta pelos seguintes campos:
    • Descrição - Descrição do elemento.
    • Instruções - Campo de texto livre para introduzir instruções caso seja necessário.
    • Apenas um ativo - Quando ativo, permite apenas um workflow em execução associado a cada registo.
    • Confirmação pelo utilizador - Quando ativo significa que tem momento de confirmação pelo utilizador antes de iniciar o workflow, caso exista variáveis de preenchimento obrigatório ou número de conexões / documentos mínimos, mesmo que este campo não este selecionado, o workflow terá sempre momento de confirmação.
    • Numero mínimo de anexos - Obriga a um numero mínimo de anexos no arranque do workflow.
    • Numero mínimo de ligações a registos - Obriga a um numero mínimo de ligações a registos no arranque do workflow.
    • Tipo de arranque - Serve para selecionar a forma de como pretendemos arrancar do workflow.
    • Tipo de arranque de entidade - Serve para selecionar o momento em que o evento deve arrancar. Apenas ativo quando o tipo de arranque é Eventos de entidade.
    • Nome da entidade - Serve para selecionar a entidade pretendida no workflow.
    • Tipo de documento - Serve para selecionar a serie relativo à entidade selecionada. Apenas ativo quando o nome da entidade selecionada tem varias series de documentos associados.
    • Nome da ação - Identificação da ação
    • Ação sugerida - Quando ativo significa que a ação aparece em destaque nas ações sugeridas.
    • Código de inicio a pedido - Este código deve ser único dentro do desenho do tipo de workflow, deve ser usado juntamente com ID (bpmprocessstamp) para iniciar a execução do workflow via código de AddOn, exemplo: SDK.BPM.StartOnDemand(bpmprocessstamp As String, demandCode As String, Optional payload As GenericVO = Nothing)

    Acessos

    Abrir/Fechar
    Código para definir condições adicionais do acesso ao tipo de arranque definido neste evento, se o arranque definido, for por exemplo, uma ação para o ecrã de clientes, podemos aqui escrever código que faça com que essa ação esteja disponível apenas para clientes cuja data de nascimento esteja preenchida.

    Retorno
    Neste código devemos retornar um valor lógico de verdadeiro para indicar que o arranque é valido, o contexto é muito reduzido, apenas temos acesso á variável ´payload´ passada por parâmetro e não existe qualquer tipo de contexto do workflow ou dos seus elementos, nem sequer está dísponivel o SDK de BPM.

    Parâmetros
     payload = Contexto fornecido.

    Exemplo de regra de acesso
    Dim cliente as ClVO = DirectCast(payload, ClVO)
    If Not cliente.nascimento.IsVoid()
    Return True
    End If !

    Atribuição

    Abrir/Fechar
    Nesta secção são exibidos 3 campos:

    Tipo de acesso - Campo que serve para definir o nível de acesso.

    Perfil de acesso - Campo que serve para identificar um perfil de acesso. Apenas habilitado quando o tipo de acesso é Acesso por perfil.

    Utilizador - Serve para definir apenas um utilizador com acesso. Apenas habilitado quando o tipo de acesso é Acesso privado para um utilizador.

    Código ao iniciar

    Abrir/Fechar
    É o primeiro código a correr no elemento, é a altura ideal para definir valores para as variáveis, ou alterar outras configurações do workflow ou da atividade que está a ser processada, a sequencia de execução do código dos diversos eventos que o elemento suporta é a seguinte ´Inicialização - Estado - Confirmação - Fim´, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Atenção, se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, o workflow é cancelado, isto só se aplica ao evento iniciar, no evento de fim, qualquer retorno de mensagens ou erro de execução é ignorado, pois não é possível cancelar a execução de código num evento de fim, no entanto todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)
    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código de estado

    Abrir/Fechar
    Código para definir o valor do estado a ser aplicado ao workflow e á atividade que está a ser processada, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código a alteração do valor do estado é cancelada mas o workflow continua em execução, todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Definir o valor de estado
    • SDKBPM.SetStatus("Em Aprovação")

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código de confirmação

    Abrir/Fechar
    Este código só é executado se o elemento evento de inicio estiver configurado que para iniciar o workflow é necessário confirmação pelo utilizador, neste código podemos escrever as regras de negócio para validar essa confirmação, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, o workflow continua no estado de necessitar de confirmação do utilizador para iniciar, qualquer tipo de mensagem retornada é mostrada ao utilizador e também registrada no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Exemplo de regra de confirmação
    If SDKBPM.GetVar(Of String)(´Cod02´).IsVoid()
    listMsg.Add(New MsgError($´Deve preencher o valor da variável {SDKBPM.GetVarTitle(´Cod02´)}´))
    Return listMsg
    End If

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código ao finalizar

    Abrir/Fechar
    É o último código a correr no elemento, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Qualquer retorno de mensagens ou erro de execução é ignorado pois não é possivel cancelar o fim da execução de um evento, no entanto todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Variáveis

    Abrir/Fechar
    Esta secção permite inserir variáveis do workflow através do botão "+", quer pela pesquisa de variáveis quer por introdução direta no elemento.


    Elemento Fim



    O cabeçalho deste elemento é constituído pelos seguintes campos:

  • Tipo de elemento - Campo indicativo do tipo de elemento. Este campo é preenchido automaticamente pela aplicação.

  • Tipo de evento - Campo que serve para indicar o tipo de evento associado ao elemento. Este campo é preenchido pela aplicação.

  • Código do evento - Código que identifica o evento associado ao elemento. Este campo deve ser preenchido pelo utilizador.

    Detalhes

    Abrir/Fechar
    Esta secção apenas é composta pelo campo Descrição que permite introduzir uma descrição do elemento fim.

    Código ao iniciar

    Abrir/Fechar
    É o primeiro código a correr no elemento, é a altura ideal para definir valores para as variáveis, ou alterar outras configurações do workflow ou da atividade que está a ser processada, a sequencia de execução do código dos diversos eventos que o elemento suporta é a seguinte ´Inicialização - Estado - Confirmação - Fim´, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Atenção, se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, o workflow é cancelado, isto só se aplica ao evento iniciar, no evento de fim, qualquer retorno de mensagens ou erro de execução é ignorado, pois não é possível cancelar a execução de código num evento de fim, no entanto todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()


    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()


    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)


    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código de estado

    Abrir/Fechar
    Código para definir o valor do estado a ser aplicado ao workflow e á atividade que está a ser processada, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código a alteração do valor do estado é cancelada mas o workflow continua em execução, todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)(


    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()


    Definir o valor de estado
    • SDKBPM.SetStatus("Em Aprovação")


    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)


    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código ao finalizar

    Abrir/Fechar
    É o último código a correr no elemento, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Qualquer retorno de mensagens ou erro de execução é ignorado pois não é possivel cancelar o fim da execução de um evento, no entanto todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()/li>


    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()


    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)


    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String



    Elemento Ponto de Decisão



    O cabeçalho deste elemento é constituído pelos seguintes campos:

  • Tipo de elemento - Campo indicativo do tipo de elemento. Este campo é preenchido automaticamente pela aplicação.

  • Código da decisão - Campo que serve para indicar um código associado ao elemento. Este campo é preenchido automaticamente pela aplicação, que pode ser alterado pelo utilizador.

    Detalhes

    Abrir/Fechar
    Esta secção apenas é composta pelo campo Descrição que permite introduzir uma descrição do elemento fim.

    Código ao iniciar

    Abrir/Fechar
    É o primeiro código a correr no elemento, é a altura ideal para definir valores para as variáveis, ou alterar outras configurações do workflow ou da atividade que está a ser processada, a sequencia de execução do código dos diversos eventos que o elemento suporta é a seguinte ´Inicialização - Ativação - Estado - Fim´, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Atenção, se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, o workflow é cancelado, no entanto todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()
    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()
    Definir valores de variáveis
      SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código de ativação

    Abrir/Fechar
    Este código serve para ativação de um ou vários caminhos de saída existentes neste ponto de decisão, todos os caminhos de saída estão inativos no inicio, sendo necessário ativar os que se deseja.

    Retorno
    Qualquer tipo de retorno de mensagens ou erro de execução é ignorado, no entanto as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Ativar um caminho
    • SDKBPM.ActivateFlow(´Flow01´)


    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código do estado

    Abrir/Fechar
    Código para definir o valor do estado a ser aplicado ao workflow e á atividade que está a ser processada, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código a alteração do valor do estado é cancelada mas o workflow continua em execução, todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Definir o valor de estado
    • SDKBPM.SetStatus("Em Aprovação")

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código ao finalizar

    Abrir/Fechar
    É o último código a correr no elemento, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Qualquer retorno de mensagens ou erro de execução é ignorado pois não é possivel cancelar o fim da execução de um ponto de decisão, no entanto todas as mensagens retornadas são registradas no log do workflow.

    Payload

    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String



    Elemento Tarefa de Utilizador



    O cabeçalho deste elemento é constituído pelos seguintes campos:

  • Tipo de elemento - Campo indicativo do tipo de elemento. Este campo é preenchido automaticamente pela aplicação.

  • Tipo de ação - Campo que serve para indicar o tipo de ação associado ao elemento. Este campo é preenchido pela aplicação.

  • Código da ação - Código que identifica ação associada ao elemento. Este campo deve ser preenchido pelo utilizador.

    Detalhes

    Abrir/Fechar
    A secção dos detalhes é composta pelos seguintes campos:

    • Descrição: Descrição do elemento.
    • Numero mínimo de anexos: Se obriga a um numero mínimo de anexos no arranque do workflow.
    • Numero mínimo de ligações a registos: Se obriga a um numero mínimo de ligações a registos no arranque do workflow.

    Código ao iniciar

    Abrir/Fechar
    É o primeiro código a correr no elemento, é a altura ideal para definir valores para as variáveis, ou alterar outras configurações do workflow ou da atividade que está a ser processada, a sequencia de execução do código dos diversos eventos que o elemento suporta é a seguinte ´Inicialização - Atribuição - Data de início - Prazo de conclusão - Tarefa - Estado - Fecho/Execução/Workflow - Fim´, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Atenção, se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, o workflow é cancelado, no entanto todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()
    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()
    Definir valores de variáveis
      SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Atribuição

    Abrir/Fechar
    Nesta secção são exibidos 5 campos:

    • Tipo de atribuição: Campo onde definimos se a atribuição é apenas a um utilizador, é a um perfil ou sem controlo de acesso.
    • Atribuição ao utilizador: Campo onde definimos o utilizador para atribuição.
    • Perfil de atribuição: Este campo só está disponível caso se tenha escolhido um tipo de atribuição de Acesso por perfil. É o campo onde definimos o perfil para atribuição.

    • Código de atribuição:

    Este código serve para definir qual o utilizador responsável pela tarefa que será criada correspondente a esta ação, deve-se colocar na parâmetro ´usstamp´ o valor do stamp que corresponde ao utilizador desejado.

    Retorno
    Atenção, se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, ou se nenhum utilizador for definido, o workflow é cancelado, no entanto todas as mensagens retornadas são registradas no log do workflow.

    Parametros
    usstamp = Identificador único do utilizador, é igual ao campo ´usstamp´ da tabela de utilizadores.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()


    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()


    Definir o utilizador responsável
    • usstamp = SDK.Query.GetOneValue(Of String)(´User´, ´usstamp´, New FilterItem(user.usercode, Comparison.Equal, ´myLoginCode´))


    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)


    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    • Espera todos os utilizadores: Quando ativo indica que a ação só é fechada quando todos os utilizadores responderem. Se ficar inativa, a ação é fechada assim que um utilizador responder.

    Prazos

    Abrir/Fechar
    Nesta secção são exibidos 6 campos:

    • Número de dias para inicio: Número de dias a contar da data em que esta ação é iniciada, para calcular a data de inicio da tarefa. Se for igual a zero, a tarefa aparecerá no monitor de trabalho assim que esta ação for iniciada.
    • Dias de inicio úteis:O número de dias de inicio são apenas dias uteis.
    • Número de dias para prazo final: Número de dias a contar da data em que esta ação é iniciada, para calcular a data de fim da tarefa. Se for igual a zero, a tarefa fica com a data fim igual á data de inicio.
    • Dias para prazo final úteis: O número de dias uteis para prazo final são dias úteis.
    • Código da função OnStartDate:

      Este código serve para definir a partir de que data a tarefa passa a aparecer no monitor de trabalho, deve-se optar por definir um valor para o parâmetro ´dateValue´ ou em alternativa para o parâmetro ´days´.

      Retorno
      Se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, ou não for definido nenhuma data ou dias, a tarefa aparecerá no monitor de trabalho de imediato, todas as mensagens retornadas são registradas no log do workflow.

      Parametros
      dateValue = Data de início em que a tarefa aparece no monitor de trabalho. days = Número de dias a contar da data em que esta ação é iniciada pelo motor do BPM.

      Payload
      Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
      • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()


      Contexto
      • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
      • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
      • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
      • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
      • SDKBPM.GetElement(Of BPMEventVO)()
      • SDKBPM.GetElement(Of BPMFlowVO)()
      • SDKBPM.GetElement(Of BPMGatewayVO)()
      • SDKBPM.GetElement(Of BPMActionVO)()


      Definir valores de variáveis
      • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)


      Obter valores de variáveis
      • SDKBPM.GetVar(´Cod02´), retorna Object
      • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    • Código da função OnDeadLine:

      Código para definir a data de fim da tarefa, deve-se optar por definir um valor para o parâmetro ´dateValue´ ou em alternativa para o parâmetro ´days´, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

      Retorno
      Se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, ou não for definido nenhuma data ou dias, o prazo de conclusão não é ativado e a data de fim da tarefa fica igual á data de início, no entanto todas as mensagens retornadas são registradas no log do workflow.

      Parametros
      dateValue = Data de prazo de conclusão da tarefa. days = Número de dias a contar da data em que esta ação é iniciada pelo motor do BPM.

      Payload
      Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
      • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()


      Contexto
      • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
      • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
      • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
      • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
      • SDKBPM.GetElement(Of BPMEventVO)()
      • SDKBPM.GetElement(Of BPMFlowVO)()
      • SDKBPM.GetElement(Of BPMGatewayVO)()
      • SDKBPM.GetElement(Of BPMActionVO)()


      Definir valores de variáveis
      • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)


      Obter valores de variáveis
      • SDKBPM.GetVar(´Cod02´), retorna Object
      • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Tarefa

    Abrir/Fechar
    Nesta secção são exibidos 4 campos:

    • Importância: Selecione a prioridade para a execução da tarefa. Tem disponíveis os itens: Reduzida, Normal ou Elevada.
    • Resumo: Resumo da tarefa.
    • Descrição: Descrição da tarefa.
    • Código da função OnTask:
      Este código corre quando o motor do workflow acaba de criar a tarefa associada á ação, serve para preencher dados da tarefa com valores personalizados, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

      Retorno
      Qualquer tipo de retorno de mensagens ou erro de execução é ignorado, no entanto todas as mensagens retornadas são registradas no log do workflow.

      Parametros
      taskItem = É a tarefa TasksVO que acabou de ser criada.

      Payload
      Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
      • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

      Contexto
      • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
      • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
      • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
      • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
      • SDKBPM.GetElement(Of BPMEventVO)()
      • SDKBPM.GetElement(Of BPMFlowVO)()
      • SDKBPM.GetElement(Of BPMGatewayVO)()
      • SDKBPM.GetElement(Of BPMActionVO)()

      Definir valores de variáveis
      • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)


      Obter valores de variáveis
      • SDKBPM.GetVar(´Cod02´), retorna Object
      • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Estado

    Abrir/Fechar
    Nesta secção são exibidos 3 campos:

    • Estado de inicio: Campo dinâmico preenchido pelo utilizador para identificar o estado de inicio.
    • Estado de fim:Campo dinâmico preenchido pelo utilizador para identificar o estado de fim.
    • Código da função OnStatus:
      Código para definir o valor do estado a ser aplicado ao workflow e á atividade que está a ser processada, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

      Retorno
      Se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, a alteração do valor do estado é cancelada mas o workflow continua em execução, todas as mensagens retornadas são registradas no log do workflow.

      Parametros
      fromStart = Indica execução depois do código de inicialização. fromClose = Indica execução depois do utilizador ter fechado a tarefa.

      Payload
      Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
      • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

      Contexto
      • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
      • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
      • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
      • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
      • SDKBPM.GetElement(Of BPMEventVO)()
      • SDKBPM.GetElement(Of BPMFlowVO)()
      • SDKBPM.GetElement(Of BPMGatewayVO)()
      • SDKBPM.GetElement(Of BPMActionVO)()

      Definir o valor de estado
      • SDKBPM.SetStatus("Em Aprovação")


      Definir valores de variáveis
      • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)


      Obter valores de variáveis
      • SDKBPM.GetVar(´Cod02´), retorna Object
      • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código de fecho

    Abrir/Fechar
    Este código corre quando o utilizador fecha a tarefa, serve para escrever regras de negócio para validar esse fecho, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, o workflow continua em funcionamento e a tarefa continua aberta, qualquer tipo de mensagem retornada é mostrada ao utilizador e também registrada no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem à atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Definir o valor de estado
    • SDKBPM.SetStatus("Em Aprovação")


    Exemplo de regra de fecho
    If SDKBPM.GetVar(Of String)(´Cod02´).IsVoid() listMsg.Add(New MsgError($´Deve preencher o valor da variável {SDKBPM.GetVarTitle(´Cod02´)}´)) Return listMsg End If

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)


    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código ao finalizar

    Abrir/Fechar
    É o último código a correr no elemento, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Qualquer retorno de mensagens ou erro de execução é ignorado pois não é possivel cancelar o fim da execução de uma ação, no entanto todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem à atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Variáveis

    Abrir/Fechar
    Esta secção permite inserir variáveis do workflow através do botão "+", quer pela pesquisa de variáveis quer por introdução direta no elemento.


    Elemento Script



    O cabeçalho deste elemento é constituído pelos seguintes campos:

  • Tipo de elemento - Campo indicativo do tipo de elemento. Este campo é preenchido automaticamente pela aplicação.

  • Tipo de ação - Campo que serve para indicar o tipo de ação associado ao elemento. Este campo é preenchido pela aplicação.

  • Código da ação - Código que identifica ação associada ao elemento. Este campo deve ser preenchido pelo utilizador.

    Detalhes

    Abrir/Fechar
    Esta secção apenas é composta pelo campo Descrição que permite introduzir uma descrição do elemento fim.

    Código ao iniciar

    Abrir/Fechar
    É o primeiro código a correr no elemento, é a altura ideal para definir valores para as variáveis, ou alterar outras configurações do workflow ou da atividade que está a ser processada, a sequencia de execução do código dos diversos eventos que o elemento suporta é a seguinte ´Inicialização - Atribuição - Data de início - Prazo de conclusão - Tarefa - Estado - Fecho/Execução/Workflow - Fim´, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Atenção, se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, o workflow é cancelado, todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()
    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()
    Definir valores de variáveis
      SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Estado

    Abrir/Fechar
    Código para definir o valor do estado a ser aplicado ao workflow e á atividade que está a ser processada, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, a alteração do valor do estado é cancelada mas o workflow continua em execução, todas as mensagens retornadas são registradas no log do workflow.

    Parametros
    fromStart = Indica execução depois do código de inicialização. fromClose = Indica execução depois do utilizador ter fechado a tarefa.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Definir o valor de estado
    • SDKBPM.SetStatus("Em Aprovação")

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código de execução

    Abrir/Fechar
    Código para definir o comportamento deste elemento, este código é executado após o código de inicialização e a atribuição de estado ao workflow definido neste elemento, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Atenção, se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, o workflow é cancelado, todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código ao finalizar

    Abrir/Fechar
    É o último código a correr no elemento, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Qualquer retorno de mensagens ou erro de execução é ignorado pois não é possivel cancelar o fim da execução de um ponto de decisão, no entanto todas as mensagens retornadas são registradas no log do workflow.

    Payload

    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String



    Elemento Chamar outro Workflow



    O cabeçalho deste elemento é constituído pelos seguintes campos:

  • Tipo de elemento - Campo indicativo do tipo de elemento. Este campo é preenchido automaticamente pela aplicação.

  • Tipo de ação - Campo que serve para indicar o tipo de ação associado ao elemento. Este campo é preenchido pela aplicação.

  • Código da ação - Código que identifica ação associada ao elemento. Este campo deve ser preenchido pelo utilizador.

    Detalhes

    Abrir/Fechar
    Esta secção apenas é composta pelo campo Descrição que permite introduzir uma descrição do elemento fim.

    Código ao iniciar

    Abrir/Fechar
    É o primeiro código a correr no elemento, é a altura ideal para definir valores para as variáveis, ou alterar outras configurações do workflow ou da atividade que está a ser processada, a sequencia de execução do código dos diversos eventos que o elemento suporta é a seguinte ´Inicialização - Atribuição - Data de início - Prazo de conclusão - Tarefa - Estado - Fecho/Execução/Workflow - Fim´, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Atenção, se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, o workflow é cancelado, todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()
    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()
    Definir valores de variáveis
      SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Estado

    Abrir/Fechar
    Código para definir o valor do estado a ser aplicado ao workflow e á atividade que está a ser processada, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, a alteração do valor do estado é cancelada mas o workflow continua em execução, todas as mensagens retornadas são registradas no log do workflow.

    Parametros
    fromStart = Indica execução depois do código de inicialização. fromClose = Indica execução depois do utilizador ter fechado a tarefa.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Definir o valor de estado
    • SDKBPM.SetStatus("Em Aprovação")

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código de workflow

    Abrir/Fechar
    Código para definir qual workflow que vai ser colocado em funcionamento e como é feito esse arranque, por exemplo que tipo de payload será usado, este código é executado após o código de inicialização e a atribuição de estado ao workflow definido neste elemento, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Atenção, se for retornada alguma mensagem de erro ´MsgError´ ou ocorrer erro na execução do código, o workflow é cancelado, todas as mensagens retornadas são registradas no log do workflow.

    Payload
    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Exemplo de chamar outro workflow
    • SDK.BPM.StartOnDemand(bpmprocessstamp As String, demandCode As String, Optional payload As GenericVO = Nothing)

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    Código ao finalizar

    Abrir/Fechar
    É o último código a correr no elemento, pode usar ´SDKBPM´ para facilmente aceder ao SDK do BPM e assim efetuar as operações desejadas.

    Retorno
    Qualquer retorno de mensagens ou erro de execução é ignorado pois não é possivel cancelar o fim da execução de um ponto de decisão, no entanto todas as mensagens retornadas são registradas no log do workflow.

    Payload

    Se o workflow foi iniciado a partir do ecrã de clientes quando se consultava o cliente João, esses dados estão dentro do workflow através de uma variável especial e em qualquer altura da execução do workflow pode-se obter esses dados da seguinte maneira:
    • Dim cliente as ClVO = SDKBPM.GetPayload(Of ClVO)()

    Contexto
    • SDKBPM.GetProcess() = Tipo de workflow iniciado BPMProcessVO
    • SDKBPM.GetWorkflow() = Workflow iniciado BPMInstanceVO
    • SDKBPM.GetActivity() = Atividade que está a ser processada BPMActivityVO
    • SDKBPM.GetElement() = Elemento que deu origem á atividade BPMElement
    • SDKBPM.GetElement(Of BPMEventVO)()
    • SDKBPM.GetElement(Of BPMFlowVO)()
    • SDKBPM.GetElement(Of BPMGatewayVO)()
    • SDKBPM.GetElement(Of BPMActionVO)()

    Definir valores de variáveis
    • SDKBPM.SetVar(´Cod02´, ´Meu resumo inicial´)

    Obter valores de variáveis
    • SDKBPM.GetVar(´Cod02´), retorna Object
    • SDKBPM.GetVar(Of String)(´Cod02´), retorna String

    • PHC GO