/
Deploying Repository Bundle
Document toolboxDocument toolbox

Deploying Repository Bundle

Owned by Sarabjeet Kaur
Jan 13, 2025
4 min read

Deploying the repository bundle on the report server

Kyvos Reporting allows you to deploy the repository bundle objects on the report server when upgrading the application version or migrating from one server to another. The packager extracts references to the selected information (repository objects/users preferences/configuration settings) from the repository or file system. It stores it as a .conf file (saved on the Web Server with a default name ‘Untitled. conf’). 

You can open a configuration file and make changes to it.  Then, the configuration file is used to build the cab file, which is later deployed on the Kyvos Reporting server.

You can deploy the repository bundle (cab file) to your report server so that the server can access the required bundle after your application is deployed.

This page discusses the steps to deploy the repository bundle to the server.

Note

A repository bundle is a ‘Package,’ ‘Bundle,’ or ‘CAB.’

A cab file may have any of the following:

  • Repository objects like categories, reports, query objects, parameter objects, analytical objects, dashboards, and dashboard widgets

  • Approval process details

  • Report Schedules

  • Organization, user, user access rights, and user mappings

  • User-created private objects.

  • User/Organization preferences

  • Data connection information (along with access rights information)

  • Printer settings

  • Web client properties

  • Report Server configuration files

  • License File

  • Templates

You need super administrator user privileges to upload and deploy customizations in a repository bundle.

  1. On the Kyvos Reporting portal, click Navigate > Repository > Deploy Repository Bundle.

    image-20241123-102543.png

Note: 

If Kyvos Reporting is security disabled, you can access this page by specifying the following URL in the browser’s address bar.

  • If you are using the computer used as a web server - http://localhost/kyvosreporting/pattern/cabIn

  • If you use a different machine - http://<IP of the server>/kyvosreporting/pattern/cab

  1. In the entry box provided under Step 1, specify the cab file name and its path. If required, use the Browse button to locate the file name.

  2. Click Upload. The content gets uploaded, and information regarding categories and reports is displayed on the page.  (Information on Legends is provided below these steps).

    image-20241123-102754.png

  3. Click Deploy to go ahead with the deployment process.

  4. Click Cancel to discontinue the deployment process.

After you click the Upload button, information about objects in the deployed bundle appears.

The legends are displayed just below the Deploy button. Information about each component in the bundle is shown in respective tabs, such as Category, Users and Roles, Server Configuration, etc.

Note

Whether an existing object should be replaced by the one being deployed is set while creating the bundle.

A log file with the deployment details will be created if Create Log File checkbox is selected. You can download and view these logs on deployment by clicking the Download Log button.

The content is deployed and is visible on respective portal pages.

Deployment status indicators

On uploading the repository bundle, you can see information about objects with the help of the legends below:

  • The object will be updated: The object exists in the repository; it will be replaced by the one being deployed.

  • The object will not be updated: The object exists in the repository and will not be replaced by the one being deployed.

  • New object: The object does not exist in repository, and it will be deployed.

  • Deny deploying: The object will not be deployed because of any of the reasons specified below.

  • Delete Object: To delete the object available in the repository.

  • Cascade Delete: To delete the entire folder along with its sub-folders.

  • The Cascade Delete option appears only for selected entities such as category names but not for objects inside the main category. For example, the Cascade Delete option appears for Reports and not for Query Objects.

    • if Not Exists

      • Click Add check box to add the entity to the repository.

In case a Category has,

  • Same name, same id, different scope

  • Different name, same id, different scope

  • Same name, different id, different scope

In case a Report has,

  • Same name, same id, different scope

  • Different name, same id, different scope

On uploading the CAB file (Deploy Repository Bundle screen), objects with ‘Prompt’ option selected (on the iPackager screen) will appear with a red dot.

You can choose a Deployment Action to be performed on clicking the Deploy button.

The following deployment actions can be taken:

  1. If an object is already present in repository, then you can skip, delete or replace the existing object.

  2. If an object is not present in repository, then you can skip or add that object in the repository.

Copyright Kyvos, Inc. All rights reserved.