Administración de servicios de Jira

El conector de Jira Service Management te permite conectarte a Jira Service Management y realizar operaciones de inserción, eliminación, actualización y lectura.

Antes de comenzar

Antes de usar el conector de Jira Service Management, realiza las siguientes tareas:

  • En tu proyecto de Google Cloud, haz lo siguiente:
    • Otorga el rol de IAM roles/connectors.admin al usuario. configurar 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.

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. Haz clic en SIGUIENTE.
  4. En la sección Detalles de la conexión, completa lo siguiente:
    1. Conector: Selecciona Jira Service Management 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 conexión no pueden superar los 49 caracteres.
    4. De manera opcional, ingresa una Descripción para la instancia de conexión.
    5. De manera opcional, habilita Cloud Logging. y, luego, selecciona un nivel de registro. De forma predeterminada, el nivel de registro se establece en Error.
    6. Cuenta de servicio: Selecciona una cuenta de servicio que tenga los roles necesarios.
    7. Ingresa un ID de Service Desk del usuario autenticado. De forma predeterminada, obtenemos el primer ID que se muestra de una llamada adicional para obtener todos los departamentos de servicio. Puedes obtener el ServiceDeskId mediante la ejecución de una consulta de lista a la entidad ServiceDesks.
    8. Ingresa el nivel de verbosidad para la conexión, que varía de 1 a 5. Un nivel de verbosidad más alto registrará todos los detalles de la comunicación (solicitud, respuesta y certificados SSL).
    9. 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.

    10. 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:

    11. De forma opcional, haz clic en + AGREGAR ETIQUETA para agregar una etiqueta a la conexión en forma de un par clave-valor.
    12. 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.
      • Selecciona Dirección de host en la lista para especificar el nombre de host o la dirección IP del destino.
      • Si deseas establecer una conexión privada a tus sistemas de backend, selecciona Adjunto de extremo en la lista y, luego, selecciona el archivo adjunto de extremo requerido en la lista Adjunto de extremo.

      Si deseas establecer una conexión pública con tus sistemas de backend con seguridad adicional, puedes considera configurar la configuración estática de direcciones IP internas para tus conexiones y, luego, para incluir en la lista de entidades permitidas 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 Jira Service Management admite los siguientes tipos de autenticación:

      • OAuth2.0
      • Básico
      • APIToken
    2. Para comprender cómo configurar estos tipos de autenticación, consulta Configura la autenticación.

    3. Haga clic en SIGUIENTE.
  7. Revisa: Revisa tus detalles de conexión y autenticación.
  8. Haz clic en Crear.

Configura la autenticación

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

  • OAuth2.0
    • ID de cliente: Es el ID de cliente que proporciona tu aplicación externa.
    • Permiso: Alcance del permiso. El permiso offline_access se debe usar con el conector de administración de servicios de Jira. Para comprender cómo funcionan los permisos y ver todos los disponibles para Jira Service Management, consulta Alcances.
    • Secreto del cliente: Selecciona el secreto de Secret Manager. Debes haber creado el secreto de Secret Manager antes de configurar esta autorización.
    • Versión del secreto: La versión del secreto de Secret Manager para el secreto del cliente.
    • Para el tipo de autenticación Authorization code, después de crear la conexión, debes realizar algunos pasos adicionales para configurar la autenticación. Para obtener más información, consulta Pasos adicionales después de la creación de la conexión.

  • Básico
    • Nombre de usuario: La cuenta de usuario de Jira Service Management que se usa para la autenticación.
    • Contraseña: Es la contraseña asociada a la cuenta.
  • APIToken
    • Nombre de usuario: Es el nombre de usuario de Jira Service Management que se usó para crear el token de API.
    • Token de API: La contraseña del nombre de usuario será un token de API. Selecciona el Secret de Secret Manager que contiene el token de API asociado con el nombre de usuario de Jira Cloud.

Pasos adicionales después de la creación de la conexión

Si seleccionaste OAuth 2.0 - Authorization code para autenticación, debes realizar los siguientes pasos adicionales después de crear la conexión:

  1. En la página Conexiones, busca la conexión recién creada.

    Ten en cuenta que el Estado del nuevo conector será Se requiere autorización.

  2. Haz clic en Se requiere autorización.

    Se mostrará el panel Editar autorización.

  3. Copia el valor de Redirect URI (URI de redireccionamiento) a tu aplicación externa.
  4. Verifica los detalles de la autorización.
  5. Haz clic en Autorizar.

    Si la autorización se realiza correctamente, el estado de la conexión se establecerá como Activa en la Página Conexiones.

Cómo volver a autorizar el código de autorización

Si usas el tipo de autenticación Authorization code y modificaste la configuración en tu aplicación de Jira Service Management, debes volver a autorizar tu conexión de Jira Service Management. Para volver a autorizar una conexión, sigue estos pasos:

  1. Haz clic en la conexión requerida en la página Conexiones.

    Se abrirá la página de detalles de la conexión.

  2. Haz clic en Editar para editar los detalles de la conexión.
  3. Verifica los detalles de OAuth 2.0: Código de autorización en la sección Autenticación.

    Si es necesario, realiza los cambios necesarios.

  4. Haz clic en Guardar. Esto te llevará a la página de detalles de la conexión.
  5. Haz clic en Editar autorización en la sección Autenticación. Esto muestra el panel Autorizar.
  6. Haz clic en Autorizar.

    Si la autorización se realiza correctamente, el estado de la conexión se establecerá como Activa en la página Conexiones.

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, estas operaciones no compatibles no se incluyen 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. Normalmente, una acción tendrá algunos parámetros de entrada y una parámetro. Sin embargo, es posible que un conector no admita ninguna acción, en cuyo caso la lista Actions estará vacía.

