Skip to main content
insightsoftware Documentation insightsoftware Documentation
{%article.title%}
Published:
Was this article helpful?
0 out of 0 found this helpful

Modify a Package

The legacy and custom packages created in the NoetixViews Workbench can be modified. Regarding the legacy package, while you cannot modify its properties, you can modify its scripts, besides exporting, importing, and deleting them. Regarding the custom packages, you can add and remove views, compare and update view revisions, and modify package properties.

NOTE: For a custom package, you cannot remove or update views, edit the properties, or delete the package if it is being exported, promoted, or staged by another user. If you try to modify such packages, a message will be displayed indicating that the action cannot be performed because the object you are trying to access has been locked by another user. Also, you cannot modify or delete scripts in a legacy package that is being modified by another user.

Modify Legacy Package

You can perform the following tasks on the legacy package:

  • Modify the legacy scripts in the legacy package.

  • Import scripts to, export scripts from, and delete scripts from the legacy package.

Modifying Legacy Scripts

After the legacy package is created, you can modify its legacy scripts according to your requirements.

IMPORTANT: If a view revision in the NoetixViews Workbench is dependent on a legacy script, and if the legacy script is modified, you must first unmanage the view in the NoetixViews Workbench to remove all the existing customizations. Then, you need to run Stage 4 to apply the modified legacy script. Thereafter, in the NoetixViews Workbench, you can recreate the customizations so that they are based on the latest legacy script.

To modify legacy scripts

  1. On the NoetixViews Workbench home page, click Manage Packages. The Manage Packages page appears.

  2. In the package list, click Legacy Package. The scripts of the legacy package are displayed.

  3. Click the legacy script that you want to modify. The following details of the legacy script will be displayed:

    • Name of the legacy script.

    • Date on which the legacy script was added to the custom package or was last modified.

    • Name of the user who added or last modified the legacy script in the custom package.

    • Description of the change.

    • Script text displayed in a box.

  1. In the section where the script details are displayed, click Edit.

  2. If you want to modify the name of the script, in the Name box, type the modified name.

    IMPORTANT: The script name including the extension cannot exceed 255 characters and can contain only letters, digits, periods, underscores, and hyphens.

  1. In the Description box, provide a description of the change. The description can contain a maximum of 200 characters.

  1. If you want to modify the script text, in the Script box, edit the SQL code.

  2. Click Save.

Importing, Exporting, Deleting Legacy Scripts

You can import legacy scripts to the legacy package if there are customization requirements that cannot be met by using the NoetixViews Workbench. Also, you can export or remove legacy scripts from the legacy package.

If a view revision in the NoetixViews Workbench is dependent on a legacy script, and if the legacy script is deleted, you must first unmanage the view in the NoetixViews Workbench to remove all the existing customizations. Then, you need to run Stage 4 to apply the modified legacy script. Thereafter, you can recreate the NoetixViews Workbench customizations so that they will be based on the latest version of the legacy script.

To import, export, delete legacy scripts

  1. On the NoetixViews Workbench home page, click Manage Packages. The Manage Packages page appears.

  2. In the package list, click Legacy Package. The details of the legacy package are displayed.

  1. Click Import Scripts. The Add Script to Legacy Package dialog box appears.

  2. In the box provided, enter the path to the legacy script that you want to add to the package. If you want to search for the legacy script, click Browse, navigate to the location of the legacy script, and select it.

    IMPORTANT: The script names cannot exceed 255 characters and can contain only letters, digits, periods, underscores, and dashes.

  1. Click Upload. A message will appear adjacent to the box indicating that the legacy script has been successfully uploaded to the server.

  1. If the legacy script that you want to add already exists in the package, and if you want to overwrite the legacy script, select the Overwrite script, if already exists check box.

  2. Click Add to package.

    IMPORTANT: If the legacy script that you want to add already exists in the legacy package, and if you have not selected the Overwrite script, if already exists check box, you will receive an error message stating that the legacy script cannot be added to the legacy package unless you overwrite the file.

    You need to ensure that the legacy script is called through a hook script.

  1. If you want to export a legacy script from the package, select the check box corresponding to the legacy script, click Export, and then save a .zip file that contains the legacy script.

  2. If you want to remove a legacy script from the package, do the following:

    1. Select the check box corresponding to the legacy script, and then click Delete. The Delete Selected scripts dialog box appears.

    2. Click OK.

    IMPORTANT: After you remove the legacy script, you need to remove the reference to the legacy  script from the corresponding hook script.

