Parámetros Dinámicos

 Descripción

El módulo Orchestrator implementa la funcionalidad de parámetros dinámicos que puede ser utilizar en el parámetro de cualquier módulo de la solución.

Los parámetros dinámicos que se permiten en los dos métodos anteriores son:          

• Una  constante
• Un context attribute -> @{FIELD} donde el campo FIELD podría ser:
  • uid > @{uid}
  • externalUID -> @{externalUID}
  • sender  -> @{sender}
  • receiver  -> @{receiver}
  • serviceName  -> @{serviceName}
  • scenarioName  -> @{scenarioName}
• Payload content of module en claro -> @MODULE{moduleName}.
• Payload content of module en Base64 -> @MODULE_ENCODEB64{ moduleName }

Si el moduleName es “actual -> Devuelve el contentido del mensaje de entrada en el módulo.  Ej: @MODULE{actual}

• Un context parameter -> @PARAM{ParamName}
• Un session context parameter -> @S_PARAM{ParamName}
• Un XPATH expression -> 
  • @XPATH{xpath expression}: Valor del XML de entrada en el módulo (Actual XML)
  • @XPATH_EXISTS{ xpath expression} Indica si la expresión XPATH existe o no en el XML de entrada en el módulo (Actual XML). Devuelve “true” en caso de encontrarlo y “false” en caso contrario.
  • @XPATH_ENCODEB64{xpath expression}: Valor del XML de entrada en el módulo (Actual XML) codificado en Base64.
  • @XPATH_DECODEB64{xpath expression}: Valor del XML de entrada en el módulo (Actual XML) decodificado de Base64.
  • @XPATH(moduleName){xpath expresion}: Valor del XML del module “moduleName”
  • @XPATH_EXISTS(moduleName){ xpath expression} Indica si la expresión XPATH existe o no en el XML del module “moduleName”.  Devuelve “true” en caso de encontrarlo y “false” en caso contrario.
  • @XPATH_ENCODEB64(moduleName){xpath expresion}: Valor del XML del module “moduleName”  codificado en Base64.
  • @XPATH_DECODEB64(moduleName){xpath expresion}: del XML del module “moduleName”  decodificado de Base64

• Un MAP à La variable “mapEntry” definida a continuación, puede declararse con cualquiera de los valores dinámicos definidos.
  • @MAP[mapID][mapEntry]: Valor (mapEntry) de un MAPA (mapID) definido para el módulo actual de entrada en el módulo.
  • @MAP(moduleName)[mapID][mapEntry]: Valor (mapEntry) de un MAPA (mapID) definido para un módulo con nombre “moduleName”.

Un ejemplo de configuración y uso de @MAP sería:

xmltransform.miparametro=@MAP[codigoefact][@XPATH(core){/ZINVOIC02_EFAC/IDOC/E1EDKA1[PARVW ='RS']/PAORG}]

xmltransform.codigosefact_name[0]=5828

xmltransform.codigosefact_value[0]=ESB1234500003

xmltransform.codigosefact_name[1]=5829

xmltransform.codigosefact_value[1]= @XPATH{/Facturae/cualquiernodo/valor}

xmltransform.codigosefact_name[2]=5810

xmltransform.codigosefact_value[2]= ESB12345000009

xmltransform.codigosefact_name[3]=DEFAULT

xmltransform.codigosefact_value[3]= ESB12345000003

Otras formas de uso de los mapas

Los siguientes métodos definidos (getAdditionalData y getAdditionalDataKey) son otras formas de uso de los mapas que también están en los módulos.

Método getAdditionalData

Este método devuelve el hashMap de los nombres y valores de los parámetros incrementales con el “paramPrefix” especificados, teniendo en cuenta que irán por parejas “_name”, “_value” más el [index].

Por ejemplo,  si se quieren definir parámetros específicos para “documentum”, en los que necesitemos añadir algún metadato adicional, se haría:

paramPrefix = “metadata” à Valor fijo establecido dentro del módulo. (También se puede hacer dinámico. Ejemplo abajo)

Opciones de parámetros a definir en el Adapter:

1-      Con parámetro “metadata” fijado en el código del módulo. (Como constante)

-          metadata_name[0] = “nombreMetadato”

-          metadata_value[0] = “valor”

-          metadata_name[1] = “nombreMetadato1”

-          metadata_value[1] = “valor1”

2-      Con parámetro dinámico: <modulename>.paramPrefix (Leído de los parámetros del módulo)

