Configuración de servicios web salientes

Este artículo contiene los siguientes temas:

El servicio web saliente permite a ServiceAide Cloud Service Management interactuar con sistemas externos utilizando llamadas de servicios web SOAP o RESTful. La operación del servicio web saliente está vinculada a una acción del workflow. Cuando un analista ejecuta la acción del workflow en un ticket, se inicia la operación del servicio web saliente. Si la aplicación externa devuelve una respuesta a la llamada del servicio web, el producto acepta la respuesta y actualiza el ticket correspondiente.

El administrador puede configurar los adaptadores del servicio web y definir la asignación de campos para activar el intercambio de datos con aplicaciones externas.

Cuando se configuran los servicios web salientes, las aplicaciones externas pueden intercambiar datos con el producto sin necesidad de crear un mecanismo de sondeo. Se puede configurar el intercambio de datos para que se actualicen los campos tanto de la aplicación externa y como de la aplicación. El intercambio de datos se produce como respuesta a una llamada iniciada por el producto.

Lleve a cabo las siguientes tareas para configurar los servicios web salientes.

Recopilación de información sobre los requisitos previos

Para configurar los servicios web salientes para una aplicación externa, se deben adquirir conocimientos básicos sobre los servicios web compatibles. También se deben identificar los campos de la aplicación externa y los campos correspondientes al producto.

Se deben recopilar las credenciales necesarias para configurar las llamadas de servicios web salientes. Estas pueden variar dependiendo de si la aplicación externa utiliza servicios web SOAP o RESTful.

Llamadas de servicios web basados en SOAP

ServiceAide Cloud Service Management utiliza el lenguaje de descripción de servicios web (WSDL) para comunicarse con las aplicaciones basadas en SOAP. El archivo WSDL de la aplicación externa contiene la información requerida para la configuración de las operaciones del servicio web. El documento WSDL contiene información como, por ejemplo, los métodos, la asignación de campos y mucho más.

Para acceder a un servicio web, se debe localizar su entrada WSDL. La entrada WSDL generalmente es una dirección URL de la Web. Las empresas controlan el acceso a sus archivos WSDL en diferentes grados. Póngase en contacto con el administrador de la aplicación externa para obtener acceso.

Llamadas de servicios web RESTful

Las llamadas del servicio web RESTful no están definidas en un documento formal. Sin embargo, algunas aplicaciones externas definen los servicios web compatibles. Se pueden encontrar las operaciones compatibles en el archivo WADL (Web Application Description Language) de la aplicación.

Por lo general, las llamadas del servicio web RESTful no requieren autenticación. Póngase en contacto con el administrador de la aplicación externa si la aplicación requiere autenticación.

Recopile la siguiente información requerida para planificar los servicios web salientes:

1. Verifique que la aplicación externa ofrece servicios web. De lo contrario, no se puede continuar.
2. Verifique que la aplicación externa es compatible con las llamadas del servicio web RESTful o SOAP.
   • Para una aplicación que es compatible con las llamadas basadas en SOAP, determine la ruta a la entrada WSDL y el nivel de autenticación. Recopile la información que se puede utilizar para configurar las credenciales.
   • Para una aplicación compatible con las llamadas del servicio web RESTful, determine si se han definido los servicios web compatibles. Una vez definidos los servicios web, recopile la información acerca de la ruta a la entrada WADL. Se puede continuar sin especificar la ruta WADL para servicios web sin definir.
3. Verifique que puede conectarse al producto con la aplicación externa. Haga ping en el servidor de aplicaciones externo desde el servidor web de Cloud Service Management. Compruebe el resultado para ver si hay errores. No se puede continuar si el servidor web de Cloud Service Management no puede conectarse a la aplicación externa.
4. Identifique la dirección URL que se invoca para acceder a la entrada WADL/WSDL de la aplicación externa. Cuando se identifica la dirección URL, confirme los siguientes requisitos:
   • El acceso y la autenticación requeridos para invocar el servicio web.
   • Confirme si la aplicación externa requiere una autenticación básica. Obtenga el nombre de usuario y la contraseña de la aplicación externa.
   • Confirme si la aplicación utiliza el control basado en sesiones. Se puede obtener esta información desde el WSDL.
