Detalles de Conexión de Jira Service Management¶

Introducción¶

Versión del conector

Esta documentación se basa en la versión 21.0.8454 del conector.

Empezando¶

Compatibilidad con la versión de Jira Service Desk

El conector aprovecha la API de Jira Service Desk para habilitar el acceso bidireccional a Jira Service Desk.

El conector funciona tanto con cuentas de Jira Service Desk Cloud como con instancias de Jira Service Desk Server.

Atlassian Jira Service Management se conocía anteriormente como * Jira Service Desk* y recibió su nuevo nombre a partir de su versión 4.14. Sin embargo, hay muchas referencias a Service Desk en esta documentación, la documentación de Atlassian y las APIs REST de Atlassian. Consulte las notas de lanzamiento de Atlassian Service Management 4.14.x para detalles.

Establecer una Conexión¶

Conexión a Jira Service Desk¶

Puede establecer una conexión con cualquier cuenta de Jira Service Desk Cloud o instancia de Jira Service Desk Server. Para conectar establezca la siguiente propiedad:

• URL (por ejemplo: https://yoursitename.atlassian.net).

Autenticación en Jira Service Desk¶

Autenticación Básica¶

Autenticación con una cuenta en la nube

Para conectarse a una cuenta en la nube, primero deberá recuperar un APIToken. Para generar uno, inicie sesión en su cuenta de Atlassian y navegue hasta API tokens > Create API token. Se mostrará el token generado.

Proporcione lo siguiente para conectarse a los datos:

• AuthScheme: Establezca este Básico.
• User: establezca esto en el nombre de usuario del usuario que se autentica.
• APIToken: establezca esto en el token de API encontrado anteriormente.

Autenticación con una cuenta de servidor local

Para autenticarse con una cuenta de servidor local, deberá proporcionar las siguientes propiedades de conexión:

• AuthScheme: Establezca este Básico.
• User: establezca esto en el nombre de usuario del usuario que se autentica.
• Password: establezca esto en la contraseña del usuario que se autentica.
• URL: Establézcalo en la URL asociada con su extremo de Jira Service Desk. Por ejemplo, https://yoursitename.atlassian.net.

Nota: La contraseña ha quedado obsoleta para conectarse a una cuenta en la nube y ahora solo se usa para conectarse a una instancia de servidor.

Autenticarse con una Aplicación OAuth Personalizada (3lo)¶

Puede aprovechar la compatibilidad con OAuth 2.0 (3LO) de "tres patas" de Jira Service Desk para conectarse a los datos sin proporcionar sus credenciales de inicio de sesión. Consulte Uso de la autenticación OAuth para obtener una guía de autenticación.

Autenticar Usando OAuth1.0¶

Para conectarse a Jira Service Desk, deberá seguir los pasos a continuación:

• En primer lugar, genere un par de claves pública/privada RSA. En su terminal, ejecute los siguientes comandos:
  -openssl genrsa -out jira_privatekey.pem 1024
  -openssl req -newkey rsa:1024 -x509 -key jira_privatekey.pem -out jira_publickey.cer -days 365
  -openssl pkcs8 -topk8 -nocrypt -in jira_privatekey.pem -out jira_privatekey.pcks8
  -openssl x509 -pubkey -noout -in jira_publickey.cer -out jira_publickey.pem
  
• Crear enlaces de aplicación en su cuenta. Vaya a Configuración -> Aplicaciones -> Enlaces de aplicación.
• Ingrese una URL de prueba para el campo URL, haga clic en 'Crear nuevo enlace'.
• Ignora el error y haz clic en continuar. Solo queremos configurar las llamadas entrantes (de la aplicación a Jira Service Desk).
• En la ventana 'Enlazar aplicaciones', rellene los campos a su gusto ya que no son relevantes. Pero asegúrese de marcar 'Crear enlace entrante'. Haga clic en Continuar para ir a la página siguiente.
• Rellene los campos obligatorios:
  -Clave de Consumidor: Llena esto como quieras. Lo utilizará como OAuthClientId más adelante.
  -Nombre del consumidor: complete esto como desee.
  -Clave pública: ingrese la clave en el archivo 'jira_publickey.pem' que generó anteriormente. Y haga clic en continuar.
  

Para conectar establezca las siguientes propiedades:

• URL (por ejemplo: https://yoursitename.atlassian.net).
• OAuthClientId a la clave de consumidor de su aplicación.
• OAuthClientSecret a cualquier valor (como 'testClientSecret').
• OAuthJWTCert a la ubicación de su archivo de clave privada.
• OAuthJWTCertType a la opción adecuada según el archivo de clave privada que se utilice. Si usa el archivo de clave PEM generado, establezca OAuthJWTCertType a PEMKEY_FILE.
• InitiateOAuth para GETANDREFRESH.

Autenticación con Multitud¶

Selecciona el AuthScheme a Crowd. Las siguientes propiedades de conexión se utilizan para conectarse a Crowd:

• User: La cuenta de usuario CROWD.
• Password: La contraseña asociada con la cuenta de Crowd.
• SSOLoginURL: La URL de inicio de sesión asociada con la cuenta de Crowd. Puede encontrar la URL de IDP navegando a your application -> SSO -> SSO information -> Identity provider single sign-on URL.
• SSOAppName: El nombre de la aplicación en la que está habilitado SSO.
• SSOAppPassword: La contraseña de la aplicación en la que está habilitado el SSO.
• SSOExchangeUrl: la URL utilizada para intercambiar el token SAML por las cookies de JiraServiceDesk. Esta URL puede tener los siguientes formatos:
  • https://<authority de la instancia de JiraServiceDesk>/plugins/servlet/samlconsumer
  • https://<authority de la instancia de JiraServiceDesk>/plugins/servlet/samlsso

La siguiente es una cadena de conexión de ejemplo:

AuthScheme=Crowd;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://<authority>/crowd/console/secure/saml/sso.action';User=crowdUserName;Password=crowdPassword;SSOExchangeUrl=https://<authority of JiraServiceDesk instance>/plugins/servlet/samlconsumer;SSOAppName=CrowdAppName;SSOAppPassword=CrowdAppPassword;

Autenticación con Okta¶

Selecciona el AuthScheme a Okta. Las siguientes propiedades de conexión se utilizan para conectarse a Okta:

• User: Configure esto para el usuario de Okta.
• Password: establezca esto en la contraseña de Okta para el usuario.
• SSOLoginURL: establezca esto en la URL de inicio de sesión utilizada por el proveedor de SSO.
• SSOExchangeUrl: la URL utilizada para intercambiar el token SAML por las cookies de JiraServiceDesk. Esta URL puede tener los siguientes formatos:
  • https://<authority de la instancia de JiraServiceDesk>/plugins/servlet/samlconsumer
  • https://<authority de la instancia de JiraServiceDesk>/plugins/servlet/samlsso

La siguiente SSOProperties son necesarios para autenticarse en Okta:

• APIToken (opcional): establezca esto en el token de API que el cliente creó a partir de la organización de Okta. Debe usarse al autenticar a un usuario a través de una aplicación confiable o un proxy que anula el contexto de solicitud del cliente de OKTA.
• MFAType (opcional): configure esto solo en caso de que haya configurado el flujo MFA. Actualmente solo admitimos los siguientes tipos: OktaVerify, Correo y SMS.
• MFAPassCode (opcional): configure esto solo en caso de que haya configurado el flujo MFA. Si está configurado como vacío/no válido, el controlador emitirá inicialmente un desafío de MFA que activará la plataforma para enviarle una contraseña de un solo uso a su dispositivo o correo, según el tipo de MFA configurado. Debe volver a emitir otra conexión en la que el valor de la contraseña de un solo uso recuperado se pase a la propiedad de conexión MFAPassCode.

La siguiente es una cadena de conexión de ejemplo:

AuthScheme=Okta;Url=https://yoursitename.atlassian.net;SSOLoginURL='https://example.okta.com/home/appType/0bg4ivz6cJRZgCz5d6/46';User=oktaUserName;Password=oktaPassword;SSOExchangeUrl=https://<authority of JiraServiceDesk instance>/plugins/servlet/samlconsumer;

Acceso a Campos Personalizados¶

De forma predeterminada, el conector muestra solo los campos del sistema. Para acceder a los campos personalizados para Incidencias, configure IncludeCustomFields.

Uso de la Autenticación OAuth¶

OAuth requiere que el usuario que se autentica interactúe con Jira Service Desk mediante el navegador. El conector facilita esto de varias maneras, como se describe a continuación.

Credenciales Personalizadas¶

Una vez que haya creado su aplicación, puede conectarse con Credenciales personalizadas.

Creación de una Aplicación OAuth Personalizada¶

Consulte Crear una aplicación OAuth personalizada para el procedimiento. Su nueva aplicación contendrá el OAuthClientId y OAuthClientSecret necesario para establecer una conexión.

Credenciales Personalizadas¶

Esta sección describe la autenticación de escritorio usando las credenciales para su aplicación OAuth personalizada. Consulte Crear una aplicación OAuth personalizada para más información.

Obtenga un Token de Acceso OAuth¶

Después de configurar lo siguiente, está listo para conectarse:

• OAuthClientId: establezca la ID de cliente en la configuración de su aplicación.
• OAuthClientSecret: establezca el secreto del cliente en la configuración de su aplicación.
• CallbackURL: Configure la URL de redireccionamiento en la configuración de su aplicación.
• OAuthVersion: Ajustado a 2.0.
• URL: la URL de su extremo de JIRA Service Desk; Por ejemplo, https://yoursitename.atlassian.net.
• InitiateOAuth: Ajustado a GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken.

Cuando se conecta, el conector abre el extremo de OAuth en su navegador predeterminado. Inicie sesión y otorgue permisos a la aplicación. Luego, el conector completa el siguiente proceso de OAuth:

1. Extrae el token de acceso de la URL de devolución de llamada y autentica las solicitudes.
2. Obtiene un nuevo token de acceso cuando caduca el antiguo.
3. Guarda los valores de OAuth en OAuthSettingsLocation para persistir a través de las conexiones.

Máquinas Sin Cabeza¶

Para crear fuentes de datos de Jira Service Desk en servidores sin periféricos u otras máquinas en las que el conector no puede abrir un navegador, debe autenticarse desde otra máquina. La autenticación es un proceso de dos pasos.

1. En lugar de instalar el conector en otra máquina, puede seguir los pasos a continuación para obtener el OAuthVerifier valor. O bien, puede instalar el conector en otra máquina y transferir los valores de autenticación de OAuth, después de autenticarse a través del flujo habitual basado en el navegador.
2. A continuación, puede configurar el conector para actualizar automáticamente el token de acceso desde la máquina sin periféricos.

Puede seguir el flujo de autenticación de OAuth sin cabeza usando las credenciales de OAuth integradas del conector o usando las credenciales de OAuth para su aplicación de OAuth personalizada.

Uso de las Credenciales para una Aplicación OAuth Personalizada¶

Crear una Aplicación OAuth Personalizada¶

Consulte Crear una aplicación OAuth personalizada para un procedimiento. Esta sección describe el procedimiento para autenticar y conectarse a los datos.

Autenticación Automática 2.0¶

Obtener un Código Verificador¶

Primero, establezca las siguientes propiedades en la máquina sin periféricos:

• InitiateOAuth: Ajustado a OFF.
• OAuthClientId: establezca la ID de la aplicación en los detalles de su aplicación.
• OAuthClientSecret: establezca el secreto de la aplicación en los detalles de su aplicación.
• OAuthVersion: Ajustado a 2.0.

A continuación, autentíquese desde otra máquina y obtenga el OAuthVerifier propiedad de conexión:

1. Llame a GetOAuthAuthorizationURL procedimiento almacenado* con el parámetro de entrada CallbackURL establecido en el URI de redirección exacto que especificó en los detalles de su aplicación en APIS AND FEATURES -> OAuth 2.0 (3LO).
2. Abra la URL devuelta en un navegador. Inicie sesión y otorgue permisos al conector. A continuación, se le redirige a la URL de devolución de llamada, que contiene el código verificador.
3. Guarde el valor del código verificador. Necesita configurar esto en OAuthVerifier propiedad de conexión.

Finalmente, en la máquina sin periféricos, configure las siguientes propiedades de conexión para obtener los valores de autenticación de OAuth:

• OAuthClientId: establezca la clave de consumidor en los detalles de su aplicación.
• OAuthClientSecret: establezca el secreto del consumidor en los detalles de su aplicación.
• OAuthVerifier: Establecido en el código del verificador.
• OAuthSettingsLocation: configurado para conservar los valores de autenticación OAuth cifrados en el archivo especificado.
• InitiateOAuth: Ajustado a REFRESH.

Autenticación Automática 1.0¶

Obtener un Código Verificador¶

Primero, establezca las siguientes propiedades en la máquina sin periféricos:

• InitiateOAuth: Ajustado a OFF.
• OAuthClientId: establezca la ID de la aplicación en los detalles de su aplicación.
• OAuthClientSecret: establezca el secreto de la aplicación en los detalles de su aplicación.
• OAuthVersion: Ajustado a 1.0.
• Guarde el valor del AuthToken y AuthKey devueltos. Se utilizarán en el siguiente paso.
• Abra la URL devuelta en un navegador. Inicie sesión y otorgue permisos al conector. A continuación, se le redirige a la URL de devolución de llamada, que contiene el código verificador.

A continuación, autentíquese desde otra máquina y obtenga el OAuthVerifier propiedad de conexión:

1. Llame a GetOAuthAuthorizationURL procedimiento almacenado* con el parámetro de entrada CallbackURL establecido en el URI de redirección exacto que especificó en los detalles de su aplicación en APIS AND FEATURES -> OAuth 2.0 (3LO).
2. Abra la URL devuelta en un navegador. Inicie sesión y otorgue permisos al conector. A continuación, se le redirige a la URL de devolución de llamada, que contiene el código verificador.
3. Guarde el valor del código verificador. Necesita configurar esto en OAuthVerifier propiedad de conexión.

Finalmente, en la máquina sin periféricos, configure las siguientes propiedades de conexión para obtener los valores de autenticación de OAuth:

• OAuthClientId: establezca la clave de consumidor en los detalles de su aplicación.
• OAuthClientSecret: establezca el secreto del consumidor en los detalles de su aplicación.
• OAuthVerifier: Establecido en el código del verificador.
• AuthToken: establezca esto en AuthToken.
• AuthKey: Establézcalo en AuthKey.
• OAuthSettingsLocation: configurado para conservar los valores de autenticación OAuth cifrados en el archivo especificado.
• InitiateOAuth: Ajustado a REFRESH.

Conectarse a Datos¶

Después de generar el archivo de configuración de OAuth, configure las siguientes propiedades para conectarse a los datos:

• OAuthSettingsLocation: Establecido en el archivo que contiene los valores de autenticación OAuth cifrados. Asegúrese de que este archivo otorgue permisos de lectura y escritura al proveedor para habilitar la actualización automática del token de acceso.
• InitiateOAuth: Ajustado a REFRESH.
• OAuthVersion: Ajustado a 2.0.
• URL: la URL de su extremo de JIRA Service Desk; Por ejemplo, https://yoursitename.atlassian.net.

Transferir la Configuración de OAuth¶

Para instalar el conector en otra máquina, autentíquese y luego transfiera los valores de OAuth resultantes:

1. En una segunda máquina, instale el conector y conéctese con el siguiente conjunto de propiedades:
   • OAuthSettingsLocation: Establecido en un archivo de texto grabable.
   • InitiateOAuth: Ajustado a GETANDREFRESH.
   • OAuthClientId: establezca el ID de cliente en los detalles de su aplicación.
   • OAuthClientSecret: establezca el secreto del cliente en los detalles de su aplicación.
   • CallbackURL: establezca la URL de devolución de llamada en los detalles de su aplicación en APIS AND FEATURES -> OAuth 2.0 (3LO).
2. Pruebe la conexión para autenticar. Los valores de autenticación resultantes se escriben, se cifran, en la ruta especificada por OAuthSettingsLocation. Una vez que haya probado con éxito la conexión, copie el archivo de configuración de OAuth en su máquina sin periféricos. En la máquina sin periféricos, configure las siguientes propiedades de conexión para conectarse a los datos:
   • InitiateOAuth: Ajustado a REFRESH.
   • OAuthSettingsLocation: establezca la ruta a su archivo de configuración de OAuth. Asegúrese de que este archivo otorgue permisos de lectura y escritura al conector para habilitar la actualización automática del token de acceso.
   • OAuthVersion: Ajustado a 2.0.
   • URL: la URL de su extremo de JIRA Service Desk; Por ejemplo, https://yoursitename.atlassian.net.

Creación de una Aplicación OAuth Personalizada¶

Si no tiene acceso al nombre de usuario y al token de la API o no desea solicitarlos, puede utilizar la autenticación OAuth. Jira Service Desk utiliza el estándar de autenticación OAuth, que requiere que el usuario que se autentica interactúe con Jira Service Desk a través del navegador. El conector facilita el intercambio de OAuth de varias formas, como se describe en esta sección. Please note OAuth 2.0 is only supported for Jira Service Desk Cloud.

Crear una Aplicación OAuth¶

Para obtener las credenciales del cliente de OAuth, la clave del consumidor y el secreto del consumidor:

1. Inicie sesión en su sitio JIRA Service Desk Cloud.
2. Vaya a la administración de su aplicación ( https://developer.atlassian.com/apps/).
3. Seleccione Create new app, luego asigne un nombre a la aplicación. Ahora se creará la aplicación.
4. Si falta, agregue la funcionalidad OAuth 2.0 a su aplicación navegando a APIS AND FEATURES -> + Add -> Add OAuth 2.0 (3LO).
5. Desde APIS AND FEATURES -> + Add, añade el JIRA Service Desk platform REST API a su aplicación. Tenga en cuenta que también debe agregar la aplicación JIRA para obtener todas las funcionalidades del controlador.
6. Desde APIS AND FEATURES -> + JIRA Service Desk platform REST API, agregue los ámbitos deseados a su aplicación.
7. Además, deberá configurar su URL de devolución de llamada. Navegar a APIS AND FEATURES -> OAuth 2.0 (3LO). Introduzca una URL a la que pueda acceder su aplicación y guarde los cambios.

Autenticarse en Jira Service Desk Desde una Aplicación de Escritorio¶

Después de configurar las siguientes propiedades de conexión, está listo para conectarse:

• OAuthClientId: establezca la clave de consumidor en los detalles de su aplicación.
• OAuthClientSecret: establezca el secreto del consumidor en los detalles de su aplicación.
• CallbackURL: establezca la URL de devolución de llamada que se encuentra en los detalles de su aplicación en APIS AND FEATURES -> OAuth 2.0 (3LO).
• InitiateOAuth: Ajustado a GETANDREFRESH. Puede usar InitiateOAuth para evitar repetir el intercambio de OAuth y configurar manualmente OAuthAccessToken propiedad de conexión.
• OAuthVersion: Ajustado a 2.0.
• URL: la URL de su extremo de JIRA Service Desk; Por ejemplo, https://yoursitename.atlassian.net.

Cuando se conecta, el conector abre el extremo de OAuth en su navegador predeterminado. Inicie sesión y otorgue permisos a la aplicación. Luego, el conector completa el siguiente proceso de OAuth:

1. Obtiene la URL de devolución de llamada y establece el token de acceso y oauthserverurl para autenticar las solicitudes.
2. Guarda los valores de OAuth en OAuthSettingsLocation para persistir a través de las conexiones.
3. Intercambia el token de actualización devuelto por un token de acceso nuevo y válido.

Autenticarse en Jira Service Desk Desde una Aplicación Web¶

Para obtener el token de acceso, establezca las siguientes propiedades de conexión:

• OAuthClientId: establezca la clave de consumidor en los detalles de su aplicación.
• OAuthClientSecret: establezca el secreto del consumidor en los detalles de su aplicación.
• CallbackURL: establezca la URL de devolución de llamada en los detalles de su aplicación en APIS AND FEATURES -> OAuth 2.0 (3LO).
• URL: la URL de su extremo de JIRA Service Desk; Por ejemplo, https://yoursitename.atlassian.net.
• OAuthVersion: Ajustado a 2.0.

Cuando se conecta a través de una aplicación web, o si el conector no está autorizado para abrir una ventana del navegador, debe intercambiar valores de verificación temporales para el token de acceso:

1. Llame a GetOAuthAuthorizationURL. El procedimiento almacenado* devuelve la URL al extremo de OAuth.
2. Inicie sesión y autorice la aplicación. Se le redirigirá a la URL de devolución de llamada. Si establece el parámetro GrantType en Implicit, la URL de devolución de llamada contiene OAuthAccessToken y oauthserverurl en un parámetro de cadena de consultar. Si establece el parámetro GrantType en code, la URL de devolución de llamada contiene el código verificador en el parámetro de cadena de consultar denominado "código". Extraiga el código del verificador y llame a GetOAuthAccessToken.

Para conectarse a los datos, establezca las siguientes propiedades de conexión:

• OAuthAccessToken
• OAuthVersion
• OAuthClientId
• OAuthClientSecret
• OAuthAccessToken
• URL

Ajuste Fino del Acceso a los Datos¶

Ajuste Fino del Acceso a Datos¶

Puede usar las siguientes propiedades para obtener más control sobre los datos devueltos por Jira Service Desk:

• ServiceDeskID: El ID de la mesa de servicio específica a la que desea conectarse.
  De forma predeterminada, obtenemos la primera identificación devuelta de una llamada adicional para obtener todos los servicios de escritorio. Puede obtener el ServiceDeskId ejecutando una consultar Select en la vista ServiceDesks.
• IncludeCustomFields: Incluir o no campos personalizados en las consultas a la tabla de Solicitudes.
• RequestLanguage: configure esto en cualquier idioma instalado en Jira para traducir los nombres de las columnas de visualización en el idioma especificado.
  Especifique una etiqueta de idioma IETF BCP 47 como se describe aquí: https://tools.ietf.org/html/bcp47.

Características Avanzadas¶

Esta sección detalla una selección de funciones avanzadas del conector de Jira Service Desk.

Vistas definidas por el usuario

El conector le permite definir tablas virtuales, llamadas vistas definidas por el usuario, cuyo contenido se decide mediante una consultar preconfigurada. Estas vistas son útiles cuando no puede controlar directamente las consultas que se envían a los controladores. Consulte Vistas definidas por el usuario para obtener una descripción general de la creación y configuración de vistas personalizadas.

Configuración SSL

Usar Configuración SSL para ajustar cómo el conector maneja las negociaciones de certificados TLS/SSL. Puede elegir entre varios formatos de certificado; ver el SSLServerCert propiedad en "Opciones de cadena de conexión" para obtener más información.

Apoderado

Para configurar el conector mediante Configuración de proxy de Agente Privado, Selecciona el Use Proxy Settings casilla de verificación en la pantalla de configuración de la conexión.

Vistas Definidas por el Usuario¶

El conector Jitterbit para Jira Service Desk le permite definir una tabla virtual cuyo contenido se decide mediante una consultar preconfigurada. Estas se denominan Vistas definidas por el usuario, que son útiles en situaciones en las que no puede controlar directamente la consultar que se envía al controlador, por ejemplo, cuando se utiliza el controlador de Jitterbit. Las vistas definidas por el usuario se pueden utilizar para definir predicados que siempre se aplican. Si especifica predicados adicionales en la consultar a la vista, se combinan con la consultar ya definida como parte de la vista.

Hay dos formas de crear vistas definidas por el usuario:

• Cree un archivo de configuración con formato JSON que defina las vistas que desea.
• Declaraciones DDL.

Definición de Vistas Utilizando un Archivo de Configuración¶

Las vistas definidas por el usuario se definen en un archivo de configuración con formato JSON llamado UserDefinedViews.json. El conector detecta automáticamente las vistas especificadas en este archivo.

También puede tener múltiples definiciones de vista y controlarlas usando UserDefinedViews propiedad de conexión. Cuando utiliza esta propiedad, el conector solo ve las vistas especificadas.

Este archivo de configuración de vista definida por el usuario tiene el siguiente formato:

• Cada elemento raíz define el nombre de una vista.
• Cada elemento raíz contiene un elemento hijo, llamado query, que contiene la consultar SQL personalizada para la vista.

Por ejemplo:

{
    "MyView": {
        "query": "SELECT * FROM Requests WHERE MyColumn = 'value'"
    },
    "MyView2": {
        "query": "SELECT * FROM MyTable WHERE Id IN (1,2,3)"
    }
}

Utilizar el UserDefinedViews propiedad de conexión para especificar la ubicación de su archivo de configuración JSON. Por ejemplo:

"UserDefinedViews", "C:\Users\yourusername\Desktop\tmp\UserDefinedViews.json"

Esquema para Vistas Definidas por el Usuario¶

Las vistas definidas por el usuario se exponen en UserViews esquema por defecto. Esto se hace para evitar que el nombre de la vista entre en conflicto con una entidad real en el modelo de datos. Puede cambiar el nombre del esquema utilizado para UserViews configurando UserViewsSchemaName propiedad.

Trabajar con Vistas Definidas por el Usuario¶

Por ejemplo, una instrucción SQL con una vista definida por el usuario llamada UserViews.RCustomers solo enumera clientes en Raleigh:

SELECT * FROM Customers WHERE City = 'Raleigh';

Un ejemplo de una consultar al controlador:

SELECT * FROM UserViews.RCustomers WHERE Status = 'Active';

Dando como resultado la consultar efectiva a la fuente:

SELECT * FROM Customers WHERE City = 'Raleigh' AND Status = 'Active';

Ese es un ejemplo muy simple de una consultar a una vista definida por el usuario que es efectivamente una combinación de la consultar de vista y la definición de vista. Es posible componer estas consultas en patrones mucho más complejos. Todas las operaciones de SQL están permitidas en ambas consultas y se combinan cuando corresponde.

Configuración SSL¶

Personalización de la Configuración SSL¶

De forma predeterminada, el conector intenta negociar SSL/TLS comparando el certificado del servidor con el almacén de certificados de confianza del sistema.

Para especificar otro certificado, consulte SSLServerCert propiedad de los formatos disponibles para hacerlo.

Certificados SSL de Cliente¶

El conector de Jira Service Desk también admite la configuración de certificados de cliente. Configure lo siguiente para conectarse mediante un certificado de cliente.

• SSLClientCert: el nombre del almacén de certificados para el certificado de cliente.
• SSLClientCertType: el tipo de almacén de claves que contiene el certificado de cliente TLS/SSL.
• SSLClientCertPassword: La contraseña para el certificado de cliente TLS/SSL.
• SSLClientCertSubject: El asunto del certificado de cliente TLS/SSL.

Modelo de Datos¶

Descripción general

Esta sección muestra los objetos de API disponibles y brinda más información sobre cómo ejecutar SQL en las APIs de Jira Service Desk.

Características clave

• El conector modela entidades de Jira Service Desk como documentos, carpetas y grupos como vistas relacionales, lo que le permite escribir SQL para consultar los datos de Jira Service Desk.
• Procedimientos almacenados* le permiten ejecutar operaciones en Jira Service Desk
• La conectividad en vivo a estos objetos significa que cualquier cambio en su cuenta de Jira Service Desk se refleja de inmediato al usar el conector.

Mesas

Mesas describe las tablas disponibles. Las tablas se definen estáticamente para modelar las entidades de Jira Service Desk, como RequestApprovals, RequestComments y RequestParticipants.

Puntos de vista

Puntos de vista describe las vistas disponibles. Las vistas se definen estáticamente para modelar las entidades de Jira Service Desk, como Usuarios, Organizaciones y ServiceDesks.

Procedimientos almacenados

NOTE: Los procedimientos almacenados no se admiten actualmente. Consulte la nota anterior para detalles.

Procedimientos almacenados son interfaces similares a funciones para Jira Service Desk. Procedimientos almacenados* le permiten ejecutar operaciones en Jira Service Desk, incluida la descarga de documentos y el movimiento de sobres.

Procesamiento colaborativo de consultas

El conector descarga la mayor parte posible del procesamiento de la declaración SELECT a Jira Service Desk y luego procesa el resto de la consultar en la memoria. Las limitaciones y requisitos de API "también se documentan en esta sección.

Ver SupportEnhancedSQL para obtener más información sobre cómo el conector elude las limitaciones de la API con el procesamiento del lado del cliente en memoria.

Mesas¶

El conector modela los datos en Jira Service Desk en una lista de tablas que se pueden consultar mediante instrucciones SQL estándar.

Por lo general, consultar las tablas de Jira Service Desk es lo mismo que consultar una tabla en una base de datos relacional. A veces hay casos especiales, por ejemplo, incluir una determinada columna en la cláusula WHERE puede ser necesario para obtener datos para ciertas columnas de la tabla. Esto suele ser necesario para situaciones en las que se debe realizar una solicitud separada para cada fila para obtener ciertas columnas. Estos tipos de situaciones están claramente documentados en la parte superior de la página de la tabla vinculada a continuación.

Conector Jitterbit para Tablas de Jira Service Desk¶

Transiciones del Cliente¶

Devuelve una lista de transiciones que los clientes pueden realizar en la solicitud.

Seleccionar¶

El conector utilizará la API de Jira Service Desk para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• RequestID apoya el = operador.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM CustomerTransitions WHERE RequestID = '10001'

Columnas¶

Solicitud de Aprobaciones¶

Este recurso representa una aprobación de solicitud.

Seleccionar¶

Nota: Este recurso está marcado como EXPERIMENTAL y puede cambiar sin previo aviso.

El conector utilizará la API de Jira Service Desk para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• Id admite el siguiente operador: =.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM RequestApprovals WHERE RequestID = '10001' AND ID = '10002'

Columnas¶

SolicitudComentarios¶

Este recurso representa los comentarios de la solicitud.

Seleccionar¶

El conector utilizará la API de Jira Service Desk para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• Id, Public admite el siguiente operador: =.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM RequestComments WHERE RequestID = '10001' AND Id = '10002'
SELECT * FROM RequestComments WHERE RequestID = '10001' AND Public = 'true'

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Solicitar Participantes¶

Este recurso representa a los participantes de la solicitud.

Seleccionar¶

El conector utilizará la API de Jira Service Desk para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• RequestID apoya el = operador.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM RequestParticipants WHERE RequestID = '10001'

Columnas¶

Puntos de Vista¶

Las vistas se componen de columnas y pseudocolumnas. Las vistas son similares a las tablas en la forma en que se representan los datos; sin embargo, las vistas no admiten actualizaciones. Las entidades que se representan como vistas suelen ser entidades de solo lectura. A menudo, un procedimiento almacenado* está disponible para actualizar los datos si dicha funcionalidad es aplicable a la fuente de datos.

Las consultas se pueden ejecutar contra una vista como si fuera una tabla normal, y los datos que regresan son similares en ese sentido. Para obtener más información sobre las tablas y los procedimientos almacenados, vaya a sus entradas correspondientes en este documento de ayuda.

Conector Jitterbit para Vistas de Jira Service Desk¶

ClientesCloud¶

Este recurso representa un cliente.

Columnas¶

KnowledgeBaseArtículos¶

Los artículos que coinciden con la cadena de consultar dada en todas las mesas de servicio.

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Organizaciones¶

Este recurso representa una organización.

Seleccionar¶

Nota: Este recurso está marcado como EXPERIMENTAL y puede cambiar sin previo aviso.

Columnas¶

QueueInternal¶

Este recurso representa a un usuario.

Columnas¶

SolicitudesInternas¶

Este recurso representa una solicitud.

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

SolicitudSLACiclos¶

Este recurso representa los SLA (acuerdos de nivel de servicio) en una solicitud de cliente.

Columnas¶

RequestStatusChangelog¶

Este recurso representa las transiciones de estado de una solicitud de cliente.

Seleccionar¶

El conector utilizará la API de Jira Service Desk para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• RequestID apoya el = operador.
• RequestKey apoya el = operador.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM RequestStatusChangelog WHERE RequestID = '10001'
SELECT * FROM RequestStatusChangelog WHERE RequestKey = 'TEST-1'

Columnas¶

Campos de Tipo de Solicitud¶

Los campos para el tipo de solicitud de cliente de una mesa de servicio.

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

RequestTypeGroups¶

Este recurso representa un grupo de tipo de solicitud.

Seleccionar¶

El conector utilizará la API de Jira Service Desk para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• ServiceDeskId apoya el = operador.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM RequestTypeGroups WHERE ServiceDeskId = '1'

Nota: Este recurso está marcado como EXPERIMENTAL y puede cambiar sin previo aviso.

Columnas¶

Tipos de Solicitud¶

Este recurso representa un tipo de solicitud.

Seleccionar¶

El conector utilizará la API de Jira Service Desk para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• ServiceDeskId apoya el = operador.
• ID apoya el = operador.
• GroupIds apoya el = operador.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM RequestTypes WHERE ServiceDeskId = '1'
SELECT * FROM RequestTypes WHERE Id = '10012'
SELECT * FROM RequestTypes WHERE GroupIds = '12'

Columnas¶

Pseudo-Columnas¶

Los campos de pseudocolumna se utilizan en la cláusula WHERE de las declaraciones SELECT y ofrecen un control más granular sobre las tuplas que se devuelven desde la fuente de datos.

Mesas de Servicio¶

Este recurso representa una mesa de servicio. Una mesa de servicio se basa en un proyecto en la plataforma JIRA y se utiliza para gestionar las solicitudes de los clientes.

Seleccionar¶

El conector utilizará la API de Jira Service Desk para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El resto del filtro se ejecuta del lado del cliente dentro del conector.

• Id apoya el = operador.

Por ejemplo, la siguiente consultar se procesa del lado del servidor:

SELECT * FROM ServiceDesks WHERE ID = '1'

Columnas¶

Usuarios¶

Este recurso representa a un usuario.

Seleccionar¶

Nota: Este recurso está marcado como EXPERIMENTAL y puede cambiar sin previo aviso.

Columnas¶

Procedimientos Almacenados¶

Procedimientos almacenados* están disponibles para complementar los datos disponibles del Modelo de datos. Puede ser necesario actualizar los datos disponibles desde una vista usando un procedimiento almacenado* porque los datos no proporcionan actualizaciones bidireccionales directas, similares a tablas. En estas situaciones, la recuperación de los datos se realiza utilizando la vista o tabla adecuada, mientras que la actualización se realiza llamando a un procedimiento almacenado. Procedimientos almacenados* toman una lista de parámetros y devuelven un conjunto de datos que contiene la colección de tuplas que constituyen la respuesta.

Conector Jitterbit para Procedimientos Almacenados de Jira Service Desk¶

Añadir un Adjunto¶

Crea un archivo adjunto temporal o asigna uno temporal a una solicitud.

Aporte¶

Columnas del Conjunto de Resultados¶

Adjuntar Archivo Temporal¶

Este método agrega uno o más archivos adjuntos temporales a una mesa de servicio, que luego se pueden adjuntar permanentemente a una solicitud de cliente mediante el procedimiento almacenado AddAttachment.

Aporte¶

Columnas del Conjunto de Resultados¶

CreateCustomer¶

Crea un nuevo cliente.

Aporte¶

Columnas del Conjunto de Resultados¶

CrearEsquema¶

Crea un archivo de esquema para la tabla o vista especificada.

Aporte¶

Columnas del Conjunto de Resultados¶

Obtener Token de Acceso de OAuth¶

Obtiene un token de autenticación de JIRA.

Aporte¶

Columnas del Conjunto de Resultados¶

Obtener URL de Autorización de OAuth¶

Obtiene la URL de autorización que el usuario debe abrir por separado para otorgar acceso a su aplicación. Solo se necesita al desarrollar aplicaciones web. Solicitará el token de autenticación de esta URL.

Aporte¶

Columnas del Conjunto de Resultados¶

RefreshOAuthAccessToken¶

Actualiza el token de acceso de OAuth utilizado para la autenticación con JiraServiceDesk.

Aporte¶

Columnas del Conjunto de Resultados¶

Tablas del Sistema¶

Puede consultar las tablas del sistema que se describen en esta sección para acceder a la información del esquema, la información sobre la funcionalidad del origen de datos y las estadísticas de operación lote.

Tablas de Esquema¶

Las siguientes tablas devuelven metadatos de la base de datos para Jira Service Desk:

• sys_catalogs: enumera las bases de datos disponibles.
• sys_schemas: enumera los esquemas disponibles.
• sys_tablas: enumera las tablas y vistas disponibles.
• sys_tablecolumns: Describe las columnas de las tablas y vistas disponibles.
• procedimientos_sys: describe los procedimientos almacenados disponibles.
• parámetros_procedimiento_sys: Describe procedimiento almacenado* parámetros.
• sys_keycolumns: describe las claves principal y externa.
• índices_sys: Describe los índices disponibles.

Tablas de Fuentes de Datos¶

Las siguientes tablas devuelven información sobre cómo conectarse y consultar la fuente de datos:

• sys_connection_props: Devuelve información sobre las propiedades de conexión disponibles.
• sys_sqlinfo: describe las consultas SELECT que el conector puede descargar al origen de datos.

Tablas de Información de Consultas¶

La siguiente tabla devuelve estadísticas de consultar para consultas de modificación de datos:

• identidad_sys: devuelve información sobre operaciones lote o actualizaciones individuales.

Sys_catalogs¶

Enumera las bases de datos disponibles.

La siguiente consultar recupera todas las bases de datos determinadas por la cadena de conexión:

SELECT * FROM sys_catalogs

Columnas¶

Sys_schemas¶

Enumera los esquemas disponibles.

La siguiente consultar recupera todos los esquemas disponibles:

SELECT * FROM sys_schemas

Columnas¶

Sys_tables¶

Enumera las tablas disponibles.

La siguiente consultar recupera las tablas y vistas disponibles:

SELECT * FROM sys_tables

Columnas¶

Sys_tablecolumns¶

Describe las columnas de las tablas y vistas disponibles.

La siguiente consultar devuelve las columnas y los tipos de datos de la tabla Solicitudes:

SELECT ColumnName, DataTypeName FROM sys_tablecolumns WHERE TableName='Requests' 

Columnas¶

Sys_procedimientos¶

Enumera los procedimientos almacenados disponibles.

La siguiente consultar recupera los procedimientos almacenados disponibles:

SELECT * FROM sys_procedures

Columnas¶

Sys_procedureparameters¶

Describe procedimiento almacenado* parámetros.

La siguiente consultar devuelve información sobre todos los parámetros de entrada para el procedimiento almacenado SampleProcedure:

SELECT * FROM sys_procedureparameters WHERE ProcedureName='SampleProcedure' AND Direction=1 OR Direction=2

Columnas¶

Sys_keycolumns¶

Describe las claves primarias y foráneas. La siguiente consultar recupera la clave principal de la tabla Solicitudes:

SELECT * FROM sys_keycolumns WHERE IsKey='True' AND TableName='Requests'

Columnas¶

Sys_foreignkeys¶

Describe las claves foráneas. La siguiente consultar recupera todas las claves foráneas que hacen referencia a otras tablas:

SELECT * FROM sys_foreignkeys WHERE ForeignKeyType = 'FOREIGNKEY_TYPE_IMPORT'

Columnas¶

Sys_indexes¶

Describe los índices disponibles. Al filtrar en los índices, puede escribir consultas más selectivas con tiempos de respuesta de consultar más rápidos.

La siguiente consultar recupera todos los índices que no son claves principales:

SELECT * FROM sys_indexes WHERE IsPrimary='false'

Columnas¶

Sys_connection_props¶

Devuelve información sobre las propiedades de conexión disponibles y las establecidas en la cadena de conexión.

Al consultar esta tabla, se debe usar la cadena de conexión de configuración:

jdbc:cdata:jiraservicedesk:config:

Esta cadena de conexión le permite consultar esta tabla sin una conexión válida.

La siguiente consultar recupera todas las propiedades de conexión que se han establecido en la cadena de conexión o se han establecido a través de un valor predeterminado:

SELECT * FROM sys_connection_props WHERE Value <> ''

Columnas¶

Sys_sqlinfo¶

Describe el procesamiento de consultar SELECT que el conector puede descargar al origen de datos.

Procesamiento Colaborativo de Consultas¶

Al trabajar con fuentes de datos que no admiten SQL-92, puede consultar la vista sys_sqlinfo para determinar las capacidades de consultar de las APIs subyacentes, expresadas en sintaxis SQL. El conector descarga la mayor cantidad posible del procesamiento de sentencias SELECT al servidor y luego procesa el resto de la consultar en la memoria.

Descubrimiento de las Capacidades SELECT de la Fuente de Datos¶

A continuación se muestra un conjunto de datos de ejemplo de las capacidades de SQL. El siguiente conjunto de resultados indica la funcionalidad SELECT que el conector puede descargar en el origen de datos o en el lado del cliente del proceso. Su fuente de datos puede admitir sintaxis SQL adicional. Algunos aspectos de la funcionalidad SELECT se devuelven en una lista separada por comas si es compatible; de lo contrario, la columna contiene NO.

La siguiente consultar recupera los operadores que se pueden usar en la cláusula WHERE:

SELECT * FROM sys_sqlinfo WHERE Name='SUPPORTED_OPERATORS'

Tenga en cuenta que las tablas individuales pueden tener diferentes limitaciones o requisitos en la cláusula WHERE; consulte el Modelo de datos para obtener más información.

Columnas¶

Sys_identidad¶

Devuelve información sobre los intentos de modificación.

La siguiente consultar recupera los Id. de las filas modificadas en una operación lote:

SELECT * FROM sys_identity

Columnas¶

Propiedades de Configuraciones Avanzadas¶

Las propiedades de configuraciones avanzadas son las diversas opciones que se pueden utilizar para establecer una conexión. Esta sección proporciona una lista completa de las opciones que puede configurar. Haga clic en los enlaces para obtener más detalles.

Autenticación

SSO

OAuth

SSL

Esquema

Misceláneas

Autenticación¶

Esta sección proporciona una lista completa de las propiedades de autenticación que puede configurar.

AuthScheme¶

El tipo de autenticación que se utilizará al conectarse a Jira Service Desk.

Valores Posibles¶

Auto, OAuth, Basic, Crowd

Tipo de Datos¶

string

Valor por Defecto¶

"Auto"

Observaciones¶

• Automático: permite que el controlador decida automáticamente según las otras propiedades de conexión que haya establecido.
• OAuth: Establézcalo para realizar la autenticación OAuth.
• Básico: configure esto para usar usuario/contraseña BÁSICO o usuario/autenticación ApiToken.
• Multitud: configure esto para realizar la autenticación SSO de multitud.

URL¶

La URL de su extremo de JIRA Service Desk.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

La URL de su extremo de JIRA Service Desk; Por ejemplo, https://yoursitename.atlassian.net.

Usuario¶

La cuenta de usuario de Jira Service Desk utilizada para la autenticación.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Junto con Contraseña, este campo se usa para autenticarse en el servidor de Jira Service Desk.

Contraseña¶

La contraseña utilizada para autenticar al usuario.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El usuario y Password se usan juntos para autenticarse con el servidor.

APIToken¶

APIToken del usuario actualmente autenticado.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

APIToken del usuario actualmente autenticado. Puede recuperar un token API en este enlace: https://id.atlassian.com/manage/api-tokens

Inicio de Sesión Único¶

Esta sección proporciona una lista completa de las propiedades de SSO que puede configurar.

SSOloginURL¶

La URL de inicio de sesión del proveedor de identidad.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

La URL de inicio de sesión del proveedor de identidad.

Propiedades de SSO¶

Se requieren propiedades adicionales para conectarse al proveedor de identidad en una lista separada por punto y coma.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Se requieren propiedades adicionales para conectarse al proveedor de identidad en una lista separada por punto y coma. se usa junto con SSOLOginURL.

La configuración de SSO se trata con más detalle en.

SSOExchangeUrl¶

La URL utilizada para consumir la respuesta SAML e intercambiarla con credenciales específicas de Jira Service Desk.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El conector de Jitterbit para Jira Service Desk utilizará la URL especificada aquí para consumir una respuesta SAML y recuperar las credenciales específicas de Jira Service Desk. Las credenciales recuperadas son la pieza final durante la conexión SSO que se utilizan para comunicarse con Jira Service Desk.

SSOAppName¶

Nombre de aplicación utilizado con SSO para IdP que lo requieran.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Junto con SSOAppPassword, se puede especificar para identificar y autenticar su aplicación configurada en el SSO IdP. Actualmente solo Crowd lo admite.

Contraseña de SSOApp¶

Contraseña de aplicación utilizada con SSO para IdP que lo requieran.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Junto con SSOAppName, se puede especificar para identificar y autenticar su aplicación configurada en el SSO IdP. Actualmente solo Crowd lo admite.

OAuth¶

Esta sección proporciona una lista completa de las propiedades de OAuth que puede configurar.

Iniciar OAuth¶

Establezca esta propiedad para iniciar el proceso para obtener o actualizar el token de acceso de OAuth cuando se conecte.

Valores Posibles¶

OFF, GETANDREFRESH, REFRESH

Tipo de Datos¶

string

Valor por Defecto¶

"OFF"

Observaciones¶

Las siguientes opciones están disponibles:

1. OFF: Indica que el flujo de OAuth será manejado en su totalidad por el usuario. Se requerirá un OAuthAccessToken para la autenticación.
2. GETANDREFRESH: indica que el conector manejará todo el flujo de OAuth. Si actualmente no existe ningún token, se obtendrá solicitándolo al usuario a través del navegador. Si existe un token, se actualizará cuando corresponda.
3. REFRESH: indica que el conector solo manejará la actualización de OAuthAccessToken. El conector nunca le pedirá al usuario que se autentique a través del navegador. El usuario debe manejar la obtención de OAuthAccessToken y OAuthRefreshToken inicialmente.

Versión OAuth¶

La versión de OAuth que se está utilizando.

Valores Posibles¶

1.0, 2.0

Tipo de Datos¶

string

Valor por Defecto¶

"1.0"

Observaciones¶

La versión de OAuth que se está utilizando. Están disponibles las siguientes opciones: 1.0,2.0

OAuthClientId¶

El ID de cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId valor, a veces también llamado clave de consumidor, y un secreto de cliente, el OAuthClientSecret.

OAuthClientSecretOAuthClientSecret¶

El secreto del cliente asignado cuando registra su aplicación con un servidor de autorización de OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Como parte del registro de una aplicación OAuth, recibirá el OAuthClientId, también denominada clave de consumidor. También recibirá un secreto de cliente, también llamado secreto de consumidor. Establezca el secreto del cliente en OAuthClientSecret propiedad.

Token de Acceso de OAuth¶

El token de acceso para conectarse mediante OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El OAuthAccessToken la propiedad se usa para conectarse usando OAuth. El OAuthAccessToken se recupera del servidor OAuth como parte del proceso de autenticación. Tiene un tiempo de espera dependiente del servidor y se puede reutilizar entre solicitudes.

El token de acceso se utiliza en lugar de su nombre de usuario y contraseña. El token de acceso protege sus credenciales manteniéndolas en el servidor.

Alcance¶

Esto determina los alcances que la aplicación OAuth solicita a Jira Service Desk.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Especifique el ámbito para obtener el acceso inicial y el token de actualización.

De forma predeterminada, el conector solicitará que el usuario autorice todos los ámbitos disponibles. Si desea anular esto, puede establecer esta propiedad en una lista separada por espacios de ámbitos de OAuth.

ID de la Nube¶

El Cloud ID para el sitio de Atlassian que fue autorizado.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Esto se determinará automáticamente durante la autenticación OAuth 2.0 y se devolverá desde GetOAuthAccessToken procedimiento almacenado. No establezca un valor para CloudId cuando use InitiateOAuth.

OAuthVerifier¶

El código verificador devuelto desde la URL de autorización de OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El código verificador devuelto desde la URL de autorización de OAuth. Esto se puede usar en sistemas en los que no se puede iniciar un navegador, como los sistemas sin cabeza.

Autenticación en Máquinas Sin Cabeza¶

Ver para obtener el OAuthVerifier valor.

Establezca OAuthSettingsLocation junto con OAuthVerifier. Cuando se conecta, el conector intercambia el OAuthVerifier para los tokens de autenticación de OAuth y los guarda, encriptados, en el archivo especificado. Establecer Iniciar OAuth para GETANDREFRESH automatizar el intercambio.

Una vez que se haya generado el archivo de configuración de OAuth, puede eliminar OAuthVerifier desde las propiedades de conexión y conéctese con OAuthSettingsLocation colocar.

Para actualizar automáticamente los valores del token de OAuth, establezca OAuthSettingsLocation y además configure InitiateOAuth refrescar.

Token de Autenticación¶

El token de autenticación utilizado para solicitar y obtener el token de acceso de OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Esta propiedad solo es necesaria cuando se realiza la autenticación sin interfaz en OAuth 1.0. Se puede obtener del procedimiento almacenado GetOAuthAuthorizationUrl.

Se puede proporcionar junto con AuthKey en GetOAuthAccessToken procedimiento almacenado* para obtener el OAuthAccessToken.

Clave de Autenticación¶

El secreto de autenticación utilizado para solicitar y obtener el token de acceso de OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Esta propiedad solo es necesaria cuando se realiza la autenticación sin interfaz en OAuth 1.0. Se puede obtener del procedimiento almacenado GetOAuthAuthorizationUrl.

Se puede suministrar junto con AuthToken en GetOAuthAccessToken procedimiento almacenado* para obtener el OAuthAccessToken.

OAuthRefreshToken¶

El token de actualización de OAuth para el token de acceso de OAuth correspondiente.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El OAuthRefreshToken la propiedad se usa para actualizar el OAuthAccessToken al usar la autenticación OAuth.

OAuthExpiresIn¶

La vida útil en segundos del AccessToken de OAuth.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Empareje con OAuthTokenTimestamp para determinar cuándo caducará el AccessToken.

OAuthTokenTimestamp¶

La marca de tiempo de la época de Unix en milisegundos cuando se creó el token de acceso actual.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Emparéjese con OAuthExpiresIn para determinar cuándo expirará AccessToken.

CertificateStoreType¶

El tipo de almacén de certificados utilizado con la autenticación de la aplicación privada de Jira Service Desk.

Valores Posibles¶

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_BLOB, P10BFILE, SSHPUBLIC_KEY_FILE, PPKFILE, XMLFILE, XMLBLOB

Tipo de Datos¶

string

Valor por Defecto¶

"USER"

Observaciones¶

El nombre del almacén de certificados para el certificado de cliente utilizado en la autenticación de aplicaciones privadas de Jira Service Desk. La autenticación de aplicaciones privadas de Jira Service Desk utiliza la autenticación de cliente SSL con certificados digitales.

Especificación del Tipo de Almacén de Certificados¶

El CertificateStoreType la propiedad puede tomar uno de los siguientes valores:

Propiedades de Conexión Relacionadas¶

Para especificar el certificado privado, es posible que deba establecer las siguientes propiedades además de CertificateStoreType:

• Tienda de certificados: establezca esto en el nombre del almacén de certificados. Por ejemplo, "MI" para un almacén de certificados de Windows o el nombre de archivo de un almacén de archivos.
• Contraseña del almacén del certificado: si la tienda está protegida con contraseña, proporcione la contraseña aquí.
• Asunto del certificado: establezca esto en el asunto del certificado. Para ubicar el certificado en el almacén, el conector ejecuta una búsqueda basada en el asunto especificado. Consulte el Asunto del certificado campo para más detalles.

Tienda de Certificados¶

El almacén de certificados utilizado para la autenticación de JIRA Service Desk.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

La ubicación del almacén de certificados para el certificado de cliente utilizado en la autenticación de la aplicación Jira Service Desk.

CertificadoAlmacenarContraseña¶

La contraseña del almacén de certificados que se usa con la autenticación de Jira Service Desk.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Si el almacén de certificados es de un tipo que requiere una contraseña, esta propiedad se usa para especificar esa contraseña para abrir el almacén de certificados.

CertificadoAsunto¶

El asunto del certificado utilizado con la autenticación de la aplicación privada de Jira Service Desk.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El asunto del certificado de cliente utilizado en la autenticación de aplicaciones privadas de Jira Service Desk.

Acerca del Flujo de Autenticación SSL del Cliente de Jira Service Desk¶

La autenticación de aplicaciones privadas de Jira Service Desk utiliza la autenticación de cliente SSL con certificados digitales.

Cargando un Certificado¶

Al cargar un certificado, el asunto se utiliza para ubicar el certificado en el almacén.

• Si no se encuentra una coincidencia exacta, se busca en la tienda temas que contengan el valor de la propiedad.
• Si aún no se encuentra una coincidencia, no se selecciona ningún certificado.
• El valor especial "*" selecciona el primer certificado en el almacén de certificados.

Especificación del Tema¶

El asunto del certificado es una lista separada por comas de valores y campos de nombre distinguido. Por ejemplo, "CN=www.server.com, OU=test, C=US, E=support@jitterbit.com". Los campos comunes y sus significados se muestran a continuación.

Nota: Si un valor de campo contiene una coma, debe estar entre comillas.

Propiedades de Conexión Adicionales¶

Para especificar el certificado privado, debe configurar CertificateSubject y las siguientes propiedades adicionales:

• Tienda de certificados
• CertificateStoreType
• Contraseña del almacén del certificado

SSL¶

Esta sección proporciona una lista completa de las propiedades SSL que puede configurar.

SSLClientCert¶

El almacén de certificados de cliente TLS/SSL para la autenticación de cliente SSL (SSL bidireccional).

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

El nombre del almacén de certificados para el certificado de cliente.

El SSLClientCertType especifica el tipo de almacén de certificados especificado por SSLClientCert. Si la tienda está protegida con contraseña, especifique la contraseña en SSLClientCertPassword.

SSLClientCert se usa junto con SSLClientCertSubject para especificar certificados de cliente. Si SSLClientCert tiene un valor y SSLClientCertSubject, se inicia una búsqueda de un certificado. Vea SSLClientCertSubject para más información.

Las designaciones de los almacenes de certificados dependen de la plataforma.

Las siguientes son designaciones de los almacenes de certificados de usuario y máquina más comunes en Windows:

En Java, el almacén de certificados normalmente es un archivo que contiene certificados y claves privadas opcionales.

Cuando el tipo de almacén de certificados es PFXFile, esta propiedad debe establecerse en el nombre del archivo. Cuando el tipo es PFXBlob, la propiedad debe establecerse en el contenido binario de un archivo PFX (por ejemplo, almacén de certificados PKCS12).

SSLClientCertType¶

El tipo de almacén de claves que contiene el certificado de cliente TLS/SSL.

Valores Posibles¶

USER, MACHINE, PFXFILE, PFXBLOB, JKSFILE, JKSBLOB, PEMKEY_FILE, PEMKEY_BLOB, PUBLIC_KEY_FILE, PUBLIC_KEY_BLOB, SSHPUBLIC_KEY_FILE, SSHPUBLIC_KEY_BLOB, P7BFILE, PPKFILE, XMLFILE, XMLBLOB

Tipo de Datos¶

string

Valor por Defecto¶

"USER"

Observaciones¶

Esta propiedad puede tomar uno de los siguientes valores:

SSLClientCertPassword¶

La contraseña para el certificado de cliente TLS/SSL.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Si el almacén de certificados es de un tipo que requiere una contraseña, esta propiedad se utiliza para especificar esa contraseña para abrir el almacén de certificados.

SSLClientCertSubject¶

El asunto del certificado de cliente TLS/SSL.

Tipo de Datos¶

string

Valor por Defecto¶

"\*"

Observaciones¶

Al cargar un certificado, el asunto se utiliza para ubicar el certificado en el almacén.

Si no se encuentra una coincidencia exacta, se busca en la tienda temas que contengan el valor de la propiedad. Si aún no se encuentra una coincidencia, la propiedad se establece en una cadena vacía y no se selecciona ningún certificado.

El valor especial "*" selecciona el primer certificado en el almacén de certificados.

El asunto del certificado es una lista separada por comas de valores y campos de nombre distinguido. Por ejemplo, "CN=www.server.com, OU=test, C=US, E=support@company.com". Los campos comunes y sus significados se muestran a continuación.

Si un valor de campo contiene una coma, debe estar entre comillas.

SSLServerCert¶

El certificado que se aceptará del servidor al conectarse mediante TLS/SSL.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Si usa una conexión TLS/SSL, esta propiedad se puede usar para especificar el certificado TLS/SSL que se aceptará del servidor. Se rechaza cualquier otro certificado que no sea de confianza para la máquina.

Esta propiedad puede tomar las siguientes formas:

Si no se especifica, se acepta cualquier certificado en el que confíe la máquina.

La máquina valida los certificados como confiables según el almacén de confianza del sistema. El almacén de confianza utilizado es el valor 'javax.net.ssl.trustStore' especificado para el sistema. Si no se especifica ningún valor para esta propiedad, se utiliza el almacén de confianza predeterminado de Java (por ejemplo, JAVA_HOME\lib\security\cacerts).

Use '*' para indicar que acepta todos los certificados. Tenga en cuenta que esto no se recomienda debido a problemas de seguridad.

Esquema¶

Esta sección proporciona una lista completa de propiedades de esquema que puede configurar.

Ubicación¶

Una ruta al directorio que contiene los archivos de esquema que definen tablas, vistas y procedimientos almacenados.

Tipo de Datos¶

string

Valor por Defecto¶

"%APPDATA%\\\JiraServiceDesk Data Provider\\Schema"

Observaciones¶

La ruta a un directorio que contiene los archivos de esquema para el conector (archivos .rsd para tablas y vistas, archivos .rsb para procedimientos almacenados). La ubicación de la carpeta puede ser una ruta relativa desde la ubicación del ejecutable. El Location La propiedad solo es necesaria si desea personalizar las definiciones (por ejemplo, cambiar el nombre de una columna, ignorar una columna, etc.) o ampliar el modelo de datos con nuevas tablas, vistas o procedimientos almacenados.

Si no se especifica, la ubicación predeterminada es "%APPDATA%\\JiraServiceDesk Data Provider\Schema" con %APPDATA% estando configurado en el directorio de configuración del usuario:

Esquemas Navegables¶

Esta propiedad restringe los esquemas informados a un subconjunto de los esquemas disponibles. Por ejemplo, BrowsableSchemas=SchemaA,SchemaB,SchemaC.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Enumerar los esquemas de las bases de datos puede resultar costoso. Proporcionar una lista de esquemas en la cadena de conexión mejora el rendimiento.

Mesas¶

Esta propiedad restringe las tablas notificadas a un subconjunto de las tablas disponibles. Por ejemplo, Tablas=TablaA,TablaB,TablaC.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Listar las tablas de algunas bases de datos puede resultar costoso. Proporcionar una lista de tablas en la cadena de conexión mejora el rendimiento del conector.

Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.

Especifique las tablas que desea en una lista separada por comas. Cada tabla debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Tables=TableA,[TableB/WithSlash],WithCatalog.WithSchema.`TableC With Space`.

Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.

Puntos de Vista¶

Restringe las vistas informadas a un subconjunto de las tablas disponibles. Por ejemplo, Vistas=VistaA,VistaB,VistaC.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Listar las vistas de algunas bases de datos puede ser costoso. Proporcionar una lista de vistas en la cadena de conexión mejora el rendimiento del conector.

Esta propiedad también se puede utilizar como una alternativa a la lista automática de vistas si ya sabe con cuáles quiere trabajar y, de lo contrario, habría demasiadas para trabajar.

Especifique las vistas que desee en una lista separada por comas. Cada vista debe ser un identificador SQL válido con cualquier carácter especial escapado usando corchetes, comillas dobles o acentos graves. Por ejemplo, Views=ViewA,[ViewB/WithSlash],WithCatalog.WithSchema.`ViewC With Space`.

Tenga en cuenta que al conectarse a una fuente de datos con varios esquemas o catálogos, deberá proporcionar el nombre completo de la tabla en esta propiedad, como en el último ejemplo aquí, para evitar la ambigüedad entre las tablas que existen en varios catálogos o esquemas.

Misceláneas¶

Esta sección proporciona una lista completa de propiedades misceláneas que puede configurar.

Incluir Campos Personalizados¶

Un valor booleano que indica si desea incluir campos personalizados en la lista de columnas.

Tipo de Datos¶

bool

Valor por Defecto¶

false

Observaciones¶

Establecer esto en verdadero hará que los campos personalizados se incluyan en la lista de columnas. Para incluir los campos personalizados, debemos realizar una solicitud individualizada por campo personalizado y esto puede causar un rendimiento deficiente al enumerar los metadatos.

Filas Máximas¶

Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.

Tipo de Datos¶

int

Valor por Defecto¶

-1

Observaciones¶

Limita el número de filas devueltas cuando no se usa agregación o agrupación en la consultar. Esto ayuda a evitar problemas de rendimiento en el momento del diseño.

Otro¶

Estas propiedades ocultas se usan solo en casos de uso específicos.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Las propiedades enumeradas a continuación están disponibles para casos de uso específicos. Los casos de uso y la funcionalidad normales del controlador no deberían requerir estas propiedades.

Especifique varias propiedades en una lista separada por punto y coma.

Integración y Formateo¶

Pseudocolumnas¶

Esta propiedad indica si incluir o no pseudocolumnas como columnas en la tabla.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Esta configuración es particularmente útil en Entity Framework, que no le permite establecer un valor para una pseudocolumna a menos que sea una columna de tabla. El valor de esta configuración de conexión tiene el formato "Tabla1=Columna1, Tabla1=Columna2, Tabla2=Columna3". Puede usar el carácter "*" para incluir todas las tablas y todas las columnas; por ejemplo, "*=*".

SolicitarIdioma¶

Utilice requestLanguage para que los nombres de las columnas se traduzcan en un idioma específico.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Utilice requestLanguage para que los nombres de las columnas se traduzcan en un idioma específico. De forma predeterminada, los nombres de las columnas se traducen en función de la preferencia de idioma del usuario solicitante o del idioma predeterminado del sitio de Jira si es anónimo. Los idiomas disponibles se basan en los idiomas instalados en Jira. Proporcione una etiqueta de idioma IETF BCP 47 como se describe en este enlace: https://tools.ietf.org/html/bcp47.

ServiceDeskID¶

Id. de Service Desk del usuario autenticado actualmente.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Id. de Service Desk del usuario autenticado actualmente. De forma predeterminada, obtenemos la primera ID devuelta de una llamada adicional para obtener todos los servicios de atención al cliente. Puede obtener el ServiceDeskId ejecutando una consultar Select en la vista ServiceDesks.

Se Acabó el Tiempo¶

El valor en segundos hasta que se lanza el error de tiempo de espera, cancelando la operación.

Tipo de Datos¶

int

Valor por Defecto¶

60

Observaciones¶

Si Timeout = 0, las operaciones no expiran. Las operaciones se ejecutan hasta que se completan correctamente o hasta que encuentran una condición de error.

Si Timeout caduca y la operación aún no se ha completado, el conector genera una excepción.