tipcli - Advanced Export options
Use the ExportPagePlugin tipcli command to export specific Jazz™ for Service Management application server data.
Restriction: When running consolecli.sh|bat commands
in Tivoli® Integrated
Portal environments,
you must use tipcli.sh/bat instead. That is, the consolecli.sh|bat commands
replaced the tipcli.sh/bat commands with the release
of Dashboard Application Services Hub.
Attention: These instructions
assume that you are exporting data from a Tivoli Integrated
Portal environment and not
a Dashboard Application Services Hub one. Therefore, the file
paths and commands are documented in relation to a Tivoli Integrated
Portal instance. For example,
commands are documented using tipcli instead of consolecli.
For Dashboard Application Services Hub environments, substitute
the tipcli element of the command with consolecli.
Note: If
you specify additional parameters for the tipcli.bat|.sh Export and
make a typing error, that is, if you type a parameter incorrectly,
or use the incorrect case, then the commands runs as if no parameters
were specified and no warning message is displayed.
- Export [--exportFile export_file] [--pages ALL|NONE|page1,page2] [--views ALL|NONE|view1,view2] [--roles ALL|NONE|REQUIRED|role1,role2] [--exportPagesInViews true|false] [--userPreferences ALL|NONE|REQUIRED|user_ID1,user_ID2] [--consolePreferenceProfiles ALL|NONE|pref_ID1,pref_ID2] [--includeEntitiesFromApp war1,war2] [--includeCustomData true|false] [--includeCredentialData true|false] [--includeMytasks true|false] [--includeMyStartupPages true|false] [--includeTransformations true|false] --username tip_username --password tip_user_password
Table 1. ExportPagePlugin command arguments Parameter and arguments Description [--exportFile export_file] Optional parameter. Specifies the path and file name for the exported data, for example, c:/tmp/extest.zip. [--pages ALL|NONE|page1,page2] Optional parameter. If you do not use the pages parameter, the default setting is ALL unless either exportPagesInViews or includeEntitiesFromApp is defined, then the default setting is NONE. You can also provide a list of pages that you want to export. [--views ALL|NONE|view1,view2] --exportpageinviews [true|false] Optional parameter. If you do not use the views parameter, the default setting is ALL. You can also provide a list of views that you want to export and optionally specify that you want to export all pages associated with the specified views. Note: Whether the optional parameter exportpageinviews is set to true or false, if a view has a default node in the navigation pane associated with it, then the page associated with the node is always exported. This is also true, even if you specify NONE as the argument to the --pages parameter.[--roles ALL|NONE|REQUIRED|role1,role2] Optional parameter. You can export no roles, all roles, or a specific list of roles. The default setting is ALL unless the pages parameter or the includeEntitiesFromApp parameter is specified. Then, the default setting is set to REQUIRED. [--exportPagesInViews true|false] Optional parameter. Use this parameter, set to true, to export the pages associated with an exported view . The default value is false. [--userPreferences ALL|NONE|REQUIRED|user_ID1,user_ID2] Optional parameter. You can export preferences for all users, no users, or for a specified list of users by user ID. The default setting is ALL. This parameter overrides the includeMytasks and includeMyStartupPages parameters. [--consolePreferenceProfiles ALL|NONE|pref_ID1,pref_ID2] Optional parameter. You can export no preference profile data, all preference profile data, or data for a specific list of preference profiles. The default setting is ALL. Note: If a console preference profile has a custom view as its default view, then that view is automatically exported. If the exported view has a default node in the navigation pane, then the associated page is automatically exported with the view.[--includeEntitiesFromApp war1,war2] Optional parameter. You can provide a list of WARs to export pages that contain widgets associated with the listed WARs. [--includeCustomData true|false] Optional parameter. The default value is true. If is set to false, no customization data is exported. [--includeCredentialData true|false] Optional parameter. The default value is true. If is set to false, no credential data is exported. [--includeMytasks true|false] Optional parameter. The default setting is true. This parameter only applies when the includeEntitiesFromApp parameter is also specified. [--includeMyStartupPages true|false] Optional parameter. The default setting is true. This parameter only applies when the includeEntitiesFromApp parameter is also specified. [--includeTransformations true|false] Optional parameter. The default setting is true. --username tip_username Mandatory parameter. The user name for a user with the iscadmins role. --password tip_user_password Mandatory parameter. The password for the specified user name.