Navigation: »No topics above this level«

API PHP (Workflow)

El objetivo de la API es permitir consultar y editar datos de una instancia del proceso. Los métodos en PHP están disponibles para realizar las operaciones. De esta forma no es necesario conocer la base de datos de SE Workflow y, también, se garantiza que las modificaciones en el sistema sean aplicadas en la API sin necesidad de adecuaciones o ajuste por parte del cliente.

Utilización de la API

La API del Workflow debe ser utilizada en una aplicación externa asociada en una actividad de sistema o en la acción del Workflow. Para crear una aplicación externa se debe acceder al menú de registro PM042.

El primer paso en el archivo de la aplicación externa es hacer el require_once del archivo global.php. La ruta "../../" significa que la aplicación externa está a 2 directorios de la raíz de SE Suite. Ejemplo: workflow/wf_app/my_app.php.

Enseguida se debe realizar el require_once de la API del workflow. Para eso se debe utilizar el archivo: workflow/api/class.WorkflowAPI.inc.

Hecho eso, es solo crear el objeto de la API pasando como parámetro el código de la instancia. De forma predeterminada, todas las aplicaciones externas del sistema ya reciben el parámetro "oid_process". No es necesario pasar parámetros adicionales para ese propósito. El cuadro 01 muestra el ejemplo:

require_once('../../global.php');

require_once('workflow/api/class.WorkflowAPI.inc');

$workflow_api = new WorkflowAPI($_REQUEST["oid_process"]); //WFPROCESS.IDOBJECT

Cuadro 01 – Crear objeto de la API

Métodos

La API admite los métodos para buscar y actualizar campos del formulario o atributos del proceso. Los métodos son:

getAttributeValue	Busca el valor de un atributo del proceso
getEntityAttributeValue	Busca el valor de un campo del formulario
getEntityRelationshipValue	Busca el valor de una lista de valores del formulario
getDateToday	Busca la fecha actual
getTimeNow	Busca la hora actual
setAttributeValue	Edita el valor de un atributo del proceso
setEntityAttributeValue	Edita el valor de un campo del formulario
setEntityRelationshipValue	Edita el valor de un campo lista de valores del formulario
setWorkflowTitle	Modificar el título del workflow
getWorkflowTitle	Buscar el título del workflow

▪Buscar el valor de un atributo del proceso

▪Buscar el valor de un campo del formulario

▪Buscar valor de un campo lista del formulario

▪Buscar la fecha y hora actual

▪Editar el valor de un atributo del proceso

▪Editar el valor de un campo del formulario

▪Editar el valor de un campo lista de valores del formulario

▪Modificar el título del workflow

▪Buscar el título del workflow