...
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 | ask]
...
This parameter enables you to identify an imported configuration with a name that is identical to the name of a configuration that already exists in your system. Using this parameter requires that you specify what you want to do with the imported configuration:
re
(REplace): Overwrite the current configuration with the imported one.an
(Add New): Add the imported configuration to your system. To resolve the name conflict, the new configuration's name is extended with_1
at the end.
...
Note!
A name that already ends with _n
is modified at the end to _n+1
.
...
sk
(SKip): Ignore the conflicting imported configuration.ask
: Prompt when a conflict is detected.
...
Note!
If you do not set this parameter, the conflicting configuration is skipped and ignored.
[-keyconflict re | an | sk | ask]
This parameter enables you to identify an imported configuration with a key that is identical to the key of a configuration that already exists in your system. Using this parameter requires that you specify what you want to do with the imported configuration. For information about the keyconflict
options, see [-nameconflict re | an | sk | ask].
Info | ||
---|---|---|
Example.The command
| ||
Note | title |
Note!
If you do not set this parameter, the conflicting configuration is skipped and ignored.
[-namekeyconflict rn | rk | an | sk | ask]
This parameter enables you to identify an imported configuration with a name as well as a key that are identical to a name and a key of two different configurations that already exist in your system. Using this parameter requires that you specify what you want to do with the imported configuration:rn
(Replace Name conflict): Replace the configuration that name conflicts with the imported configuration.rk
(Replace Key conflict): Replace the configuration that key conflicts with the imported configuration.an
(Add New): Add the imported configuration to your system.sk
(SKip): Ignore the conflicting imported configuration.ask
: Prompt a message when a conflict is detected.
...
Note!
If you do not set this parameter, the conflicting configuration is skipped and ignored.
[ -he|-holdexecution [ r | sr | sir | wr ] ]
Info | ||
---|---|---|
Example. Using the holdexecution parameter
|
...
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 the Event Notification Editor to transfer it according to your preferences. For information about the Suppressed Event event type, see /wiki/spaces/MD82/pages/3770259 in the Desktop user's guide.
...
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.
...
Note!
A workflow that becomes Unreachable after a system import has begun, will be restarted only when and if the contact with the Execution Context that it runs on, is regained while still importing.
If a workflow is unreachable when system import is started, the import is aborted and the following error message is generated: Abort Import: At least one wf that is Unreachable
.
For further information about the Unreachable state, see /wiki/spaces/MD82/pages/3769891 in the /wiki/spaces/MD82/pages/3768690.
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.Note title Note! An Unreachable workflow is restarted once contact with the Execution Context that it runs on, is regained. For further information about the Unreachable state, see /wiki/spaces/MD82/pages/3769891 in the /wiki/spaces/MD82/pages/3768690.
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.Note title Note! Any workflow that runs past the timeout limit is restarted as soon as it completes execution.
...
When you use systemimport, 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.
...
...
Note!
Use the importrollback command only to revert the systemimport
command and not for the purpose of a system rollback. For further information see importrollback.
To suppress the creation of the rollback file, provide either a nr
or a norollback
option.
...
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 importingUse
[ -onError < ABORT | ASK | 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.
Info | |||
---|---|---|---|
title | Example - The resolveDependencies attribute
|
...
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.
...
Note!
Set the
keepOld
attribute to true in order to prevent removal of workflow table data which has no match in the export file. Use false to overwrite the data. This parameter is only used during import, and has no effect during export.The
onError
attribute can either be set from the XML selection file, or from the systemimport in-line command. If set from both, the XML selection file attribute is the value that applies. For further information about the values that you can choose from, seeonError.
This parameter is only used during import, and has no effect during export.Set the
encryptPassword
attribute to the workflow configuration password if the workflow configuration is password protected.
Info | ||
---|---|---|
Example. The XML selection tags
|
...
If the onError attribute is not specified in the XML selection file, the value that you set it to in systemimport, is the value that applies. Otherwise, the attribute value applies. Set [-onError]
to any of the following values:
ask
: to generate an interactive messageignore
: to do nothingabort
: to abort the command and stop a current configuration import
[-m|-message]
If you want to add a comment when making a systemimport, the -m
or -message
option can be used as in the following example:
Info | |||
---|---|---|---|
title | Example - message
"My Import" will be the commented. |
...
When exports have been made in a previous version of MediationZone, they may have to be upgraded. In this case you can use the -u
or -upgrade
option as in the following example:
Info | ||
---|---|---|
Example - upgrade
|
...
If you want imported users to be active after you run the import, use the -eu
or -enableusers
option as shown in the following example:
Info | ||
---|---|---|
Example - enableusers
|
...
Listed below are the different return codes for the systemimport
command:
Code | Description |
---|---|
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. Additional information from the "critical error log" will be included, this is further described in /wiki/spaces/MD82/pages/3778787 in the System Administrator's Guide. |