Sistema de

Gestión de

Procesos

Manual de Alambrado de

Web Services con AZ Digital

Modele, gestione y optimice los procesos

de la organización, y genere

automáticamente el código de sus

aplicativos

2

1. Tabla de contenido

1. Tabla de contenido .................................................................................................... 2

2. Introducción .............................................................................................................. 3

3. Aplicación de Web Services de AZ Digital ................................................................. 4

3.1. Introducción ....................................................................................................... 4

3.2. Web Service ....................................................................................................... 4

3.2..1.1. Crear un directorio ..................................................................................... 5

3.2..1.2. Crear una colección .................................................................................... 7

3.2..1.3. Mover un directorio ................................................................................... 8

3.2..1.4. Renombrar un directorio ............................................................................ 9

3.2..1.5. Convertir un directorio en colección ........................................................ 10

3.2..1.6. Informar .................................................................................................... 11

3.2..1.7. Compartir un archivo ................................................................................ 12

3.2..1.8. Radicar ...................................................................................................... 14

4. Glosario. .................................................................................................................. 18

3

2. Introducción

Este manual brinda información para alambrar procesos que se integran con el

gestor documental AZ Digital, vía Web Services. El contenido está desarrollado

para usuarios con conocimientos básicos de Extensible Markup Language (XML).

El manual consta de los siguientes capítulos:

- Definición, descripción y aplicación del comando ‘invocar’ Web Services. En

este apartado se describen las funcionalidades del comando. Adicionalmente,

se presentan ejemplos prácticos para cada Web Services del Gestor

Documental.

- Glosario. Define los conceptos más importantes que aparecen en este manual.

4

3. Aplicación de Web Services de AZ Digital

3.1. Introducción

En este capítulo se explica la integración del Sistema de Gestión de Procesos SGP con

el Gestor Documental AZ Digital a través de Web Services. En color azul se presenta la

información que debe ajustarse en cada comando.

3.2. Web Service

La comunicación entre SGP y AZ Digital se realiza por medio de Web Services. En este

proceso el Web Services es un contenedor que encapsula funciones específicas,

y permite que estas funciones puedan ser utilizadas en otros servidores. Los Web

Services permiten la comunicación entre aplicaciones o componentes de aplicaciones

de forma estándar, a través de protocolos comunes (como http). Este proceso de

realiza de forma independiente a factores como el lenguaje de programación,

plataforma de implantación, formato de presentación y sistema operativo.

Veamos el esquema de este comando:

5

A continuación se presentan las invocaciones que se pueden realizar desde SGP a AZ

Digital:

3.2..1. Crear un directorio

Permite crear carpetas desde el SGP cuando se está ejecutando un proceso. En el

mensaje del XSGP se especifica la ubicación donde se creará el directorio (D) y el

nombre.

6

<InvocarWS UrlWS="http://localhost/AZDigitalV1.4/WebServices/CrearDirectorio/CrearDirectorio.php?Accion=RespuestaWS"> <Declaraciones> <Variable Nombre="Nombreempleado" Valor="Nombreempleado"/> <Variable Nombre="NumeroIdentificacion" Valor="NumeroIdentificacion"/> <Variable Nombre="NombreCarpeta" Valor="concat($Nombreempleado, ' ', $NumeroIdentificacion)"/> </Declaraciones> <Mensaje> <CrearDirectorio Tipo="D" Nombre="$NombreCarpeta" IdPadre="64"/> </Mensaje> <ActualizarMetadata> <Agregar XPath="."> <CrearDirectorioEmpleado>$__RespuestaWS</CrearDirectorioEmpleado> </Agregar> </ActualizarMetadata> </InvocarWS>

La ubicación IdPadre puede ser declarada directamente con un número, o bien,

puede ser declarada mediante una variable global:

$ColeccionClientesPotenciales = "64";

7

En este caso, el llamado se hace directamente sin necesidad de declarar la variable.

3.2..2. Crear una colección

Las colecciones se utilizan para crear restricciones de acceso a la información. Por

ejemplo, contratos con clientes a los cuales sólo debe acceder el área administrativa

y comercial de una organización.

Cabe resaltar que se puede crear colección con o sin administrador.

El comando XSGP que se debe utilizar es:

