API PHP (Workflow)
API PHP (Workflow) |
|
|
O objetivo da API é permitir consultar e editar dados de uma instância do processo. São disponibilizados métodos em PHP para realizar as operações. Dessa forma não é necessário conhecer a base de dados do SE Workflow e, também, se garante que as alterações no sistema sejam aplicadas na API sem necessidade de adequações por parte do cliente.
Utilização da API
A API do Workflow deve ser utilizada em uma aplicação externa associada em uma atividade de sistema ou na ação do Workflow. Para criar uma aplicação externa deve-se acessar o menu de cadastro PM042. O primeiro passo no arquivo da aplicação externa é fazer o require_once do arquivo global.php. O caminho "../../" significa que a aplicação externa está 2 diretórios a partir da raiz do SE Suite. Exemplo: workflow/wf_app/my_app.php. Em seguida deve-se realizar o require_once da API do workflow. Para isso deve-se utilizar o arquivo: workflow/api/class.WorkflowAPI.inc. Feito isso, basta criar o objeto da API passando como parâmetro o código da instância. Por padrão, todas as aplicações externas do sistema já recebem o parâmetro "oid_process". Não é necessário passar parâmetros adicionais para esse propósito. O quadro 01 mostra o exemplo:
Quadro 01 – Criar objeto da API
Métodos
A API suporta os métodos para buscar e atualizar campos do formulário ou atributos do processo. Os métodos são:
▪Buscar o valor de um atributo do processo ▪Buscar o valor de um campo do formulário ▪Buscar valor de um campo lista do formulário ▪Editar o valor de um atributo do processo ▪Editar o valor de um campo do formulário ▪Editar o valor de um campo lista de valores do formulário |