[-s|-skipexisting]

If you use the skipexisting option, the imported data will not overwrite existing configurations that have the same key, name, type, and folder. This means that repeatedly importing a configuration, does not overwrite the data.

[-pp|-preservepermissions]

When user permissions are modified, set the preservepermissions parameter to prevent user permissions in the current system from being updated while importing a configuration.

[-nameconflict re|an|sk]

Decide what to do when there is a name conflict; replace, add new, or skip. Default is to skip the item when there is a name conflict.

[-keyconflict re|an|sk]

Decide what to do when there is a key conflict; replace, add new, or skip. Default is to skip the item when there is a key conflict.

[-namekeyconflict rn|rk|an|sk]

Decide what to do when there is a key or name conflict; replace, add new, or skip. Default is to skip the item when there is a key or a name conflict.

[-he|-holdexecution [ r | sr | sir | wr ] ]

Use the holdexecution option to prevent scheduled workflow groups from being started while importing configurations.

If a workflow or a workflow group does not stop within 5 minutes (300 seconds) when doing a systemimport with either one of the following holdexecution parameters: sr, sir, and wr, a timeout will occur. You can change the timeout value  by setting the Platform property mz.import.suppress.timeout.

When the import is completed and a workflow group is still running, systemimport -holdexecution [ r | sr | sir | wr ] awaits the current running workflow member to come to a stop, and then restarts the whole group instead of continuing the execution of the member that follows.

If you do not specify any of the r, sr, sir or wr options:

• A batch workflow or a workflow group will remain suppressed until all the workflows finish executing. Then, the workflow or the members of the workflow group, become idle.

• A real-time workflow group will return to the running state.

systemimport -holdexecution generates events. To retrieve the events data, configure an Event Notification to transfer it according to your preferences. 

holdexecution Parameters

Select the action that should resolve held executions:

• r (restart): When the import activity is done, and a workflow group is partly executed, specifying this option will restart that workflow group. Workflow groups that are fully executed, will not be restarted. A workflow that is started manually, will be restarted if it has been stopped.

• sr (stop and restart): Stops the workflows or workflow groups that are still running after an import is complete, waits for them to come to a stop or finish processing a batch, and then restarts synchronously all the workflow groups and all the manually started workflows that had not executed completely within the timeout boundaries.

• sir (stop immediately and restart): Stops the workflows or workflow groups that are still running after an import is complete, even in the middle of processing a batch, and synchronously restarts all the workflow groups and all the manually started workflows that had not executed completely within the timeout boundaries.

• wr (wait for completion and restart): After an import is complete, synchronously restarts all the workflow groups and all the manually started workflows that had not executed completely within the timeout boundaries.

[-nr|-norollback]

When you us the systemimport command, a file that contains rollback information will be created. This file contains data about configuration changes during the system import, and is saved in the directory where you apply the command. You use the rollback file to undo a system import and return to the configuration that you had before the system import.

To suppress the creation of the rollback file, provide either a nr or a norollback option.

[-no|-newowner]

Change ownership of the configuration on import. The user must match an user already defined in the Access Controller(4.3).

[ -cp|-configfrompackage ] 

Add this option if you would like to import the Workflow Package (MZP) as configuration instead of a Workflow Package.

[ -iv|-importextrefvalues ]

Add this option if you would like to import the values from External References.

[-select <xml-selection file>
[-dryrun ]
[-onerror < ABORT | IGNORE > ] ]

The -select <xml-selection file> parameter enables you to:

• Provide systemimport with an XML file that specifies your selection of configurations and workflow tables.

• Use [ -dryrun ] to test data compatibility prior to actually importing

• Use [ -onError < ABORT | IGNORE > ] to manage an occurrence of an error

XML Selection File

This selection information that you find in the XML selection file corresponds to the selection information that you specify on the System Import tool view, in the Desktop user interface.

The XML selection file consists of two main tags:

• <configurations>: contains your configuration import selections

• <workflows>: contains your workflow tables import selections

<configurations>

Select configurations from the <Export file|directory> that systemimport imports.

• Use the 

• resolveDependencies attribute to either include (true), or ignore (false), dependent configurations. See the following example:

• To import all the configurations that are included in a specific folder, include the following text in the XML file:
  <configuration foldername="myFolder"/>

<workflows>

This XML tag enables you to use systemimport [-select <xml-selection file>] to import both workflow configurations and their CSV file in one action.
Use this tag to associate workflow tables with CSV data files.

[ -m|-message]

If you want to add a comment when using the systemimport command, the -m or -message option can be used as in the following example:

The comment will replace the default information saved when making a system import, and will both be included in the System Log message that is generated, as well as visible when selecting to view history in any of the configurations in the imported data.

[-u|-upgrade]

When exports have been made in a previous version of Usage Engine, they may have to be upgraded. In this case you can use the -u or -upgrade option as in the following example:

The configurations will then be upgraded.

[-dryrun]

To test data compatibility prior to actually importing.

<export file|directory>

Specify the path to the directory or ZIP file that contains the configurations you want to import.

[password]

To import encrypted configurations, provide a password.

0

Will be returned if the command is successful.

1

Will be returned if the argument count is incorrect or argument(s) are invalid.

2

Will be returned if the command was unable to find an export (file|directory) at the supplied path.

3

Will be returned if the import could not be started due to locked import.

4

Will be returned if any errors were reported during the import.

5

Will be returned if the XML file did not contain any configurations or workflows to import.

8

Will be returned if the XML file did not contain any workflows to use in dry run.

10

Will be returned if the import results in invalid workflows due to compilation errors. 

14

Will be returned if there are configurations not imported

20

Will be returned if the value for a supplied option or option is missing.

100

Will be returned if an error occurs while parsing the selection file

101

Will be returned if an error occurs while parsing a node in the selection XML file.

102

Will be returned if an error occurs while getting the attribute from a configuration tab, or if expected wfTable attribute in tag with the supplied name is missing.

103

Will be returned if the import was unable to parse the value for a booolean XML attribute.

104

Will be returned if an error occurs while parsing dependencies for a configuration.

300

Will be returned if an OutOfMemoryError occurs during import.