createOrUpdateJMSEntries

Creates or updates JMS Entries defined by properties files. The properties files will be processed for property replacement using ${{VARIABLE_NAME}} format.

If using multiple files, make sure that the lists contain unique values across files.

See the Appendix for more information about property replacement.

Environment/Instance Properties

Property Name

Property Code

Required

Description

Oracle Weblogic Home (WL_HOME)

FDWLS_WEBLOGIC_HOME

Yes

WebLogic Home Directory. (e.g. /u01/oracle/products/fmw/wlserver)

Weblogic Domain Name

FDWLS_DOMAIN_NAME

Yes

WebLogic Domain Name.

Weblogic Admin Listen Address

FDWLS_ADMIN_LISTEN_ADDRESS

Yes

The listener address of the WLS admin server. (e.g. localhost)

Weblogic Admin Listen Port

FDWLS_ADMIN_LISTEN_PORT

Yes

The port of the WLS admin server. (e.g. 7001)

Weblogic Admin SSL Connection

FDWLS_ADMIN_USE_SSL

No

Indicates whether the admin server is using SSL.

Weblogic Admin User

FDWLS_ADMIN_USER

Yes

The user name for the WLS admin server.

Weblogic Admin Password

FDWLS_ADMIN_PASSWORD

Yes

The password for FDWLS_ADMIN_USER.

Weblogic Admin Domain Directory

FDWLS_ADMIN_DOMAIN_DIRECTORY

No

Weblogic Domain Directory for AdminServer. If not provided, FDWLS_DOMAIN_DIRECTORY will be used.

Weblogic Domain Directory

FDWLS_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).
If relative paths are given, they are assumed relative to the FD_ARTIFACTS_DIR directory.
If this property is not specified, all properties files in the FD_ARTIFACTS_DIR directory will be processed.

Outputs

Output Name

Required

Description

FDWLS_OUT_IS_RESTART_REQUIRED

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 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 Example Properties File below.
  • 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.

Backslash in Properties file

If you want \ (backslash) in any property value, use \\ or \u005c. This is Java properties file load syntax.

SystemModuleList=Flex_JMSModule1
SubDeploymentList=Flex_JMSSubdeployment1
ConnectionFactoryList=CF1
QueueList=Q1
TopicList=T1
UniformDistributedQueueList=UDQ1
UniformDistributedTopicList=UDT1

Flex_JMSModule1.Targets=MS1

Flex_JMSSubdeployment1.SystemModule=Flex_JMSModule1
Flex_JMSSubdeployment1.Targets=Flex_JMSServer1

CF1.SystemModule=Flex_JMSModule1
CF1.JNDI=jms/CF1
CF1.Targets=MS1
CF1.XAConnectionFactoryEnabled=False
CF1.DefaultTargetingEnabled=True

Q1.SystemModule=Flex_JMSModule1
Q1.JNDI=jms/Q1
Q1.SubDeployment=Flex_JMSSubdeployment1
Q1.DeliveryMode=Persistent

T1.SystemModule=Flex_JMSModule1
T1.JNDI=jms/T1
T1.SubDeployment=Flex_JMSSubdeployment1

UDQ1.SystemModule=Flex_JMSModule1
UDQ1.JNDI=jms/UDQ1
UDQ1.SubDeployment=Flex_JMSSubdeployment1
UDQ1.Notes=Notes on UDQ1

UDT1.SystemModule=Flex_JMSModule1
UDT1.JNDI=jms/UDT1
UDT1.SubDeployment=Flex_JMSSubdeployment1
UDT1.Notes=Notes on 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.

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.

JMS Element List Objects

JMS Element Type

List Name

Connection Factory

ConnectionFactoryList

Destination Sort Key

DestinationSortKeyList

File StoreFileStoreList

Foreign Server

ForeignServerList

JDBC StoreJDBCStoreList
JMS ServerJMSServerList

Queue

QueueList

Quota

QuotaList

Replicated StoreReplicatedStoreList

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

Name*<not set>

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 DefaultUnitOfOrder is "Other"

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

Name*<not set>

SystemModule*

<not set>

KeyType

String

Notes

<not set>

SortKey

JMSMessageID

SortOrder

Ascending

File Store

Property Name

Default Value

StoreName*<not set>

Directory

<not set>

BlockSize

-1

MaxFileSize

1342177280

FileLockingEnabled

true

LogicalName

<not set>

InitialSize0
IoBufferSize1
SynchronousWritePolicy

Direct-Write

(Cache-Flush|Direct-Write-With-Cache|Direct-Write|Disabled|Cache-Flush)

CacheDirectory<not set>
Notes<not set>
Targets<not set>
MinWindowBufferSize-1
MaxWindowBufferSize-1
Properties below are only compatible with WLS Version 12.2.1+
InitialBootDelaySeconds-1
RestartInPlacetrue
FailbackDelaySeconds-1
NumberOfRestartAttempts6
DistributionPolicy

Distributed

(Singleton|Distributed)

MigrationPolicy

Off

(Off|On-Failure|Always)

PartialClusterStabilityDelaySeconds-1
SecondsBetweenRestarts30
Partition<not set>
ResourceGroup<not set>
ResourceGroupTemplate<not set>

