| Ambos lados, revisión anteriorRevisión previaPróxima revisión | Revisión previa |
| mav:doc:documentacion_integracion_kilotou [2026/07/30 10:08] – juanma | mav:doc:documentacion_integracion_kilotou [2026/07/30 15:38] (actual) – juanma |
|---|
| The data can be reached in two ways: | The data can be reached in two ways: |
| |
| * **SmartWebDoc** (web service): the procedures are called over HTTP with a POST request, as described below and used throughout the examples of this document. //SmartWebDoc can be installed by Smart Software Solutions.// | * **SmartWebDoc** (web service): the procedures are called over HTTP with a POST request, as described below and used throughout the examples of this document. **This service is already installed and running** at this installation. //SmartWebDoc is installed by Smart Software Solutions.// See the SmartWebDoc documentation: [[https://wiki.smartastur.com/doku.php?id=usu:smartweb:introduccion_a_smartwebdoc|Introducción a SmartWebDoc]]. |
| * **ODBC**: alternatively, the same procedures can be queried directly through an ODBC connection to the Firebird database. The procedure and field names are identical, and the ''SELECT * FROM <procedure>(...)'' statements are the same; **only the transport and the response format change**. Over ODBC the client receives the query result set directly (rows and columns), without the JSON envelope (''version'' / ''resultados'' / ''metaData'' / ''datos'') described below, which is specific to SmartWebDoc. //The ODBC driver installation is the responsibility of the client's system administrator.// | * **ODBC**: alternatively, the same procedures can be queried directly through an ODBC connection to the Firebird database. The procedure and field names are identical, and the ''SELECT * FROM <procedure>(...)'' statements are the same; **only the transport and the response format change**. Over ODBC the client receives the query result set directly (rows and columns), without the JSON envelope (''version'' / ''resultados'' / ''metaData'' / ''datos'') described below, which is specific to SmartWebDoc. //The ODBC driver installation is the responsibility of the client's system administrator.// This option is not set up; SmartWebDoc is the method in use. |
| | |
| At present the company has **neither** of the two services installed; one of them must be set up before the integration can run. | |
| |
| The connection details and examples below refer to the **SmartWebDoc** service. | The connection details and examples below refer to the **SmartWebDoc** service. |
| === Format === | === Format === |
| http://#ip:#port/services/ismartwebdoc/?format=json | http://#ip:#port/services/ismartwebdoc/?format=json |
| | |
| | For this installation: http://172.30.0.98:8000/services/ismartwebdoc/?format=json |
| === Possible ports === | === Possible ports === |
| - //(to be defined)// | - 8000 |
| === Possible IP addresses === | === Possible IP addresses === |
| - //(to be defined)// | - 172.30.0.98 |
| === User credentials === | === User credentials === |
| These credentials are not required by the interface, but are stated here so that the Smart administrator can set access restrictions or privileges on tables and procedures. | No credentials need to be entered on the client side: the SmartWebDoc service is already configured with a dedicated user, created ad-hoc for Kiloutou, through which the Smart administrator sets the access restrictions and privileges on tables and procedures. |
| - Id: //(to be provided by the Smart administrator)// | |
| - Password: //(to be provided by the Smart administrator)// | |
| === Other === | === Other === |
| "Postman v8.0.4" was used for the examples. | "Postman v8.0.4" was used for the examples. |
| | |
| | SmartWebDoc documentation: [[https://wiki.smartastur.com/doku.php?id=usu:smartweb:introduccion_a_smartwebdoc|Introducción a SmartWebDoc]]. |
| |
| === Response envelope === | === Response envelope === |
| - COUT_UNITAIRE_LIGNE_OR NUMERIC(17,5), | - COUT_UNITAIRE_LIGNE_OR NUMERIC(17,5), |
| - BOOL_LIGNE_OR_A_REFACTURER VARCHAR(1), | - BOOL_LIGNE_OR_A_REFACTURER VARCHAR(1), |
| - PRIX_UNITAIRE_VENTE_CLIENT_LIGNE_OR NUMERIC(17,5), | - PRIX_UNIT_VTE_CLIENT_LIGNE_OR NUMERIC(17,5), //(template field: PRIX_UNITAIRE_VENTE_CLIENT_LIGNE_OR)// |
| - TAUX_REMISE_CLIENT_LIGNE_OR NUMERIC(17,5), | - TAUX_REMISE_CLIENT_LIGNE_OR NUMERIC(17,5), |
| - MONTANT_A_REFACTURER_LIGNE_OR NUMERIC(17,5), | - MONTANT_A_REFACTURER_LIGNE_OR NUMERIC(17,5), |
| |
| ''NUMERO_OR'' is the order number (Kiloutou's "OR-0000031566" format cannot be reproduced; SMART's number is issued). ''CODE_STATUT_OR'': "1" (open), "TERMINE" (in progress), "CLOS" (closed). //These values are provisional pending Kiloutou's status logic.// | ''NUMERO_OR'' is the order number (Kiloutou's "OR-0000031566" format cannot be reproduced; SMART's number is issued). ''CODE_STATUT_OR'': "1" (open), "TERMINE" (in progress), "CLOS" (closed). //These values are provisional pending Kiloutou's status logic.// |
| | |
| | **Shortened column name:** the template field ''PRIX_UNITAIRE_VENTE_CLIENT_LIGNE_OR'' (35 characters) exceeds Firebird's 31-character identifier limit, so it is emitted as the output column ''PRIX_UNIT_VTE_CLIENT_LIGNE_OR''. The export process maps it back to the full template name. |
| === Example === | === Example === |
| == One month's repair orders == | == One month's repair orders == |
| === Usage === | === Usage === |
| ''RACCOD'', ''GBV'' and ''GBVA'' feed the fields of the same name in the referentials and fact tables (Equipment, Stock snapshots, Invoices...). The FCCS consolidation account (''KIL_ACCOUNT'' in Invoices) is mapped by Kiloutou in its platform. | ''RACCOD'', ''GBV'' and ''GBVA'' feed the fields of the same name in the referentials and fact tables (Equipment, Stock snapshots, Invoices...). The FCCS consolidation account (''KIL_ACCOUNT'' in Invoices) is mapped by Kiloutou in its platform. |
| | |
| | === Loading workflow === |
| | ''KIL_RACINE'' is populated through an iterative spreadsheet round-trip: |
| | |
| | - **Extract the pending equipment.** Smart runs a procedure that returns every asset not yet present in ''KIL_RACINE'', and exports it to an Excel sheet. The sheet has five columns: ''COD_ACTIVO'' and ''DESCRIPCION'' (already filled in, for identification only) and ''RACCOD'', ''GBV'', ''GBVA'' (empty, to be completed). |
| | - **Send the sheet to Kiloutou.** The Fleet Dept. fills in ''RACCOD'' (Kiloutou root) and the finance team fills in ''GBV''/''GBVA''. ''COD_ACTIVO'' and ''DESCRIPCION'' must not be changed. |
| | - **Return and import.** Smart loads the completed sheet back into SmartOffice and processes it into ''KIL_RACINE''. |
| | - **Repeat** until step 1 returns no rows, i.e. every asset has a Kiloutou root. |
| | |
| | Notes: |
| | - Only rows that come back **with a ''RACCOD''** are registered. Rows left without a root are ignored and will appear again in the next extraction, so the loop keeps requesting them until they are resolved. |
| | - ''GBV'' and ''GBVA'' may be left empty in a given round and completed later; the amount fields accept decimals. |
| | - New equipment added after a round is automatically picked up by the next extraction. |
| |
| ---- | ---- |
| |
| == Document change log == | == Document change log == |
| | --- //[[juanma@smartastur.com|Juanma]] 2026/07/30 // Repair Orders: column PRIX_UNITAIRE_VENTE_CLIENT_LIGNE_OR shortened to PRIX_UNIT_VTE_CLIENT_LIGNE_OR (Firebird 31-char identifier limit). |
| | |
| | --- //[[juanma@smartastur.com|Juanma]] 2026/07/30 // SmartWebDoc connection details (IP, port) and documentation link. Credentials configured ad-hoc on the service. |
| | |
| | --- //[[juanma@smartastur.com|Juanma]] 2026/07/30 // KIL_RACINE loading workflow (spreadsheet round-trip). |
| | |
| --- //[[juanma@smartastur.com|Juanma]] 2026/07/30 // Initial document. SMART → Kiloutou extraction (EX06468): referentials, fact tables and snapshots. | --- //[[juanma@smartastur.com|Juanma]] 2026/07/30 // Initial document. SMART → Kiloutou extraction (EX06468): referentials, fact tables and snapshots. |
| |