Modify Custom Package

You can perform the following tasks on a custom package:

  • Add managed views to and remove them from the custom package.

  • Compare the revision of a managed view in the custom package with the current revision of the view in the environment, and update the revision of the view in the package to the current revision.

  • Modify properties of the custom package.

Adding Views to, Removing Views from Custom Package

You can add a managed view to or remove it from the custom package.

To add a view to a custom package

  1. On the NoetixViews Workbench home page, clickManage Packages. TheManage Packagespage appears.

  2. In the package list, click the name of the custom package that you want to use. The details of the custom package are displayed.

  3. Click Add View. The Add View dialog box appears.

  4. If you want to add all the managed views other than the views already available in the custom package, click Add all remaining managed views, and go to step 7.

  5. If you want to individually select the managed views that you want to add to the custom package, click Add selected views, and select the check boxes corresponding to the managed views. The list in which the managed views are displayed has the following columns:

    • View Label: Indicates the name of the managed view.

    • Current revision: Indicates the current revision number of the managed view in the environment.

    • Updated date: Indicates the date and time when the managed view was added or last modified.

    • Updated by: Indicates the name of the user who added the managed view to the NoetixViews Workbench or last modified the view.

    NOTE: If there are multiple pages in the list, use the page navigation controls to navigate through the pages. Also, if you want to sort the list by a column, click the column label.

  1. Click Add. The managed views are added to the custom package. The information about the views is displayed in a list with the following columns:

    • View Label: Indicates the name of the managed view.

    • Packaged revision: Indicates the revision number of the managed view in the custom package.

    • Current revision: Indicates the current revision number of the managed view in the environment.

    • Compare revisions: Provides an option to compare the package revision of the view with its environment revision. For information, see Comparing, Updating View Revisions in Custom Package.

    • Updated date: Indicates the date and time when the managed view was last modified in the custom package.

    • Updated by: Indicates the user who added or last modified the managed view in the custom package.

    NOTE: If there are multiple pages in the list, use the page navigation controls to navigate through the pages. Also, if you want to sort the list by a column, click the column label.

  2. If you want to remove a managed view from the custom package, select the check box corresponding to the view, and then click Remove.

Comparing, Updating View Revisions in Custom Package

The package revision of a managed view can be compared against the environment revision and updated. Before you stage or promote a custom package, you need to make sure that the revisions of the managed views are the latest.

To compare, update view revisions

  1. On the NoetixViews Workbench home page, clickManage Packages. TheManage Packagespage appears.

  2. In the package list, click the name of the custom package that contains the managed view. The details of the custom package are displayed.

  3. Locate the managed view for which you want to compare the revisions.

  4. Under the Compare revisions column, click Show. The Compare Customizations dialog box appears.

  5. Compare the package revision with the environment revision.

  6. Click Close.

  7. If you need to update the package revision to the environment revision, select the check box next to the view, and then click Update.

Modifying Custom Package Properties

After adding a custom package, you can modify its properties.

To modify custom package properties

  1. On the NoetixViews Workbench home page, click Manage Packages. The Manage Packages page appears.

  2. In the package list, select the check box for the custom package.

  3. Click Edit properties. The Edit Package Properties dialog box appears.

  4. Use the Name and Description boxes to modify the name and description of the custom package.

    IMPORTANT: The name of the package must be unique within a selected environment. Also, the name must contain only letters, numbers, underscores, periods, and dashes and must not exceed 30 characters. The description can contain a maximum of 1,000 characters.

  5. Click OK.