Limitaciones del sistema

El conector de Jira Service Management puede procesar 15 transacciones por segundo, por nodo, y throttles las transacciones supera este límite. De forma predeterminada, Integration Connectors asigna 2 nodos (para una mejor disponibilidad) por una conexión.

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

Acciones

El conector de administración de servicios de Jira proporciona acciones, como AddAttachment, AttachTemporaryFile y CreateCustomer. Para comprender cómo configurar las acciones, consulta Ejemplos de acciones.

Ejemplos de acciones

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

Ejemplo: Cómo adjuntar un archivo temporal

En este ejemplo, se adjunta un archivo temporal y se proporciona un ID de archivo adjunto que usas para agregar un archivo adjunto.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción AttachTemporaryFile y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value:
      {
        "Content": "test to create 1 temporaryid"
      }
  4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
        "TemporaryAttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
        "FileName": "16324233309516250343.connector.txt"
    }] 

Ejemplo: Cómo agregar un archivo adjunto

En este ejemplo, se adjunta el archivo temporal al ID de solicitud proporcionado en la carga útil de entrada.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción AddAttachment y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value:
    {
        "AttachmentId": "3ef17ee7-3877-4ac6-b586-481cb2121ef8",
        "RequestId": "10032"
    }  
  4. Si la acción se realiza correctamente, tus respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
      "Success": "true",
      "filename": "16324233309516250343.connector.txt",
    }] 

Ejemplo: crea un cliente

En este ejemplo, se crea un cliente.

  1. En el cuadro de diálogo Configure connector task, haz clic en Actions.
  2. Selecciona la acción CreateCustomer y haz clic en Listo.
  3. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el Campo Default Value:
    {
      "Email": "something@something.com",
      "FullName": "Something"
    } 
  4. Si la acción se realiza correctamente, el parámetro de respuesta connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

    [{
        "Key": null,
        "AccountId": "qm:476582de-e968-4bc9-b0be-0349e8e3ec97:244dd7e4-0b49-4468-adac-561ab09bf2bb",
        "Name": null,
        "EmailAddress": "something@something.com",
        "DisplayName": "Something",
        "Active": "true",
        "Timezone": "Asia/Calcutta",
        "_links.jirarest": "https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb",
        "_links.avatarurls.48x48": "https://avatar-management.services.atlassian.com/default/48",
        "_links.avatarurls.24x24": "https://avatar-management.services.atlassian.com/default/24",
        "_links.avatarurls.16x16": "https://avatar-management.services.atlassian.com/default/16",
        "_links.avatarurls.32x32": "https://avatar-management.services.atlassian.com/default/32",
        "_links.self": "https://google-team-zlre6yes.atlassian.net/rest/api/2/user?accountId=qm%3A476582de-e968-4bc9-b0be-0349e8e3ec97%3A244dd7e4-0b49-4468-adac-561ab09bf2bb"
    }]

Ejemplos de operaciones de entidades

Ejemplo: Muestra todas las solicitudes

En este ejemplo, se enumeran todas las solicitudes de la entidad Requests.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Solicitudes en la lista Entity.
  3. Selecciona la operación LIST y haz clic en Listo.

Ejemplo: recibir solicitudes de un ID de Service Desk específico

En este ejemplo, se obtiene la solicitud con la RequestKey como DP1-14 de la entidad Requests.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Requests de la lista Entity.
  3. Selecciona la operación LIST y, luego, haz clic en Listo.
  4. En la sección Entrada de tarea de la tarea Conectores, haz clic en filterClause. Luego, ingresa RequestKey='DP1-14' en el campo Valor predeterminado.

    Aquí, RequestKey es el valor de clave primaria de la entidad Requests.

Ejemplo: Crea una solicitud

En este ejemplo, se crea una solicitud en la entidad Requests.

  1. En el cuadro de diálogo Configure connector task, haz clic en Entities.
  2. Selecciona Requests en la lista Entity.
  3. Selecciona la operación Create y haz clic en Listo.
  4. En la sección Task Input de la tarea Connectors, haz clic en connectorInputPayload y, luego, ingresa un valor similar al siguiente en el campo Default Value:
    {, , ,) VALUES ('2', '1', '','test');
        "RequestTypeId": "2",
        "ServiceDeskId": "1",
        "Summary": "test",
        "Description": "test"
      }
      

    Si la integración se realiza de forma correcta, el campo connectorOutputPayload de la tarea del conector tendrá un valor similar al siguiente:

     {
        "RequestId": "10032"
      } 
      

Usar Terraform para crear conexiones

Puedes usar Terraform resource 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.

Para ver una plantilla de Terraform de ejemplo para la creación de conexiones, consulta la plantilla de ejemplo.

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

Nombre del parámetro Tipo de datos Obligatorio Descripción
proxy_enabled BOOLEAN Falso Selecciona esta casilla de verificación a fin de configurar un servidor proxy para la conexión.
proxy_auth_scheme ENUM Falso Es el tipo de autenticación que se usará para autenticarse en el proxy de ProxyServer. Los valores admitidos son: BASIC, DIGEST, NONE.
proxy_user STRING Falso Es un nombre de usuario que se usará para autenticarse en el proxy de ProxyServer.
proxy_password SECRET Falso Una contraseña que se usará para autenticarse en el proxy ProxyServer.
proxy_ssltype ENUM Falso Es el tipo de SSL que se usará para conectarse al proxy de ProxyServer. Los valores admitidos son: AUTO, ALWAYS, NEVER, TUNNEL

Usa la conexión de Jira Service Management en una integración

Después de crear la conexión, estará disponible en la integración de Apigee y en la integración de aplicaciones. Puedes usar la conexión en una integración a través de la tarea Connectors.

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

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?