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 App Connections
  9. System Services, Listeners and Connectors
  10. Designing Human Tasks

Design

Design

Rules and Guidelines for using Process Objects in a Process

Rules and Guidelines for using Process Objects in a Process

Consider the following rules and guidelines when you use process objects in a process:
  • If you use a process object with required fields as the input for an Application Integration process, you must ensure that the required fields are present in the request payload. Otherwise, when you run the process, you receive an error for the missing fields.
    For example, in a process object, you have set the ID field as required, but the field is not present in the request payload as shown in the following sample:
    <root xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”> <Employee> <Name xsi:nil=”true”></Name> <Address xsi:nil=”true”></Address> </Employee> </root>
    After you run the process, you will receive the following error:
    <root> <code>400</code> <details> <missing>[ID]</missing> </details> <message>The parameter validation failed</message> </root>
  • If you set a process object field as Nullable, it can contain a valid value or be null. Non-nullable fields cannot be set as null.
    In the JSON and XML formats, null values in a process object field that is used as the input for an Application Integration process are handled differently.
    In the JSON format, you can specify null values directly as a field value.
    For example,
    {"Name":null}
    XML does not support null values. Therefore, in the XML format, if a field is set as Nullable and you want to pass null values, you must set the
    xsi:nil
    attribute as
    "true"
    in the field element and include
    <xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
    in the root element as shown in the following sample:
    <root xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”> <Employee> <ID>1234</ID> <Name xsi:nil=”true”></Name> <Address xsi:nil=”true”></Address> </Employee> </root>

0 COMMENTS

We’d like to hear from you!