v7

Implementación de métodos SOAP

Introducción

Es posible crear métodos SOAP en JavaScript. Esta función simplemente habilita los procesos aplicativos, puede evitar desarrollar JSP y sus llamadas en los formularios.

Estos métodos SOAP se comportan del mismo modo que los definidos de forma nativa en la aplicación. Se admiten los mismos atributos: static, key only y const.

Definir una biblioteca de métodos

La creación de una biblioteca de métodos consta de dos fases:

• La declaración del método SOAP,
• Definición (o implementación) en JavaScript.

Declaración

Comience declarando los métodos en los esquemas (para obtener más información sobre cómo crear y editar esquemas, consulte esta sección).

Su declaración es similar a la de los métodos nativos, excepto que necesita agregar el atributo "library" (biblioteca) que especifica el nombre de la biblioteca de métodos donde se encuentra la definición.

Este nombre coincide con el nombre (con el área de nombres) de la entidad de tipo "JavaScript Code".

Ejemplo:

El método testLog(msg) se declara en una extensión nms:recipient

<method name="testLog" static="true" library="cus:test">
     <parameters>
       <param name="message" type="string" inout="in"/>
     </parameters>
   </method>

Definición

Los métodos SOAP se implementan en forma de función de JavaScript agrupada en una secuencia de comandos que representa una biblioteca.

La secuencia de comandos puede contener el código que se va a ejecutar durante la carga inicial de la biblioteca.

1. Nombre

El nombre de la función debe cumplir con el siguiente formato:

 <schema-namespace>_<schema-name>_<method-name>

Ejemplo:

La siguiente función de JavaScript es la implementación del método descrito anteriormente. Se definirá en la entidad de tipo "JavaScript Code" utilizando el nombre "cus:test".

function nms_recipient_testLog(message)
 {
   logInfo("*** " + message)
 }

2. Firma

La firma de la función debe incluir un argumento para cada parámetro "in" o "inout" de la declaración.

Casos específicos:

• métodos no estáticos: la función debe incluir primero un argumento adicional, que coincida con la entidad XML pasada en forma de objeto de tipo "xml" (E4X).
• Métodos de tipo "solo clave": la función debe incluir primero un argumento adicional, que coincida con la clave pasada en forma de cadenas de caracteres.

3. Valores devueltos

La función debe devolver un valor para cada parámetro de tipo "out" o "inout". Caso específico: si el método se declara sin ninguno de los atributos "static", "key only" o "const", el primer valor devuelto debe coincidir con la entidad modificada. Es posible devolver un objeto nuevo o devolver el primer parámetro modificado.

Por ejemplo:

function nms_recipient_setLastName(self, name)
 {
   self.@lastName = name
   return self
 }

Cuando se devuelven varios valores, estos deben mostrarse en una tabla.

Ejemplo:

function nms_recipient_getKey(self)
 {
   return [self.@firstName, self.@lastName]
 }