¶ 1. Visión General
El Client Gateway es un ejecutable creado por T6 Planning para ser instalado en el entorno del cliente. A través de él, las tareas de carga de datos remotos son posibles. Funciona como un intermediario entre el servidor y el cliente, buscando datos de acuerdo con la configuración proporcionada por el servidor y devolviendo los datos solicitados.
¶ 2. Instalación
El Client Gateway está disponible para los sistemas operativos Windows y Linux. Instálelo de acuerdo con su sistema operativo. No es necesario instalar otros paquetes como requisitos.
El Client Gateway es una aplicación que se ejecutará en segundo fondo en el terminal. Para finalizar la aplicación, simplemente cambie a la ventana donde se está ejecutando y envíe el comando CTRL+C.
¶ 2.1. Requisitos Previos
Antes de comenzar la instalación, es necesario descargar el archivo del Client Gateway correspondiente a su sistema operativo Linux o Windows. Sin embargo, es imprescindible que el SO sea compatible con uno de los cifrados TLS 1.2 o 1.3 utilizados por T6 Planning:
Para que ClientGateway para v12.0 funcione correctamente, debe instalar el paquete de tiempo de ejecución y hospedaje de .NET Core 8.0 para Windows (v8.0.0). Para obtener más información sobre los requisitos previos para la versión 12.0, vaya a Guía de instalación - v12.0.
Client Gateway para la versión v12.0:
Client Gateway para la versión v12.1:
Client Gateway para la versión v12.2:
Client Gateway para la versión v12.3:
TLS 1.2:
- TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256 (0xc02f) ECDH x25519 (eq. 3072 bits RSA) FS;
- TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384 (0xc030) ECDH x25519 (eq. 3072 bits RSA) FS;
- TLS_ECDHE_RSA_WITH_CHACHA20_POLY1305_SHA256 (0xcca8) ECDH x25519 (eq. 3072 bits RSA) FS.
TLS 1.3:
- TLS_AES_256_GCM_SHA384 (0x1302) ECDH x25519 (eq. 3072 bits RSA) FS;
- TLS_CHACHA20_POLY1305_SHA256 (0x1303) ECDH x25519 (eq. 3072 bits RSA) FS;
- TLS_AES_128_GCM_SHA256 (0x1301) ECDH x25519 (eq. 3072 bits RSA) FS.
Es necesario realizar la liberación del firewall para el puerto 443.
¶ 3. Configuración
En la carpeta descomprimida, donde se encuentran los archivos del Client Gateway, busque el archivo appsettings.json. Ábralo en un editor de texto, preferiblemente uno que lea archivos JSON.
A continuación se muestra una imagen que enmarca todos los parámetros que actualmente se encuentran en el Client Gateway, basándose en la versión utilizada en este manual.
{
"DataLoadGatewayConfig": {
"LogFile": "ppGateway.log",
"HealthFile": "ppHealth.log",
"HealthInterval": 20,
"Url": "http://localhost/Sysphera/dataloadhub",
"Key": "",
"Issuer": "https://sysphera.com/dataloadhub/issuer",
"Audience": "https://sysphera.com/dataloadhub/audience",
"ClientId": "",
"DataSources": [
{
"DataSourceName": "",
"DataSourceType": "",
"StringConnection": ""
},
]
}
}
¶ Descripción de los parámetros:
- LogFile: Ingrese aquí un nombre para el archivo de registro. En este archivo se registrará información recurrente del Client Gateway;
- HealthFile: Ingrese aquí el nombre del archivo que se utilizará para el chequeo de salud (realiza verificaciones regulares de seguridad, rendimiento e integridad de los datos);
Tanto
LogFilecomoHealthFileaceptan rutas completas donde se espera que se guarden los archivos. Sin embargo, también se aceptan rutas relativas y, en este caso, se considerará la carpeta desde donde se llamó al Client Gateway para formar la ruta absoluta.
- HealthInterval: Intervalo entre chequeos de salud. Parámetro opcional con un valor predeterminado de 20 (minutos).
- Url: Ingrese aquí la URL de la aplicación T6, terminando con
/dataloadhub/. Este parámetro informa dónde se encuentra la parte que está en el servidor, con la cual el Client Gateway se comunicará.
Tenemos 3 parámetros que no necesitan ser modificados:
- Key: el valor de esta clave será proporcionado por el equipo de implementación;
- Issuer: https://Sysphera.com/dataloadhub/issuer;
- Audience: https://Sysphera.com/dataloadhub/audience;
Para los próximos parámetros, necesitaremos acceder a T6 y crear un objeto del tipo Carga de Datos Remota.
- ClientId: Ingresaremos el código generado al guardar el objeto del tipo Carga de Datos Remota;
- DataSources: Cada datasource tiene 3 informaciones que deben completarse de acuerdo con los valores utilizados en la creación de la Carga de Datos Remota. Son:
- DataSourceName: ” ” (Es el nombre de la base de datos que tenemos en la base de datos.)
- DataSourceType: “ ” (Es el nombre agregado al crear la Carga de Datos)
- StringConnection: ” ” (Podemos obtener referencias de connectionstring en el sitio https://www.connectionstrings.com/)
Podemos tener varios datasources. Simplemente agréguelos al archivo respetando el formato JSON.
Podemos conectarnos a través de SQLserver, Oracle, REST, MySQL, Postgree y ODBC.
Para obtener los datos para completar los parámetros mencionados anteriormente, necesitaremos seguir los siguientes pasos:
- Después de iniciar sesión en T6, vaya al menú principal y acceda a Explorer;
- En la página del explorer, en la ribbon, haga clic en Nuevo Ítem;
- Haga clic en Carga de Datos y seleccione Carga de Datos Remota;
- Se creará un nuevo objeto. Al abrir el objeto creado, se mostrará un panel lateral donde tendremos Código y Fuentes;
- Código: Mostrará
00000000-0000-0000-0000-000000000000porque no se ha guardado ningún datasource; - Fuentes: Muestra la lista de fuentes añadidas al objeto;
- Código: Mostrará
- Se creará un nuevo objeto. Al abrir el objeto creado, se mostrará un panel lateral donde tendremos Código y Fuentes;
- En el panel, al lado de Fuentes, haremos clic en
; - Se mostrará un formulario donde completaremos: Nombre, Usuario, Contraseña e Intervalo
- Nombre: Es el nombre de la base de datos en la base de datos, que añadiremos en el parámetro
DataSourceNamedel archivoappsettings.json; - Usuario: Es el nombre de usuario que accede a la base de datos y que añadiremos en el parámetro
StringConnectiondel archivoappsettings.json; - Contraseña: Es la contraseña del usuario que accede a la base de datos y que añadiremos en el parámetro
StringConnectiondel archivoappsettings.json; - Intervalo: Podemos definir el tiempo de espera, en segundos, para que se complete la carga de datos (valor predeterminado 0);
- Nombre: Es el nombre de la base de datos en la base de datos, que añadiremos en el parámetro
- Después de completar los datos, haremos clic en Confirmar y volveremos a la página inicial del panel;
- De vuelta en el panel de la carga de datos remota, el código seguirá en cero y se mostrará la fuente creada;
- Al hacer clic en Guardar, el panel se cerrará. Abra el objeto nuevamente para volver a abrir el panel;
- Al abrir el objeto después de guardarlo, el código se habrá generado. Para copiarlo, podemos hacer clic en:
Vamos asignar estos valores a los parámetros mencionados. A continuación, se muestra un ejemplo con los datasources de tipo SQLSERVER, ORACLE, POSTGRE, MySQL, CosmosDB y DATALOADREST:
"ClientId": "A1A1A1A1-B2B2-C3C3-D4D4-E5E5E5E5E5E5",
"DataSources": [
{
"DataSourceName": "SQLServer",
"DataSourceType": "SQLSERVER",
"StringConnection": "Data Source=SQLServerConnection;Initial Catalog=DataBaseName;Trusted_Connection=false;Persist Security Info=True;User ID=User;Password=pwd"
},
{
"DataSourceName": "Oracle",
"DataSourceType": "ORACLE",
"StringConnection": "Data Source=OracleConnection;User ID=user;Password=pwd"
},
{
"DataSourceName": "PostgreSQL",
"DataSourceType": "POSTGRESQL",
"StringConnection": "Server=host.docker.internal;Port=5432;Database=mydb;User Id=user;Password=pwd;"
},
{
"DataSourceName": "MySQL",
"DataSourceType": "MYSQL",
"StringConnection": "Server=host.docker.internal;Database=myDataBase;Uid=user;Pwd=pwd;"
},
{
"DataSourceName": "CosmosDB",
"DataSourceType": "COSMOSDB",
"StringConnection": "AccountEndpoint=https://cosmodb-example.documents.azure.com:443/;AccountKey=bpuRR4tLLQO6M2RB1Jop1KBJbByDm1zLGp2LJHeZJLaSSkft5aCApY9T2tUKx9qg591XyaSLZ0hRDDiACDb44k1vkA==",
"Configuration": {
"Database": "SampleDB",
"Container": "SampleContainer"
}
},
{
"DataSourceName": "Data Load Rest",
"DataSourceType": "DATALOADREST"
}
]
En el caso de CosmosDB, el propio motor de Azure proporciona el ConnectionString, que es una combinación de su URL con el campo Primary Key (o Secondary Key) que se muestran en la pestaña Keys de su portal de Azure. También tenemos el campo Configuration, que no se solicita en otros datasources. Los datos para completar este campo son el nombre del Database creado en el portal de Azure y el nombre del Container utilizado.
- Para configurar CosmosDB en T6, las configuraciones permanecen iguales, siendo necesario solo insertar el campo Nombre (el mismo configurado en el parámetro DataSourceName);
¶ 3.1. Carga de datos remota con CosmosDB
Utilizando la carga de datos remota en una conexión con una base de datos NoSQL (CosmosDB), podemos garantizar la existencia de una columna, incluso si no contiene datos:
Para visualizar, vamos a crear un proceso del Workflow:
- Cree un objeto del Workflow y añada una tarea;
- Ingrese un nombre cualquiera para la tarea;
- En el tipo de tarea, seleccione Carga de Datos Remota y haga clic en siguiente;
- En Carga de Datos Remota, seleccione el objeto de carga de datos remota creado anteriormente (CosmosDB);
- En Comando SQL, ingrese la llamada SQL que desea ejecutar, por ejemplo:
SELECT
Container.ID AS itemId, Container.price, Container.tags, Container.custom ? (Container.custom): null AS custom
FROM Container;
Esta sintaxis realizará la consulta en la base de datos y generará una columna llamada
custom, independientemente de si existe o no en la base. Si existe y contiene datos, estos serán retornados; si no, la columna será retornada con el valornull.
- En Destino, seleccione Nuevo;
- Cuando seleccionamos Nuevo como destino y el proceso se ejecuta correctamente, se crea una Tabla de Datos de acuerdo con los metadatos.
- Haga clic en Finalizar, se creará una Tabla de Datos con el nombre de la conexión creada en el objeto de carga de datos remota;
Puede seleccionar en Destino una tabla de datos ya existente en nuestro sistema, pero es necesario que el número de columnas y los nombres en sus encabezados coincidan con los de la tabla de origen;
Puede marcar la casilla Reestructurar tabla de datos automáticamente, que ajustará automáticamente la tabla de destino, sin necesidad de que coincida el número y los nombres de las columnas con los de la tabla de origen;
- Guarde y publique el proceso del workflow.
¶ 4 Client Gateway via Docker
Primero, es necesario preparar un contenedor para el gateway;
- Abra un terminal desde la carpeta
srcdel proyecto PowerPlanning cd C:...\powerplanning\src;
- Necesitaremos utilizar una imagen pública del gateway, que podemos obtener a través de un repositorio de imágenes Docker o a través de DockerHub;
- Seleccionaremos la imagen dentro del repositorio (para fines de ejemplo, la nombraremos
ImagenPublica/ClientGateway:latest); - Dentro del terminal, ejecutaremos el comando docker pull ImagenPublica/ClientGateway:latest para descargar la imagen pública de DockerHub;
Reemplace
ImagenPublica/ClientGateway:latestcon el nombre correcto de la imagen pública que está utilizando.
- Copiar el archivo
.envde ejemplo cp ClientGateway/.env.sample ./;- Este comando copiará el contenido del proyecto ClientGateway/.env.sample y lo colocará en la carpeta
src;
- Este comando copiará el contenido del proyecto ClientGateway/.env.sample y lo colocará en la carpeta
- Editar el archivo
.env.samplecon sus configuraciones code .env.sample;
El clientID se obtiene a través de T6. Cuando creamos un objeto del tipo "Carga de Datos Remota", al abrirlo, tendremos un código que deberá ser insertado en la parte de configuración
DataLoadGatewayConfig__ClientId=********-****-****-****-***********;
- Ejecutar el Gateway via Docker
docker run --env-file .env.sample --name ClientGateway -d ImagenPublica/ClientGateway:latest
- Dentro de T6, abriremos un objeto del tipo Carga de Datos Remota, se abrirá un panel lateral donde haremos clic en Añadir;
- Será necesario proporcionar Nombre, Usuario y Contraseña;
- Aún dentro de T6, crearemos un proceso del Workflow;
- Añadiremos una tarea al proceso del workflow, en este ejemplo la nombraremos Load Postgres, del tipo Carga de Datos Remota;
- Haremos clic en Siguiente;
- En Carga de Datos Remota, seleccionaremos Postgres;
- En Comando SQL insertaremos: SELECT * FROM employee ("employee" es el nombre de una tabla dentro de la base de datos);
- En Destino seleccionaremos "Nuevo";
Se creará dentro de T6 una Tabla de Datos con el nombre de la conexión creada en el objeto Carga de Datos Remota Load Postgres;
Podemos marcar la checkbox Reestructurar tabla de datos automáticamente que hará el ajuste automático de la tabla de destino, sin la necesidad de tener el mismo número y nombre de columnas de la tabla de origen;
- Crearemos un gatillo para la ejecución del proceso del workflow;
- Ejecutaremos el gatillo;
- Después de ejecutar el gatillo, crearemos un Formulario de Datos, haciendo link con la Tabla de Datos creada;
Al añadir datos a la tabla de forma externa (a través de la base de datos) y ejecutar el gatillo nuevamente, estos cambios se reflejarán en la tabla de datos creada en T6.
¶ 5. Conectando Client Gateway con MSSQL (ODBC)
- Vamos a configurar nuestro Client Gateway accediendo al archivo
appsettings.jsondentro de la carpeta ClientGateway;
En la configuración tenemos 2 parámetros principales a los que debemos prestar atención:
- URL: Debe contener necesariamente el endpoint /dataloadhub
- ClientID: Es el código generado al guardar el objeto del tipo Carga de Datos Remota en T6;
- Vamos a crear una fuente de datos ODBC para conectar a MSSQL. Dentro del
appsettings.jsonvamos a insertar otro bloque de información:
{
"DataSourceName": "ODBC MSSQL",
"DataSourceType": "ODBC",
"StringConnection": "Driver={ODBC Driver 17 for SQL Server};Server=myServerAddress;Database=myDataBase;UID=myUsername;PWD=myPassword;"
}
- Para ejecutar el ClientGateway nuevamente, vamos a ejecutar el comando dotnet run;
Después de configurarlo, vamos a volver a T6, donde crearemos un Proceso del Workflow para poder visualizar el funcionamiento.
- Cree un objeto del Workflow y añada una tarea;
- Vamos a ingresar cualquier nombre para la tarea;
- En el tipo de tarea, vamos a seleccionar Carga de Datos Remota y hacer clic en siguiente;
- En Carga de Datos Remota, vamos a seleccionar el objeto de carga de datos remota creado anteriormente;
- En Comando SQL, vamos a ingresar la llamada SQL que deseamos ejecutar, por ejemplo SELECT * FROM REP_APPLICATION;
- En Destino, vamos a seleccionar Nuevo;
- Cuando seleccionamos Nuevo en destino y el proceso funciona, se crea la Tabla de Datos de acuerdo con el metadato;
- Vamos a hacer clic en Finalizar, se creará una Tabla de Datos con el nombre de la conexión creada en el objeto de carga de datos remota;
Podemos seleccionar en Destino una tabla de datos ya existente en nuestro sistema, pero es necesario que el número de columnas y los nombres en sus encabezados sean iguales a los de la tabla de origen;
Podemos marcar la checkbox Reestructurar tabla de datos automáticamente que hará el ajuste automático de la tabla de destino, sin la necesidad de tener el mismo número y nombre de columnas de la tabla de origen;
- Vamos a guardar y publicar el proceso del workflow;
- Vamos a volver al explorer y crear un Trigger del Workflow, donde seleccionaremos el proceso creado y ejecutaremos el trigger;
- De vuelta en el explorer, ahora vamos a crear un Formulario de Datos;
- Al abrir el formulario, vamos a vincular la tabla de datos creada, seleccionar las filas y columnas que se mostrarán y guardar el formulario;
- Después de hacer esto, vamos a volver al explorer y abrir el formulario de datos creado;
- Al abrir el formulario, se mostrarán las filas y columnas seleccionadas, presentes en la base de datos MSSQL traídas vía ODBC;
¶ 6. Conectando Client Gateway con Excel (ODBC)
Vamos a crear un objeto en T6 del tipo Carga de Datos Remota (o añadir otra conexión si ya tiene un objeto de este tipo);
- Vamos a configurar nuestro Client Gateway accediendo al archivo
appsettings.jsondentro de la carpeta ClientGateway; - Vamos a crear una fuente de datos ODBC para conectar a Excel. Dentro del
appsettings.jsonvamos a insertar otro bloque de información:
{
"DataSourceName": "ODBC EXCEL",
"DataSourceType": "ODBC",
"StringConnection": "Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\MyExcel.xls;"
}
En StringConnection, DBQ es la ubicación donde se guarda el archivo de Excel
- Para ejecutar el ClientGateway nuevamente, vamos a ejecutar el comando dotnet run;
Después de configurarlo, vamos a volver a T6, donde crearemos un Proceso del Workflow para poder visualizar el funcionamiento.
- Cree un objeto del Workflow y añada una tarea;
- Vamos a ingresar cualquier nombre para la tarea;
- En el tipo de tarea, vamos a seleccionar Carga de Datos Remota y hacer clic en siguiente;
- En Carga de Datos Remota, vamos a seleccionar el objeto de carga de datos remota creado anteriormente;
- En Comando SQL, vamos a ingresar la llamada SQL que deseamos ejecutar, por ejemplo SELECT * FROM [Sheet1$];
- Sheet1 es la tabla del archivo Excel. $ se coloca para informar al driver que se trata de una tabla.
- En Destino, vamos a seleccionar Nuevo;
- Cuando seleccionamos Nuevo en destino y el proceso funciona, se crea la Tabla de Datos de acuerdo con el metadato;
- Vamos a hacer clic en Finalizar, se creará una Tabla de Datos con el nombre de la conexión creada en el objeto de carga de datos remota;
- Vamos a guardar y publicar el proceso del workflow;
- Vamos a volver al explorer y crear un Trigger del Workflow, donde seleccionaremos el proceso creado y ejecutaremos el trigger;
- De vuelta en el explorer, ahora vamos a crear un Formulario de Datos;
- Al abrir el formulario, vamos a vincular la tabla de datos creada, seleccionar las filas y columnas que se mostrarán y guardar el formulario;
- Después de hacer esto, vamos a volver al explorer y abrir el formulario de datos creado;
- Al abrir el formulario, se mostrarán las filas y columnas seleccionadas, presentes en el archivo de Excel traídas vía ODBC;
- Al añadir datos a las columnas de la tabla de Excel y guardarlos, podemos volver al sistema y ejecutar el trigger nuevamente, y los cambios se reflejarán en el formulario de datos.
Ocurrirá un error si hay cambios en las columnas existentes en el archivo de Excel. Se debe mantener el mismo nombre en el encabezado de las columnas, así como no debe alterarse el número de columnas.
¶ 7. Cómo ejecutar una carga vía REST
- Dentro del archivo de configuración de
DataLoadGatewayConfigserá necesario incluir una nueva entrada:
DataSourceName: "Data Load Rest",
DataSourceType: "DATALOADREST"
- DataSourceName: puede ser cualquier nombre, siempre que contenga "rest" en su composición;
- DataSourceType: debe ser este nombre, no debe ser alterado;
¶ 8. Ejecutando el Client Gateway como servicio (Windows)
Los pasos para registrar el Client Gateway como un servicio de Windows.
- Abra un terminal de Windows con privilegios de administrador.
- En el símbolo del sistema, escriba la siguiente sintaxis: sc.exe create NewService binpath= c:\windows\system32\NewServ.exe
- NewService: es el nombre del servicio que desea crear;
- binpath: vamos a asignar la ruta completa donde se encuentra el ejecutable del Client Gateway;
- Presione Enter en la línea escrita.
- El nuevo servicio aparecerá listado en la pantalla de servicios de Windows.
SC.exe tiene otros parámetros que pueden ser utilizados en la creación de un servicio. En el paso a paso descrito anteriormente, estos son los parámetros mínimos obligatorios para registrar un servicio. Puede obtener más información sobre los otros parámetros haciendo clic en el enlace: Microsoft Learn - SC.exe create
Para eliminar el servicio creado, el comando es: sc delete ServiceName, donde ServiceName es el nombre del servicio que deseamos eliminar.
¶ 8.1. Identificación de Error
En algunos casos, puede ocurrir un error al iniciar el servicio de Windows. Si esto sucede, será necesario ejecutar el Client Gateway a través del símbolo del sistema para identificar el error.
Para ello, siga los siguientes pasos:
- Abra el Explorador de archivos de Windows;
- Ubique la carpeta donde está guardado el ejecutable del Client Gateway;
- Después de ubicarla, aún en el Explorador de archivos, abra esa ruta en el terminal (clic derecho en Abrir en Terminal, o haga clic en la ruta mostrada y escriba
cmd); - Al hacer el paso anterior, el terminal se abrirá en la ubicación del archivo;
- En el terminal, en esa ubicación, ejecute el siguiente comando:
ClientGateway.exe;
Al ejecutar este paso a paso, estará ejecutando el Client Gateway, y posiblemente verá un mensaje de error registrado en el terminal. Con eso, podrá identificar qué está causando el error al ejecutar el Client Gateway como servicio de Windows.
¶ 9. Ejecutando el Client Gateway como servicio (Linux)
Después de descargar el archivo de ClientGateway para Linux en la sección 2.1 de este manual, necesitaremos crear un servicio en el directorio /etc/systemd/system/, que nombraremos como ClientGateway.service.
- Vamos a abrir un editor de texto con privilegios de superusuario;
- Se pueden utilizar editores como
nano,vi,vim. En este manual utilizaremosnano;
- Después de abrir el editor, vamos a ejecutar el siguiente comando para crear el servicio:
sudo nano /etc/systemd/system/ClientGateway.service
- Vamos a añadir el contenido del archivo de servicio:
# ClientGateway.service
[Unit]
Description=T6 Enterprise Client Gateway
[Service]
ExecStart=dotnet /home/azureuser/ClientGateway/ClientGateway.dll
SyslogIdentifier=T6ClientGateway
User=azureuser # Nombre del usuario de Linux que ejecutará el servicio
Restart=always
RestartSec=5
[Install]
WantedBy=multi-user.target
- Después de añadir el contenido, vamos a guardar (utilizando
nanopodemos hacerlo presionando CTRL + O); - Después de finalizar, podemos cerrar el editor (utilizando
nanopodemos hacerlo presionando CTRL + X);
- Necesitaremos habilitar e iniciar el servicio de ClientGateway;
- Para habilitar el servicio, aún en el editor de texto, vamos a ejecutar el siguiente comando: sudo systemctl enable ClientGateway;
- Para iniciar el servicio, aún en el editor de texto, vamos a ejecutar el siguiente comando: sudo systemctl start ClientGateway;
Para asegurarnos de que el servicio está funcionando correctamente, podemos verificar su estado ejecutando el siguiente comando: sudo systemctl status ClientGateway.
¶ 10. Carga de Datos Incremental
La carga de datos incremental reemplaza los datos de la tabla en la base de datos, primero eliminando los datos y luego insertándolos, según el período seleccionado.
Para utilizar la carga de datos incremental, seguiremos los siguientes pasos:
- Vamos a crear un objeto del tipo proceso del Workflow;
- Este proceso debe contener una tarea y esta tarea debe incluir 2 parámetros del tipo Fecha, uno indicando la fecha de inicio de los registros deseados y otro indicando la fecha final de los registros seleccionados. Para fines de ejemplo, los nombraremos como
StartDateyEndDate; (Para información complementaria sobre Workflow, Triggers y Parámetros, acceda a: Workflow BPM)
- Vamos a ingresar cualquier nombre para la tarea;
- En el tipo de tarea, vamos a seleccionar Carga de Datos Remota y hacer clic en siguiente;
- En Carga de Datos Remota, vamos a seleccionar el objeto de carga de datos remota creado anteriormente;
- En Comando SQL, vamos a ingresar la llamada SQL que deseamos ejecutar;
- En Destino, vamos a seleccionar Nuevo;
- Cuando seleccionamos Nuevo en destino y el proceso funciona, se crea la Tabla de Datos de acuerdo con el metadato;
- Vamos a hacer clic en Finalizar, se creará una Tabla de Datos con el nombre de la conexión creada en el objeto de carga de datos remota;
Podemos seleccionar en Destino una tabla de datos ya existente en nuestro sistema, pero es necesario que el número de columnas y los nombres en sus encabezados sean iguales a los de la tabla de origen;
Podemos marcar la checkbox Reestructurar tabla de datos automáticamente que hará el ajuste automático de la tabla de destino, sin la necesidad de tener el mismo número y nombre de columnas de la tabla de origen;
- Vamos a marcar la checkbox Carga Incremental;
- Para cargar las columnas disponibles de acuerdo con el comando SQL ingresado anteriormente, necesitaremos hacer clic en el !Botón Refresh, siempre que se altere el comando SQL, es necesario hacer clic en el botón para recargar las columnas disponibles;
- En el campo Nombre de la columna con las fechas vamos a seleccionar la columna que usaremos como referencia para la carga;
- Justo debajo, tendremos Parámetro con la fecha inicial, donde seleccionaremos el parámetro
StartDate, referente a la fecha de inicio de los registros que queremos; - En Parámetro con la fecha final, seleccionaremos el parámetro
EndDate, referente a la fecha final de los registros seleccionados;
Estas configuraciones solo definirán los registros que serán eliminados de la tabla de destino. La parte de inserción dependerá de lo que se defina en el comando SQL anterior (si solo hace el "SELECT", se cargarán todos los registros, independientemente de la cantidad).
Ejemplo del comando SQL aplicando los parámetros:
SELECT * FROM REP_EXPLORER_OBJECT
WHERE
datModified >= COALESCE(NULLIF('Instance(StartDate)',"),'1970-01-01')
AND
datModified < COALESCE(NULLIF('Instance(EndDate)',"),'5000-01-01')
- En el trigger del proceso, vamos a definir los parámetros
StartDateyEndDate, con la fecha inicial y la fecha final, respectivamente; - Para finalizar, después de ingresar la fecha de inicio y la fecha final de los registros, vamos a disparar el trigger.
Siempre que se actualice la versión de T6, es estrictamente necesario actualizar la versión del Client Gateway.
¶ 11. Creación Dinámica de Tabla de Datos
Para utilizar la carga de datos para la creación dinámica de una tabla de datos, sigamos los siguientes pasos:
- Crearemos un objeto del tipo proceso en el Workflow;
- Este proceso deberá configurarse con un parámetro del tipo Texto para nombrar la tabla de datos, al cual llamaremos TableName (Este parámetro será utilizado en el paso 8 de este tema). (Para información complementaria sobre Workflow, Triggers y Parámetros, acceda a: Workflow BPM)
- Crearemos una nueva tarea y definiremos un nombre cualquiera;
- En el tipo de tarea, seleccionaremos Carga de Datos Remota y haremos clic en siguiente;
- En Carga de Datos Remota, seleccionaremos el objeto de carga de datos remota creado anteriormente;
- En Comando SQL, insertaremos la consulta SQL que deseamos ejecutar;
- En Destino, podremos seleccionar cualquier opción disponible en el menú desplegable (independientemente de la tabla de datos seleccionada como destino, solo se creará al disparar el trigger del proceso);
- Marcaremos la casilla Reestructurar tabla de datos automáticamente, que ajustará automáticamente la tabla de destino;
- En Parámetro para nombre de tabla dinámico, seleccionaremos el parámetro del tipo texto creado anteriormente, TableName;
- Cuando se ejecute la tarea, el valor insertado en el parámetro TableName definirá el nombre de la tabla de datos de destino.
Si no existe ninguna tabla de datos con el nombre definido, esta se creará dinámicamente y se guardará en la carpeta Raíz del T6.
Atención, si ya existe una tabla de datos con el nombre definido en el parámetro, sus datos serán sobrescritos;
-
Después de finalizar la configuración del proceso, haga clic en Guardar y publique el cubo;
-
En el trigger del proceso, definiremos en el parámetro TableName el nombre de la tabla de datos de destino;
-
Para finalizar, después de insertar el valor en el parámetro, disparemos el trigger.
¶ 12. Q&A
Preguntas Frecuentes
1. ¿Qué es Client Gateway?
Client Gateway es un ejecutable que funciona como intermediario entre el servidor y el cliente. A través de él, son posibles las cargas de datos remotas. Client Gateway obtiene datos según la configuración del servidor y devuelve los datos solicitados.
2. ¿En qué sistemas operativos funciona Client Gateway?
Client Gateway está disponible para los sistemas operativos Windows y Linux.
3. ¿Cuáles son los requisitos previos para usar Client Gateway en T6 v12.0?
Para el correcto funcionamiento de Client Gateway a partir de la versión 12.0 de T6, es necesario instalar .NET Core 8.0 Runtime & Hosting Bundle for Windows (v8.0.0), contar con soporte para cifrados TLS 1.2 o 1.3 y habilitar el puerto 443 en el firewall.
4. ¿Dónde descargar Client Gateway?
La descarga de Client Gateway se puede realizar mediante enlaces específicos para cada versión (v12.0, v12.1, v12.2), para los sistemas operativos Windows y Linux, disponibles en el manual Client Gateway.
5. ¿Dónde configuro Client Gateway?
Después de descargar Client Gateway en la ubicación deseada, descomprima la carpeta y realice las configuraciones necesarias en el archivo appsettings.json.
6. ¿Cómo obtengo el ClientId para configurar Client Gateway?
Para obtener el ClientId, cree un objeto de Carga de Datos Remota en T6, agregue la fuente de datos y guarde el objeto. Abra nuevamente el objeto de Carga de Datos Remota y copie el código generado.
7. ¿Qué fuentes de datos son compatibles con Client Gateway?
Con Client Gateway es posible conectarse a las siguientes fuentes de datos:
SQLServer;
Oracle;
CosmosDB;
REST;
MySQL;
PostgreSQL;
ODBC.
8. ¿Cómo configuro múltiples fuentes de datos en Client Gateway?
En el archivo appsettings.json de Client Gateway, agregue múltiples bloques en el array DataSources respetando el formato JSON, como en el siguiente ejemplo:
"DataSources": [
{
"DataSourceName": "SQLServer",
"DataSourceType": "SQLSERVER",
"StringConnection": "Data Source=SQLServerConnection;Initial Catalog=DataBaseName;Trusted_Connection=false;Persist Security Info=True;User ID=User;Password=pwd"
},
{
"DataSourceName": "Oracle",
"DataSourceType": "ORACLE",
"StringConnection": "Data Source=OracleConnection;User ID=user;Password=pwd"
}
]
9. ¿Cómo configuro CosmosDB en Client Gateway?
Para usar CosmosDB en Client Gateway, utilice la ConnectionString proporcionada por Azure (URL + Primary Key) y agregue el campo Configuration con Database y Container.
Por ejemplo:
{
"DataSourceName": "CosmosDB",
"DataSourceType": "COSMOSDB",
"StringConnection": "AccountEndpoint=https://cosmodb-example.documents.azure.com:443/;AccountKey=bpuRR4tLLQO6M2RB1Jop1KBJbByDm1zLGp2LJHeZJLaSSkft5aCApY9T2tUKx9qg591XyaSLZ0hRDDiACDb44k1vkA==",
"Configuration": {
"Database": "SampleDB",
"Container": "SampleContainer"
}
}
10. ¿Cómo me conecto vía ODBC con MSSQL en Client Gateway?
Para conectarse vía ODBC con MSSQL en Client Gateway, configure DataSourceType como ODBC y utilice connectionString con el driver ODBC Driver 17 for SQL Server.
Ejemplo:
{
"DataSourceName": "ODBC MSSQL",
"DataSourceType": "ODBC",
"StringConnection": "Driver={ODBC Driver 17 for SQL Server};Server=myServerAddress;Database=myDataBase;UID=myUsername;PWD=myPassword;"
}
11. ¿Cómo conecto archivos Excel usando Client Gateway?
Para conectar archivos Excel usando Client Gateway, use ODBC con el driver Microsoft Excel y especifique la ruta del archivo en DBQ.
Por ejemplo:
{
"DataSourceName": "ODBC EXCEL",
"DataSourceType": "ODBC",
"StringConnection": "Driver={Microsoft Excel Driver (*.xls, *.xlsx, *.xlsm, *.xlsb)};DBQ=C:\\MyExcel.xls;"
}
12. ¿Cómo ejecuto Client Gateway vía Docker?
Para ejecutar Client Gateway vía Docker, será necesario utilizar una imagen pública, configurar el archivo .env con sus ajustes y ejecutar docker: docker run --env-file .env.sample --name ClientGateway -d PublicImage/ClientGateway:latest.
Será necesario crear un objeto de Carga de Datos Remota en T6 para conectarse con Client Gateway vía Docker.
13. ¿Qué es la Carga de Datos Incremental en Client Gateway?
La carga de datos incremental en Client Gateway reemplaza los datos de la tabla por período, primero eliminando y después insertando datos según el período seleccionado.
Para utilizarla, cree un proceso de Workflow con parámetros de fecha (inicio y fin), configure una tarea de carga de datos remota con esos parámetros y marque la opción de carga incremental.
Al disparar el trigger del proceso, solo se verán afectados los registros dentro del intervalo definido.
14. ¿Cómo ejecuto cargas de datos vía REST en Client Gateway?
Para ejecutar cargas de datos vía REST en Client Gateway, en el archivo de configuración de Client Gateway, configure DataSourceType como DATALOADREST (debe ser ese nombre, no debe alterarse) y DataSourceName conteniendo rest (cualquier nombre, siempre que contenga "rest").
15. ¿Cuándo debo actualizar Client Gateway?
Siempre que se actualice la versión de T6, es necesario actualizar Client Gateway.