<Steps>

The <Steps> element is the parent for the collection of <Step> elements that define how the imported data is to be processed. This table describes each attribute of the <Steps> element:

AttributeDescription
RootQueryXPath query that specifies an XML element in the import file. The RootQuery is used for all root steps (steps that aren’t linked to other steps). The root query for a child step is set by its parent.

This attribute is optional. If you don’t specify a RootQuery, you can use the RelativeQuery attribute of a <Link> element to define the XPath query for a root step.

<Step>

The <Steps> element has one or more <Step> elements as children.

There are two types of steps. Root steps are not linked to other steps. Steps that are linked to other steps are children. If a step has children, the children will be processed before moving on to the next step. This is important because a step might set a variable that is required by its children.

This table describes each attribute of the <Step> element.

AttributeDescription
Id Alphanumeric ID for the step. Required.
TargetBusinessObjectInfor Public Sector or agency business object that the step acts on. The target can be specified by a moniker or a variable. If using a variable, the variable should be enclosed in curly brackets and preceded by a dollar sign, such as “${SR}.” Required.
Action Action that the step performs. Required.
  • Create: Adds a new record.
  • Update: Updates an existing record, if found.
  • Create, Update: Creates a new record if it doesn’t already exist, or updates the existing record if one is found.
  • Lookup: Searches for an existing record.
  • Select: Same as Lookup.
  • Sync: Used to synchronize a set of records in the database with the data in the import file. Records that exist in the XML but not the database will be added. Records that exist in both will be updated in the database. Records that exist in the database but not the XML will be deleted.
  • None: The step performs no action on the target business object.
OrderNumber indicating the order in which the step is to be processed. If no order is defined, steps are processed in the order in which they were added to the mapping file.
OptionalIndicates whether this step is optional. By default all steps are required, meaning the import processor will return an error if no source data is found. If a step is optional, the import processor will add a warning if source data is missing, but will continue processing the import.
UpdateCheck If the step’s action is “Update,” “Create, Update,” or “Sync,” the UpdateCheck attribute defines the properties that will be used to search for existing records to update.

The attribute should specify one or more properties of the step’s target business object in a comma-separated list. Each property listed must be the target of one of the step’s <Map> elements.

VariableIdVariable ID that will be assigned to the step’s business object. The variable ID is assigned after the step is processed, but before any extended actions are performed.
VariableTypeType of variable for the variable ID. If the variable type is a collection (an implementation of the IList interface), the import processor will call the .Add method and add the object to the collection. Otherwise it will overwrite the current value of the variable, if set.
AllowNullSelectNo longer used, but kept for backwards compatibility.