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.
Info
EitherFDOIC_CLOUD_ACCOUNT_CODEenvironment instance property value orFDOIC_INP_CLOUD_ACCOUNT_CODEplugin input value should exist. When both exists, plugin input value will take precedence.SeeCreating/Editing a Cloud Account and Providerfor details on how to setup Cloud Account for OIC.
Environment/Instance Properties
Property Name
Property Code
Required
Description
OIC Base URIAccount
FDOIC_CLOUD_INSTANCEACCOUNT_BASE_URICODE
YesNo
The REST Base URI of a running OIC Instance
OIC User
FDOIC_USERNAME
Yes
The user to connect to OIC as
OIC Password
FDOIC_PASSWORD
Yes
The password for the OIC User
OIC account with all the required properties like Base URI, Username and Password for running OIC Instance.
Project Properties
Property Name
Property Code
Required
Description
Insert excerpt
OIC Cloud Account Properties
OIC Cloud Account Properties
nopanel
true
Inputs
Input Name
Input Code
Required
Description
FDOIC_INP_CLOUD_ACCOUNT_CODE
No
The OIC account with all the required properties like Base URI, Username and Password for running OIC Instance.
Connection List
FDOIC_INP_CONNECTION_LIST
No
CSV list of connection ids to use during creation. Leave blank to use all.
OIC Connection Plan File
FDOIC_INP_CONNECTION_PLAN
No
Optional 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.
...
This operation will execute on any one of the selected endpoints and will be random in the determination of which one.
Special Considerations
Anchor
ConnectionPlanFormat
ConnectionPlanFormat
Connection Plan Format
The connection plan closely follows Java Properties syntax with the notable exception that spaces to not delimit the key value pairs.
The 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|
...
secure
Literal text of either 'connection' or 'secure' to indicate if it is a secure property or normal connection property.
propertyDisplayName
...
This is the name of the property as seen in the UI.
...
value
This can literal text or FD Properties.
Code Block
language
text
firstline
1
title
Sample Properties
linenumbers
true
#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.
Info
title
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.