Usage
systemimport [ -s|-skipexisting ] [ -pp|-preservepermissions ] [ -nameconflict re|an|sk ] [ -keyconflict re|an|sk ] [ -namekeyconflict rn|rk|an|sk ] [ -he|-holdexecution [ r|sr|sir|wr ] ] [ -nr|-norollback ] [ -no|-newowner ] [ -cp|-configfrompackage ] [ -iv|-importextrefvalues ] [ -select <xml-selection file> [ -dryrun ] [ -onerror < ABORT | IGNORE > ] ] [ -m|-message ] [ -u|-upgrade ] [ -dryrun ] <export file|directory> [password] ---------------------------------------------------- Import Conflict re = Replace sk = Skip an = Add New rk = Replace Key conflict rn = Replace Name conflict Holdexecution r = Restart sr = Stop and Restart sir = Stop Immediate and Restart wr = Wait for completion and Restart
This command imports a ZIP file, an MZP file, or a directory. If an import entry is in conflict with an entry that already exists in the current system, the entry will not be imported. An example of such a conflict might be an identical entry name, but a different ID.
If you try to import exactly the same MZP file or workflow package twice you get an error. The error is given if the checksums of MZP files are identical. Note that if you export exactly the same configuration twice the checksums will differ.
A workflow group that is scheduled to start while an import activity is happening, will not start until the import is complete.
Options
Option | Description |
---|---|
[-s|-skipexisting] | If you use the |
[-pp|-preservepermissions] | When user permissions are modified, set the |
[-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. NoteIf -nameconflict is not specified and there is a name conflict, the configuration is skipped. To avoid this, use -dryrun to verify before importing. |
[-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. NoteIf -keyconflict is not specified and there is a key conflict, the configuration is skipped. To avoid this, use -dryrun to verify before importing. |
[-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. NoteIf neither of -namekeyconflict, -keyconflict, or -nameconflict is specified and there is a key or name conflict, the configuration is skipped. To avoid this, use -dryrun to verify before importing. |
[-he|-holdexecution [ r | sr | sir | wr ] ] | Use the If a workflow or a workflow group does not stop within 5 minutes (300 seconds) when doing a When the import is completed and a workflow group is still running, systemimport -holdexecution If you do not specify any of the
Select the action that should resolve held executions:
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:
Note! An unreachable workflow is restarted once contact with the Execution Context that it runs on, is regained.
Note! Any workflow that runs past the timeout limit is restarted as soon as it completes execution. Example - Using the holdexecution Option$ systemimport -s -he r export.zip $ systemimport -s -he sr export.zip $ systemimport -s -he sir export.zip $ systemimport -s -he wr export.zip |
[-nr|-norollback] | When you us the Note!Use the To suppress the creation of the rollback file, provide either a |
[-no|-newowner] | Change ownership of the configuration on import. The user must match an user already defined in the Access Controller(4.2). |
[ -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> | Note!Do not use -select for Workflow Packages (MZP files). The
Note!Dryrun is only applicable to ZIP file and directory.
XML Selection FileThis 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>Select configurations from the
Example - The resolveDependencies attribute<import> <configurations> <!-- Ignoring dependencies of the Default.x configuration--> <configuration name="Default.x" resolveDependencies="false"/> <!-- Including dependencies of the Default.y configuration--> <configuration name="Default.y" resolveDependencies="true"/> <!-- Ignoring dependencies of the Default.z configuration--> <!-- Note: Equal to selection of Default.x above --> <configuration name="Admin.C07E02_DEMO_BWF"/> <!-- Ignoring dependencies of configurations within the folder --> <configuration foldername="systemunits"/> <!-- Including dependencies of all the configurations in the folder --> <configuration foldername="billing" resolveDependencies="true"/> </configurations> </import>
Note!If you specify configuration selections in the XML file that do not exist in the Export file, a warning is generated. <workflows>This XML tag enables you to use Note!
Example - The XML selection tags<import> <configurations> <configuration name="myFolder.DB_PROFILE"/> <configuration name="myFolder.APL_PROFILE" resolveDependencies="true"/> <configuration foldername="myFolder"/> </configurations> <workflows > <workflow name="Mobile.FTP_workflow" wfTable="/home/user1/FTP_workflows.csv"/> <workflow name="Mobile.SFTP2_workflow" wfTable="/home/user1/SFTP2_workflows.csv" resolveDependencies="true"/> <workflow name="Mobile.GGSN1_workflow" wfTable="/home/user1/GGSN1_workflows.csv" resolveDependencies="true" onError="ask"/> <workflow name="Mobile.GGSN3_workflow" wfTable="/home/user1/GGSN3_workflows.csv" resolveDependencies="true" onError="ignore"/> <workflow name="Mobile.GGSN4_workflow" wfTable="/home/user1/GGSN4_workflows.csv" resolveDependencies="true" onError="abort"/> <workflow name="Mobile.GGSN5_workflow" wfTable="/home/user1/GGSN5_workflows.csv" resolveDependencies="true" keepOld="false" encryptPassword="password" onError="ask"/> </workflows> </import> |
[ -m|-message] | If you want to add a comment when using the Example - message$ systemimport -m "My Import" /home/Directory/<file to import>.zip "My Import" will be the commented. 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 Example - upgrade$ systemimport -u <file to import>.zip The configurations will then be upgraded. |
[-dryrun] | To test data compatibility prior to actually importing. Note!Dry run is only applicable to ZIP file and directory. |
<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. |
Return Codes
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. |