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

AVEVA™ Work Tasks

SOA Assembly

  • Last UpdatedJul 01, 2024
  • 6 minute read

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 Tools, and then click SOA Assembly.

    The Assembly List window appears.

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

  4. Right-click the assembly 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 Assembly 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 Assembly 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.

Note: If the SOA Assembly is registered in Framework 4.0, ensure that Client-Service is also configured in Framework 4.0.

Runtime Initialization Settings

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

Configuration settings for SOA Assembly

The SOA Assembly 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 window

  • Target Environment > Manage Package window

The configuration settings for the SOA Assembly differs based on how the SOA Assemblies are registered. SOA Assemblies can be registered from GAC, Web Service, or Physical Path. For more information, see Resolve Custom Dependent Files for SOA Assembly.

Settings tab

You can define the configuration settings of the SOA Assembly 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 Assembly Exists: Use this property to take appropriate action when the SOA Assembly that is being installed is present in the target environment.

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

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

Update

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

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

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

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

      • Retain: Select this option if you want to retain the SOA Assembly along with the modifications in the target environment even after the package is updated.

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

      • Delete: Select this option to delete the SOA Assembly from the target environment when updating the package.

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

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

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

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

Uninstall

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

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

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

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

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

    • Retain: Select this option to retain the SOA Assembly along with the modifications in the target environment even after the package is uninstalled.

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

    • Delete: Select this option to delete the SOA Assembly from the target environment when uninstalling the package

Resolving Associated Workflow of SOA Assembly

The Associated Workflow Details grid in the Settings Form contains the following fields:

Field Name

Description

Workflow Name

Displays the name of the associated workflow.

Source Version

Displays the source version of the associated workflow. You can use the same values for the target, or change the values as required.

Target Version

Displays the target version of the associated workflow. You can use the same values as that in the source, or change the values as required.

Associated Artifacts of SOA Assembly

The Associated Artifacts tab displays all the associated artifacts of the selected SOA Assembly artifact.

SOA Assembly can include the following associated Artifacts:

  • Parent Folder

  • SOA Folder

When you select the Include Associated Artifacts option as Yes while adding the SOA Assembly to a Package Template, the associated artifacts are added to the package template. You can then view the associated artifacts of the SOA Assembly 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 of SOA Assembly

The Child Artifacts tab displays all the child artifacts of the selected SOA Assembly artifact.

SOA Assembly can include the following child artifacts:

  • Folder

  • Child SOA Assembly

When you select the Include Child Artifacts option as Yes while adding the SOA Assembly to a Package Template, the child artifacts are added to the package template. You can then view the child artifacts of the SOA Assembly in the tree view of a package. If you select the Include Child Artifacts option as No, the child artifacts are not added to the package template and are also not visible in the tree view of a package.

Include Child Item

For more information, see Include Child Item.

Security Artifacts of SOA Assembly

The Security Artifacts tab displays all the security artifacts of the selected SOA Assembly artifact. You can enable the security settings of the SOA assembly that you want to include in the package.

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

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