Adding a parse action

A parse action controls the parsing of an input document. When the input document is a JSON string, the string is parsed instead of copied over.

About this task

With a parse action, the parse settings override the following settings.
  • Parser limits in the XML manager tor input documents
  • Maximum message size in the service configuration
You can retrieve parse settings by using the following methods in increasing order of precedence.
  1. An instance of a parse settings object. If not specified, the default parse settings are applied.
  2. A literal string as serialized XML or JSON properties as parse settings. These properties take precedence over any existing default properties.
    • The XML form of the string is as follows.
      <ParseSettings><property>value</property></ParseSettings>
    • The JSON form of the string is as follows.
      { \"ParseSettings\" : { \"property\" : value } }

    For more information, see the parse-settings-reference command.

  3. A string that represents a named context or a URL that represents a named context from which to retrieve the serialized XML or JSON properties as parse settings. These properties take precedence over any existing literal or default properties.

When the selected format to save the metrics of parsing is JSON or XML, specify a URL or string that represents a named context to store the metrics of parsing.

Procedure

  1. Drag the Advanced icon to the configuration path.
  2. Double-click the Advanced icon.
  3. From the action list, select Parse.
  4. Click Next.
  5. In the Input field, specify the context of the message to process.
  6. Optional: Define how to retrieve parse settings.
    • In the URL reference field, specify the URL or string to retrieve parse settings.
    • In the Literal configuration field, specify parse settings with an XML or JSON text string with parameters and their values.
    • From the Object reference list, select the parse settings to retrieve the default settings. For more information, see Creating parse settings.
  7. Optional: From the Parse metrics result type list, select the format to save the metrics of parsing.
    GraphQL is not supported.
  8. Optional: When JSON or XML is the result type, specify the URL or string to store the metrics of parsing in the Parse metrics result location field.
  9. Set the Asynchronous property to indicate whether to process asynchronously. When enabled, the action does not need to complete before the rule starts processing its next action.
  10. In the Output field, specify the context of the message after processing.
  11. Click Done.

What to do next

If this action is the last one for the rule, click Apply policy. Otherwise, drag another icon to the configuration path.