-          <modulename>.paramPrefix = “metadata”

-          metadata_name[0] = “nombreMetadato”

-          metadata_value[0] = “valor”

-          metadata_name[1] = “nombreMetadato1”

-          metadata_value[1] = “valor1”

 Método getAdditionalDataKey

Este método devuelve el valor del “paramName” dado (actúa como key del hashmap), de entre valores de los parámetros incrementales con el “paramPrefix” especificados, teniendo en cuenta que irán por parejas “_name”, “_value” más el [index].

Este ”paramName” puede ser uno de los valores especificados en el punto de Parámetros Dinámicos.  Si se especifica un valor DEFAULT, se escogerá este si no encuentra ninguno.

Ejemplo para uso de certificados en módulo “wscall”. Parámetros a definir en el Adapter:

-          wscall.paramPrefix = “certificados”

-          wscall.paramKeyName= 02345 à Parámetro para recuperar el valor. Devolvería “Certificado2”

-          wscall.certificados_name[0] = 0001

-          wscall.certificados_value[0] = Certificado1

-          wscall.certificados_name[1] = 02345

-          wscall.certificados_value[1] = Certificado2

-          …

-          wscall.certificados_value[n] = DEFAULT

-          wscall.certificados_value[n] = CertificadoN

Ejemplo para uso de múltiples “hashmaps” en el módulo de documentum.

-          documdfs. paramPrefix_tipoDocumental=tipoDocumental

-          documdfs.tipoDocumental_paramKeyName=@XPATH(module){/Facturae/XXX}

-          documdfs.tipoDocumental_name[0]=NIF1

-          documdfs.tipoDocumental_value[0]=do_fac

-          documdfs.tipoDocumental_name[1]=DEFAULT

-          documdfs.tipoDocumental_value[1]=do_fac_default

-          documdfs.paramPrefix_user=user

-          documdfs.user_paramKeyName=@XPATH(module){/Facturae/XXX}

-          documdfs.user_name[0]= NIF1

-          documdfs.user_value[0]=usuario

-          documdfs.user_name[1]=DEFAULT

-          documdfs.user_value[1]=usuario_default

Métodos comunes para gestión de contexto y parámetros: 

Método persistContext

Este método gestiona la persistencia del XML (Payload) en el contexto desde cada módulo. Para ello, en el módulo, se configurará, de forma opcional, el parámetro “set­_payload_to_context”. Existen varias opciones de configuración, que se detallan a continuación:

1. “X”: Valor por defecto por retro-compatibilidad (Comportamiento actual). Se persiste el payload del módulo a la salida.
2. "-": No vuelque nada al contexto
3. @XPATH{xpath expression}: Selecciona el contenido de la etiqueta indicada por el valor XPATH y guarda ese contenido como salida del módulo. 
4. @GetNodeContent{xpath expression}: Obtiene el XML contenido dentro del nodo indicado por la expresión XPATH y la persiste como salida del módulo.

Método setParamsToContext

Este método gestiona la persistencia  de un parámetro en una variable de sesión o de contexto desde cada módulo. Para ello, en el módulo, se configurará, de forma opcional, el parámetro “set­_param_to_context”. Los posibles valores de configuración son:

• Un context parameter @PARAM{ParamName, Value}
• Un session context parameter @S_PARAM{ParamName, Value}

Donde value puede ser:

• una constante
• @XPATH{xpath expression}

De esta manera se darán de alta un valor por modulo. Si es necesario dar de alta más valores se debe usar la configuración de MAP:

• @MAP[PARAM]. Se deben definir los valores de ese MAP, de modo que se guardarán en variables de contexto. La configuración sería:
  • .set_param_to_context_name[0]= nombreDelParametroEnElHashMap
  • .set_param_to_context_value[0]= valorDelParametroEnElHashMap. Puede ser:
    • una constante
    • @XPATH{xpath expression}
    • ….
    • set_param_to_context_name[n]= nombreDelParametroEnElHashMap
    • .set_param_to_context_value[n]= valorDelParametroEnElHashMap. Puede ser:
      • una constante
      • @XPATH{xpath expression}

• @MAP[S_PARAM]:  Se deben definir los valores de este MAP, de la la misma forma que para el hashmap anterior (@MAP[PARAM]), pero cuyos valores se guardarán en variables de sesión.

Posteriormente, en otros módulos, se podrán utilizar estos valores recuperándolos con la sentencia @PARAM o @S_PARAM del orchestrador.