Add Records To Complex Schema Node activity

An activity that adds records to a complex schema node.


Add Records To Complex Schema Node activity

Configure the Add Records To Complex Schema Node activity

Prerequisites

Good to Know

How to Start

  1. Open Process Builder.

    For information about how to open this screen, refer to Process Builder.


    Open Process Builder
  2. In Process Builder, in the Activity Library, open the Utilities tab.

    Open Utilities tab
  3. On the Utilities tab, drag the Add Records To Complex Schema Node activity onto your process.

    Drag Add Records To Complex Schema Node activity

General Configuration

Specifies the basic settings for the Add Records To Complex Schema Node activity.

Figure: General Configuration screen

General Configuration screen

Fields

Field NameDefinition

Display Name

Description:
Specifies the activity name that shows in your process.
Allowed Values:
One line of text (a string).

Accepted:

  • Letters
  • Numbers
  • Spaces
Default Value:
None
Accepts 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

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

Add Records To Complex Schema Node Configuration

Configures the form fields to add records to a complex schema node.

Figure: Add Records To Complex Schema Node Configuration screen

Add Records To Complex Schema Node Configuration screen

Fields

Field NameDefinition

Complex Schema Node

Description:
Specifies the complex schema node to which to add records.
Allowed Values:
A repeating complex schema node.
Default Value:
None
Accepts Variables:
Yes

Field Name

Description:
Specifies a form field to add as part of a record to the complex schema node.
Allowed Values:
A form field from the repeating complex schema node specified in the Complex Schema Node field.

When you specify the complex schema node in the Complex Schema Node field, the Field Name column shows all the form fields associated with the complex schema node by default. These are the fields that are included in a record for the complex schema node.

Default Value:
None
Accepts Variables:
Yes

Field Type

Description:
Specifies the value for the form field.
Allowed Values:
A number or a text string that can contain spaces.

The value must be the same data type as the form field.

Default Value:
None
Accepts Variables:
Yes

Create Add Token icon

Function:
Adds a row for the Field Name and Field Type.

Delete Delete icon

Function:
Deletes the selected row.

Update Initial Row If Empty

Description:
Specifies whether to update the first record if it is blank on the Process Detail > Data > Form Variable tab.
Allowed Values:
  • Deselected - Shows the first record even if it is blank.
  • Selected - Updates the first record with the values from the next record if it is blank.
Default Value:
Selected

Preserve Schema

Description:
Specifies whether the schema retain the form field in the records if an app designer deletes it from the complex schema node.
Allowed Values:
  • Deselected - The schema does not retain the form field in the records if it is deleted from the complex schema node.

    You can view the records in Manage Center on the Process Detail > Data > Form Variable tab.

  • Selected - The schema retains the form field in the records even if it is deleted from the complex schema node.
Default Value:
Selected
Example:
A subform has 4 form fields: Name, Age, Address, and Telephone. In the activity configuration, an app designer configures the subform deletes the Address field from the subform.
  • If the Preserve Schema field is selected, the schema retains all 4 fields in the record, regardless of the fields in the subform control. The value for the Address field is null.
  • If the Preserve Schema field is deselected, the schema does not retain the Address field.