Foreign Server

Property Name

Default Value

Name*<not set>

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>

JDBC Store

Property Name

Default Value

StoreName*<not set>

PrefixName

<not set>
CreateTableDDLFile<not set>
InsertsPerBatchMaximum20
ThreeStepThreshold200000
OraclePiggybackCommitEnabledfalse
WorkerCount1
DeletesPerBatchMaximum20
DeletesPerStatementMaximum20
LogicalName<not set>
WorkerPreferredBatchSize10
Notes<not set>
Targets<not set>
Properties below are only compatible with WLS Version 12.2.1+
InitialBootDelaySeconds-1
RestartInPlacetrue
FailbackDelaySeconds-1
NumberOfRestartAttempts6
DistributionPolicy

Distributed

(Singleton|Distributed)

MigrationPolicy

Off

(Off|On-Failure|Always)

PartialClusterStabilityDelaySeconds-1
SecondsBetweenRestarts30
Partition<not set>
ResourceGroup<not set>
ResourceGroupTemplate<not set>
MinWindowBufferSize-1
MaxWindowBufferSize-1

JMS Server

Property Name

Default Value

ServerName*

<not set>

PersistentStore

None

BytesThresholdLow

-1

BytesThresholdHigh

-1

MessagesThresholdLow

-1

MessagesThresholdHigh

-1
MaximumMessageSize2147483647
BytesMaximum-1
MessagesMaximum-1
TemporaryTemplateResource<not set>
TemporaryTemplateName<not set>
BlockingSendPolicyFIFO (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
HostingTemporaryDestinationstrue
AllowsPersistentDowngradefalse
InsertionPausedAtStartupfalse
PagingFileLockingEnabledtrue
StoreEnabledtrue
ConsumptionPausedAtStartupfalse
ProductionPausedAtStartupfalse
PagingMaxFileSize1342177280
PagingMaxWindowBufferSize-1
PagingMinWindowBufferSize-1
PagingIoBufferSize-1
PagingBlockSize-1
ExpirationScanInterval30
Targets<not set>
Notes<not set>
Properties below are only compatible with WLS Version 12.2.1+
Partition

<not set>

ResourceGroup<not set>
ResourceGroupTemplate

<not set>

Queue

Property Name

Default Value

Name*

<not set>

AttachSender

supports        (supports|always|never)

BytesHigh

9223372036854775807

BytesLow

9223372036854775807

ConsumptionPausedAtStartup

false

DefaultUnitOfOrder

false

DeliveryModeNo-Delivery   ( Non-Persistent|Persistent|No-Delivery)
DestinationSortKeys<not set>
ErrorDestination<not set>
ExpirationLoggingPolicy<not set>
ExpirationPolicyDiscard            (Discard|Log|Redirect)
IncompleteWorkExpirationTime-1
InsertionPausedAtStartupfalse
JMSCreateDestinationIdentifier<not set>
JNDI<not set>
LocalJNDIName<not set>
MaximumMessageSize2147483647

MessageLoggingEnabled

False

MessageLoggingFormat

<not set>

MessagesHigh

9223372036854775807

MessagesLow

9223372036854775807

MessagingPerformancePreference

25

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

UnitOfWorkHandlingPolicyPassThrough     ( PassThrough | SingleMessageDelivery)

Quota

Property Name

Default Value

Name*<not set>

SystemModule*

<not set>

BytesMaximum

9223372036854775807

MessagesMaximum

9223372036854775807

Notes

<not set>

Policy

FIFO                      (FIFO|Preemptive)

Shared

false

Replicated Store (WLS Version 12+)

Property Name

Default Value

StoreName*<not set>

RegionSize

134217728
LocalIndex0
IoBufferSize-1
Directory200000
OraclePiggybackCommitEnabledfalse
WorkerCount1
DeletesPerBatchMaximum20
DeletesPerStatementMaximum20
LogicalName<not set>
WorkerPreferredBatchSize10
Notes<not set>
Targets<not set>
Properties below are only compatible with WLS Version 12.2.1+
InitialBootDelaySeconds-1
RestartInPlacetrue
FailbackDelaySeconds-1
NumberOfRestartAttempts6
DistributionPolicy

Distributed

(Singleton|Distributed)

MigrationPolicy

Off

(Off|On-Failure|Always)

PartialClusterStabilityDelaySeconds-1
SecondsBetweenRestarts30
Partition<not set>
ResourceGroup<not set>
ResourceGroupTemplate<not set>
MinWindowBufferSize-1
MaxWindowBufferSize-1

Sub Deployment

Property Name

Default Value

Name*<not set>

SystemModule*

<not set>

Targets*
**Comma-separated list of target names (e.g. DefaultServer, Cluster1, server2)

<not set>

System Module

Property Name

Default Value

SystemModule*

<not set>

Targets*
**Comma-separated list of target names
(e.g. DefaultServer, Cluster1, server2)

<not set>

Properties below are only compatible with WLS Version 12.2.1+

Partition

<not set>

ResourceGroup

<not set>

ResourceGroupTemplate<not set>

Topic