Packages
You can back up all of your system configuration by exporting packages. You can back up these package files and use them to restore your configurations in the event of a system failure.
Packages can contain the configurations for:
- Workflows
- Workflow components (such as pipelines)
- System security settings
- Security components (such as identity providers)
- Your custom plugins
You can also import and export your workflows and their components as .bundle files. For information, see Importing and exporting workflow components.
Exporting packages
You can export the configurations for system components as package files. You can back up these package files and use them to restore your configurations in the event of a system failure.
After exporting a package, you can store it in one of your data sources. When you want to import the package, your system can retrieve it directly from the data source.
Procedure
Click the Configuration window.
Click Packages.
Click Export.
Under Customize Package Description, give your package a name and an optional description.
Under Encryption, select a security passphrase for the package. If no passphrase is entered, one will not be required upon import.
Under Configuration, select any configuration items to export.
Under Plugins, select any plugin bundles to export.
Under Components, select any available components to export.
If you select one component but not the components it depends on, the Admin App prompts you to add those missing components to the package.
Under Validate, make sure your package is valid and then click Download Package.
When your package downloads, click Download Package to download it again, or click Finish to exit.
List of components you can and can't export
You can export:
- Workflows themselves
- Processing pipelines
- Index collections (but not the actual search indexes they represent)
- Data connections
- Content classes
- Plugin bundles that you've built
- The SSL certificate for the system
- The SSL certificates for your data sources
- Security settings
- Identity providers
- Groups
- Roles
You cannot export:
- The system license
- Built-in plugin bundles
- Search indexes
- Default pipelines
Related CLI commands
buildPackage
downloadPackage
Related REST API methods
POST /package/build
POST /package/download
You can get help on specific REST API methods for the Admin App at REST API - Admin.
Importing packages
To import a package, you can upload it from your computer or have your system retrieve it from one of your data sources. After you import the package, your system runs a system task to synchronize the package components across all instances in your system.
The system can have only one imported package at a time.
If the package contains a workflow but not its individual components, you cannot import the package. You need to either:
- Export a new package that contains all the workflow's dependencies.
- Create components with the same names on the system to which you're importing the file.
- Importing a component that already exists on your system might cause conflicts and should be avoided.
- You need to manually resolve conflicts with components, while conflicts with configuration are handled automatically by the system.
- If you encounter errors, make sure you are uploading a package file and not a workflowcomponent bundle.
- Components and workflows from Hitachi Content Monitor should not be imported, as it may cause undesirable behaviors to occur on your system.
Procedure
Click the Configuration window.
Click Packages.
Click Import.
Do one of these:
- If the package you want to import is stored on your computer, click and drag the package file into the Upload Package window.
- If the package you want to import is stored in one of your data sources, click the Click to Upload window. Then, browse for the package file.
Enter the Package Protection Passphrase created during export, leaving the field empty if the package doesn't require one. Then, click CLICK TO CONTINUE.
Under Package Description, review the description and then click Continue.
Under Configuration, select any configuration items to import.
Under Plugins, select any plugin bundles to import.
Under Components, select any available components to import.
Under Validate, make sure your package is valid and then click Install Package.
Your system starts a system task to install the package components on all instances in the system.
You can monitor the task from the current page or from the Processes page.
When the task has completed and all package components have been installed, clicking Complete Install deletes the package from the system.
Related CLI commands
uploadPackage
loadPackage — (Loads a package from a data connection)
installPackage
getPackageStatus
deletePackage
Related REST API methods
POST /package (Uploads a package)
POST /package/load (Loads a package from a data connection)
POST /package/install
GET /package (Gets the status of the imported package)
DELETE /package
You can get help on specific REST API methods for the Admin App at REST API - Admin.