SOA Folder

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

To add SOA Folder to Package Template

1. Log on to the Enterprise Console.

2. In the Enterprise Console, click menu icon, click Settings, and then click SOA Folder.

   The Folder List window appears.

3. Select the folder list that you want to package.

4. Right-click the folder list item and then click Add to Package Template.

   The Add to Package Template window appears.

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

   You can set the configuration properties of the SOA Folder in the Add to Package Template window. The left side of the configuration window shows the package template and its configurations. You can set the configuration properties of the SOA Folder package in the Settings form on the right side of the Add to Package Template window.

5. Configure the required settings.

6. Click Save Template to save the configured settings.

Configuration Settings for SOA Folder

The SOA Folder has an unique set of configuration settings required for installing, updating, and uninstalling the package. You can edit and view the configuration settings in one of the following two ways:

• Source Environment > Package Template screen

• Target Environment > Manage Package screen

You can define the configuration settings of the SOA Folder artifact in the Settings tab. 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.

• SOA folder exists: Use this property to take appropriate action when the SOA folder in the package is already present in the target environment.

  • Do not install SOA folder: Select this option to use the SOA folder that is present in the target environment.

  • Install to overwrite the existing SOA folder: Select this option to overwrite the SOA folder that is present in the target environment with the one in the package.

• Folder Path Configuration: Use this property to view the path of SOA folder in the target environment.

  • Source Physical Path: This is a read-only field that displays the physical path of the SOA folder in the source environment.

  • Target Physical Path: This is a read-only field that displays the physical path of SOA folder in the target environment. If this field is blank, then the physical path in the target environment will be the same as the path specified in source environment.

Update

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

• Delete SOA folder: Use this property to delete or retain the SOA folder that is present in the target environment.

  • Yes: Select this option to remove the SOA folder from the target environment.

    SOA folder is modified: Use this option to retain, roll back the SOA folder to original state, or delete the SOA folder from the target environment even after the package is updated. This property is applicable only if Delete SOA folder is set to Yes and the SOA folder is modified.

    • Retain: Select this option to retain the SOA folder along with the modifications in the target environment.

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

    • Delete: Select this option to delete the SOA Folder from the target environment.

  • No: Select this option to retain the SOA folder in the target environment.

    SOA folder exists: Use this property to take appropriate action when the SOA folder that is being installed is present in the target environment.

    • Do not install SOA Folder: Select this option to use the SOA folder that is present in the target environment.

    • Install to overwrite existing SOA Folder: Select this option to overwrite the SOA folder that is present in the target environment with the one that is in the package.

• Folder Path Configuration: Use this property to set the path of SOA folder in the target environment.

  • Source Physical Path: This is a read-only field that displays the physical path of SOA folder in the source environment.

  • Target Physical Path: This is a read-only field that displays the physical path of SOA folder in the target environment.

    If the source folder is relative to the AVEVA Work Tasks installed path, then the Target Physical Path points to the same relative path in the Target environment. If the folder does not exist, ensure to create the folder before installing the package. If the source folder is not relative to the AVEVA Work Tasks installed path, then the Target Physical Path points to the [AVEVA Work Tasks Installed Path]\AVEVA\Work Tasks\bin folder.

Uninstall

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

• Delete SOA folder: Use this property to retain or delete the SOA folder from the target environment even after the package is uninstalled.

  • Yes: Select this option to delete the SOA folder from the target environment when the package is uninstalled.

  • No: Select this option to retain the SOA folder in the target environment even after the package is uninstalled.

• SOA folder is modified: Use this option to retain, roll back the SOA folder to original state, or delete the SOA folder from the target environment even after the package is uninstalled. This property is displayed only if Delete SOA folder is set to Yes. However, if Delete SOA folder is set to No, this property is not displayed.

  • Retain: Select this option to retain the SOA folder along with the modifications in the target environment.

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

  • Delete: Select this option to delete the SOA folder from the target environment.

Associated Artifacts for SOA Folder

SOA Folder does not have any associated artifacts.

Child Artifacts for SOA Folder

SOA Folder does not have any child artifacts.

Security Artifacts for SOA Folder

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