Macros de velocidad para acciones de datos

Las integraciones de acciones de datos le permiten crear acciones personalizadas. Estas acciones personalizadas incluyen configuraciones de solicitud y configuraciones de respuesta con plantillas que utilizan Velocity Template Language. Estas plantillas admiten una variedad de macros Velocity.

Las plantillas de velocidad son válidas para los siguientes campos:

• requestUrlTemplate
• encabezados
• requestTemplate
• SuccessTemplate

Para más información, ver Crea una acción personalizada, Solicitar configuración, y Configuración de respuesta.

• Biblioteca de matemáticas
• Biblioteca de escape de cadenas
• encoding.base64
• esc.jsonEncode
• esc.jsonDecode
• successTemplateUtils.firstFromArray
• successTemplateUtils.moveKeysIntoArrayOfObjects
• urlTool.optionalQueryParam
• Macros del método de cadena de Java
• Macros de Microsoft Dynamics
• Macros de Salesforce

Biblioteca de matemáticas

Prefijo: Matemáticas

Utilice estas macros matemáticas para realizar una operación matemática básica. Para más información, ver Clase MathTool en la documentación de Velocity.

Biblioteca de escape de cadenas

Prefijo: Esc

Utilice EscapeTool para escapar de las cadenas en las plantillas de Velocity. EscapeTool proporciona métodos para escapar salidas para Java, JSON, JavaScript, HTML, XML y SQL. EscapeTool también proporciona métodos para escapar de los caracteres de Velocity Template Language. Para más información, ver Clase EscapeTool en la documentación de Velocity.

Los siguientes métodos en particular son muy útiles:

• $esc.urlFormEncode(): Utilice este método para escapar caracteres y cumplir las normas de codificación de formularios URL. Tenga en cuenta que los espacios se codifican como "+" con este método. Lo más probable es que no se utilice para el urlTemplate. Véase el método $esc.uriEncode().
• $ esc.url (): Alias para el $esc.urlFormEncode() con la misma funcionalidad.
• $esc.uriEncode(): Utilice este método para escapar caracteres para cumplir con la URI, por ejemplo, la URL, reglas. Este método debe utilizarse para escapar caracteres en el urlTemplate. Tenga en cuenta que este método codifica los espacios como '%20'.
• $esc.jsonEncode(): Utilice este método para escapar los caracteres reservados de JSON en la salida. Permite almacenar JSON en forma de cadena.
• $esc.jsonString(): Alias para el $esc.jsonEncode() con la misma funcionalidad.
• $esc.jsonDecode(): Utilice este método para eliminar los caracteres reservados de JSON y obtener el JSON original.
• $ esc.d (): Utilice este método para incluir un signo de dólar ($).

La siguiente tabla muestra ejemplos de entradas y salidas de varias macros. 

encoding.base64

Base64 codifica las cadenas que usted proporciona. 

Ejemplo de plantilla

