createConnectionPlan
- Karl Henselin
This operation will create a template connection plan file using all the connections found on the current OIC Target. This connection plan can be applied during the updateConnections, importIntegration, or partialDeploy operation.
Its purpose is to allow environment-specific properties to be replaced for connections prior to deployment. This prevents manual updates of the connection's artifacts between deployments to different environments.
Either FDOIC_CLOUD_ACCOUNT_CODE target property value or FDOIC_INP_CLOUD_ACCOUNT_CODE plugin input value should exist. When both exist, the plugin input value will take precedence. See Creating/Editing a Cloud Account and Provider for details on how to setup Cloud Account for OIC.
Target Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
OIC Account |
| No | The OIC account with all the required properties like Base URI, Username and Password for connecting to an OIC Instance. |
Inputs
Input Name | Input Code | Required | Description |
|---|---|---|---|
OIC Account |
| No | The OIC account with all the required properties like Base URI, Username and Password for connecting to an OIC Instance. Typically, this will not be used because the value will come from the property FDOIC_CLOUD_ACCOUNT_CODE instead. |
Connection List |
| No | CSV list of connection ids to use during creation. Leave blank to create a connection plan for all connections on in the OIC environment. |
OIC Connection Plan File |
| No | Optional input to specify a different connection plan file name. If not specified, it defaults to 'connectionPlan.properties'. An absolute path can be specified. Otherwise, the location is relative to the temp directory. |
Artifacts
This operation doesn’t consume or produce any artifacts.
Endpoint Selection
This operation will select all available endpoints associated to the Target.
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 Field | Description |
|---|---|
ConnectionId | 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 is the literal text or FD Properties. |
Sample Properties
#Add values for any properties you wish to change when updating connections.
#FlexDeploy properties or plain text are 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 a Target 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. The properties should be added to a deploy workflow that is used to deploy the integrations or update the connections. Then the workflow must be connected to the OIC target group using the topology screens.
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), the property will be set to null.
- style