Skip to main content
Documentation
Documentation
Administrator Guide
Last Updated: 2023-06-23
Reference: JSON Transformer Properties

Reference: JSON Transformer Properties

Common Tab

Property
XML Attribute Name
Description
Step Id
id
The unique ID of the
json-transformer
 mediation step within the assembly.
Input
input
Specifies where the
json-transformer
 mediation step obtains data as input. There are 5 possible values:
  • message
    : the entire message, including
    rootpart
     and attachments.
  • soapbody
    : the content of the SOAP body from the
    rootpart
     of the message. Only applicable when the input contains a SOAP message.
  • attachment
    : a MIME attachment within the message. You must specify the attachment index.
  • rootpart
    : the content of the root part of a MIME message. If the message isn't MIME, the entire message is selected.
  • variable
    : use a named variable from the
    MediationContext
    .
Output
output
Specifies where the
json-transformer
 mediation step directs the output. There are 5 possible values:
  • message
    : the entire message, including
    rootpart
     and attachments. This value creates a new message, effectively removing any attachments.
  • soapbody
    : the content of the SOAP body from the
    rootpart
     of the message.
  • attachment
    : a MIME attachment to the message. You must specify the attachment index.
  • rootpart
    : the content of the root part of a MIME message, or if the message isn't MIME, the message itself. This value preserves any attachments on the original message.
  • variable
    : save the output as a named variable in the
    MediationContext
    .

Advanced Tab

Property
XML Attribute Name
Description
Description
description
A description of the
json-transformer
 mediation step that displays in the consolidated log. You can use this feature to describe the step's function and the data on which it is operating.
Execute When
execute-when
A condition that determines whether the
json-transformer
 step executes.

Mappings Tab

Property
XML Attribute Name
Description
Json Path
json-path
Specifies the location on the JSON tree where the associated
Value
 is assigned.
Fail No Match
fail-no-match
Determines what happens when the specified JSON path doesn't return a node:
  • true
    : Raise an error.
  • fail
    : Ignore the missing path.