Wrapped list definition | Developer Documentation

Usage

<modifiers> wrapped list xml-name of element-definition

<modifiers> wrapped list xml-name of choice-def

<modifiers> wrapped list xml-name of sequence-definition

Modifiers

Modifier	Description
optional	Makes the wrapped list optional in the integration message. The initial value of an optional list in the workflow script representation of the message is null - see the remarks section for how this affects integration scripting.

Parameters

Parameter	Description
xml-name	The name of the attribute's XML node in the integration message.
element-definition (required)	An element definition.
choice-def	A choice definition.
sequence-definition	A sequence definition.

Remarks

Only a wrapped list element can be the root element of an integration message.

You can get or set the values of wrapped list items the same way you access items in conventional lists. To access items in an optional wrapped list in a workflow script, the script needs to check for a null reference first (see the relevant sample).

You can add new list items to wrapped lists in workflow scripts the same way you add new items to conventional lists. To populate an optional wrapped list with new items in a workflow script, a new instance of the list needs to be created first, using the [Name]New() (see the relevant sample).

Samples

Some of the workflow scripts in the samples below are triggered by incoming integration messages. Others are referencing integration message schema so that they can create outgoing integration messages. To try the following samples out for yourself, you'll need to upload an intconf.xml file that defines inbound and outbound integration endpoints and the integration messages and schema that they accept, so that these workflow scripts can reference them. You'll also need to create the inbound and outbound endpoints on your Cloud instance that match the names specified in the intconf.xml file.

wrapped list sample

Integration message schema

wrappedListSample.dacsem

schema wrappedListSample
  meta 'rockyJupiter:wrappedListSample'
  namespace "http://schemas.rockyjupiter.com/wrappedListSample"
  order: element {
    fruits: wrapped list of element fruit of type string without whitespace;
}

Sample schema-conformant XML

wrappedListSample.xml

<order xmlns="http://schemas.rockyjupiter.com/wrappedListSample">
  <fruits>
    <fruit>nectarine</fruit>
    <fruit>orange</fruit>
    <fruit>pomegranate</fruit>
    <fruit>raspberry</fruit>
  </fruits>
</order>

Accessing an item of a wrapped list in a workflow script

wrappedListSampleRead.rfs

server program wrappedListSampleRead for dacs wrappedListSample
{
  var fruits = dacs.order.fruits;
  foreach (var fruit in fruits) trace fruit;
}

Creating and populating a wrapped list to an integration message in a workflow script

wrappedListSampleWrite.rfs

server program wrappedListSampleWrite for form orson
using dacs wrappedListSample;
{
  var msg = messages.wrappedListSample.New();
  msg.order.fruits.Add("apple");
  msg.order.fruits.Add("strawberry");
}

optional wrapped list sample

Integration message schema

optionalList.dacsem

schema optionalList meta 'rockyJupiter:optionalList' namespace "http://schemas.rockyjupiter.com/optionalList"
pawa: element {
  classs : optional wrapped list of element class {
    konya: attribute of type int;
    bemidji: content of type float;
  }
}

Sample schema-conformant XML

optionalList.xml

<pawa>
  <classs>
    <class konya="45">6.3</class>
  </classs>
</pawa>

Accessing an item of an optional wrapped list in a workflow script

optionalListRead.rfs

server program optionalListRead for dacs optionalList
{
  if(dacs.pawa.classs != null)
  {
    foreach( var class in classs) trace class; 
  }
}

Creating and populating an optional wrapped list to an integration message in a workflow script

optionalListWrite.rfs

server program optionalListWrite for form bashful
using dacs optionalList;
{
  var msg = messages.optionalList.New();
  var classs = msg.pawa.classsNew();
  var class = classs.AddNew();
  class.konya = 7;
  class.bemidji = 90.56;
}