Create XML Payload activity

An activity that lets you create an XML payload.


Create XML Payload activity

Configure the Create XML Payload activity

To configure the Create XML Payload activity, do the procedure in this topic.

Good to Know

  • In most text fields, you can use process data variables as an alternative to literal data values.
  • You can configure whether this activity waits for other activities before it runs.

    For more information, refer to How Do I Configure an Activity to Wait for Other Incoming Activities?

  • Some information about third-party integrations is outside the scope of the AgilePoint NX Product Documentation, and it is the responsibility of the vendors who create and maintain these technologies to provide this information. This includes specific business uses cases and examples; explanations for third-party concepts; details about the data models and input and output data formats for third-party technologies; and various types of IDs, URL patterns, connection string formats, and other technical information that is specific to the third-party technologies. For more information, refer to Where Can I Find Information and Examples for Third-Party Integrations?

How to Start

  1. On the Application Explorer screen, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Utilities Utilities icon tab.
      2. Utilities Utilities icon, drag the Create XML Payload Create XML Payload icon activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a System Activity.

  2. Click Create XML Payload Create XML Payload icon.
  3. Configure Create XML Payload Configuration screen.

    For more information, refer to Create an XML Payload.

  4. (Optional) Click Advanced Advanced icon > E-mail Notifications E-mail Notifications icon.

    For more information, refer to Configure E-mail Notifications for Any Activity.

General Configuration

Specifies the basic settings for the Create XML Payload activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field Name Definition

Display Name
Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No
Example:
This is a common configuration field that is used in many examples. Refer to:
  • Examples - Step-by-step use case examples, information about what types of examples are provided in the AgilePoint NX Product Documentation, and other resources where you can find more examples.

Description
Function:
Specifies an optional text description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Create XML Payload Configuration

Specifies the information to make an XML payload.

Figure: Create XML Payload Configuration screen

Create XML Payload Configuration screen

Fields

Field Name Definition

XML Payload
Function:
Specifies the payload to create the XML document. The payload must be in XML format.
Accepted Values:
More than one line of text
Default Value:
None
Accepts Process Data Variables:
Yes

Save Generated XML to
Function:
Specifies the download destination for the XML file.
Accepted Values:
  • A valid file path.
  • A process data variable.

    You can use Process Data screen to specify a process data variable.

Default Value:
None
Accepts Process Data Variables:
Yes