Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

This operation will create a template connection plan file using all the connections found on the current OIC environment instanceTarget.  This connection plan can be applied during the importConnections operation or importIntegration operation updateConnectionsimportIntegration, 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 connections connection's artifacts in between deployments to different environments.

...

Info

Either FDOIC_CLOUD_ACCOUNT_CODE environment-instance 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

Base URI

Account

FDOIC_CLOUD_

INSTANCE

ACCOUNT_

BASE_URI

CODE

Yes

No

The

REST Base URI of a running OIC InstanceOIC UserFDOIC_USERNAMEYesThe user to connect to OIC asOIC PasswordFDOIC_PASSWORDYesThe password for the OIC User

Project Properties

...

Inputs

Input NameInput CodeRequiredDescription

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

FDOIC_INP_CLOUD_ACCOUNT_CODE

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

FDOIC_INP_CONNECTION_LIST

No

CSV list of connection ids to use during creation. Leave blank to

use all

create a connection plan for all connections on in the OIC environment.

OIC Connection Plan File

FDOIC_INP_CONNECTION_PLAN

No

Optional input to specify a different connection plan file name.

Default

If not specified, it defaults to 'connectionPlan.properties'.  An absolute path can be specified

otherwise

. Otherwise, the location is relative to the temp directory.

Outputs

Output NameDescription

Artifacts

This operation doesn’t consume or produce any artifacts.

...

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

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

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. 

title
Info

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

is the literal text or FD Properties.

Sample Properties
Code Block
languagetext
firstline1
titleSample Properties
linenumberstrue
#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.

Info

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.