ServiceNow

El conector de ServiceNow te permite realizar operaciones de inserción, eliminación, actualización y lectura en la base de datos de ServiceNow.

Antes de comenzar

Antes de usar el conector de Servicenow, realiza las siguientes tareas:

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • Otorga el rol de IAM roles/connectors.admin al usuario que configura el conector.
    • Otorga los siguientes roles de IAM a la cuenta de servicio que deseas usar para el conector:
      • roles/secretmanager.viewer
      • roles/secretmanager.secretAccessor

      Una cuenta de servicio es un tipo de Cuenta de Google especial que representa a un usuario no humano que debe autenticarse y tener autorización para acceder a los datos de las APIs de Google. Si no tienes una cuenta de servicio, debes crear una. Para obtener más información, consulta Crea una cuenta de servicio.

    • Habilita los siguientes servicios:
      • secretmanager.googleapis.com (API de Secret Manager)
      • connectors.googleapis.com (API de conectores)

      Para comprender cómo habilitar servicios, consulta Habilita servicios.

    Si estos servicios o permisos no se habilitaron antes para tu proyecto, se te solicitará que los habilites cuando configures el conector.

  • Proporciona acceso a las siguientes tablas en tu instancia de ServiceNow:

    • sys_db_object
    • sys_dictionary
    • sys_glide_object

    Este permiso es necesario para que el conector se conecte a tus datos. Para proporcionar el acceso, sigue estos pasos:

    1. En tu aplicación de ServiceNow, ve a Seguridad del sistema > Controles de acceso (LCA).
    2. Selecciona Nuevo para crear un objeto de control de acceso.
    3. En Tipo, selecciona record.
    4. En Operación, selecciona lectura.
    5. En Nombre, selecciona Table [sys_db_object] en el primer menú desplegable y --None-- en el segundo.
    6. En la sección Requiere rol, haz doble clic en el cuadro de texto Insertar una fila nueva... y, luego, busca y selecciona el rol que desees.
    7. Haz clic en Enviar para crear el objeto de LCA.
    8. Asigna la función que tiene la LCA creada al usuario que se está autenticando. Para ello, ve a Administración de usuarios > Usuarios > Seleccionar usuario de autenticación > Roles > Editar... > . y, luego, agrega el rol de tu colección.

Configura el conector

