createOrUpdateEISEntries
- Karl Henselin
- Divij.Sehgal
Creates or updates EIS Entries defined within properties files. The EIS entries will be redeployed at the end.
The properties files will be processed for property replacement using ${{VARIABLE_NAME}} format. See Property Replacement Support for more information about property replacement.
Adapter Deployment
This operation will Redeploy Adapter at the end after processing EIS entries.
To only Save Adapter Plan, use the generateEISDeploymentPlans operation instead of this operation.
To Update Adapter instead, use the updateEISDeploymentPlans operation instead of this operation.
So, if you want save or update the Adapter, then create a workflow containing the desired EIS operation. If you want to process JMS, DataSource, and Work Manager entries in same workflow add those necessary operations in the same workflow.
If using multiple files, make sure that the lists contain unique values across files.
If deploying to a cluster that does not make use of shared storage, this operation will fail to complete if any of the configured adapters have never been deployed previously. See the generateEISDeploymentPlans operation for information on using multiple plugin operations to create the deployment plans, sync them to all the servers, and then complete the redeployment of the adapter so that they take effect.
If you want to detect changes in WebLogic resource (properties) files and only deploy changed files, you can implement custom workflow as defined in Custom Workflow to detect changes in Properties Files.
Blog Posts
Target Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
Oracle Weblogic Home (WL_HOME) |
| Yes | WebLogic Home Directory. (e.g. /u01/oracle/products/fmw/wlserver) |
Weblogic Domain Name |
| Yes | WebLogic Domain Name. |
Weblogic Admin Listen Address |
| Yes | The listener address of the WLS admin server. (e.g. localhost) |
Weblogic Admin Listen Port |
| Yes | The port of the WLS admin server. (e.g. 7001) |
Weblogic Admin SSL Connection |
| No | Indicates whether the admin server is using SSL. |
Weblogic Admin User |
| Yes | The user name for the WLS admin server. |
Weblogic Admin Password |
| Yes | The password for Weblogic Admin User. |
Weblogic Admin Domain Directory |
| No | Weblogic Domain Directory for AdminServer. If not provided, FDWLS_DOMAIN_DIRECTORY will be used. |
Weblogic Domain Directory |
| Yes | Weblogic Domain Directory.(e.g. /u01/oracle/config/domains/soa_domain) |
Weblogic Adapter Plan |
| No | Path to the XML files used by Resource Adapters. (optional) If this parameter is not used, the adapters' last-used setting will be used. |
Inputs
Input Name | Input Code | Required | Description |
|---|---|---|---|
Properties File Path |
| No | Comma-separated list of paths to the properties file(s). |
Restrict Target Group |
| No | Provide comma-separated target group codes to restrict available target properties. If no value is provided, all target properties are available in environment. |
Outputs
Output Name | Required | Description |
|---|---|---|
| No | A boolean value that indicates whether the server needs to be restarted to finish applying the configuration changes. You could use this in a workflow condition. |
Artifacts
This operation consumes properties-file artifacts.
Endpoint Selection
This operation will select all available endpoints associated to the Target which have a resource type of WLS Admin Server. Since the admin server only runs on one server, it is expected that for a given domain, there will only be one endpoint with a resource type set to WLS Admin Server.
Endpoint Execution
This operation will execute on the Admin Server endpoint selected using the WLS Admin Server resource type.
Special Considerations
If Properties File Path is not specified, the FD_ARTIFACTS_DIR folder will be used. If a relative path is specified, the path will be relative to the FD_ARTIFACTS_DIR directory. Each EIS Adapter plan file is backed up to FD_TEMP_DIR/configbackup before it is modified. As with all files in the endpoint working directory, these files will be saved for 3 days before being deleted. It is important to set up the properties files like the examples below.
Example Folder Structure
Properties file can be named per your requirements. See Example Properties File below.
eisconfigurations.properties – This is the main properties file. The path to it is referenced by Properties File Path.
DEV/eisconfigurations.properties - optionally create a file here and override some properties with it per environment. The filename must match.
PROD/eisconfigurations.properties - optionally have several environments.
Sub folder names for environment overrides must be FlexDeploy environment code
Example Property File
This sample file creates 3 EIS entries with properties. Property names can be gathered from the WebLogic console, WLST, Oracle's documentation, or existing plan.xml files.
Backslash in Properties file
If you want \ (backslash) in any property value, use \\ or \u005c. This is Java properties file load syntax.
EISList=SOADB,SOAJMS,SOARODB
SOADB.Adapter=DbAdapter
SOADB.JNDI=eis/db/SOA
SOADB.properties.XADataSourceName=jdbc/ebs01
SOAJMS.Adapter=JmsAdapter
SOAJMS.JNDI=eis/jms/SOAJMS
SOAJMS.properties.ConnectionFactoryLocation=jms/ConnectionFactoryName
SOAJMS.TransactionSupport=LocalTransaction
SOARODB.Adapter=DbAdapter
SOARODB.JNDI=eis/db/SOASOARODB
SOARODB.properties.XADataSourceName=jdbc/ebs02Properties File Format
Multiple EIS Entries can be defined in the properties files. The properties files must start with a list of EIS Entries present in the format EISList=eis1,eis2,eis3. Change eis1, eis2, eis3 to the names of the EIS Entries for your projects. Any number of EIS Entries is acceptable.
If using multiple files, make sure that the lists contain unique values across files.
The properties files will be processed for property replacement using ${{VARIABLE_NAME}} format. See Property Replacement Support for more information about property replacement.
Required Properties
Each EIS Entry must contain the following required properties
Property Name | Description |
|---|---|
Adapter | The adapter name (e.g. JmsAdapter, DbAdapter). The adapter name is used to find its associated rar file, so it must be named exactly the same. The first part of the adapter name will also be used to create the plan file name. |
JNDI | The JNDI name (e.g. eis/db/SOA) |
Optional Properties
Optional Property Name | Notes |
|---|---|
ConnectionFactoryInterface | The default value varies by adapter name. |
TransactionSupport | Valid values are XATransaction, NoTransaction, and LocalTransaction. No default is sent by FlexDeploy. The Weblogic default applies if no value is given. |
User-Specified Properties
Any number of properties of any kind may be applied to each EIS Entry. Use XADataSourceName or DataSourceName for EIS entry for Data Source. You can see such properties in the Outbound Connection Properties table in WebLogic console. Please use following format:
<EISNAME>.properties.username=weblogic
<EISNAME>.properties.password=welcome1
<EISNAME>.properties.PlatformClassName=oracle.toplink.platform.database.SQLServerPlatform
User-Specified Connection Pool Properties
Any number of connection pool properties (pool-params) of any kind may be applied to each EIS Entry. You can see such properties in the Connection Pool table in WebLogic console. Please use following format:
<EISNAME>.pool-param.initial-capacity=0
<EISNAME>.pool-param.max-capacity=201
<EISNAME>.pool-param.capacity-increment=1
<EISNAME>.pool-param.shrinking-enabled=true
<EISNAME>.pool-param.shrink-frequency-seconds=900
<EISNAME>.pool-param.highest-num-unavailable=0
<EISNAME>.pool-param.highest-num-waiters=0
<EISNAME>.pool-param.connection-creation-retry-frequency-seconds=0
<EISNAME>.pool-param.connection-reserve-timeout-seconds=-1
<EISNAME>.pool-param.test-frequency-seconds=0
<EISNAME>.pool-param.test-connections-on-create=false
<EISNAME>.pool-param.test-connections-on-reserve=false
<EISNAME>.pool-param.test-connections-on-release=false
<EISNAME>.pool-param.match-connections-supported=true
Â
- style