Intellicus Enterprise Reporting and Business Insights 18.1

Backup Files Using iPackager (CAB)

0 views June 28, 2020 0

iPackager is a utility to package repository objects, users’ preferences and configuration settings from Intellicus repository or local file system. This packaged information can then be deployed at any of the installation of Intellicus.

This way, you can use iPackager to setup and maintain Intellicus repository from remote location.

When Intellicus is deployed at multiple locations, iPackager helps save a lot of efforts spent to set up Intellicus repository at each of the locations. Set it up at one location and just upload the package at other locations. This method eliminates the need of re-doing all the configuration activities at multiple locations.

How to access iPackager

You can launch iPackager from the Intellicus Portal as shown below.

To open iPackager, click Navigate > Repository > iPackager.

Menu option for ipackager
Figure 1: Menu option to open iPackager from Intellicus portal

Application Window

Top of the application window has menus. Remaining part of the screen is divided in three panes: Entity Type, Select Entities and Selection Summary.

ipckager home screen
Figure 2: iPackager home screen

  • Entity Type: This is the list of all repository objects available on Intellicus Report Server.
  • Select Entities: This is the list of entities selected for creating the configuration file.
  • Selection Summary: This is the area where you can view the summarized details of your selected objects.

Adding objects to the Configuration file

The CAB file that you create for restoring objects in the new version, we also call it as a configuration file. Information can be added in a configuration file in the following way. We recommend you keep saving your work in the configuration file.

Under Entity Type, expand Repository, Users and Configuration upon clicking the adjacent arrow keys. You can now click the sub-items like Reports, Query Objects, Parameter Objects, Analytical Objects, Dashboards, Dashboard Widgets, etc. to view the list of objects in the Select Entities pane.

Make your required choices in the User Management and Repository categories. The objects under these categories are your user preferences settings, and report and design related operations that you performed.

Adding objects to configuration file
Figure 3: Adding objects to configuration file

Under Select entities, you can then either select the parent (say Category) to select all objects under it or individually select the objects you wish to add to the configuration file.

The Selection Summary pane enables you to view the number of all the selected objects.

Clicking “Select All Data From Report Server” would enable to select all the objects from Intellicus repository.

Click “Include Dependent Objects” checkbox to package referenced/dependent objects at the time of creating a cab file. For example, for a selected Dashboard object, you can build a cab using all the objects associated to that dashboard.

Once you have selected the required objects under User Management and Repository categories, expand the arrow of the Configuration category.

In the Configuration category, you will find many sub categories, however, in the upgrade process you only need to select the Connections sub category. Skip selecting any other entity under Configuration category under Entity Type pane. The remaining configuration files needs to be merged manually.

Once you select Connections, you will see the entities stored in it in the Select Entity pane, in here check the Configuration box so as all your connections are selected.

Building the Cab file

When you issue a command to build the cab file, all the information that you stored in the open configuration file is picked up from the respective locations.

If any of the information saved in configuration file is not available at the right source while building the cab, then respective error message will be given, and the cab building process will be stopped.

Build CAB file
Figure 4: Building the Cab file

To build the cab,

  1. Click “Build Cab”. The Build Properties screen appears.
  2. Specify build properties like Name of the cab, along with its Author, Company, Version and any additional information under Comment.
    The configuration file gets saved with the same name as the Cab file if not saved earlier.
    If the configuration file already exists on the Web Server with the same name, the user is prompted with a message to overwrite or not.
  3. Click the “Build and Download” button.
  4. The cab building process starts.
  5. The cab file gets saved under the browser’s default download folder location.

Error Cases

A cab is built only when all the objects added in an open configuration file are available on the Report Server at the time of building the cab.

When the configuration file is opened, iPackager validates the information stored in the configuration file with respective server. If any of the information stored in configuration file is not found on server, the entry (including parent entries) is highlighted in red. In addition to this, if any of the following conditions exist, red highlight would appear.

  • Source report for a linked report is not found.
  • Task for a job is not found.
  • Report for a task is not found.
  • Any object added but not found in the server at the time of opening a configuration file or building the cab file.
  • Invalid characters used in object names.

Valid and Invalid characters for filenames

Valid characters for filename: 0-9, a-z, A-Z, “-“, “_”, “@”, “.”

All the above can be one word or multiple words.

Configuration file having invalid filename is prompted with a warning message stating that the file cannot be saved.