5. Identifique la asignación de campos que se desea configurar. Confirme que los campos que desea asignar están disponibles en el producto. Identifique algunos campos adicionales que necesite para la configuración que se planifica.
6. Identifique el tipo de operaciones que se desea configurar. Se pueden configurar las operaciones de servicios web y las acciones del workflow relacionadas según este plan.

Configuración de atributos y plantillas de campos personalizados para la asignación de campos

Durante el proceso de planificación, se pueden identificar los requisitos de asignación de campos. Cuando los campos de ticket estándar y los campos personalizados existentes no son suficientes, se pueden configurar atributos personalizados. A continuación, se pueden relacionar los atributos a las plantillas de campos personalizados. Se puede identificar el nombre del atributo y el tipo de datos y, a continuación, se pueden configurar los atributos. Cuando se relacionan los campos personalizados a las plantillas de campos personalizados, los atributos estarán disponibles para la asignación de campos.

Nota: No se admite la asignación de campos personalizados para el campo Fecha.

Para obtener más información sobre la creación de atributos, consulte Creación y gestión de atributos.

Para obtener más información sobre la creación de plantillas de campos personalizados, consulte Creación y gestión de las plantillas de campos personalizados.

Activación de la invocación del servicio web

Siga los pasos siguientes:

1. Vaya a ESPACIOS DE TRABAJO, ADMINISTRACIÓN, Herramientas, Parámetros de la configuración.
2. En el campo Buscar, busque el parámetro ACTIVAR_INVOCACIÓN_DE_SERVICIOS_WEB_EXTERNOS.
3. Haga clic en el nombre del parámetro en la lista para ver los detalles del parámetro.
4. Establezca el valor Sí para el parámetro.

El producto ahora es compatible con el intercambio de datos mediante llamadas del servicio web saliente.

Configuración de las credenciales del servicio web

Cloud Service Management utiliza las credenciales de los servicios web para conectarse a la aplicación externa para el intercambio de datos. Se pueden crear y gestionar las credenciales requeridas para invocar a los servicios web externos para el intercambio de datos. Se pueden utilizar las mismas credenciales de un servicio web externo para todos los métodos de autenticación compatibles con la aplicación externa.

Siga los pasos siguientes:

1. Vaya a ESPACIOS DE TRABAJO, ADMINISTRACIÓN, Herramientas y Credenciales de servicios web.
   Se muestra la ficha Credenciales de servicios web. Se puede filtrar la lista para ver las credenciales de activas o inactivas. Se puede modificar una credencial existente o se pueden crear credenciales desde aquí. Aquí se pueden proporcionar las credenciales del servicio web para la aplicación externa.
2. Proporcione la información requerida y haga clic en Guardar.

Al hacer clic en Guardar, se muestran las secciones Resumen y Operaciones relacionadas.

Configuración de las operaciones del servicio web para llamadas basadas en SOAP

Las operaciones del servicio web activan el intercambio de datos entre el producto y la aplicación externa. Una vez configuradas las credenciales del servicio web, se pueden configurar varias operaciones mediante los métodos compatibles con la aplicación externa.

Siga los pasos siguientes:

1. Vaya a ESPACIOS DE TRABAJO, ADMINISTRACIÓN, Herramientas y seleccione Operaciones de servicios web.
2. Proporcione el nombre, la descripción y las credenciales de la aplicación externa.
3. Introduzca los detalles de la asignación de campos para la operación del servicio web. Especifique la siguiente información:
   • Tipo de enlace con el servicio web utilizado para la operación
   • Método utilizado para la operación
   • Duración del tiempo de espera de la operación.
   • Tipo de ticket disponible para esta operación

