Element definition | Developer Documentation

Usage

<modifiers> element xml-nametype-definition

<modifiers> element xml-name
{
  field-definition₁
  ...
  field-definition_n
}

Modifiers

Modifier	Description
optional	Use it to make an element or attribute optional in the integration message. This modifier sets the initial value of the associated element or attribute to null in the workflow script representation of the message. This modifier is not available for the root element of the integration message XML hierarchy.
unordered	Use this modifier to make the integration message schema accept child elements for an element in any order, not only the order they are declared in.

Parameters

Parameter	Description
xml-name	The name of the element's XML node in the integration message.
type-definition (required)	The type definition for the element.
field-definition (required)	One or more element field definitions (attributes, child elements, or text node content - see the remarks for restrictions).

Remarks

In general, to get or set the values in an element, or to create a new schema-conformant element in a workflow script, use dot notation.

A sample integration message schema with a complex element:

generalElement.dacsem

schema generalElement meta 'rockyJupiter:generalElement' namespace "http://schemas.rockyjupiter.com/generalElement"
splat: element
{
  squish: element
  {
    swoosh: attribute of type int;
  }
}

A workflow script that accesses the values of the complex element in a message that conforms to the schema above:

generalElementRead.rfs

server program generalElementRead for dacs generalElement
{
  trace dacs.splat.squish.swoosh;
}

A workflow script (triggered by the chuck.fls.xml form) that creates and populates an integration message that conforms to the schema above:

generalElementWrite.rfs

server program generalElementWrite for form chuck
using dacs generalElement;
{
  var msg = messages.generalElement.New();
  msg.splat.squish.swoosh = 8080;
}

When accessing the attributes or child elements of optional elements in a workflow script,

optionalParent.dacsem

schema optionalParent meta 'rockyJupiter:optionalParent'
namespace "http://schemas.rockyjupiter.com/optionalParent"
achoo: element {
  boing: optional element
  {
    clang: attribute of type int;
    ding_dong: content of type string without whitespace;
  }
}

Figure 426. An integration message schema with an optional parent element, used in the workflow script samples below

you need to first check if the parent element exists to prevent a null-reference:

optionalParentRead.rfs

server program optionalParentRead for dacs optionalParent
{
  if(dacs.achoo.boing != null)
  {
    trace dacs.achoo.boing;
    trace dacs.achoo.boing.clang;
  }
}

For optional XML nodes that do not have child nodes, such as attributes or text node elements, you only need the script to explicitly check for a null value if a null value would break the solution.

When creating optional elements in a workflow script, use the [Name]New() method:

The sample script below is triggered by the cluck.fls.xml webform, and uses the optionalParent.dacsem schema from above.

optionalParentWrite.rfs

server program optionalParentWrite for form cluck
using dacs optionalParent;
{
  var msg = messages.optionalParent.New();
  var boing = msg.achoo.boingNew();
  boing.ding_dong = "fizz";
  boing.clang = 650;
}

Mixed content, that is, XML elements with both text nodes and child elements, is not supported in the integration message schema language. No valid integration message schema could declare the sample XML below.

mixedContent.xml

<dontTryThisAtHome>
  This 
  <invalid>element</invalid>
  would not be valid as an 
  <illegal>integration message</illegal>
  .
</dontTryThisAtHome>

Child elements and lists, however, may be declared on the same parent element:

perfectlyLegal.dacsem

schema perfectlyLegal meta 'rockyJupiter:perfectlyLegal' namespace "http://schemas.rockyjupiter.com/perfectlyLegal"
potato: element
{
  aardvark: element of type int;
  flabbergasted: list of choice
  {
    rubber: element
    {
      posh: attribute of type string;
    }
    clark: element of type dtl;
  }
}

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.

Simple text node element

Integration message schema

elementOfType.dacsem

schema elementOfType meta 'rockyJupiter:elementOfType'
  namespace "http://schemas.rockyjupiter.com/elementOfType"
  finks: element Niagara of type string without whitespace;

Sample schema-conformant XML

elementOfType.xml

<Niagara xmlns="http://schemas.rockyjupiter.com/elementOfType">
  "Hovercraft!"
</Niagara>

Accessing an integration message XML element value in a workflow script

elementOfTypeRead.rfs

server program elementOfTypeRead for dacs elementOfType
{
  trace dacs.finks;
}

Assigning a new value to an integration message XML element in a workflow script

Download the inky.fls.xml trigger form for the script below.

elementOfTypeWrite.rfs

server program elementOfTypeWrite for form dummy
using dacs elementOfType;
{
  var msg = messages.elementOfType.New();
  msg.finks = "Blucher!";
}

Element with an attribute and text node content

Integration message schema

elementWithContent.dacsem

schema elementWithContent meta 'rockyJupiter:elementWithContent'
  namespace "http://schemas.rockyjupiter.com/elementWithContent"
  dragee: element
{
  biddie: attribute of type dtl (dtf yyyy"-"MM"-"dd);
  feute: content of type int;
}

Sample schema-conformant XML

elementWithContent.xml

<dragee xmlns="http://schemas.rockyjupiter.com/elementWithContent"
  biddie="1976-03-21">16</dragee>

Accessing an integration message XML element value in a workflow script

elementWithContentRead.rfs

server program elementWithContentRead for dacs elementWithContent
{
  trace dacs.dragee;
  trace dacs.dragee.biddie;
  trace dacs.dragee.feute;
}

Assigning a new value to an integration message XML element in a workflow script

Download the pinky.fls.xml trigger form for the script below.

elementWithContentWrite.rfs

server program elementWithContentWrite for form pinky
using dacs elementWithContent;
{
  var msg = messages.elementWithContent.New();
  msg.dragee.biddie = dtl.New(2015, 10, 20, 0, 0, 0, 0);
  msg.dragee.feute = 76;
}

Element with child element

Integration message schema

elementWithChildren.dacsem

schema elementWithChildren meta 'rockyJupiter:elementWithChildren'
  namespace "http://schemas.rockyjupiter.com/elementWithChildren"
compy: element
{
  cephalo: element
  {
    raip: optional attribute of type float;
  }
  salami: list of element salam of type int;
}

Sample schema-conformant XML

elementWithChildren.xml

<compy>
  <salam>62</salam>
  <salam>431</salam>
  <salam>10</salam>
  <salam>98320</salam>
  <cephalo raip="3.14"/>
</compy>

Accessing an integration message XML element value in a workflow script

elementWithChildrenRead.rfs

server program elementWithChildrenRead for dacs elementWithChildren
{
  trace dacs.compy.cephalo.raip;
  foreach(var salam in dacs.compy.salami) trace salam;
}

Assigning a new value to an integration message XML element in a workflow script

Download the blinky.fls.xml trigger form for the script below.

elementWithChildrenWrite.rfs

server program elementWithChildrenWrite for form blinky
using dacs elementWithChildren;
{
  var msg = messages.elementWithChildren.New();
  msg.compy.cephalo.raip = 3.6;
  msg.compy.salami.Add(1800);
  msg.compy.salami.Add(10);
  msg.compy.salami.Add(213);
}