Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Work Tasks

TABLE OF CONTENTS

Report Templates

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedJul 01, 2024
  • 5 minute read

You can package and deploy the Report Templates artifact from one environment or repository to another environment or repository using the Package feature in AVEVA Work Tasks.

To add Report Templates to Package Template

Complete the following tasks to add a report template to a package template:

  1. Log on to the Enterprise Console.

  2. In the Enterprise Console, point to Settings, point to Reporting Service, and then click Report Templates.
    The Report Templates window appears.

  3. Select the report template that you want to package.

  4. Right-click the report template 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.

Runtime Initialization Settings

You can configure runtime initialization settings for Report Templates. For more information about configuring runtime initialization settings, see Runtime Initialization Settings.

Configuration settings for Report Templates

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

  • Source Environment > Package Template > Edit 

  • Target Environment > Manage Package > Edit

Settings

You can use the Settings tab to define the configuration settings. Set the properties in this tab to take appropriate actions while installing, updating, or uninstalling the package.

Install

Use this tab to set the configurations for installing the package.

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

    • Do Not Install Report Template: Select this option if you want to use the report template which is present in the target environment.

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

  • Associated Artifacts Not Present: This property allows you to take appropriate action when the associated artifacts of the Report Template is not present in the target environment.

    • Install Report Template: Select this option if you want to install the Report Template, even if the associated artifacts are not present in the target environment.

    • Do Not Install Report Template: Select this option if you do not want to install the Report Template as its associated artifacts are not present.

Update

Use the settings in this tab to update an installed package.

  • Delete Report Template: Select this option if you want to delete the Report Template which exists in the target environment.

    • Yes: Select this option to remove the Report Template in the target environment. On selection of this option, the Report Template Is Modified option appears.

      Report Template is Modified: Use this option to retain, delete, or rollback to original state the Report Template in the target environment even after the package is updated. This property is applicable only if Delete Report Template is set to Yes and the report template is modified.

      • Retain: Select this option to retain the Report Template 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 rollback to the original state. All modifications that were done to the Report Template after it was installed in the target environment will be reverted. However, the Report Template will be retained in the target environment.

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

    • No: Select this option if you want to retain the Report Template in the target environment. On selection of this option, the Report Template Exists and the Associated Artifacts not present options appear.

      Report Template Exists: Use this option to take appropriate action when the Report Template is present in the target environment.

      • Do Not Install Report Template: Select this option if you want to use the existing Report Template which is present in the target environment.

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

Associated Artifacts not present: Use this property to take appropriate action when the associated artifacts of the Report Template are not present in the target environment.

  • Install Report Template: Select this option if you want to update the Report Template.

  • Do Not Install Report Template: Select this option if you do not want to update the Report Template as associated artifacts are not present.

Uninstall

Use this tab to configure the settings when the package is being uninstalled from the target environment.

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

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

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

  • Report Template Is Modified: This option allows you to decide if you want to retain, roll back to original state or delete the Report Template in the target environment even after the Package is uninstalled. This property is displayed only if Delete Report Template is set to Yes. However, if Delete Report Template is set to No, this property is not displayed.

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

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

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

Associated Artifacts

This tab displays all the associated artifacts of the selected Report Template artifact.

Report Templates can include "Report Connection" as an associated artifact.

Note: When you select the Include Associated Artifacts option as Yes while adding the Report Template to a Package Template, the associated artifacts are added to the package template and it also allows you to view the associated artifacts of a Report Template in the tree view of a Package. If you select the Include Associated Artifacts option as No, the associated artifacts are not added to the package template and are also not visible in the tree view of a Package.

Child Artifacts

This tab is not available as the Report Template artifact does not have any child artifacts.

Security Artifacts

The Security Artifacts tab displays the security artifacts of report templates, if any.

You can enable the security settings of the report templates that you want to include in the package.
For more information about including security artifacts, see Include Security Artifacts.

In This Topic
TitleResults for “How to create a CRG?”Also Available in