<InvocarWS UrlWS="http://localhost/AZDigitalV1.4/WebServices/CrearDirectorio/CrearDirectorio.php?Accion=RespuestaWS"> <Declaraciones> <Variable Nombre="Nombreempleado" Valor="Nombreempleado"/> <Variable Nombre="NumeroIdentificacion" Valor="NumeroIdentificacion"/> <Variable Nombre="NombreColeccion" Valor="concat($Nombreempleado, ' ', $NumeroIdentificacion)"/> <Variable Nombre="IdUsuarioAuxiliarCorrespondencia" Valor=" IdUsuarioAuxiliarCorrespondencia/Tabla/fil[1]/AlUsuario"/> </Declaraciones> <Mensaje> <CrearDirectorio Tipo="C" Nombre="$NombreColeccion" IdPadre="$ColeccionClientesPotenciales" IdUsuario="$IdUsuarioAuxiliarCorrespondencia"/> </Mensaje> <ActualizarMetadata> <Agregar XPath="."> <CrearColeccion>$__RespuestaWS</CrearColeccion> </Agregar> </ActualizarMetadata> </InvocarWS>

8

3.2..3. Mover un directorio

Permite cambiar la ubicación de un directorio en el gestor documental. Por

ejemplo, cuando una factura sea causada y paga se deberá mover a la colección o

carpeta de las cuentas pagadas.

Las llaves para ejecutar este comando son el id de la carpeta a mover y de la carpeta

destino.

<InvocarWS

UrlWS="http://localhost/AZDigitalV1.4/WebServices/Mover/Mover.php?Accion=RespuestaWS">

<Declaraciones> <Variable Nombre="CarpetaClientePotencial" Valor="Escaneo/Expediente/@DirectorioId"/>

</Declaraciones> <Mensaje> <Mover TipoElemento="Directorio" IdElemento="$CarpetaClientePotencial" IdDirectorioDestino="$ColeccionAdmin"/> </Mensaje> <ActualizarMetadata> <Agregar XPath="."> <MoverDirectorio>$__RespuestaWS</MoverDirectorio> </Agregar> </ActualizarMetadata> </InvocarWS>

9

3.2..4. Renombrar un directorio

Permite cambiar el nombre de un directorio con el fin de facilitar la categorización

de los directorios en AZ Digital. La información con la cual se va renombrar debe

estar previamente capturada en Metadata, e igualmente se debe conocer el Id de la

carpeta.

<InvocarWS UrlWS="http://localhost/AZDigitalV1.4/WebServices/Renombrar/Renombrar.php?Accion=RespuestaWS"> <Declaraciones> <Variable Nombre="Nombreempleado" Valor="Nombreempleado"/> <Variable Nombre="NumeroIdentificacion" Valor="NumeroIdentificacion"/> <Variable Nombre="NombreCarpeta" Valor="concat($Nombreempleado, ' ', $NumeroIdentificacion)"/>

<Variable Nombre="CarpetaClientePotencial" Valor="Escaneo/Expediente/@DirectorioId"/> </Declaraciones> <Mensaje> <Renombrar TipoElemento="Directorio" IdElemento="$CarpetaClientePotencial" NuevoNombre="Cliente Potencial Productos de Inversión"/> </Mensaje> <ActualizarMetadata>

10

<Agregar XPath="."> <RenombrarDirectorio>$__RespuestaWS</RenombrarDirectorio> </Agregar> </ActualizarMetadata> </InvocarWS>

3.2..5. Convertir un directorio en colección

Con esta invocación se restringe el acceso a los documentos que están inmersos en

el directorio. Por ejemplo, cuando se finaliza un proceso de vinculación de un

cliente, cierto número de usuarios deben acceder a dichos documentos -como es el

caso de los comerciales-, entonces se convierte la carpeta en colección al final de la

ejecución, y se define el usuario administrador.

Nota. En caso que se requiera asociar un administrador a la colección, se debe

capturar el Id del usuario previamente en la Metadata.

<InvocarWS UrlWS="http://localhost/AZDigitalV1.4/WebServices/ConvertirAColeccion/ConvertirAColeccion.php?Accion=RespuestaWS"> <Declaraciones>

11

