soaRetire

Provides the ability to retire a composite on the SOA server.  This operation will handle all revisions for a given composite (the default revision will not be maintained).  Operation only available on plugin version 5.1.0.2.x and greater.

Environment/Instance Properties

Property NameProperty CodeRequiredDescription
SOA Server Host

FDSOA_SERVER_HOST

Yes

Host name of the SOA managed server.

SOA Server Port

FDSOA_SERVER_PORT

Yes

Port number of the SOA managed server.

Weblogic Admin User

FDWLS_ADMIN_USER

Yes

Admin user name for WebLogic server.

Weblogic Admin Password

FDWLS_ADMIN_PASSWORD

Yes

Weblogic Admin User password for WebLogic server.

Oracle SOA Home

FD_ORACLE_SOA_HOME

Yes

Oracle SOA Home, indicates where SOA Suite is installed.

Project Properties

Property NameProperty CodeRequiredDescription
SOA Composite Name

FDSOA_COMPOSITE_NAME

Yes

Name of composite that is being deployed.

SOA Partition

FDSOA_PARTITION

Yes

Name of the partition to hold the composite on the server.

Inputs

Input NameInput CodeRequiredDescription
Composites FileFDSOA_INP_COMPOSITE_NAME_LISTNoFile name (anywhere in temp directory) or absolute path to file with comma separated composite names.  See Special Considerations section below for additional details.
Composite Name ListFDSOA_INP_START_ALL_REVISIONSNo

Comma separated composite names, overrides Composite File Name input (default value is false).  See Special Considerations section below for additional details.

Composite Revision

FDSOA_INP_REVISION

No

Provide specific revision to stop, otherwise all revisions will be retired.  See Special Considerations section below for additional details.

Outputs

Output NameDescription




Artifacts 

This operation doesn’t consume or produce any artifacts.

Endpoint Selection

This operation will select all available endpoints associated to the environment/instance.

Endpoint Execution

This operation will execute on any one of the selected endpoints and will be random in the determination of which one.

Special Considerations

The composite names that are used will be determined by first looking at the Composite Names input, then the Composite File Name input and lastly the SOA Composite project project (the first two inputs can provide multiple composite names).  The Revision input should generally not be utilized with the Composite Names or Composite File Name inputs.  The single revision input will be checked against each composite from the composite list and the specific revision may not be available on all composites, which will cause the operation to fail. 

  • retiring a single revision (this is the backwards compatibility capability)
    • utilizes "Composite Revision" input to control what revision to stop
  • retiring multiple composites/revisions
    • utilizes "Composites File" or "Composite Name List" inputs
      • if utilizing "Composite File", there can be several variations of file name;
        1. just a file name, will look in the temp directory for the given file name
        2. relative path, will only look for the relative path within the temp directory for the given file name
        3. absolute path, will only look at the absolute path for the given file
    • either input (Composite File or Composite Name List) provides a list of composite names to retire that must use the following format: <partition:>composite1,composite2 (partition is optional)
    • all non-default revisions will be retired first and then the default revision will be retired.  This operation will not maintain the default revision, Enterprise Manager executes in the same manner.  If a composite is in two partitions, then specify the partition in the above format to direct the operation to the correct composite.