Table of Contents

Search

  1. Preface
  2. Understanding Data Types and Field Properties
  3. Designing Processes
  4. Using and Displaying Data
  5. Designing Guides
  6. Designing Process Objects
  7. Designing Service Connectors
  8. Using Connectors
  9. System Services, Listeners and Connectors

2. Design

2. Design

Input Field Properties

Input Field Properties

The input fields available for a process are those contained in the object(s) to which the process applies. This is specified in the Applies To property (on the
Start
tab).
The Input field values are available in all steps of the process. You must define a name and type for the input field category for use in a process:
Property
Description
Input Format
Determines whether the input field can represent one or more fields, or the entire contents of the request. When you select
Whole Payload
, the input field represents the entire content of the request. For example, if you have a customer process object, its contents might be:
"customer": {"name" :"Joe Smith", "street":"3 Main St", "city":"Shelton", "state":"CT"}}
If you check this option, the following would be posted:
{"name" :"Joe Smith", "street":"3 Main St", "city":"Shelton", "state":"CT"}
Name
The name of the input field.
Type
The data type.
Description
Description for the input field.
Required
If the field is required for a process to execute, check
Required
.
For more information on fields, see Introduction to Data Types and Field Properties.

XML Payload

In JSON syntax, a root container is not required. If the payload is XML, however, the root element is required. When it sends XML, Process Designer always adds a root node. If the payload is XML, Process Designer always adds a root node when it sends the request.
For example, if the XML is wrapped:
<root> <oAddressPO> <Street>3 Enterprise Drive</Street> <State>CT</State> <Zipcode>6484.0</Zipcode> <City>Shelton</City> </oAddressPO> <oAddressPO> <Street>31 Enterprise Drive</Street> <State>CT1</State> <Zipcode>106484.0</Zipcode> <City>Shelton1</City> </oAddressPO> </root>
If the XML is unwrapped:
<root> <_1> <Street>3 Enterprise Drive</Street> <State>CT</State> <Zipcode>6484.0</Zipcode> <City>Shelton</City> </_1> <_2> <Street>31 Enterprise Drive</Street> <State>CT1</State> <Zipcode>106484.0</Zipcode> <City>Shelton1</City> </_2> </root>


Updated February 11, 2021