Diferencias

Muestra las diferencias entre dos versiones de la página.

--- ada:howto:sicoferp:factory:integrations:mssicofdownloaddocumentdb [2023/06/01 13:29]
192.168.175.173 [Ejemplo de generación de despliegue completo]
+++ ada:howto:sicoferp:factory:integrations:mssicofdownloaddocumentdb [2023/06/01 14:25] (actual)
192.168.175.152 [Descarga un documento]
@@ Línea 61: / Línea 61: @@
-===== Ejemplo de generación de despliegue completo =====
+===== Ejemplos de Consumos =====
+La utiidad se puede utilizar desde cualquier navegador web que este conectado a internet y esté dentro de la red de ADA. Tambien puede utilizar una herrameinta para consumo de Apis Rest como Postman, etc.
+==== Recomendaciones ====
+  * Identifica el código únnico de identificación del documento que se desea descargar los cuales pueden ser (CUFE:FE - CUNE:ND, NC - CUDS: DS)
+  * Identifique el tipo de archivo que se desea descargar los cuales pueden ser (fv:XML del documento FE, NC, ND o DS - ad: document attachment del documento FE, NC, ND o DS - pdf: Representación gráfica del documento FE, NC, ND o DS)
+  * Arme la url del servicio previamente en un editor de texto teniendo presente la siguiente estructura: URL: es la ruta del servicio http://10.1.20.84:3131/SicofDownload/exportDocumentDian, operación la cual puede ser file o read, Código único de identificación del documento el cual es un hash y por último el tipo de archivo que se desea exportar el cual puede ser (fv:xml documento - ad:xml document attachment  - pdf: representación gráfica).
+==== Testerar disponibilidad del servicio ====
 ^Http^Url^Request^Response^
-|POST|http://10.1.20.84:3131/SicofDownload/exportDocumentDian/|N/A|Text|
+|GET|http://10.1.20.84:3131/SicofDownload/exportDocumentDian/|N/A|Text|
 ==== Request ====
 <code yaml>
-{
+Online!!!
-  "profileDeploymentName": "DesplieguePruebaPresupuesto",
-  "deploymentPhases": [
-    "ALL_PHASES"
-  ],
-  "sshHost": "10.1.140.1",
-  "sshPort": 22,
-  "sshUser": "jboss09",
-  "sshPassword": "*********",
-  "powerbuilderExecutablePath": "\"D:\\Program Files (x86)\\Sybase\\PowerBuilder 12.5\\PB125.EXE\"",
-  "powerbuilderWorkspaceProjectPath": "\"D:\\ADA\\SICOF\\Presupuesto\\Fuentes\\Branches\\branches 12.5.2.5.0\\presupuesto.pbw\"",
-  "powerbuilderTargetProjectPath": "\"D:\\ADA\\SICOF\\Presupuesto\\Fuentes\\Branches\\branches 12.5.2.5.0\\presupuesto.pbt\"",
-  "appeonRepositoryConfigDirectory": "/opt/jboss09/appeon/repository/standalone/config/",
-  "appeonDeveloperExecutablePath": "\"C:\\Program Files (x86)\\Appeon\\Developer2016\\EonADeploy60.exe\"",
-  "appeonProfileDeployment": [
-    {
-      "appeonProfileDeploymentName": "sicoferp_presupuesto_ada_test",
-      "appeonProfileDeploymentDatasource": "db104_presupuesto"
-    }
-  ],
-  "emailToNotificationDeployment": "carlos.torres@ada.co",
-  "emailCcNotificationDeployment": "abdimar.estrada@ada.co",
-  "notes": "Despliegue de Pruebas ADA - Presupuesto",
-  "stopWebServerCommand": "sudo  /etc/init.d/jboss09 stop",
-  "startWebServerCommand": "sudo  /etc/init.d/jboss09 start"
-}
 </code>
