Creates or updates JMS Entries defined by properties files. The properties files will be processed for property replacement using $VARIABLE_NAME format. See the Appendix for more information about property replacement.
Environment/Instance 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 FDWLS_ADMIN_USER. |
| Weblogic Admin Domain Directory |
| No | Weblogic Domain Directory for AdminServer. If not provided, |
| Weblogic Domain Directory |
| Yes | Weblogic Domain Directory.(e.g. /u01/oracle/config/domains/soa_domain) |
Project Properties
Property Name | Property Code | Required | Description |
|---|---|---|---|
Inputs
| Property Name | Property Code | Required | Description |
|---|---|---|---|
| Properties File Path | FILE_PATH_TO_PROPERTIES | No | Comma-separated list of paths to the properties file(s). |
Outputs
Output Name | Required | Description |
|---|---|---|
FDWLS_OUT_IS_RESTART_REQUIRED | No | A |
Artifacts
This operation consumes properties-file artifacts.
Endpoint Selection
This operation will select all available endpoints associated to the environment instance 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 FILE_PATH_TO_PROPERTIES 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. WebLogic configuration files including JMS modules are backed up to FD_TEMP_DIR/configbackup before modifications. As with all files in the endpoint working directory, these files will be saved for 3 days before being deleted.
Example Folder Structure
- Properties file can be named as per your requirements. See Properties File Format.
- jmsconfigurations.properties – This is the main properties file. The path to it is referenced by FILE_PATH_TO_PROPERTIES.
- DEV/ jmsconfigurations.properties - optionally create a file here and override some properties with it per environment. The filename must match.
- PROD/ jmsconfigurations.properties - optionally have several environments.
- Sub folder names for environment overrides must be FlexDeploy environment code.
Example Property File
This sample file defines a few simple JMS objects with a sub-set of the available properties. The name used in each of the lists will be the name used on the server.
ConnectionFactoryList=CF1 QueueList=Q1 TopicList=T1 UniformDistributedQueueList=UDQ1 UniformDistributedTopicList=UDT1 SystemModuleList=JMSModule1 CF1.SystemModule=JMSModule1 CF1.JNDI=jms/CF1 CF1.Targets=MS1 (managed server) CF1.XAConnectionFactoryEnabled=False CF1.DefaultTargetingEnabled=True UDQ1.Notes=notes on UDQ1 UDQ1.SystemModule=JMSModule1 UDQ1.JNDI=jms/UDQ1 UDQ1.SubDeployment=JMSSubDeployment2 JMSModule1.Targets=MS1 JMSSubDeployment2.SystemModule=JMSModule1 JMSSubDeployment2.Targets=JMSServer1 Q1.SystemModule=JMSModule1 Q1.JNDI=jms/Q1 Q1.DeliveryMode=Persistent T1.SystemModule=JMSModule1 T1.JNDI=jms/T1 UDT1.Notes=notes on UDT1 UDT1.SystemModule=JMSModule1 UDT1.JNDI=jms/UDT1
Properties File Format
Multiple JMS Properties can be defined in each properties file. Each properties file must start with one or more lists of JMS element types present in the file. Any number of element types is acceptable in each file, and any number of each type of element is acceptable as well. The properties files will be processed for property replacement using $VARIABLE_NAME format. See the Appendix for more information about property replacement.
JMS Element List Objects
JMS Element Type | List Name |
|---|---|
Connection Factory | ConnectionFactoryList |
Destination Sort Key | DestinationSortKeyList |
Foreign Server | ForeignServerList |
| JMS Server | JMSServerList |
Queue | QueueList |
Quota | QuotaList |
SubDeployment | SubDeploymentList |
System Module | SystemModuleList |
Topic | TopicList |
Uniform Distributed Queue | UniformDistributedQueueList |
Uniform Distributed Topic | UniformDistributedTopicList |
Weighted Distributed Queue | WeightedDistributedQueueList |
Weighted Distributed Topic | WeightedDistributedTopicList |
JMS Element Properties
All required properties are listed with an asterisk (all other properties are optional).
Connection Factory
Property Name | Default Value | Notes | |
SystemModule* | <not set> | ||
JNDI | <not set> | ||
AcknowledgePolicy | All | ||
AttachJMSXUserId | False | ||
ClientID | <not set> | ||
ClientIdPolicy | Restricted | Restricted, Unrestricted | |
DefaultCompressionThreshold | 2147483647 | ||
DefaultDeliveryMode | Persistent | Persistent, Non-Persistent | |
DefaultPriority | 4 | ||
DefaultRedeliveryDelay | 0 | ||
DefaultTargetingEnabled | True | ||
DefaultTimeToDeliver | 0 | ||
DefaultTimeToLive | 0 | ||
DefaultUnitOfOrder | None | None, Other, System | |
UserDefaultUnitOfOrder | <not set> | used if | |
FlowInterval | 60 | ||
FlowMaximum | 500 | ||
FlowMinimum | 50 | ||
FlowSteps | 10 | ||
LoadBalancingEnabled | True | ||
LocalJNDIName | <not set> | ||
MessagesMaximum | 10 | ||
MulticastOverrunPolicy | KeepOld | KeepOld, KeepNew | |
Notes | <not set> | ||
OneWaySendMode | Disabled | disabled, enabled | |
OneWaySendWindowSize | 1 | ||
ReconnectBlockingMillis | 60000 | ||
ReconnectPolicy | Producer | all, none, producer | |
SendTimeout | 10 | ||
ServerAffinityEnabled | True | ||
SubscriptionSharingPolicy | Exclusive | Exclusive, Sharable | |
SynchronousPrefetchMode | Disabled | disabled, topicSubscriberOnly, enabled | |
TotalReconnectPeriodMillis | -1 | ||
TransactionTimeout | 3600 | ||
XAConnectionFactoryEnabled | True | ||
Destination Sort Key
Property Name | Default Value |
|---|---|
SystemModule* | <not set> |
KeyType | String |
Notes | <not set> |
SortKey | JMSMessageID |
SortOrder | Ascending |
Foreign Server
Property Name | Default Value | |
SystemModule* | <not set> | |
ConnectionURL* | <not set> | |
DefaultTargetingEnabled | True | |
ForeignCFNames (Comma-separated list of Foreign Connection Factories) | <not set> | |
ForeignCF{Name}EncryptedPassword | <not set> | |
ForeignCF{Name}HealthChecking | disabled (disabled | enabled) | |
ForeignCF{Name}LocalJNDI | <not set> | |
ForeignCF{Name}Password | <not set> | |
ForeignCF{Name}RemoteJNDI | <not set> | |
ForeignCF{Name}Username | <not set> | |
ForeignDestinationNames (Comma-separated list of Foreign Destinations) | <not set> | |
ForeignDestination{Name}LocalJNDI | <not set> | |
ForeignDestination{Name}RemoteJNDI | <not set> | |
JNDIInititalContextFactory | weblogic.jndi.WLInitialContextFactory | |
JNDIPropertiesCredential | <not set> | |
JNDIProperty{Name/Key} | <not set> | |
JNDIPropertyNames (Comma-separated list of Property Name/Keys) | <not set> | |
Notes | <not set> | |
JMS Server
Property Name | Default Value |
ServerName* | <not set> |
PersistentStore | None |
BytesThresholdLow | -1 |
BytesThresholdHigh | -1 |
MessagesThresholdLow | -1 |
MessagesThresholdHigh | -1 |
| MaximumMessageSize | 2147483647 |
| BytesMaximum | -1 |
| MessagesMaximum | -1 |
| TemporaryTemplateResource | <not set> |
| TemporaryTemplateName | <not set> |
| BlockingSendPolicy | FIFO (FIFO|Preemptive) |
| MessageCompressionOptions (Version 12+ only) | GZIP_DEFAULT_COMPRESSION (GZIP_DEFAULT_COMPRESSION|GZIP_BEST_COMPRESSION|GZIP_BEST_SPEED|LZF) |
| PagingMessageCompressionEnabled (Version 12+ only) | false |
| StoreMessageCompressionEnabled (Version 12+ only) | false |
| HostingTemporaryDestinations | true |
| AllowsPersistentDowngrade | false |
| InsertionPausedAtStartup | false |
| PagingFileLockingEnabled | true |
| StoreEnabled | true |
| ConsumptionPausedAtStartup | false |
| ProductionPausedAtStartup | false |
| PagingMaxFileSize | 1342177280 |
| PagingMaxWindowBufferSize | -1 |
| PagingMinWindowBufferSize | -1 |
| PagingIoBufferSize | -1 |
| PagingBlockSize | -1 |
| ExpirationScanInterval | 30 |
| Targets | <not set> |
| Notes | <not set> |
| In 12.2.1, these parameters are added: | |
| Partition | <not set> |
| ResourceGroup | <not set> |
| ResourceGroupTemplate | <not set> |
Quota
Property Name | Default Value |
SystemModule* | <not set> |
BytesMaximum | 9223372036854775807 |
MessagesMaximum | 9223372036854775807 |
Notes | <not set> |
Policy | FIFO (FIFO|Preemptive) |
Shared | false |
Sub Deployment
Property Name | Default Value |
|---|---|
SystemModule* | <not set> |
Targets* | <not set> |
System Module
Property Name | Default Value |
|---|---|
SystemModule* | <not set> |
Targets* | <not set> |
In 12.2.1, these parameters are added: | |
Partition | <not set> |
ResourceGroup | <not set> |
| ResourceGroupTemplate | <not set> |
Topic
Property Name | Default Value |
SystemModule* | <not set> |
AttachSender | Supports (supports|always|never) |
BytesHigh | 9223372036854775807 |
BytesLow | 9223372036854775807 |
ConsumptionPausedAtStartup | False |
DefaultUnitOfOrder (Auto-generate Unit-of-Order Name) | False |
DeliveryMode | No-Delivery ( Non-Persistent|Persistent|No-Delivery) |
DestinationSortKeys (Comma-separated names of destinations) | <not set> |
ErrorDestination | <not set> |
ExpirationLoggingPolicy | <not set> |
ExpirationPolicy | Discard (Discard|Log|Redirect) |
IncompleteWorkExpirationTime | -1 |
InsertionPausedAtStartup | False |
JMSCreateDestinationIdentifier | <not set> |
JNDI | <not set> |
LocalJNDIName | <not set> |
MaximumMessageSize | 2147483647 |
MessageLoggingEnabled | False |
MessageLoggingFormat | <not set> |
MessagesHigh | 9223372036854775807 |
MessagesLow | 9223372036854775807 |
MessagingPerformancePreference | 25 |
MulticastAddress | <not set> |
MulticastPort | 6001 |
MulticastTimeToLive | -1 |
Notes | <not set> |
Priority | -1 |
ProductionPausedAtStartup | False |
Quota | <not set> |
RedeliveryDelay | -1 |
RedeliveryLimit | -1 |
SAFExportPolicy | All (All|None) |
SubDeployment | <not set> |
Template | <not set> |
TimeToDeliver | -1 |
TimeToLive | -1 |
UnitOfWorkHandlingPolicy | PassThrough ( PassThrough | SingleMessageDelivery) |
Uniform Distributed Queue
Property Name | Default Value |
SystemModule* | <not set> |
AttachSender | supports |
BytesHigh | 9223372036854775807 |
BytesLow | 9223372036854775807 |
ConsumptionPausedAtStartup | False |
DefaultTargetingEnabled | False |
DefaultUnitOfOrder | False |
DeliveryMode | No-Delivery |
DestinationSortKeys | <not set> |
ErrorDestination | <not set> |
ExpirationLoggingPolicy | <not set> |
ExpirationPolicy | Discard |
ForwardDelay | 1 |
IncompleteWorkExpirationTime | 1 |
InsertionPausedAtStartup | False |
JMSCreateDestinationIdentifier | <not set> |
JNDI | <not set> |
LoadBalancingPolicy | Round-Robin (Random|Round-Robin) |
LocalJNDIName | <not set> |
MaximumMessageSize | 2147483647 |
Members | <not set> |
MessageLoggingEnabled | False |
MessageLoggingFormat | <not set> |
MessagesHigh | 9223372036854775807 |
MessagesLow | 9223372036854775807 |
MessagingPerformancePreference | 25 |
Notes | <not set> |
Priority | -1 |
Quota | <not set> |
ProductionPausedAtStartup | False |
RedeliveryDelay | -1 |
RedeliveryLimit | -1 |
ResetDeliveryCountOnForward | True |
SAFExportPolicy | All |
Uniform Distributed Topic
Property Name | Default Value |
SystemModule* | <not set> |
AttachSender | supports |
BytesHigh | 9223372036854775807 |
BytesLow | 9223372036854775807 |
ConsumptionPausedAtStartup | False |
DefaultTargetingEnabled | False |
DefaultUnitOfOrder | False |
DeliveryMode | No-Delivery |
DestinationSortKeys | <not set> |
ErrorDestination | <not set> |
ExpirationLoggingPolicy | <not set> |
ExpirationPolicy | Discard |
ForwardingPolicy | <not set> |
IncompleteWorkExpirationTime | -1 |
InsertionPausedAtStartup | False |
JMSCreateDestinationIdentifier | <not set> |
JNDI | <not set> |
LoadBalancingPolicy | Round-Robin (Random|Round-Robin) |
LocalJNDIName | <not set> |
MaximumMessageSize | 2147483647 |
Members | <not set> |
MessageLoggingEnabled | False |
MessageLoggingFormat | <not set> |
MessagesHigh | 9223372036854775807 |
MessagesLow | 9223372036854775807 |
MessagingPerformancePreference | 25 |
MulticastAddress | <not set> |
MulticastPort | 6001 |
MulticastTimeToLive | 1 |
Notes | <not set> |
Priority | -1 |
ProductionPausedAtStartup | False |
Quota | <not set> |
RedeliveryDelay | -1 |
RedeliveryLimit | -1 |
SAFExportPolicy | All |
Template | <not set> |
TimeToDeliver | -1 |
TimeToLive | -1 |
UnitOfOrderRouting | Hash |
UnitOfWorkHandlingPolicy | PassThrough |
Weighted Distributed Queue
Property Name | Default Value |
SystemModule* | <not set> |
{Member}Weight | 1 |
ForwardDelay | -1 |
LoadBalancingPolicy | Round-Robin (Random | Round-Robin) |
Members **Comma-separated Member Names | <not set> |
Notes | <not set> |
ResetDeliveryCountOnForward | False |
SAFExportPolicy | none (none|all) |
UnitOfOrderRouting | Hash (Hash|PathService) |
Weighted Distributed Topic
Property Name | Default Value |
|---|---|
SystemModule* | <not set> |
{Member}Weight | 1 |
LoadBalancingPolicy | Round-Robin (Random | Round-Robin) |
Members **Comma-separated Member Names | <not set> |
Notes | <not set> |
SAFExportPolicy | none (none|all) |
UnitOfOrderRouting | Hash (Hash|PathService) |