Create a Setup

When a file is ready to be processed, a Setup is used to give the file a unique identity and provide instructions on how to correctly process the data.

Each Setup includes the following components:

Setup Code: A Unique Identifier for the Setup. It ensures that the correct updates are applied to the correct files across clients. Only capital letters can be used to create a Setup Code, as spaces are not permitted. (However, an underscore or dash will be accepted.)
Setup Name: Name to assist with identifying the purpose of the Setup.
Setup Note: A free form text field to add notes for users.
Mode: Setting used to determine the method of processing used by a Setup.

Once the Mode is set, the Setup can be turned On and Off. The Mode options include: On/Off, Trigger, Off.
Setup Options: XML encoded options that will direct the feed during processing. Each Option is equivalent to an instruction detailing how a feed should be processed. Setup Options should include a FeedKey, which is derived from the XML file being imported.

To create a Setup:

Navigate to: System Tools > Data Exchange Manager > Configuration link.

The Configuration screen displays.

Locate the Setups section and select Open.

The DXM Setup screen displays.

Select New.

The New: DXM Setup screen displays.

Use the various fields provided to create the Setup.

DXM Setup For: Name and QuickRef

In the DXM Setup For section:

Select the Wand button (located to the right of the screen).

The Select Entity Wizard opens.

Use the search options provided to locate and select the Entity to whom the Setup will apply. Once complete, select Finish to close the wizard and return to the New: DXM Setup screen.

The name and associated QuickRef of the selected entity will populate the relative fields.

Summary

Type

Note

The DXM Setup option will automatically be selected as the option in the Type dropdown menu.

Setup Code

Use the field provided to enter a unique code to act as an identifier for the newly created Setup.

Setup Name

Use the field provided to enter a unique name to act as an identifier for the newly created Setup.

Setup Note

Use the field provided to enter any additional information regarding the Setup that may assist users of the newly created Setup.

Mode

Modes determine the method of processing used by a Setup. A Mode is set when creating or updating an existing Setup. Once created or updated, the Mode will determine how the Setup operates. A Mode that is set to Off, for example, will disable a Setup and remove it as an option when a file is processed.

The following Modes are available for each Setup:

Mode	Label	Description
Auto	(blank)	Default Mode.
On/Off	ONOFF	Similar to Auto Mode but the feed will show in the list to toggle between On and Off.
Trigger	TRIGGER	Appears in the feed list with an action to Trigger. Will be initiated when processing next occurs, before automatically switching to a non-triggered state.
Off	OFF	No option to enable from Setup Manager list.

To set the Mode:

Select the Mode dropdown menu and select the appropriate option.

Once the Setup is saved, the Mode is set.

Setup Options: What is a FeedKey?

A FeedKey is an identifier that sits within an XML file. A FeedKey ensures that company feeds remain distinct during import. A FeedKey typically includes the Company Name (or an abbreviation of it) and an Indicator describing the contents of the feed in a coded format.

This XML FeedKey is added to a Setup to become the Setup FeedKey, and is used to provide directions and processing options.

When importing an XML file, a FeedKey is used on the outer tag of the XML.

For example:

FeedKey = "ACOMP-REAL"

- would be appropriate for A Company feed containing Real Estate data.

Once the XML FeedKey code has been located, add it to the Setup options field.

Refer to XML files for more details.

With all of the sections populated, select Save.

The new Setup is created and displays.

Select Close.

The new Setup is listed on both the DXM Setup and Setups Manager screens.

Setup Management

Setups can be managed, easily turned On and Off within the Manage section. They list of the current Setups can be accessed through the manage section.

To access a list of all the current Setups in DXM:

Navigate to either:

System Tools > Data Exchange Manager > Configuration link.