4. (Opcional) Especifique la asignación de salida. El valor del campo del ticket que se especifica aquí rellena el campo correspondiente en la aplicación externa.
   Se pueden asignar los campos a través del archivo XML o a través de los campos de la lista desplegable.

   1. Para utilizar el archivo XML, seleccione la casilla de verificación Configuración avanzada. Se muestra el contenido del archivo XML. Se puede proporcionar la asignación de campos salientes mediante la especificación de valores en los nodos correspondientes. Mediante la utilización de la configuración avanzada, se puede visualizar el archivo XML completo de la solicitud SOAP y se puede utilizar el mismo en la llamada basada en SOAP. La configuración avanzada incluye un área de texto de aumento automático. Se puede utilizar el icono de búsqueda para abrir la ventana de búsqueda de entidades y seleccionar los tókenes de entidad. Los tókenes de entidad seleccionados se reemplazan como valores de campo externos. En el archivo XML de la solicitud SOAP, se pueden insertar símbolos mediante el cursor o mediante la selección del texto que debe sustituirse por el token. Cuando la solicitud se envía a la aplicación externa, los tókenes de entidad seleccionados se reemplazan como valores de campo externos.

   2. Para especificar la asignación de campos mediante las opciones de la lista desplegable, proporcione la siguiente información y haga clic en el icono + para agregar la asignación:
      Campo externo
      Seleccione un campo externo de la lista desplegable. La lista desplegable se muestra de forma dinámica en función del método seleccionado en el campo Seleccionar método.
      Campo del ticket
      Especifique los tókenes de campo de ticket de Cloud Service Management para asignar el campo del ticket que se actualiza cuando se ejecuta la operación del servicio web en el ticket. Se pueden utilizar campos de ticket estándar, campos personalizados o los tókenes de usuario configurados.
      Ejemplo: Campo de ticket estándar ${description_long}
      Nota: De forma predeterminada, en la lista Campo externo se muestran los campos que aparecen como campos obligatorios en el documento WSDL.

5. (Opcional) Especifique la asignación de entrada. El valor de la aplicación externa se actualiza en el campo de ticket correspondiente en la aplicación. Mencione el campo del ticket y la ruta del campo de la aplicación externa. También se pueden asignar hasta diez campos Entidad para mostrar. Los campos de entidad para mostrar proporcionan información adicional como referencia, pero no se guardan en el ticket. Se pueden visualizar los campos de entidad para mostrar en la página de detalles del ticket, en el tipo de atributo Búsqueda de servicios web.
   
6. Haga clic en Guardar.

La operación del servicio web está configurada.

{
    "employees": {
        "employee": [
            {
                "id": "1",
                "firstName": "Tom",
                "lastName": "Cruise",
                "photo": "http://cdn2.gossipcenter.com/sites/default/files/imagecache/story_header/photos/tom-cruise-020514sp.jpg"
            }
         ]
    }
}

A partir de este momento, ya se puede relacionar la operación del servicio web con una acción del workflow.

Configuración de operaciones del servicio web para llamadas RESTful

Las operaciones del servicio web activan el intercambio de datos entre el producto y la aplicación externa. Una vez configuradas las credenciales del servicio web, se pueden configurar varias operaciones mediante los métodos compatibles con la aplicación externa.

Siga los pasos siguientes:

1. Vaya a ESPACIOS DE TRABAJO, ADMINISTRACIÓN, Herramientas y seleccione Operaciones de servicios web.
2. Proporcione el nombre, la descripción y las credenciales del servicio web para la aplicación externa.
3. Especifique los detalles de la asignación de campos para la operación del servicio web. Especifique la siguiente información:
   • Tipo de entidad de la operación o tipo de ticket correspondiente.
   • Dirección del punto final del servicio web
   • Método que se utiliza para la operación.
   • Duración del tiempo de espera de la operación.