The encoded field is $encoding.base64(\"${first} and ${second}\")

Resultados de ejemplo de plantilla

esc.jsonEncode

Cuando construya cuerpos JSON para peticiones POST, PUT y PATH, debe escapar los caracteres reservados en cualquier cadena. Esta macro escapa de las comillas y otros caracteres según las reglas de codificación JSON.

Ejemplo de plantilla

$esc.jsonEncode(${input.json})

Ejemplo de codificación

esc.jsonDecode

Cuando tenga una cadena codificada en JSON y desee obtener la forma JSON de la misma, puede utilizar la macro esc.jsonDecode(). Esta macro descomprime las comillas y otros caracteres basándose en las reglas de codificación de JSON.

Ejemplo de plantilla

$esc.jsonDecode(${input.escapedjson})

Ejemplo de descodificación

successTemplateUtils.firstFromArray

Esta macro extrae el primer elemento de la cadena de matriz JSON proporcionada y tiene dos parámetros. Se requiere el primer parámetro, que es la matriz de entrada para el valor extraído. El segundo parámetro, que especifica la respuesta que se devuelve cuando la matriz está vacía, es opcional y, por defecto, no devuelve nada. Si la matriz no está vacía, se ignora el segundo parámetro. 

Si la entrada para firstFromArray Si los datos se extraen a través de translationMap JSONPath, no es necesario ningún escape de cadena. En los siguientes ejemplos de plantillas, identificadores podría provenir de una entrada de translationMap, como "identificadores": "$ .idArray".

Ejemplos de plantillas y resultados

* Este ejemplo de plantilla utiliza EscapeTool para escapar caracteres. Para más información, ver Biblioteca de escape de cadenas.

successTemplateUtils.moveKeysIntoArrayOfObjects

Esta macro convierte los datos a un formato compatible con Architect y tiene dos parámetros obligatorios. El primer parámetro es la entrada de la respuesta original. El segundo parámetro es el nombre de la clave que la macro agrega a un objeto y el valor es el campo dinámico de la respuesta original.

Para devolver los datos convertidos, configure el traducciónMapa y SuccessTemplate en su acción de datos basada en el siguiente ejemplo.

Ejemplo de acción de datos

"config": {
  "request": {
    "requestUrlTemplate": "https://some.website.com/with/normalized/data",
    "requestType": "GET",
    "headers": {
    },
    "requestTemplateDefault": true
  },
  "response": {
    "translationMap": {
      "entitySegmentMembershipUps": "$.*.path.to.dynamic.key"
    },
    "translationMapDefaults": {},
    "successTemplate": "{\"segments\": ${successTemplateUtils.moveKeysIntoArrayOfObjects(${entitySegmentMembershipUps})},\"segmentId\")}}"
  }
}

En la respuesta original, no puede acceder al GUID porque es una clave dinámica y no se puede aplanar correctamente.

Respuesta original devuelta

"segmentMembership": { 
  "ups": { 
    "a959c128-d6d9-4a42-a307-c5d278cfcbe2": { 
      "lastQualificationTime": "2020-11-16T03:23:31Z", 
      "status": "realized" 
    } 
  }
}

La macro mueve el ID a un objeto y lo devuelve como segmentoId. 

Macro devolvió la respuesta

"segments": [
  {
    "lastQualificationTime": "2020-11-16T03:23:31Z",
    "status": "realized",
    "segmentId": "a959c128-d6d9-4a42-a307-c5d278cfcbe2"
  }
]

urlTool.optionalQueryParam

Esta macro formatea un par clave-valor como parámetro de consulta, a menos que el valor esté vacío. De lo contrario, la macro devuelve una cadena vacía. No incluya el ampersand (&) en su plantilla; la macro agrega automáticamente el ampersand. Consulte los resultados del ejemplo de plantilla.  Utilice la macro solo después de al menos un parámetro de consulta obligatorio. En el siguiente ejemplo de plantilla, el parámetro de consulta requerido es $ {input.AMOUNT}.

amount=${input.AMOUNT}$urlTool.optionalQueryParam(\"description\", $!{input.DESCRIPTION})

Resultados de ejemplo de plantilla

Macros del método de cadena de Java

Utilice métodos de cadena de Java en las plantillas de Velocity para manipular variables de cadena, como cambiar el caso de un valor o extraer un valor de una cadena. Para más información, consulte Class String en la documentación de Java 17.

En el siguiente ejemplo, el método toUpperCase() convierte el valor de cadena de la variable $a a mayúsculas. los separar() El método divide la variable $ b en una matriz de cadenas. La variable $ d concatena valores de la variable $ a, la variable $ b y el primer elemento de la matriz para la variable $ c.

Ejemplo de plantilla

#set($a = ${input1.string1} )
#set($a = $a.toUpperCase() )
#set($b = ${input1.string2} )
#set($c = $b.split("\+") )
#set($d = "We are using ""${a}"" ""${b}"" ""$c[1]"" to render this." )
$d

Resultados de ejemplo de plantilla

Macros de Microsoft Dynamics

msdynamics.fieldSearchFilter

Esta macro crea un filtro de búsqueda dado un valor y una lista de campos que desea buscar. La macro compara el valor con cada uno de los campos de la lista.

Ejemplo de plantilla

$msdynamics.fieldSearchFilter(\"$input.EMAIL_ADDRESS\", [\"emailaddress1\", \"emailadress2\"]

Resultados de ejemplo de plantilla

msdynamics.phoneNumberFilter

Esta macro crea un filtro de búsqueda dado un número de teléfono y una lista de campos que desea buscar. La macro elimina los caracteres no admitidos y cualquier valor que no sea un dígito, como + y paréntesis, del número de teléfono y agrega "o" entre cada campo. Este filtro de búsqueda es útil para comparar un número de teléfono con varios números de teléfono en un registro de cuenta.

Ejemplo de plantilla

$msdynamics.phoneNumberFilter(\"$input.PHONE_NUMBER\", [\"telephone1\", \"telephone2\"])

Resultados de ejemplo de plantilla

Macros de Salesforce

salesforce.escReservado

Esta macro escapa los caracteres reservados de las consultas de Salesforce SOQL / SOSL realizadas en una URL. Salesforce se reserva los siguientes caracteres: ? & | ! { } [ ] ( ) ^ ~ * : \ " ' + -. Esta macro asegura que los personajes se escapen correctamente. Para más información, ver ENCONTRAR {SearchQuery} en la documentación de Salesforce.

Ejemplo de plantilla

FIND {$salesforce.escReserved(${input.PHONE_NUMBER})} IN PHONE FIELDS

Resultados de ejemplo de plantilla

Para más información, ver Acerca de las acciones personalizadas para integraciones.

Para obtener más información sobre las integraciones, consulte Acerca de las integraciones de acciones de datos.