Para configurar el conector, debes crear una conexión a tu fuente de datos (sistema de backend). Una conexión es específica de una fuente de datos. Significa que, si tienes muchas fuentes de datos, debes crear una conexión independiente para cada fuente. Para crear una conexión, sigue estos pasos:

  1. En la consola de Cloud, ve a la página Conectores de Integration > Conexiones y, luego, selecciona o crea un proyecto de Google Cloud.

    Ir a la página Conexiones

  2. Haz clic en + CREAR NUEVO para abrir la página Crear conexión.
  3. En la sección Ubicación, elige la ubicación para la conexión.
    1. Región: selecciona una ubicación de la lista desplegable.

      Para obtener la lista de todas las regiones compatibles, consulta Ubicaciones.

    2. Haga clic en SIGUIENTE.
  4. En la sección Detalles de la conexión, completa lo siguiente:
    1. Conector: Selecciona ServiceNow en la lista desplegable de Conectores disponibles.
    2. Versión del conector: selecciona la versión del conector de la lista desplegable de versiones disponibles.
    3. En el campo Nombre de la conexión, ingresa un nombre para la instancia de conexión.

      Los nombres de las conexiones deben cumplir con los siguientes criterios:

      • Los nombres de las conexiones pueden usar letras, números o guiones.
      • Las letras deben estar en minúsculas.
      • Los nombres de las conexiones deben comenzar con una letra y terminar con una letra o un número.
      • Los nombres de las conexiones no pueden superar los 63 caracteres.
    4. De manera opcional, ingresa una Descripción para la instancia de conexión.
    5. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
    6. Si quieres usar la conexión para suscripciones a eventos, selecciona Habilitar suscripción a eventos. Si seleccionas esta opción, se muestran las siguientes opciones:
      • Habilitar la suscripción a eventos con entidades y acciones: Selecciona esta opción para usar la conexión para las operaciones de suscripción a eventos y de conector (entidades y acciones).
      • Habilitar solo la suscripción a eventos: Selecciona esta opción a fin de usar la conexión solo para suscripción a eventos.

      Para ambas selecciones, se te solicitará que configures los detalles del evento en los pasos posteriores.

    7. De manera opcional, configura los parámetros de nodo de conexión:

      • Cantidad mínima de nodos: Ingresa la cantidad mínima de nodos de conexión.
      • Cantidad máxima de nodos: Ingresa la cantidad máxima de nodos de conexión.

      Un nodo es una unidad (o réplica) de una conexión que procesa transacciones. Se requieren más nodos para procesar más transacciones para una conexión y, del mismo modo, se requieren menos para procesar menos transacciones. Para comprender cómo los nodos afectan el precio del conector, consulta Precios de nodos de conexión. Si no ingresas ningún valor, se establecen de forma predeterminada los nodos mínimos en 2 (para una mejor disponibilidad) y los nodos máximos se establecen en 50.

    8. Usar proxy: selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión y configurar los siguientes valores:
      • Esquema de autenticación del proxy: Selecciona el tipo de autenticación para autenticar con el servidor proxy. Se admiten los siguientes tipos de autenticación:
        • Básico: Autenticación HTTP básica.
        • Resumen: Autenticación de HTTP de resumen.
      • Usuario de proxy: Un nombre de usuario que se usará para autenticarse con el servidor proxy.
      • Contraseña de proxy: el secreto de Secret Manager de la contraseña del usuario.
      • Tipo de SSL del proxy: el tipo de SSL que se usará para conectarse al servidor del proxy. Se admiten los siguientes tipos de autenticación:
        • Automático: Configuración predeterminada. Si la URL es HTTPS, se usa la opción Túnel. Si la URL es una URL HTTP, se usa la opción NUNCA.
        • Siempre: La conexión siempre está habilitada para SSL.
        • Nunca: La conexión no está habilitada para SSL.
        • Túnel: La conexión se realiza a través de un proxy de túnel. El servidor proxy abre una conexión con el host remoto y el tráfico fluye de un lado a otro a través del proxy.
      • En la sección Proxy Server, ingresa los detalles del servidor proxy.
        1. Haz clic en Agregar destino.
        2. Selecciona un Tipo de destino.
          • Dirección del host: Especifica el nombre de host o la dirección IP del destino.

            Si deseas establecer una conexión privada a tu sistema de backend, haz lo siguiente:

    9. De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
    10. Haga clic en SIGUIENTE.
  5. En la sección Destinos, ingresa los detalles del host remoto (sistema de backend) al que deseas conectarte.
    1. Tipo de destino: Selecciona un Tipo de destino.
      1. En el campo Dirección de host, especifica el nombre de host o la dirección IP del destino.
        1. Si deseas establecer una conexión privada a tus sistemas de backend, sigue estos pasos:
          1. Crea un adjunto de servicio de PSC.
          2. Crea un adjunto de extremo y, luego, ingresa los detalles del adjunto del extremo en el campo Dirección del host.
        2. Si deseas establecer una conexión pública a tus sistemas de backend con seguridad adicional, puedes considerar configurar direcciones IP salientes estáticas para tus conexiones y, luego, configurar tus reglas de firewall para incluir solo las direcciones IP estáticas específicas.

      Para ingresar destinos adicionales, haz clic en +AGREGAR DESTINO.

    2. Haga clic en SIGUIENTE.
  6. En la sección Autenticación, ingresa los detalles de autenticación.
    1. Selecciona un Tipo de autenticación y luego, ingresa los detalles relevantes.

      La conexión de Servicenow admite los siguientes tipos de autenticación:

      • Nombre de usuario y contraseña

      2. Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

    2. Haga clic en SIGUIENTE.
  7. Si habilitaste la suscripción a eventos, aparecerá la sección Event Subscription Details en la página de creación de la conexión. Para comprender cómo configurar los detalles de suscripción a eventos, consulta Cómo configurar la suscripción a eventos.
  8. Revisa: Revisa tus detalles de conexión y autenticación.
  9. Haz clic en Crear.

Configura la autenticación

Ingresa los detalles según la autenticación que desees usar.

  • Nombre de usuario y contraseña
    • Nombre de usuario: El nombre de usuario de ServiceNow que se usará para la conexión.
    • Contraseña: Secret Manager que contiene la contraseña asociada con el nombre de usuario de ServiceNow

Configura la suscripción a eventos [Preview]