4. (Opcional) Especifique la asignación de salida. El valor del campo del ticket que se especifica aquí rellena el campo correspondiente en la aplicación externa. Cuando se configura WADL para el servicio web, se muestran los valores de la aplicación externa en un menú desplegable. Los valores que se muestran dependen del método seleccionado en el campo Seleccionar método. Se puede seleccionar un valor en el menú desplegable para configurar la asignación de salida. Cuando WADL no está configurado, los campos se muestran como áreas de texto. Se pueden introducir manualmente los valores válidos. Los campos que aparecen como campos obligatorios en el documento WADL se muestran en los campos externos de forma predeterminada.
5. (Opcional) Para utilizar el archivo XML o JSON, seleccione la casilla de verificación Configuración avanzada. Se puede proporcionar la asignación de campos salientes mediante la especificación de valores en los nodos correspondientes. Al utilizar las configuraciones avanzadas, aparecerá un cuadro de texto para introducir el contenido XML o JSON. Se puede utilizar el icono de búsqueda para abrir la ventana de búsqueda de entidades y seleccionar los tókenes de entidad. Los tókenes de entidad seleccionados se reemplazan como valores de campo externos. En el archivo XML o JSON de la solicitud REST, se insertan los tókenes utilizando el cursor o seleccionando el texto que debe sustituirse por el token. Cuando la solicitud se envía a la aplicación externa, los tókenes de entidad seleccionados se reemplazan como valores de campo externos.
6. (Opcional) Especifique la asignación de entrada. El valor de la aplicación externa se actualiza en el campo de ticket correspondiente del producto. Mencione el campo del ticket y la ruta al campo de la aplicación externa.
   Nota:
   • No utilice caracteres comodín u operadores en la ruta de búsqueda XML para asignaciones de entrada.

   • Verifique que solo se haya asignado el nodo necesario del archivo de respuesta para configurar el valor de asignación de entrada. Por ejemplo, en el siguiente fragmento de código, si se desea rellenar el atributo id, introduzca el nodo como employees.employee.id. Al especificar el nodo como employees.employee no se rellenará ningún atributo.

     
7. Haga clic en Guardar.

La operación del servicio web está configurada.

A partir de este momento, ya se puede relacionar la operación del servicio web con una acción del workflow.

Establecimiento de una relación entre las configuraciones del servicio web y las acciones del workflow

Una vez configurada la operación del servicio web, se puede relacionar la operación con una acción del workflow. La aplicación invoca a la operación del servicio web cuando el analista ejecuta la acción del workflow correspondiente en un ticket.

Se puede relacionar una operación del servicio web con una acción del workflow desde la página Acciones del workflow, ubicada en ESPACIOS DE TRABAJO, ADMINISTRACIÓN, Herramientas. Se debe utilizar el campo Operaciones de servicios web de una acción del workflow para relacionar la acción con una configuración del servicio web.

Se pueden configurar acciones de workflow mediante llamadas a servicios web RESTful y SOAP.

Para obtener más información acerca de las acciones del workflow, consulte Creación y gestión de las acciones del workflow.

Verificación de las configuraciones

Para verificar la configuración, se necesita obtener acceso tanto al producto como a la aplicación externa.

Tenga en cuenta el siguiente ejemplo. Un usuario configura el servicio web saliente para comunicarse con SalesForce. El usuario desea que al crear una solicitud de servicio en Cloud Service Management, se cree un incidente en SalesForce. Para activar la comunicación, el usuario configura las credenciales del servicio web de SalesForce. A continuación, configura la operación del servicio web para crear un incidente en SalesForce. A continuación, configura la asignación de salida para que el campo de detalles del ticket actualice el campo de detalles del ticket correspondiente en SalesForce.

Configure la asignación de campos para actualizar los campos personalizados del producto con los detalles del ticket de SalesForce. A continuación, configure una acción del workflow SFDC_Create Ticket y relaciónela con la operación del servicio web. Asigne el permiso de grupo de soporte L1 a la acción del workflow.

Para verificar las configuraciones, envíe un ticket y utilice la acción de trabajo para desplazar el ticket por el workflow. Todas las operaciones del servicio web se registran en el foro del ticket. Se puede visualizar la operación del servicio web, la hora de inicio y de finalización y el estado de la operación. Cuando se produce un fallo durante la ejecución de la operación del servicio web, aparece un mensaje de registro del seguimiento que proporciona más información sobre la causa del fallo.

Siga los pasos siguientes:

1. Inicie sesión en la aplicación como analista.
2. Haga clic en ESPACIOS DE TRABAJO, CENTRO DE SERVICIO AL USUARIO, Centro de tickets.
3. Haga clic en Acciones, Crear solicitud.
4. Proporcione la información básica como, por ejemplo, los detalles y la descripción en la sección Acerca de del ticket.
5. Haga clic en Acciones, SFDC_Create Ticket (esta acción es la acción del workflow que se ha creado).
6. Inicie sesión en Salesforce mediante las credenciales adecuadas.
7. Vaya a la lista de tickets y busque los tickets recién creados.

Si la lista de tickets muestra el ticket de incidente correspondiente, significará que la llamada de los servicios web salientes se ha realizado correctamente. Se puede volver al ticket en el producto para obtener información más detallada en el foro del ticket.