<Variable Nombre="IdUsuarioComercial" Valor=" IdUsuarioComercial/Tabla/fil[1]/AlUsuario"/>

<Variable Nombre="CarpetaClientePotencial" Valor="Escaneo/Expediente/@DirectorioId"/> </Declaraciones> <Mensaje> <ConvertirAColeccion IdDirectorio="$ CarpetaClientePotencial" IdUsuario="$ IdUsuarioComercial "/> </Mensaje> <ActualizarMetadata> <Agregar XPath="."> <ConvertirCarpetaColeccion>$__RespuestaWS</ConvertirCarpetaColeccion> </Agregar> </ActualizarMetadata> </InvocarWS>

3.2..6. Informar

Permite capturar el detalle de la información que contiene un expediente o

documento en la Metadata del proceso. La información capturada corresponde al

tipo de elemento, el id, el nombre del elemento y la categoría.

<InvocarWS UrlWS="http://localhost/AZDigitalV1.4/WebServices/Informar/Informar.php?Accion=RespuestaWS"> <Declaraciones> <Variable Nombre="IdDirectorio" Valor="DatosBasicosNegocio/@Directorio"/>

12

</Declaraciones> <Mensaje> <Informar TipoElemento="Directorio" IdElemento="$IdDirectorio "/> </Mensaje> <ActualizarMetadata> <Agregar XPath="."> <InformarDirectorio>$__RespuestaWS</InformarDirectorio> </Agregar> </ActualizarMetadata> </InvocarWS> La respuesta de este WS es así: <InformarDirectorio> <Informacion> <Directorio Id="9" Nombre="Nelson Bendeck_CC_80416722" Categoria="Certificación de la Cancillería"> <Directorio Id="10" Nombre="Test1" Categoria=""/> <Directorio Id="11" Nombre="Test2" Categoria=""/> <Archivo Id="2" Nombre="ActasPosesion_Nelson Bendeck_CC_80416722" TipoMIME="application/pdf" Categoria="ActosConstitucion"/> <Archivo Id="3" Nombre="fb0001.pdf" TipoMIME="application/pdf" Categoria=""/> </Directorio> </Informacion> </InformarDirectorio>

3.2..7. Compartir un archivo

Compartir brinda la posibilidad de que otros usuarios puedan tener acceso a

documentos o elementos de información. Esta función se realiza a través del envío

de correos electrónicos a usuarios que requieran acceso a dicha información, y

tengan permisos sobre la colección contenedora. Una característica importante de

compartir es que no genera “copias” del documento, sino que permite que los otros

usuarios lo puedan ver simplemente usando el hipervínculo que se comunica vía

email.

13

<InvocarWS UrlWS="$URL_AZDigital/WebServices/Compartir/Compartir.php?Accion=RespuestaWS"> <Declaraciones> <Variable Nombre="CarpetaTramite" Valor="CrearDirectorio/RespuestaOperacion/@NuevoDiId"/> <Variable Nombre="ListaUsuariosCompartir" Valor="ListaUsuariosCompartir/*" Tipo="XML"/> </Declaraciones> <Mensaje> <Compartir> <Directorios> <Directorio Id="$CarpetaTramite"/> </Directorios> <Archivos/> <Usuarios> $ListaUsuariosCompartir </Usuarios> <Grupos/> <Emails/> <Mensaje>'Hola....'</Mensaje> </Compartir> </Mensaje> <ActualizarMetadata> <Agregar XPath="."> <Compartir>$__RespuestaWS</Compartir> </Agregar> </ActualizarMetadata> </InvocarWS>

14

3.2..8. Radicar

Por medio de este proceso se asigna un identificador unívoco a un documento o

expediente, y se le asocia cierta información considerada relevante a la hora de

ingresar o salir de la organización, tal como la fecha y hora de recepción o

despacho.

Este es el esquema para la radicación, destinatarios y remitentes de la información:

15

16

17

