createConnectionPlan
- Joel Wenzel
- Karl Henselin
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.
Read the blog at https://flexagon.com/2019/01/flexdeploy-loves-oic-manage-connection-property-replacement/ for more information.
Environment/Instance Properties
| Property Name | Property Code | Required | Description |
|---|---|---|---|
OIC Base URI | FDOIC_CLOUD_INSTANCE_BASE_URI | Yes | 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 |
Project Properties
| Property Name | Property Code | Required | Description |
|---|
Inputs
| Input Name | Input Code | Required | Description |
|---|---|---|---|
| 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. |
Outputs
| Output Name | Description |
|---|
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 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 can literal text or FD 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
- style