Integración SET
La integración SET se encarga de enviar la información presente en el Relationship Management | CRM a otro sistema (receptor). El envío de información a través del Integrador tiene sus peculiaridades y se configura de manera diferente a otras integraciones, ya que los campos tienen diferentes funciones, también reciben diferentes valores.
Cuando la integración se complete con éxito, el integrador configurado devolverá un mensaje de éxito. Si el servicio web tiene algún tipo de devolución para quien se configuró el envío, se desplegará la devolución y el mensaje. En caso de error, el integrador solo presentará el error, cuyos detalles se mostrarán en el registro.
Consejos de usabilidad
Pedido para la creación de la integración
Sugerencia de pedido para la creación de la integración, registrando información entre tablas según sea necesario, para facilitar la comprensión y organización de los datos. Entonces hay uncírculo entre las tablas CAMPOS_INTEGRACAO, DEPENDENCIAS y RULES, de manera que se verifica cada información registrada en CAMPOS_INTEGRACAO si es necesario crear registros en las otras tablas.
Valores variables
Todos los valores de las variables se escriben en el lenguaje del integrador usando el símbolo # al principio y al final del nombre de la variable. Y, al configurar las consultas, insertar y actualizar SQL, el integrador compila la cadena exactamente como una cadena PHP, por lo que el valor puede estar o no dentro de la cadena que contiene comillas dobles o simples. Por ejemplo, SELECT * FROM accounts WHERE id = '# id #'.
Orden de integraciones
El orden en que se disponen las integraciones en la tabla INTEGRACOES marca la diferencia, por lo que deben colocarse en un orden lógico, de acuerdo con la estructura del CRM.
Orden de índice
Orden de índice delcuerda JSON en el campo CAMPO_CRM de la tabla CAMPOS_INTEGRACAO no hace ninguna diferencia, pero se debe mantener la estructura lógica.
Registro de integración
El nivel de personalización en el registro de integraciones es grande y los SQL presentes en la tabla INTEGRATIONS, las columnas CONSULTA, SQL_CONSULTA, SQL_INSERT y SQL_UPDATE pueden ser complejas y más de uno, si es necesario, sin embargo no se recomienda utilizar más de un SQL. en el mismo campo.
Nota
Es posible ejecutar integraciones de diferentes tipos en dependencia (GET + SET), pero se recomienda ejecutar solo integraciones del mismo tipo en dependencia. Primero, es necesario configurar la conexión con el sistema a integrar, y luego configurar los módulos y campos.
Tabelas
El Integrador tiene una estructura de tablas de base de datos donde será posible registrar y configurar integraciones.
| Campo | Descripción | Valores posibles |
|---|---|---|
| TYPE_CONNECTION | Clasifica la forma en que se conecta la integración. |
|
| NAME_CONNECTION | Informa el nombre de la conexión guardada en el archivo de conexiones del cliente dentro de los archivos del integrador. Cada tipo de conexión tiene un diseño específico para configurar la conexión en el archivo. |
| Campo | Descripción | Valores posibles |
|---|---|---|
| NOME (NOMBRE) | Descripción de la integración. Información importante en el caso deIntegración INFO, ya que es el índice de retorno para llegar a la información integrada. | |
| TIPO DE SERVICIO | cuerda que representa el tipo de integración a realizar. | SET: enviar los valores a un sistema de terceros. |
| COMPANY_ID / COMPANY_FILIAL_ID | Empresa para la que está disponible la integración. | |
| ENLACE | cuerda que informa la dirección para conectar la integración, el complemento para llegar a un servicio en particular. |
LINK WEB: complemento de la dirección de conexión para un servicio determinado; PALABRA CLAVE: actualmente 'componente' es la palabra clave disponible, y establece que la integración es un componente o un campo de otra integración. |
| TABLA | Mesa donde se realizará la integración. | |
| CONSULTA | Texto JSON que debe representar la consulta de datos realizada en el sistema CRM. | JSON-SQL: dentro de la clave "consulta" se puede escribir un texto SQL completo que se ejecutará para la búsqueda. |
| CONNECTION_INTEGRACAO_ID | Identificador que hace referencia a la información de la tabla CONEXAO_INTEGRACAO. | |
| PORT_WS | Se refiere al puerto para ejecutar un servicio en particular. Solo se utiliza en integraciones a través deservicio web. Esta información se puede encontrar en la documentación WSDL del sistema que se va a integrar. | Puede contener valores NULL. |
| INDEX_ARRAY_RETURN | Representa la clave delformación donde se encuentran los datos de retroalimentación de la integración realizada. Este valor debe aparecer en la documentación del servicio. Si la solicitud es a través de un servicio web o API y no tiene un índice predeterminado para devolver valores, puede usar la palabra reservada 'parámetros' como index_array_return; | Puede contener valores NULL. |
| INDEX_VALUE_RETURN | Índice que se buscará en elformación de devolución de envío de valor al tercer sistema, para realizar acciones luego de una integración exitosa. Se puede insertar más de un índice, siempre que estén separados por una coma. | Puede contener valores NULL. |
| INDEX_ERROR_RETURN | Estos son los índices en los que se buscarán errores en la matriz de retorno de las búsquedas realizadas por el Integrador, es decir, si estos índices se encuentran con un valor, el Integrador interpretará la búsqueda como 'con error'. El campo puede contener varios índices separados por comas (no debe haber espacios entre los índices y la coma). Solo se utilizará como validador general el primer índice de la lista, es decir, si el primer índice no presenta errores, los demás no se contabilizarán. | |
| SQL_QUERY | Campo no utilizado en la integración SET. | |
| SQL_INSERT | Campo no utilizado en la integración SET. | |
| SQL_UPDATE |
SQL que se encargará de actualizar un registro en el CRM cuando el retorno de la integración SET sea positivo y traer la información de identificación del registro realizado en el sistema de terceros. No olvide el consejo 2. Para ensamblar la consulta de actualización se habilita la inyección de valores, que contiene todos los valores mapeados, de la tabla CAMPOS_INTEGRACAO, de CRM, columna CAMPO_CRM y el resultado de la integración, es decir, los valores devueltos por la inserción de el registro, que se informa en la columna INDICE_VALOR_RETORNO, al que se puede acceder de la siguiente manera: # account_id #: representa las columnas disponibles en la integración, campos CRM consultados y que se enumeran para la integración en curso; # codCli #: representa los valores registrados en la columna INDICE_VALOR_RETORNO, que son los índices devueltos por la inserción del tercer registro del sistema. Por ejemplo: ACTUALIZAR oportunidades SET order_number = # Pednum # WHERE id = # id # |
|
| DEPENDIENTE | Informa que la integración actual depende de la integración con el identificador dado y se ejecutará antes. |
El valor informado es el identificador de la tabla INTEGRACIÓN. Puede contener valores NULL. |
| DEPENDE DE | Informa que el valor registrado es una integración que depende de la integración actual y se ejecutará posteriormente. |
El valor informado es el identificador de la tabla INTEGRATIONS. Puede contener valores NULL. |
| PARAMETERS_MANDATORY | Informa qué valores deben estar en la URL de solicitud de integración. Los parámetros deben estar separados por una coma y deben ser exactamente los mismos que los parámetros que pasará la URL. | Puede contener valores NULL. |
- Identificación de campo: 19
- Campo de nombre: SET-WS-CONTAS
- Campo Service_time: SET
- campo company_id / company_branch_id: 1
- Campo de enlace: / g5-senior-services / sapiens_Synccom_senior_g5_co_ger_cad_clientes? Wsdl
- Campo de tabla: cuentas
- Campo de consulta: {"query": "SELECT c.id_erp, c.fax, c.email_geral, c.email_financeiro, c.cadastro_timestamp, c.cliente_desde, c`status`, c.representante_id, c.id, c. account_type, c.person_type, c.city_id, c.cellular, c.phone, c.phone2, c.phone3, c.name, c.fantasia, c.cnpj, c.cpf, c.branch_activity_id, c.registration, c.municipal_inscription, c.address, c.complement, c.number, c.zip, c.neighborhood FROM cuentas AS c WHERE c.id = # accountId # "}
- Campo Connection_integracao_id: 3
- campo ws_port: WriteClients
- campo index_array_return: returnsClients - en integraciones a través del servicio web, el valor de esta columna debe ser idéntico al valor del servicio web
- Campo return_value_index: codCli - esta columna solo se usa en integraciones SET
- campo index_erro_return: error, messageErro, erroExecucao
- campo sql_query: no utilizado
- campo sql_insert: no utilizado
- campo sql_update: ACTUALIZAR cuentas SET id_erp = # codCli # WHERE id = # accountId #
- Campo dependiente: 1 - la columna "dependiente" debe ser el id de una integración válida, es decir, el id de un registro válido en la tabla INTEGRATIONS
- Depende del campo: 1: la columna "depende de" debe ser el ID de una integración válida, es decir, el ID de un registro válido en la tabla INTEGRATIONS.
- Campo de parámetros_obligatorios: companyIdErp, filialIdErp, contaId - en caso de múltiples parámetros, deben estar separados por comas sin espacios
| Campo | Descripción | Valores posibles |
|---|---|---|
| INTEGRATION_ID | Identificador que hace referencia a información de la tabla INTEGRATIONS. | |
| FIELD_CRM |
Representación del campo CRM interno, solo se puede llenar en formato JSON, debe contener la referencia a la tabla (INDICE) y la columna (ATRIBUTO) en estos casos dice que solo hay un nivel de profundidad, ej: ' {“Índice”: "cuentas", "atributo": "nombre_corporativo"} '. También existen casos donde se necesitan más niveles para alcanzar un cierto valor, presenta uniones de tablas (JOIN), donde el valor se origina en otra tabla, referencia a la tabla (INDEX) y la columna (ALIAS) donde se busca la información. y la tabla (INDICE) y la columna (ATTRIBUTE) originales, y pueden contener N niveles, por ejemplo: '{"índice": "cuentas", "atributo": {"alias": "term_payment_id", "índice": " pago_deadline ”,” atributo ”:” id ”}} '. En casos como este, donde existen dos niveles, se entiende que existe una dependencia para ser informado, es decir, es necesario vincular la regla CONSULTAR DEPENDENCIA en la columna REGRA_ID y registrar una dependencia en la tabla DEPENDENCIA. En los casos donde solo hay un nivel, se pueden registrar registros donde el ATRIBUTO sea una palabra clave o variables de palabras reservadas o información registrada como valores globales en la columna VALOR_GLOBAL de la tabla CAMPOS_INTEGRACAO, de la siguiente manera: |
IGNORAR: ignore este campo cuando realice la acción de guardar o exportar; COMPONENT: carga un componente de integración, siempre que tenga el mismo no utilizado en la columna COMPONENT_NAME; VALOR FIJO: informa que la siguiente cadena es un valor fijo. En este caso, es necesario informar a la regla ADD FIXED VALUE en la columna RULE_ID. En el caso de agregar un valor fijo, es posible agregar variables para ser reemplazadas por sus respectivos valores durante el procesamiento de campo. Las palabras reservadas (CurrentDate, CurrentDate, etc) y los valores de integración que se informan como valores globales están disponibles, para eso la variable debe estar entre # (# CurrentDate #, # CurrentDate #, # etc #). Ejemplos:
|
| CAMPO_ERP |
Representación del campo externo del CRM (sistema de terceros), solo se puede llenar en formato JSON, debe contener la referencia a la tabla (INDICE) y la columna (ATRIBUTO) en estos casos dice que solo hay una nivel de profundidad, por ejemplo: '{"índice": "cliente", "atributo": "Cliname"}'. También hay casos donde se necesitan más niveles para alcanzar un cierto valor, presenta uniones de tablas / información (JOIN), donde el valor se origina en otra tabla / nivel delformación, referencia a tabla / índice (INDICE) y el otro nivel del formación (ÍNDICE) y el valor buscado (ATRIBUTO), y puede contener N niveles, por ejemplo: '{"índice": "cuentas", "atributo": {"índice": "histórico", "atributo": "codCpg"} } '. |
|
| RULE_ID | Identificador que hace referencia a información de la tabla REGLAS. | |
| GLOBAL_VALUE | Booleano que permite que el campo, si se ingresa como verdadero / 1¸, guarde el valor y el nombre del campo en un alcance global para que se pueda acceder a él desde cualquier otra integración, campo o regla. | |
| USE_INSERT | Campo no utilizado en la integración SET. | |
| USE_UPDATE | Campo no utilizado en la integración SET. | |
| PARÁMETROS ADICIONALES |
Se utiliza para pasar varios parámetros a una regla determinada durante el procesamiento de campo. Solo se deben registrar las cadenas en formato JSON. Ej .: {"data_format_erp": "Ymd"}; |
Puede contener valores NULL. |
- Id. De campo: 1,149
- Campo de Integration_id: 19
- Campo crm_field: {"índice": "cuentas", "atributo": {"índice": "término_pago", "alias": 'id_term_pago "," atributo ":" id_erp "}}
- Field_erp campo: {"index": "GeneralDataCustomer", "atributo": {"index": "Customerdefinitions", "attribute": "codCpg"}}
- campo rule_id: 5
- campo global_value: 0
- campo use_insert: 1
- campo use_update: 1
- Campo de parámetros_adicionales: nulo
| Campo | Descripción | Valores posibles |
|---|---|---|
| INTEGRATION_ID | Identificador que hace referencia a información de la tabla INTEGRATIONS. | |
| TABLA | Tabla / vista donde se obtendrá la información para que los registros se comparen al consultar las dependencias durante el procesamiento de campo. | |
| COLUMNS_SEARCH | Nombre de columna de la tabla ingresada arriba que contiene el valor deseado. Se puede ingresar más de un campo, solo separado por una coma. | |
| COLUMN_COMPARE | Columna que contiene el valor que se comparará con el retorno de la consulta al tercer sistema. Funciona de manera similar a la cláusula ON presente en el JOIN de unconsulta. | |
| VALOR POR DEFECTO | Valor que se informa, de manera que en los casos en que no se encuentre un registro con el valor informado en la columna COLUNA_COMPARAR, se inserta, para que el campo no quede vacío. El valor informado tiene que ser necesariamente un identificador válido en la tabla informada en la columna TABLA. | Puede contener valores NULL. |
| COMPANY_BRANCH_ID | Identificador que hace referencia a información de la tabla EMPRESA_FILIAL. Separa las dependencias por empresa y sucursal, permitiendo diferentes valores según las necesidades de la sucursal. Esta información solo se utiliza cuando la base de clientes es de varias empresas. |
- Identificación de campo: 75
- Campo de Integration_id: 8
- Campo de tabla: usuarios
- Columns_search campo: user_id, nombre
- Campo de comparación_columna: user_id_erp
- Campo valor_predeterminado: 383
- campo company_branch_id: 1
| Campo | Descripción | Valores posibles |
|---|---|---|
| NOME (NOMBRE) | Informa una descripción de la regla, el nombre para identificar la regla. | |
| TYPE_METHOD | Responsable de informar al Integrador cómo se ejecuta la regla. |
0: ejecuta una función, solo llama al método pasado por parámetro en la columna METHOD; 1: realiza la consulta de una dependencia, el método fijo, devolviendo el valor configurado para. Si se informó un método en la columna METHOD, se ejecuta después de consultar la dependencia; 2: agrega un valor fijo, la regla interpreta el valor informado de la columna CAMPO_ERP, de la tabla CAMPOS_INTEGRACAO, como un valor de hecho, no como una clave de consulta. Si se informó un método en la columna MÉTODO, se ejecuta después de la devolución del valor fijo; 4: carga un componente, agrega los valores a la variable interna de un integrador para que el integrador interprete el componente como una integración, con sus particulares, y cuando el componente finalice su ejecución, devuelva los valores formateados para la integración principal; |
| MÉTODO |
Método o función que se ejecutará cuando se produzca una llamada a una regla. El método puede ser: SQL: una consulta con alguna condición que devuelve el valor deseado; FIRMA DEL MÉTODO: una clave que representa un método presente en los archivos de reglas del Integrador, reglas generales o específicas del cliente; NULL: puede contener valores NULL. |
- Identificación de campo: 26
- Campo de nombre: Cargar / Preparar componente
- Campo Method_type: 4
- Campo de método: nulo
English
Español


