APIs de SoftExpert Proceso
Introducción
Vea a continuación las API disponibles en SoftExpert Proceso:
API PHP (Workflow)
El propósito de esta API es permitir la consulta y edición de los datos de una instancia de proceso. Varios métodos en PHP están disponibles para realizar las operaciones.
De este modo, no es necesario conocer la base de datos del workflow y también se garantiza que los cambios en el sistema se apliquen a la API sin necesidad de ajustes por parte del cliente.
Utilización de la API
La API del Workflow debe utilizarse en una aplicación externa asociada en una actividad del sistema o en la acción del workflow.
Para crear una aplicación externa, 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 SoftExpert Suite. Ejemplo: workflow/wf_app/my_app.php.
A continuación, se debe realizar el require_once de la API del workflow. Para ello, debe utilizar el archivo: workflow/api/class.WorkflowAPI.inc.
Una vez realizado, basta con crear el objeto de la API pasando el código de la instancia como parámetro. De forma predeterminada, todas las aplicaciones externas del sistema ya reciben el parámetro “oid_process”.
No es necesario pasar parámetros adicionales para ello, como ejemplifica la tabla 01:
require_once('../../global.php');
require_once('workflow/api/class.WorkflowAPI.inc');
$workflow_api = new WorkflowAPI($_REQUEST["oid_process"]); //WFPROCESS.IDOBJECT
Métodos
La API admite los métodos para obtener y actualizar campos de formulario o atributos del proceso. Los métodos son los siguientes:
| 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 | Cambia el título del workflow. |
| getWorkflowTitle | Busca el título del workflow. |
API de inicialización
Inicia una instancia del proceso modelo, tipo de incidente o tipo de problema pasado por parámetro.
Workflow
https://domain/se/workflow/api/new_workflow.php?processid=PROCESSID&workflowtitle=WORKFLOWTITLE
Parámetros
| PROCESSID | Identificador del proceso. |
| WORKFLOWTITLE | Título del workflow. |
| INCIDENTTYPEID | Identificador del tipo de incidente. |
| INCIDENTTITLE | Título del tipo de incidente. |
| PROBLEMTYPEID | Identificador del tipo de problema. |
| PROBLEMTITLE | Título del tipo de problema. |
API de ejecución
Abre la pantalla de tareas de ejecución (el parámetro activitysequence es requerido cuando hay más de una actividad con el mismo identificador).
Workflow
https://domain/se/workflow/api/execute_activity.php?workflowid=WORKFLOWID&activityid=ACTIVITYID&activitysequence=ACTIVITYSEQ
Parámetros
| WORKFLOWID | Identificador del workflow (instancia). |
| ACTIVITYID | Identificador de la actividad. |
| ACTIVITYNRORDER | Número de la orden (el parámetro activityorder es requerido cuando hay más de una actividad con el mismo identificador). |
| INCIDENTID | Identificador del incidente (instancia). |
| PROBLEMID | Identificador del problema (instancia). |
API de consulta
Abre la pantalla de datos de la instancia.
Workflow
https://domain/se/workflow/api/view_workflow.php?workflowid=WORKFLOWID
Parámetros
| WORKFLOWID | Identificador del workflow (instancia). |
| PROBLEMID | Identificador del problema (instancia). |
| INCIDENTID | Identificador del incidente (instancia). |