SDK PHP: SoftExpert Workflow
O SDK PHP do componente SoftExpert Workflow é uma ferramenta de desenvolvimento que tem como objetivo permitir que desenvolvedores possam facilmente consultar e editar dados de uma instância de workflow. Com esse kit de desenvolvimento, não é necessário ter conhecimento prévio da estrutura interna do SoftExpert Workflow, já que são oferecidos diversos métodos que possibilitam a realização de operações no componente.
Os métodos disponíveis garantem a segurança e a integridade dos dados, pois são realizadas validações para garantir que as operações realizadas estejam de acordo com as regras de negócio e de segurança da plataforma.
É proibido o uso de métodos e funções que não estejam contemplados no escopo deste SDK. A SoftExpert não oferecerá suporte nem se responsabilizará por quaisquer problemas decorrentes da utilização de funções não abrangidas pelo escopo estabelecido.
Utilização do SDK do SoftExpert Workflow
Para utilizar o SDK do componente SoftExpert Workflow, é necessário criar uma
aplicação externa associada a uma atividade de sistema ou à ação do
Workflow, por meio do menu de cadastro PM042.
Passo 1: Acesso ao menu de cadastro PM042
Para criar uma aplicação externa, é necessário acessar o menu de cadastro PM042, localizado no componente SoftExpert Processo. Este menu é responsável pela configuração e registro de aplicações externas. Para obter informações detalhadas sobre como cadastrar uma aplicação externa, consulte o seguinte artigo: "Como cadastrar uma aplicação externa no sistema".
Passo 2: Criação do arquivo de aplicação externa
Neste passo é necessário criar um arquivo PHP e fazer o "require_once" do
arquivo "global.php". É importante notar que o caminho "../../" significa
que a aplicação externa está dois diretórios acima da raiz do SoftExpert Suite,
como no exemplo "workflow/wf_app/my_app.php".
Passo 3: Requerimento do SDK do SoftExpert Workflow
Deve-se realizar o "require_once" do SDK do SoftExpert Workflow, utilizando o
arquivo "workflow/api/class.WorkflowAPI.inc". Com isso, é possível criar o
objeto da API, passando como parâmetro o código da instância de workflow. Todas
as aplicações externas do sistema já recebem, por padrão, o parâmetro
"oid_process", não sendo necessário passar parâmetros adicionais para esse
propósito.
Passo 4: Utilização dos métodos disponibilizados pelo SDK do SoftExpert Workflow
É possível, então, utilizar os métodos disponibilizados pelo SDK para realizar
consultas e edições nos dados da instância do Workflow. Por exemplo, pode-se
utilizar o método getWorkflowTitle() para obter o título de uma instância, e
em seguida realizar as operações desejada com esse dado.
Exemplo do cabeçalho do arquivo PHP:
require_once('../../global.php');
require_once('workflow/api/class.WorkflowAPI.inc');
$workflow_api = new WorkflowAPI($_REQUEST["oid_process"]); //WFPROCESS.IDOBJECT
Métodos disponíveis
O SDK do componente SoftExpert Workflow oferece alguns métodos que permitem buscar e atualizar campos do formulário ou atributos do processo.
| Método | Descrição |
|---|---|
| getAttributeValue | Busca o valor de um atributo do workflow |
| getEntityAttributeValue | Busca o valor de um campo do formulário do workflow |
| getEntityRelationshipValue | Busca o valor de uma lista de valores do formulário do workflow |
| getDateToday | Busca a data atual do servidor WEB |
| getTimeNow | Busca a hora atual do servidor WEB |
| setAttributeValue | Edita o valor de um atributo do workflow |
| setEntityAttributeValue | Edita o valor de um campo do formulário do workflow |
| setEntityRelationshipValue | Edita o valor de um campo lista de valores do formulário do workflow |
| setWorkflowTitle | Alterar o título do workflow |
| getWorkflowTitle | Buscar o título do workflow |