createConnectionPlan

This operation will create a template connection plan file using the connections found on the current OIC environment instance.  This connection plan can be applied during the importConnections operation or importIntegration operation.

Its purpose is to allow environment specific properties to be replaced for connections prior to deployment.  This prevents manual updates of the connections artifacts in between deployments to different environments.

Either FDOIC_CLOUD_ACCOUNT_CODE environment instance property value or FDOIC_INP_CLOUD_ACCOUNT_CODE plugin input value should exist. When both exists, plugin input value will take precedence. See Creating/Editing a Cloud Account and Provider for details on how to setup Cloud Account for OIC.

Environment/Instance Properties

Property NameProperty CodeRequiredDescription
OIC AccountFDOIC_CLOUD_ACCOUNT_CODENoThe OIC account with all the required properties like Base URI, Username and Password for running OIC Instance.

Project Properties

Property NameProperty CodeRequiredDescription

Cloud Account Properties

Property NameProperty CodeRequiredDescription
OIC UserFDOICACCT_USERNAMEYesUser name for the registered OIC account
OIC PasswordFDOICACCT_PASSWORDYesPassword for the registered OIC account
OIC Base URIFDOICACCT_BASE_URIYesThe REST Base URI of a running OIC Instance

Inputs

Input NameInput CodeRequiredDescription
FDOIC_INP_CLOUD_ACCOUNT_CODENoThe OIC account with all the required properties like Base URI, Username and Password for running OIC Instance.
Connection ListFDOIC_INP_CONNECTION_LISTNoCSV list of connection ids to use during creation. Leave blank to use all.
OIC Connection Plan FileFDOIC_INP_CONNECTION_PLANNoOptional input to specify a different connection plan file name. Default 'connectionPlan.properties'.  An absolute path can be specified otherwise the location is relative to the temp directory.

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

Connection Plan Format

The connection plan closely follows Java Properties syntax with the notable exception that spaces to not delimit the key value pairs. 

Line Format

%ConnectionId%.(connection|secure).%propertyDisplayName%=%value%

Line FieldDescription
ConnectionIdThe connectionId on the server.  This is typically the connection name found in the UI with spaces replaced by underscores and in all caps.  Example: Sample FTP Connection = SAMPLE_FTP_CONNECTION.
connection|secureLiteral text of either 'connection' or 'secure' to indicate if it is a secure property or normal connection property.
propertyDisplayNameThis is the name of the property as seen in the UI.
valueThis can literal text or FD Properties.


Sample Properties
#Add values for any properties you wish to change when updating connections.
#FlexDeploy properties or plain text allowed

SAMPLE_FTP_CONNECTION.connection.FTP Server Host Address=${{FD_OIC_FTP_HOST}}
SAMPLE_FTP_CONNECTION.connection.FTP Server Port=
SAMPLE_FTP_CONNECTION.connection.SFTP Connection=
SAMPLE_FTP_CONNECTION.connection.Host Key=
SAMPLE_FTP_CONNECTION.connection.SSL Certificate=
SAMPLE_FTP_CONNECTION.connection.FTP Server Time Zone=
SAMPLE_FTP_CONNECTION.secure.User Name=albundy
SAMPLE_FTP_CONNECTION.secure.Password=${{FD_OIC_FTP_PASSWORD}}
SAMPLE_FTP_CONNECTION.secure.SSL Certificate Password=
SAMPLE_FTP_CONNECTION.secure.PGP Public Key=
SAMPLE_FTP_CONNECTION.secure.ASCII-Armor Encryption Format=
SAMPLE_FTP_CONNECTION.secure.Cipher Algorithm=
SAMPLE_FTP_CONNECTION.secure.PGP Private Key=
SAMPLE_FTP_CONNECTION.secure.PGP Private Key Password=

TEST_SOAP_CONNECTION.connection.WSDL URL=
TEST_SOAP_CONNECTION.connection.Service WSDL=
TEST_SOAP_CONNECTION.connection.Target Server's TLS version (Optional)=
TEST_SOAP_CONNECTION.connection.Suppress insertion of timestamp into the request (Optional)=
TEST_SOAP_CONNECTION.connection.Ignore timestamp in the response message (Optional)=
TEST_SOAP_CONNECTION.connection.Enable two way SSL for outbound connections (Optional)=
TEST_SOAP_CONNECTION.connection.Identity keystore alias name (Optional)=

Connection Plan Processing

In the sample above we can see we are replacing the FTP Server Host on the SAMPLE_FTP_CONNECTION with ${{FD_OIC_FTP_HOST}}.  This means that FD_OIC_FTP_HOST is configured as a FlexDeploy property(most likely an environment instance property) and has a different value for each OIC environment we have.  This allows us to dynamically set the FTP Server Host based on environment without ever changing our artifacts.

Empty Properties

Only properties that need to be replaced should be in the connection plan file.  If there are lines without a value (as seen above), this will be treated as updating the property to null.