<InvocarWS UrlWS="$URL_AZDigital/WebServices/Radicar/Radicar.php?Accion=RespuestaWS"> <Declaraciones> <Variable Nombre="SrId" Valor="SitioRadicacionUsuario[1]/Tabla/fil/SrId"/> <Variable Nombre="IdComuniacionInterna" Valor="TipoTramite[1]/@Tramite"/> <Variable Nombre="UsId" Valor="IdUsuarioFuncionarioDependencia[1]/Tabla/fil/AlUsuario"/> <Variable Nombre="NombreTramite" Valor="NombreTramite[1]/Tabla/fil/TtDescripcion"/> <Variable Nombre="Asunto" Valor="Asunto/@Asunto"/> </Declaraciones> <Mensaje> <Radicar Estado="Cr" Tramite="$IdComuniacionInterna" Tipo="I" Modalidad="E" ImagenAsociada="0" Sitio="$SrId" Dependencia="'1'" UsuarioRadica="$UsId"> <Asunto>$Asunto</Asunto> <Observaciones>Radicación vía WS comunicación interna $NombreTramite, usuario asociado $UsId</Observaciones> <Remitentes> <Remitente> <Persona Nombre="INGRID MAYE CARDENAS LANCHsEROS" TipoIdentificacion="CC" Identificacion="1073998279" Telefono1="" Telefono2="" Fax="" Email="" Organizacion="" IdentificacionOrganizacion="" Dependencia=""> <Direccion Pais="169" Estado="11" Ciudad="001" CodigoPostal="">110010</Direccion> </Persona> </Remitente> </Remitentes> </Radicar> </Mensaje> <ActualizarMetadata> <Agregar XPath="."> <RadicarDocumento>$__RespuestaWS</RadicarDocumento> </Agregar> </ActualizarMetadata> </InvocarWS>

18

4. Glosario

HTTP, HTML. HTTP (Hypertext Transfer

Protocol). HTML (Hypertext Markup

Language). Son elementos sobre los

que está construida la World Wide

Web. Un navegador de internet –como

MS Explorer o Firefox– interpreta y

muestra un documento al usuario

gracias a estos dos elementos. Utiliza

HTTP para solicitar y transportar el

documento basado en HTML, que es el

lenguaje de descripción de página

web.

PHP. Su nombre es acrónimo de

“Hypertext Preprocessor”. Es un

lenguaje de alto nivel, de “código

abierto”, interpretado, que se ejecuta

en el servidor. Permite generar HTML

de forma dinámica. El componente

lógico de las aplicaciones que dinámi-

camente genera el SGP está escrito en

este lenguaje

WEB SERVICES. Es un componente de

software que se comunica con otras

aplicaciones codificando los mensaje

en XML, y enviando estos mensaje a

través de protocolos estándares de

Internet tales como Hypertext Transfer

Protocol (HTTP). Un Web Service

recibe solicitudes a través de un

mensaje formateado en XML desde

una aplicación, realiza una tarea y

devuelve un mensaje de respuesta

formateado también en XML.

La transferencia de mensajes se basa

en el estándar SOAP, donde un

mensaje SOAP es similar a una carta;

se compone de un sobre que contiene

una cabecera con la dirección del

receptor del mensaje, un conjunto de

opciones de entrega (tal como la

información de encriptación), y un

cuerpo o body con la información o

data del mensaje.

XML (Extensible Markup Language). Es

un metalenguaje extensible de

etiquetas, desarrollado por el World

Wide Web Consortium (W3C). Permite

definir la gramática de lenguajes

específicos para diferentes necesidades.

El SGP utiliza este lenguaje para definir

elementos como el conjunto de datos

que serán procesados por las interfaces,

o su descripción dentro del archivo de

diccionario.

XPATH. XML Path Language es un

lenguaje usado para construir expre-

siones que recorren y procesan un

documento XML. Permite buscar y

seleccionar teniendo en cuenta la

estructura jerárquica del XML. XPath se

creó para ser usado en el estándar XSLT,

con el fin de seleccionar y examinar la

estructura del documento de entrada de

la transformación.

XSLT (XSL Transformations). Es un

estándar de la organización W3C que

19

permite transformar documentos XML

en otros, e incluso en formatos dife-

rentes a XML. Las aplicaciones genera-

das por el SGP utilizan una serie de

hojas de estilo, como componente de

presentación, basadas en esta

tecnología. En particular, todas las hojas

de HTML del aplicativo se generan

dinámicamente como una transfor-

mación XSLT sobre un conjunto de datos

XML. Estas transformaciones pueden

ocurrir tanto en el aplicativo del cliente

como en el servidor.