Published:

Modify a Package

The legacy and custom packages created in the NoetixViews Workbench can be modified. Regarding the legacy package, while you cannot modify its properties, you can modify its scripts, besides exporting, importing, and deleting them. Regarding the custom packages, you can add and remove views, compare and update view revisions, and modify package properties.

NOTE: For a custom package, you cannot remove or update views, edit the properties, or delete the package if it is being exported, promoted, or staged by another user. If you try to modify such packages, a message will be displayed indicating that the action cannot be performed because the object you are trying to access has been locked by another user. Also, you cannot modify or delete scripts in a legacy package that is being modified by another user.

Modify Legacy Package

You can perform the following tasks on the legacy package:

  • Modify the legacy scripts in the legacy package.

  • Import scripts to, export scripts from, and delete scripts from the legacy package.

Modifying Legacy Scripts

After the legacy package is created, you can modify its legacy scripts according to your requirements.

IMPORTANT: If a view revision in the NoetixViews Workbench is dependent on a legacy script, and if the legacy script is modified, you must first unmanage the view in the NoetixViews Workbench to remove all the existing customizations. Then, you need to run Stage 4 to apply the modified legacy script. Thereafter, in the NoetixViews Workbench, you can recreate the customizations so that they are based on the latest legacy script.

To modify legacy scripts

  1. On the NoetixViews Workbench home page, click Manage Packages. The Manage Packages page appears.

  2. In the package list, click Legacy Package. The scripts of the legacy package are displayed.

  3. Click the legacy script that you want to modify. The following details of the legacy script will be displayed:

    • Name of the legacy script.

    • Date on which the legacy script was added to the custom package or was last modified.

    • Name of the user who added or last modified the legacy script in the custom package.

    • Description of the change.

    • Script text displayed in a box.

  1. In the section where the script details are displayed, click Edit.

  2. If you want to modify the name of the script, in the Name box, type the modified name.

    IMPORTANT: The script name including the extension cannot exceed 255 characters and can contain only letters, digits, periods, underscores, and hyphens.

  1. In the Description box, provide a description of the change. The description can contain a maximum of 200 characters.

  1. If you want to modify the script text, in the Script box, edit the SQL code.

  2. Click Save.

Importing, Exporting, Deleting Legacy Scripts

You can import legacy scripts to the legacy package if there are customization requirements that cannot be met by using the NoetixViews Workbench. Also, you can export or remove legacy scripts from the legacy package.

If a view revision in the NoetixViews Workbench is dependent on a legacy script, and if the legacy script is deleted, you must first unmanage the view in the NoetixViews Workbench to remove all the existing customizations. Then, you need to run Stage 4 to apply the modified legacy script. Thereafter, you can recreate the NoetixViews Workbench customizations so that they will be based on the latest version of the legacy script.

To import, export, delete legacy scripts

  1. On the NoetixViews Workbench home page, click Manage Packages. The Manage Packages page appears.

  2. In the package list, click Legacy Package. The details of the legacy package are displayed.

  1. Click Import Scripts. The Add Script to Legacy Package dialog box appears.

  2. In the box provided, enter the path to the legacy script that you want to add to the package. If you want to search for the legacy script, click Browse, navigate to the location of the legacy script, and select it.

    IMPORTANT: The script names cannot exceed 255 characters and can contain only letters, digits, periods, underscores, and dashes.

  1. Click Upload. A message will appear adjacent to the box indicating that the legacy script has been successfully uploaded to the server.

  1. If the legacy script that you want to add already exists in the package, and if you want to overwrite the legacy script, select the Overwrite script, if already exists check box.

  2. Click Add to package.

    IMPORTANT: If the legacy script that you want to add already exists in the legacy package, and if you have not selected the Overwrite script, if already exists check box, you will receive an error message stating that the legacy script cannot be added to the legacy package unless you overwrite the file.

    You need to ensure that the legacy script is called through a hook script.

  1. If you want to export a legacy script from the package, select the check box corresponding to the legacy script, click Export, and then save a .zip file that contains the legacy script.

  2. If you want to remove a legacy script from the package, do the following:

    1. Select the check box corresponding to the legacy script, and then click Delete. The Delete Selected scripts dialog box appears.

    2. Click OK.

    IMPORTANT: After you remove the legacy script, you need to remove the reference to the legacy  script from the corresponding hook script.

