Detalles de Conexión SAP Fieldglass¶

Introducción¶

Versión del conector

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

Empezando¶

Compatibilidad con la versión SAP Fieldglass

El conector aprovecha la API de SAPFieldglass para habilitar el acceso bidireccional a SAPFieldglass.

Establecer una Conexión¶

Conexión a SAP Fieldglass¶

Para autenticarse, deberá especificar el User, Password, APIKey, y EnvironmentURL propiedades de conexión.

Para obtener un APIKey, inicie sesión en SAP API Business Hub y haga clic en Obtener clave de API.

Notas Importantes¶

Procedimientos Almacenados¶

• Las funciones de procedimientos almacenados descritas en esta documentación no se admiten actualmente.
• Debido a que los procedimientos almacenados no se admiten actualmente, cualquier característica que dependa de los procedimientos almacenados tampoco se admite actualmente.

Archivos de Configuración y Sus Rutas¶

• Todas las referencias a la adición de archivos de configuración y sus rutas se refieren a archivos y ubicaciones en Harmony Agente donde está instalado el conector. Estas rutas deben ajustarse según corresponda según el agente y el sistema operativo. Si se utilizan varios agentes en un grupo de agentes, se requerirán archivos idénticos en cada agente.

Características Avanzadas¶

Esta sección detalla una selección de funciones avanzadas del conector SAP Fieldglass.

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 SAP Fieldglass le permite definir una tabla virtual cuyos contenidos se deciden 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 Usando 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 AuditTrails 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.

Modelo de Datos¶

Jitterbit Connector for SAP Fieldglass modela los objetos de SAP Fieldglass como tablas y vistas relacionales. Un objeto de SAP Fieldglass tiene relaciones con otros objetos; en las tablas, estas relaciones se expresan a través de claves foráneas. Las siguientes secciones muestran los objetos de API disponibles y brindan más información sobre cómo ejecutar SQL para las APIs de SAP Fieldglass.

Los esquemas para la mayoría de los objetos de la base de datos se definen en archivos de configuración simples basados en texto.

El conector descarga la mayor parte posible del procesamiento de sentencias SELECT a las APIs de SAP Fieldglass y luego procesa el resto de la consultar en la memoria. 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. Puede desactivar la ejecución del lado del cliente configurando SupportEnhancedSQL a falso, en cuyo caso cualquier criterio de búsqueda que se refiera a otras columnas dará como resultado que se envíen datos sin filtrar.

Selección de Informes en SAP Fieldglass¶

El conector ofrece la posibilidad de seleccionar informes como vistas relacionales.

Selección de Datos de Sus Informes¶

Para acceder a los datos de sus informes, consultar una vista con el nombre de los informes. Todas las vistas posibles se pueden ver usando el sys_views tabla del sistema.

SELECT * FROM [Job Posting Report 1]

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 SAP Fieldglass Views¶

Aprobaciones¶

Consulte esta tabla para aprobaciones en SAPFieldglass.

Ver Información Específica¶

El conector utilizará la API de SAP Fieldglass para procesar las condiciones de la cláusula WHERE creadas con las siguientes columnas y operadores. El criterio de filtro restante se ejecuta en el lado del cliente dentro del conector.

• ModuleId apoya el = operador.
• WorkItemId admite el operador '='. Esto debe usarse junto con ModuleId.

Por ejemplo, las siguientes consultas se procesan en el lado del servidor:

SELECT * FROM Approvals WHERE ModuleId='70'
SELECT * FROM Approvals WHERE ModuleId='70' AND WorkItemId='300'

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.

Pistas de Auditoría¶

Consulte esta tabla para registros de auditoría en SAPFieldglass.

Ver Información Específica¶

El conector utilizará la API de SAP Fieldglass para procesar las condiciones de la cláusula WHERE creadas con la siguiente columna y operador. El criterio de filtro restante se ejecuta en el lado del cliente dentro del conector.

• Status apoya el = operador.

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

SELECT * FROM AuditTrails WHERE Status='OK'

Columnas¶

RechazarRazones¶

Consulte esta tabla por motivos de rechazo en SAPFieldglass.

Ver Información Específica¶

El conector utilizará la API de SAP Fieldglass para procesar las condiciones de la cláusula WHERE creadas con la siguiente columna y operador. El criterio de filtro restante se ejecuta en el lado del cliente dentro del conector.

• ModuleId apoya el = operador.

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

SELECT * FROM RejectReasons WHERE ModuleId='70'

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 SAP Fieldglass¶

Modificar Elemento¶

Aprobar o rechazar un artículo.

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 SAP Fieldglass:

• 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 Consulta¶

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 AuditTrails:

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

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 AuditTrails:

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

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:sapfieldglass: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

SSL

Esquema

Misceláneas

Autenticación¶

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

URL del Ambiente¶

La URL del ambiente donde se encuentra la instancia de SAP Fieldglass.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

La URL del ambiente donde se encuentra la instancia de SAP Fieldglass.

Usuario¶

La cuenta de usuario de SAP Fieldglass utilizada para la autenticación.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

Junto con Contraseña, este campo se utiliza para autenticarse en el servidor SAP Fieldglass.

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.

Clave API¶

La clave API utilizada para autenticarse en SAP Fieldglass.

Tipo de Datos¶

string

Valor por Defecto¶

""

Observaciones¶

La clave API utilizada para autenticarse en SAP Fieldglass.

SSL¶

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

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%\\\SAPFieldglass 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%\\SAPFieldglass 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.

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, "*=*".

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.

UsarNombresSimples¶

Booleano que determina si se deben usar nombres simples para tablas y columnas.

Tipo de Datos¶

bool

Valor por Defecto¶

false

Observaciones¶

Las tablas y columnas de SAP Fieldglass pueden usar caracteres especiales en los nombres que normalmente no están permitidos en las bases de datos estándar. UseSimpleNames hace que el conector sea más fácil de usar con las herramientas de bases de datos tradicionales.

Configuración UseSimpleNames a verdadero simplificará los nombres de las tablas y columnas devueltas. Aplicará un esquema de nomenclatura tal que solo los caracteres alfanuméricos y el guión bajo sean válidos para los nombres de las tablas y columnas que se muestran. Cualquier carácter no alfanumérico se convertirá en un guión bajo.