The following macros are not currently supported in the header:
  • style

createInstance__

Create a SOA Cloud Service instance, along with its Load Balancer if desired. Property Replacement is performed on the property file. See the File Plugin Guide for information about property replacement.

See the special considerations below for information about formatting the properties file, and information about how Storage Cloud is handled by the plugin.

Environment/Instance Properties

Property Name

Required

Description

 

 

 

Project Properties

Property Name

Required

Description

 

 

 

Inputs

Input Name

Required

Description

FDSOA_CLOUD_IDENTITY_DOMAIN

Yes

The SOA Cloud Identity Domain

FDSOA_CLOUD_URL_PREFIX

No

The region prefix of the SOA Cloud REST resources. Defaults to jaas.

FDSOA_CLOUD_INSTANCE_NAME

Yes

The name of the SOA Cloud Service instance.

FDSOA_CLOUD_USERNAME

Yes

The username to connect to the SOA Cloud Service instance with.

FDSOA_CLOUD_PASSWORD

Yes

The password for FDSOA_CLOUD_USERNAME.

FDSOA_CLOUD_TIMEOUT

No

The number of minutes to wait for the instance to be created. If the number of minutes is exceeded, the operation will exit with a failure. Defaults to 60 minutes.

FDSOA_CLOUD_PROPERTY_FILE_PATH

Yes

The path to the properties file that describes the instance to be created. If a relative path is given, a path inside the FD_ARTIFACTS_DIR will be assumed.

Outputs

Output Name

Required

Description

 

 

 

Artifacts

This operation consumes a property file artifact.

Endpoint Selection

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

Endpoint Execution

This operation will randomly execute on one of the endpoints identified during selection.

Special Considerations

The properties file is closely based on the Oracle REST Services. If you need more information than is found in this guide, please see the Oracle documentation.


If you receive a 500 error when creating an instance, check if your database instance is up and you have the correct name and password.

 

Property Name

Required

Description

weblogic.adminUserName

Yes

The admin user name for the Weblogic Servers

weblogic.adminPassword

Yes

The password for weblogic.adminUserName

weblogic.dbServiceName

Yes

The Service name of the database for the Weblogic instances

weblogic.dbaName

Yes

A database username which has sysdba rights

weblogic.dbaPassword

Yes

The password for weblogic.dbaName

weblogic.shape

Yes

The shape of the SOA server to create.
Current choices are OC1M,OC2M,OC3M,OC4M,OC5M

weblogic.VMsPublicKey

Yes

The public key for the VM. This should be a String starting with "ssh-rsa".

provisionOTD

No

Whether a load balancer should be provisioned for this instance (true / false). Defaults to false.

topology

Yes

osb - Oracle Service Bus Topology.
soa - Service Oriented Architecture.
soaosb - Both OSB and SOA Topology.
apim - API Manager Topology.
b2b – Oracle SOA Suite, Oracle B2B, and adapters
mft - Oracle Managed File Transfer

subscriptionType

No

HOURLY / MONTHLY Currently, Oracle defaults this value to HOURLY

cloudStorageContainer

No

The storage container e.g. SOAContainer1. Defaults to FDSOA_CLOUD_INSTANCE_NAME + "BK".

The container is automatically created if it doesn't already exist in the Storage Cloud.

cloudStorageUser

No

The username with which to connect to the Storage Cloud Service instance, if different from FDSOA_CLOUD_USERNAME

cloudStoragePassword

No

The password for cloudStorageUser if different from FDSOA_CLOUD_PASSWORD


If provisionOTD is set to true, this field is required:

 

Property Name

Required

Description

otd.shape

Yes

The shape of the OTD instance. Current choices are
[oc3,oc4,oc5,oc6,oc7,oc1m, oc2m,oc3m,oc4m,oc5m]


This plugin is designed to accommodate changes in Oracle's REST API. It will pass all properties that don't start with weblogic. or otd. as top-level data in the JSON request, and pass each prefixed data as data inside of parameters as the type of the prefix. Any properties that Oracle supports can be used even if not listed in the tables above. If there is a validation error, the data from Oracle is excellent for providing the solution.


Here is an example error message from leaving a field blank:

flexagon.ff.common.core.exceptions.FlexCheckedException: FDSOACloud-00051: Unexpected status code 400 - Bad Request - SOA-PROVISIONING-13: validation error - field "type": "OTD" - shape - value is required.


This means that you need to send in otd.shape={value}


If you set it to an invalid value, you will receive an error like this:

flexagon.ff.common.core.exceptions.FlexCheckedException: FDSOACloud-00051: Unexpected status code 400 - Bad Request - SOA-PROVISIONING-14: validation error - field "type": "OTD" - shape - entered value thjklas is invalid, please set one of the values - OC3/OC4/OC5/OC6/OC7/OC1M/OC2M/OC3M/OC4M/OC5M

 

In this error, "OTD" – shape means that otd.shape had an invalid value, and lists possible correct values.

 

See
https://docs.oracle.com/cloud/latest/soacs_gs/SCSAP/op-instances-%7BidentityId%7D-post.html for more information about Oracle's API.

The following macros are not currently supported in the footer:
  • style