-^Columna^Descripcion^
+==== Descarga un documento ====
-|profileDeploymentName|Nombre de la tarea de despliegue.|
-|temporaryDeploymentProcessingDirectoryPath|Directorio temporal que se utilizará para la generación de archivos del depsliegue. Esta propiedad no es obligatoria y si no se envía se utilizará un directorio temporal.|
-|deploymentPhases|Array de cadenas que contienen las fases del depsliegue las cuales son: PHASE_1_COPY_CONFIG_FROM_REMOTE_TO_LOCAL_SERVER, PHASE_2_FULL_BUILD_PB, PHASE_3_DEPLOY_APPEON_DEVELOPER, PHASE_4_COPY_CONFIG_FROM_LOCAL_TO_REMOTE_SERVER, PHASE_5_RESTART_WEB_SERVER. Si desea ejecutar todas las fases sólo debe enviar la fase ALL_PHASES|
-|deploymentExcludePhases|Array de fases que pueden ser excluidas del despliegue. Es utilizada cuando ejecutamos la fase ALL_PHASES|
-|sshHost|Dirección Ip de la conexión ssh|
-|sshPort|Puerto de la conexión ssh|
-|sshUser|Usuario de la conexión ssh. Debe tener permisos de lectura/escritura.|
-|sshPassword|Contraseña del usuario de la conexión ssh|
-|powerbuilderExecutablePath|Ruta del ejecutable powerbuilder. Si el path tiene espacios deben encapsularse en cadenas "" y separadores \\|
-|powerbuilderWorkspaceProjectPath|Ruta del workspace del proyecto powerbuilder. Si el path tiene espacios debe encapsularse en cadenas "" y separadores \\|
-|powerbuilderTargetProjectPath|Ruta del target(proyecto) powerbuilder. Si el path tiene espacios debe encapsularse en cadenas "" y separadores \\|
-|powerbuilderTargetProjectPath|Ruta del target(proyecto) powerbuilder. Si el path tiene espacios debe encapsularse en cadenas "" y separadores \\|
-|appeonRepositoryConfigDirectory|Ruta del directorio appeon donde se guarda la configuración. Si el path tiene espacios debe encapsularse en cadenas "" y separadores \\|
-|appeonDeveloperExecutablePath|Ruta del ejecutable appeon. Si el path tiene espacios debe encapsularse en cadenas "" y separadores \\|
-|appeonProfileDeployment|Array que contiene los perfiles de despliegue que se van a generar. Solo puede enviar despliegues de un mismo proyecto. Cada depsliegue requiere nombre del despliegue y datasource.|
-|emailToNotificationDeployment|Correo principal de notificación de despliegue.|
-|emailCcNotificationDeployment|Correo de copia de notificación de despliegue.|
-|emailBccNotificationDeployment|Correo de copia oculta de notificación de despliegue.|
-|notes|Nota asociada al proceso de despliegue.|
-|stopWebServerCommand|Comando de parada del servidor de despliegue.|
-|startWebServerCommand|Comando de inicio del servidor de despliegue.|
-==== Response ====
+^Http^Url^Response^
+|GET|http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/file/(CUFE,CUNE,CUDS)/pdf|PDF|
+|GET|http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/file/(CUFE,CUNE,CUDS)/fv|XML|
+|GET|http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/file/(CUFE,CUNE,CUDS)/ad|XML|
+==== Ejemplo ====
+http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/file/45f477dee2038a13c43f6e748fecb92303e1c67006bd3866fb96f0f3502acb7618d4b31bb8e31b1a09352a7349cb773f/pdf
+==== Request ====
+<code yaml>
+File
+</code>
+==== Consultar el registro un documento ====
+^Http^Url^Request^Response^
+|GET|http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/read/|45f477dee2038a13c43f6e748fecb92303e1c67006bd3866fb96f0f3502acb7618d4b31bb8e31b1a09352a7349cb773f/pdf/|Info SQL|
+|GET|http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/read/|45f477dee2038a13c43f6e748fecb92303e1c67006bd3866fb96f0f3502acb7618d4b31bb8e31b1a09352a7349cb773f/fv/|Info SQL|
+|GET|http://10.1.20.84:3131/SicofDownloadDocumentDB/exportDocumentDian/read/|45f477dee2038a13c43f6e748fecb92303e1c67006bd3866fb96f0f3502acb7618d4b31bb8e31b1a09352a7349cb773f/ad/|Info SQL|
+==== Request ====
 <code yaml>
-{
+Consulta SQL
-  "code": 0,
-  "message": "string",
-  "content": {}
-}
 </code>
-^Columna^Descripcion^
-|code|Código de respuesta del proceso|
-|message|Mensaje de respuesta del proceso|
-|content|Array de mensajes complementarios del proceso|
 ==== Códigos de Respuesta ====
-^Código^Mensaje^Acción^
+^Código^Mensaje^
-|0|Error en la validación.|Debe consultar el array de mensajes content para más información.|
+|200|Petición procesada correctamente. Se devuelve el registro o el archivo consultado.|
-|-1|Error en las ejecución de las fases.|Debe consultar el array de mensajes content para más información.|
+|404|No se identifica el recurso solicitado con los parámetros ingresados. No existe|
-|1|Despliegue realizado correctamente.|Puede consultar el array de mensajes content para más información.|
+|500|Error interno en el servidor. Se debe consultar el log del servidor para más información|

Wiki

Herramientas de usuario

Herramientas del sitio

Diferencias

Herramientas de la página