Si habilitaste la suscripción al evento, ingresa los siguientes valores en la sección Event Subscription Details:

  • Token de autenticación: Selecciona el secreto de Secret Manager de tu token de autenticación y la versión del secreto correspondiente en el menú desplegable Versión del secreto (opcional).
  • Algoritmo HMAC: Selecciona el algoritmo HMAC para encriptar la carga útil de la respuesta (opcional).
  • Clave de secreto HMAC: Si seleccionaste un algoritmo HMAC, selecciona el secreto de Secret Manager de la clave HMAC y la versión del secreto correspondiente en el menú desplegable Versión del secreto.

Pasos posteriores a la creación de la conexión

Para completar la configuración de la suscripción al evento, debes registrar la URL de webhook con tu aplicación de ServiceNow. Por lo tanto, después de crear la conexión de forma correcta, realiza los siguientes pasos adicionales:

  1. Ve a la página de detalles de la conexión recién creada y copia la URL de webhook para la suscripción al evento.
  2. Accede a tu aplicación de ServiceNow y haz lo siguiente:
    1. En la página Todos > Reglas comerciales > Cuándo ejecutarse, selecciona la operación que deseas escuchar.
    2. Haz clic en la pestaña Avanzado. Se abrirá un editor de secuencias de comandos.
    3. Ingresa un código JavaScript que envíe una solicitud a la URL de devolución de llamada. La solicitud contiene la carga útil que se activa cada vez que se produce alguna de las operaciones habilitadas. A continuación, se muestra un ejemplo de JavaScript:

      Plantilla

      (function executeRule(current, previous /*null when async*/ ) {
var request = new sn_ws.RESTMessageV2();
request.setEndpoint('WEBHOOK_URL'); // here you must the listener url where you want send the event payload

request.setHttpMethod('POST');

var authToken = "AUTHENTICATION_TOKEN"
request.setRequestHeader("authorization", authToken);
request.setRequestHeader("Accept", "application/json");
request.setRequestHeader('Content-Type', 'application/json');

request.setRequestBody("{\"eventType\":\"" +
"EVENT_TYPE" + CUSTOM_FIELDS "\"}");

var data = request.getRequestBody();
var secretKey = "SECRET_KEY";

var signature = SncAuthentication.encode(data, secretKey, "ENCRYPTION_ALGORITHM");
request.setRequestHeader("hmacauthorization",signature);
var response = request.execute();

})(current, previous);

      Reemplaza lo siguiente:

      • WEBHOOK_URL: Es la URL de webhook para la suscripción a eventos que obtendrías de la página de detalles de la conexión de Integration Connectors.
      • AUTHENTICATION_TOKEN: Es el texto real del token de autenticación que configuraste para la conexión.
      • EVENT_TYPE: El texto real del tipo de evento que configuraste en el activador ServiceNow.
      • CUSTOM_FIELDS: El cuerpo de la solicitud siempre debe tener el campo eventType. Además de este campo, puedes agregar otros campos según tus requisitos.
      • SECRET_KEY: Es el texto real de la clave secreta que configuraste para la conexión.
      • ENCRYPTION_ALGORITHM: Debe ser cualquiera de los siguientes valores:
        • HmacSHA224
        • HmacSHA256
        • HmacSHA384
        • HmacSHA512

        El algoritmo debe ser el mismo que configuraste para la conexión.

      Ejemplo

      (function executeRule(current, previous /*null when async*/ ) {
var request = new sn_ws.RESTMessageV2();
request.setEndpoint('https://webhook.site/bb37937e-24ea-19b3-9dcd-84eca77f60eg'); // here you must the listener url where you want send the event payload

request.setHttpMethod('POST');

var authToken = "YWRtaW46ZkVpNypxVzhCL3VY"
request.setRequestHeader("authorization", authToken);
request.setRequestHeader("Accept", "application/json");
request.setRequestHeader('Content-Type', 'application/json');

request.setRequestBody("{\"caller_id\":\"" +
current.caller_id + "\",\"eventType\":\"" +
"service_now_event_type_1" + "\",\"company\":\"" +
current.company + "\",\"number\":\"" +
current.number + "\",\"description\":\"" +
current.description + "\",\"FirstName\":\"" +
current.u_firstname + "\",\"LastName\":\"" +
current.u_lastname + "\",\"status\":\"" +
current.u_status + "\",\"Element\":\"" +
current.getElement() + "\",\"category\":\"" +
current.category + "\",\"opened_at\":\"" +
current.opened_at + "\",\"opened_by\":\"" +
current.opened_by + "\",\"location\":\"" +
current.location + "\",\"salesforceId\":\"" +
current.u_salesforceid + "\"}"); //fields you want

var data = request.getRequestBody();
var secretKey = "YWRtaW46ZkVpNypxVzhCL3VY";

// var MAC_ALG_4 = "HmacSHA384";
var MAC_ALG_3 = "HmacSHA256";
// var MAC_ALG_5 = "HmacSHA512";
// var MAC_ALG_2 = "HmacSHA224";

var signature = SncAuthentication.encode(data, secretKey, MAC_ALG_3);
request.setRequestHeader("hmacauthorization",signature);
var response = request.execute();

})(current, previous);