Modify Custom Package

You can perform the following tasks on a custom package:

  • Add managed views to and remove them from the custom package.

  • Compare the revision of a managed view in the custom package with the current revision of the view in the environment, and update the revision of the view in the package to the current revision.

  • Modify properties of the custom package.

Adding Views to, Removing Views from Custom Package

You can add a managed view to or remove it from the custom package.

To add a view to a custom package

  1. On the NoetixViews Workbench home page, clickManage Packages. TheManage Packagespage appears.

  2. In the package list, click the name of the custom package that you want to use. The details of the custom package are displayed.

  3. Click Add View. The Add View dialog box appears.

  4. If you want to add all the managed views other than the views already available in the custom package, click Add all remaining managed views, and go to step 7.

  5. If you want to individually select the managed views that you want to add to the custom package, click Add selected views, and select the check boxes corresponding to the managed views. The list in which the managed views are displayed has the following columns:

    • View Label: Indicates the name of the managed view.

    • Current revision: Indicates the current revision number of the managed view in the environment.

    • Updated date: Indicates the date and time when the managed view was added or last modified.

    • Updated by: Indicates the name of the user who added the managed view to the NoetixViews Workbench or last modified the view.

    NOTE: If there are multiple pages in the list, use the page navigation controls to navigate through the pages. Also, if you want to sort the list by a column, click the column label.

  1. Click Add. The managed views are added to the custom package. The information about the views is displayed in a list with the following columns:

    • View Label: Indicates the name of the managed view.

    • Packaged revision: Indicates the revision number of the managed view in the custom package.

    • Current revision: Indicates the current revision number of the managed view in the environment.

    • Compare revisions: Provides an option to compare the package revision of the view with its environment revision. For information, see Comparing, Updating View Revisions in Custom Package.

    • Updated date: Indicates the date and time when the managed view was last modified in the custom package.

    • Updated by: Indicates the user who added or last modified the managed view in the custom package.

    NOTE: If there are multiple pages in the list, use the page navigation controls to navigate through the pages. Also, if you want to sort the list by a column, click the column label.

  2. If you want to remove a managed view from the custom package, select the check box corresponding to the view, and then click Remove.

Comparing, Updating View Revisions in Custom Package

The package revision of a managed view can be compared against the environment revision and updated. Before you stage or promote a custom package, you need to make sure that the revisions of the managed views are the latest.

To compare, update view revisions

  1. On the NoetixViews Workbench home page, clickManage Packages. TheManage Packagespage appears.

  2. In the package list, click the name of the custom package that contains the managed view. The details of the custom package are displayed.

  3. Locate the managed view for which you want to compare the revisions.

  4. Under the Compare revisions column, click Show. The Compare Customizations dialog box appears.

  5. Compare the package revision with the environment revision.

  6. Click Close.

  7. If you need to update the package revision to the environment revision, select the check box next to the view, and then click Update.

Modifying Custom Package Properties

After adding a custom package, you can modify its properties.

To modify custom package properties

  1. On the NoetixViews Workbench home page, click Manage Packages. The Manage Packages page appears.

  2. In the package list, select the check box for the custom package.

  3. Click Edit properties. The Edit Package Properties dialog box appears.

  4. Use the Name and Description boxes to modify the name and description of the custom package.

    IMPORTANT: The name of the package must be unique within a selected environment. Also, the name must contain only letters, numbers, underscores, periods, and dashes and must not exceed 30 characters. The description can contain a maximum of 1,000 characters.

  5. Click OK.

For an optimal Community experience, Please view on Desktop
Powered by Zendesk