Reports

You can package and deploy the Report artifact along with its associated and child artifacts from  one environment or repository to another environment or repository.

While installing the Report artifacts, it is possible that you can find n number of different reports with same title in the Reports list. The package module identifies a unique Report based on the UniqueReportValue column value of the repository database and installs it to the target environment.

Limitations of the Form Reports

The Form Reports artifact has some behavior limitations. Make sure that you adhere to the following guidelines while installing a Form Reports to a package:

• The Report you want to package must not contain any semicolon (;) in its name.

• Report does not exceed 10 MB of file size.

  You cannot import a package file size exceeding 10 MB to Manage Package list. Hence, you must not add any single report file or more than one report file that exceeds 10 MB file size in a single package. In such cases, we recommend to package each report file in a separate package template.

To add Reports to Package Template

1. Log on to the Enterprise Console.

2. On the Enterprise Console menu, point to Settings, point to Reporting Service, and then click Reports.

   The Reports page appears.

3. Select the report that you want to package.

4. Right-click the report, and then click Add to Package Template.

   The Add to Package Template dialog box appears.

   For more information about adding artifacts to Package Template, see Adding Artifacts to a Package Template.

Configuration Settings for Reports

Reports has an unique set of configuration settings required to install, update, and uninstall the package.

You can view and edit the configuration settings from one of the following windows:

• Source Environment > Package Template window

• Target Environment > Manage Package window

You can use the Settings tab to define the configuration settings. The Associated Artifacts tab displays the associated artifacts of the Reports definition. The Child Artifacts tab displays child artifacts of the Reports definition.

Settings Tab

The properties in this tab allows you to take appropriate actions while installing, updating, or uninstalling the Package.

Install

The settings in this tab is referred to when installing the Package.

• Report Exists: This property allows you to take appropriate action when the Report that you are installing is already present in the target environment.

  • Do not install Report: Select this option if you want to use the existing report which is present in the target environment.

  • Install to overwrite existing Report: Select this option if you want to overwrite the Report which is present in the target environment with the one that is currently being packaged.

• Source: This property allows you to specify the source type of the Report or update the source type in the target environment if it is not present in the target environment.

• Source: This option displays the source type of the Report that you want to package.

• Target: This option allows you to modify or add the source type of the Report that you want to use in the target environment.

Update

The settings in this tab is referred to when the same Package is installed for the consecutive time.

• Delete Report: Select this option if you want to delete an existing Report which is present in the target environment.

  • Yes: Select this option to remove the Report in the target environment and the Report Is Modified option appears.

    Report Is Modified

    • Retain: Select this option if you want to retain the Report along with the modifications, in the target environment even after the Package is updated.

    • Rollback to original state: Select this option if you want to roll back to the original state. All modifications that were done to the Report after it was installed in the target environment will be reverted. However, the Report will be retained in the target environment.

    • Delete: Select this option if you want to delete the Report from the target environment when updating the Package.

  • No: Select this option if you want to retain the Report in the target environment and the Report Exists option appears.

    Report Exists

    • Do not install Report: Select this option if you want to use the existing Report which is present in the target environment. By default, the Do not install Report option is selected.

    • Install to overwrite existing Report: Select this option if you want to overwrite the existing Report which is present in the target environment with the one that is currently being packaged.

      Source

    • Source: Displays the source of the Report.

    • Target: Click to update the source of the Report in the Target environment.

Uninstall

This settings in this tab allows you to define the Package behavior when the Package is being uninstalled in the target environment.

• Delete Report: This property allows you to define whether you want to retain, rollback, or delete the Report in the target environment even after the Package is uninstalled.

  • Yes: Select this option to delete the Report from the target environment when the Package is uninstalled.

  • No: Select this option to retain the Report in the target environment even after the Package is uninstalled.

• Report Is Modified: Select this option to retain, rollback, or delete the Report in the target environment even after the Package is uninstalled. This property is displayed only if Delete Report is set to Yes. However, if Delete Report is set to No, this property is not displayed.

  • Retain: Select this option to retain the Report along with the modifications, in the target environment even after the Package is uninstalled.

  • Roll back to original State: Select this option to roll back to the original state. All modifications that were done to the Report after it was installed in the target environment will be reverted. However, the Report will be retained in the target environment.

  • Delete: Select this option to delete the Report from the target environment when uninstalling the Package.

Associated Artifacts for Reports

This tab displays all the available associated artifacts of the selected Reports artifact.

Report can include the following associated artifacts:

• Parent Report

• Parent Folder: You cannot install a Folder which is disabled but it will allow you to install, update, or uninstall the Reports within it by validating the UniqueReportValue.

Child Artifacts for Reports

If a Report contains a child artifact, the Child Artifacts tab displays all the child artifacts of the selected Report artifact. Otherwise, the Child Artifacts tab is disabled.

Report can include the following Child Artifacts:

• Folder

• Child Reports

Include Child Item

For more information, see Include Child Item.

Security Artifacts for Reports

The Security Artifacts tab displays the security artifacts of a Report, if any.

You can enable the security settings of the reports that you want to include in the package.

For more information about including security artifacts, see Include Security Artifacts.

Note: When a report reference variable is assigned to report viewer artifacts then the report artifact will not be added automatically. The report artifact should be added manually.