Entidades, operaciones y acciones

Todos los Integration Connectors proporcionan una capa de abstracción para los objetos de la aplicación conectada. Solo puedes acceder a los objetos de una aplicación a través de esta abstracción. La abstracción se expone como entidades, operaciones y acciones.

  • Entidades: Una entidad puede considerarse como un objeto o una colección de propiedades en la aplicación o servicio conectados. La definición de una entidad difiere de conector a conector. Por ejemplo, en un conector de bases de datos, las tablas son las entidades; en un conector de servidor de archivos, las carpetas son las entidades; en un conector de sistema de mensajería, las colas son las entidades.

    Sin embargo, es posible que un conector no admita o tenga ninguna entidad, en cuyo caso la lista Entities estará vacía.

  • Operaciones: Una operación es la actividad que puedes realizar en una entidad. Puedes realizar cualquiera de las siguientes operaciones en una entidad:

    Cuando se selecciona una entidad de la lista disponible, se genera una lista de operaciones disponibles para esa entidad. Para obtener una descripción detallada de las operaciones, consulta las operaciones de entidades de la tarea de conectores. Sin embargo, si un conector no admite ninguna de las operaciones de entidad, tales operaciones no compatibles no aparecerán en la lista Operations.

  • Acción: Una acción es una función de primera clase que está disponible para la integración mediante la interfaz de Conectores. Una acción te permite realizar cambios en una entidad o entidades y variar de un conector a otro. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Acciones

En esta sección, se enumeran todas las acciones que admite la conexión de Servicenow.

Acción UploadAttachment

Esta acción permite subir un archivo como archivo adjunto a un registro especificado.

Parámetros de entrada de la acción UploadAttachment

Nombre del parámetro Tipo de datos Requeridos Descripción
Temario String No Contenido de cadena para subir como archivo.
ContentBytes String No Contenido de bytes que se subirá como archivo.
HasBytes Booleano No Indica si se debe subir contenido como bytes.
TableName String No Nombre de la tabla a la que se adjuntará el archivo.
TableSysId String No Sys_id del registro en la tabla especificada por TableName a la que deseas adjuntar el archivo.

Parámetros de resultado de la acción UploadAttachment

Esta acción muestra un conjunto de parámetros de la entidad subida

Por ejemplo, sobre cómo configurar la acción UploadAttachment, consulta Ejemplos.

Acción DownloadAttachment

Esta acción permite descargar un archivo adjunto de un registro específico.

Parámetros de entrada de la acción DownloadAttachment

Nombre del parámetro Tipo de datos Requeridos Descripción
SysId String Sí Sys_id del archivo adjunto.
HasBytes Booleano No Indica si se debe descargar contenido como bytes.

Parámetros de resultado de la acción DownloadAttachment

Esta acción muestra si la descarga es verdadera o falsa mediante el parámetro Success y, si es Verdadero, muestra el contenido del DownloadAttachment.

Por ejemplo, sobre cómo configurar la acción DownloadAttachment, consulta Ejemplos.

Ejemplos

En esta sección, se describe cómo realizar algunas de las operaciones y acciones de entidades en este conector.

Ejemplo: Subir un archivo adjunto para un incidente

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción UploadAttachment y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
  "Content": "File is uploaded",
  "TableName": "Incident",
  "TableSysId": "018f4057473ae5104593a6b5316d4357"
}

    4. En este ejemplo, se sube el valor de contenido de la carga útil como archivo adjunto y se muestra el conjunto de parámetros de la entidad subida . Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea UploadAttachment tendrá un valor similar al siguiente:

    {
                      "SysId": "a667f5d1939be110ff87352d6cba10fc",
                      "FileName": "7043426257788756581.connector.txt",
                      "TableSysId": "018f4057473ae5104593a6b5316d4357",
                      "TableName": "Incident",
                      "DownloadLink": "https://gcp.service-now.com/api/now/v1/attachment/a667f5d1939be110ff87352d6cba10fc/file",
                      "ContentType": "text/plain",
                      "SizeBytes": "16",
                      "ChunkSizeBytes": "700000",
                      "Compressed": "true",
                      "SizeCompressed": "36",
                      "SysTags": "",
                      "ImageHeight": "",
                      "ImageWidth": "",
                      "AverageImageColor": "",
                      "SysModCount": "0",
                      "Hash": "807e96c2942c41ad699d004a9d6a74595c84fab09111d479b6bbe013d5debff6",
                      "State": "pending",
                      "SysUpdatedBy": "gcp2",
                      "SysUpdatedOn": "2023-06-07 07:23:34",
                      "SysCreatedBy": "gcp2",
                      "SysCreatedOn": "2023-06-07 07:23:34",
                      "encryption_context": ""
                    }

Ejemplo: descarga un archivo adjunto de un incidente

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción DownloadAttachment y haz clic en Listo.
  3. En la sección Entrada de la tarea de la tarea Conectores, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value: 
    {
  "SysId": "440c3995471fe1104593a6b5316d4384"
}

    4. En este ejemplo, se muestra si la descarga es verdadera o falsa mediante el parámetro Success y, si es verdadera, se muestra el contenido de DownloadAttachment. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea DownloadAttachment tendrá un valor similar al siguiente:

    [
                    {
                      "Success": "True"
                    },
                    {
                      "Content": " A Simple Text File \r\n\r\n\r\n This is a small demonstration .txt file - \r\n just for use in the Virtual Mechanics tutorials. More text. And more \r\n text. And more text. And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. And more text. Boring, zzzzz. And more text. And more text. And \r\n more text. And more text. And more text. And more text. And more text. \r\n And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. And more text. And more text. Even more. Continued on page 2 ...\r\n Simple PDF File 2 \r\n ...continued from page 1. Yet more text. And more text. And more text. \r\n And more text. And more text. And more text. And more text. And more \r\n text. Oh, how boring typing this stuff. But not as boring as watching \r\n paint dry. And more text. And more text. And more text. And more text. \r\n Boring. More, a little more text. The end, and just as well. "
                    }]

Limitaciones del sistema

El conector de ServiceNow puede procesar un máximo de 10 transacciones por segundo por nodo y limita cualquier transacción que supere este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para una mejor disponibilidad) a una conexión.

Para obtener más información sobre los límites aplicables a Integration Connectors, consulta Límites.

Usa Terraform para crear conexiones

Puedes usar el recurso de Terraform para crear una conexión nueva.

Si deseas obtener más información para aplicar o quitar una configuración de Terraform, consulta los comandos básicos de Terraform.

Si quieres ver una plantilla de muestra de Terraform para crear conexiones, consulta la plantilla de muestra.

Cuando creas esta conexión en Terraform, debes establecer las siguientes variables en tu archivo de configuración de Terraform:

Nombre del parámetro Tipo de datos Requeridos Descripción
proxy_enabled BOOLEAN Falso Selecciona esta casilla de verificación para configurar un servidor proxy para la conexión.
proxy_auth_scheme ENUM Falso El tipo de autenticación que se usará para autenticar en el proxy de ProxyServer. Los valores admitidos son BASIC, DIGEST y NONE.
proxy_user STRING Falso Un nombre de usuario que se usará para autenticarse en el proxy de ProxyServer.
proxy_password SECRET Falso Una contraseña que se utilizará para autenticarse en el proxy de ProxyServer.
proxy_ssltype ENUM Falso El tipo de SSL que se usará cuando se establezca la conexión con el proxy de ProxyServer. Los valores admitidos son AUTO, ALWAYS, NEVER, TUNNEL.
include_system_tables BOOLEAN Falso Controla si se deben exponer o no las tablas del sistema.
filter_tables STRING Falso Especifica las tablas que quieras en una lista separada por comas.

Usa la conexión de Servicenow en una integración

Después de crear la conexión, estará disponible en Apigee Integration y en Application Integration. Puedes usar la conexión en una integración mediante la tarea Conectores.

  • Para comprender cómo crear y usar la tarea Conectores en la integración de Apigee, consulta la Tarea Conectores.
  • Para comprender cómo crear y usar la tarea Conectores en Application Integration, consulta la tarea Conectores.

Obtén ayuda de la Comunidad de Google Cloud

Puedes publicar tus preguntas y debatir sobre este conector en la comunidad de Google Cloud en Cloud Forums.

¿Qué sigue?