17.10 - Syntax - Access Module

Teradata® Tools and Utilities Access Module Reference

Product
Access Module
Release Number
17.10
Published
October 2021
Language
English (United States)
Last Update
2021-11-02
dita:mapPath
uur1608578381725.ditamap
dita:ditavalPath
obe1474387269547.ditaval

The initialization string consists of a series of keyword and value pairs separated by blanks. Each keyword is preceded by a hyphen, and it is not case-sensitive. The value is either an integer or a string. Keywords can be specified within the initialization string or in a file. See Access Module Calls for information about specific AXSMOD command or command option syntax for each Teradata utility.

Load Syntax.svg


where the following is true:

Syntax Element Description
-ADD_LINE_FEED <yes/no> (Optional) Accepts either 'YES' or 'NO'. Teradata Access Module for JMS appends a newline character to the message it receives from the JMS server if -ADD_LINE_FEED=YES is specified in the initialization string.
bksz <maxMsgSize> (Optional) Specifies the maximum message length in bytes. The acceptable range of maximum message length is 1 byte-16 MB. Default value is 1,048,576 bytes.
cid <clientID> (Optional) Specifies the unique client ID for the connection in a load job. Use with durable subscriptions. For example:
-cid clientID
ckfile <objectName> (Optional) Specifies the name of the file that contains checkpoint data from load jobs only. For example:
-ckfile sampleCheckpointFile
-DEFERRED_MODE <yes/no> (Optional) Accepts either 'YES' or 'NO'. The deferred mode can be enabled by specifying -DEFERRED_MODE=YES.

Teradata Access Module for JMS creates a LOB object containing a message it receives from the JMS server, and passes the LOB object name to the TPT DC operator instead of the actual message so that TPT loading operators can load the LOB object in deferred mode.

dnm <durableName> (Optional) Supplies the durable subscriber name for a load job. The subscriber receives all published messages, including the ones published while it is disconnected. For example:
-dnm sampleDurableName
flush yes/no (Optional) Ensures that all checkpoint data (from load jobs) is written to media. Default value is no. For example:
-flush yes
help (Optional) Displays a list of parameter keywords and valid values. For example:
-help
icf <initContextFactoryName> (Required) Specifies the class name of the initial context factory. For example:
-icf com.ibm.websphere.naming.WsnInitialContextFactory
-icf weblogic.jndi.WLInitialContextFactory
-icf com.sun.jndi.fscontext.RefFSConextFactory
-icf oracle.jms.AQjmsInitialContextFactory
-icf com.evermind.server.ApplicationClientInitialContextFactory
latency <seconds> Specifies the time delay between receiving a current load message and the next message within a transaction, if transx is greater than 1. Default value is 5 seconds. For example:
-latency 4
-LOBDIRPATH <directory path> (Optional) Can be used alongside -DEFERRED_MODE parameter. The user can specify a directory to store the LOB objects using this parameter.
log <logObjectName> (Optional) Specifies the name of a log file or STDOUT. All messages received from a queue or topic are displayed in the specified file. Default value is no. For example:
-log myLogFile
logfill <yes/no> (Optional) Packs log records to minimize wasted disk space. Default value is yes.
-logfill no
-MESSAGE_CLOSE_QUOTE <close quote character> (Optional) Specifies a close quote. Use this parameter in a scenario where the close quote is different from the open quote character.
-MESSAGE_OPEN_QUOTE <open quote character> (Optional) Specifies an open quote. Use this parameter in a scenario where the open quote is different from the close quote character.
-MESSAGE_QUOTE quote character> (Optional) User can specify a quote character using this parameter. Teradata Access Module for JMS encloses the message it receives from the JMS server with the specified quote character.
msgtype <messageType> Specifies the type of export message. Valid values include:
  • Text
  • Binary (default)

For example:

-msgtype  TEXT
pack <numberRecordsPerMessage> Specifies the number of records per message. For example:
-pack 10
paramfile <objectName> (Optional) Supplies the object name for a file that includes more parameters. For example:
-paramfile myParmFile
Do not use any blank characters or lines at the end of the paramfile.
qcf <queueConnectionFactoryName> Specifies the name of the queue connection factory. Required if tcf is not specified. For example:
-qcf sampleQCF
qnm <queueName> Specifies the queue name. Required if qcf is defined. For example:
-qnm myQueue
qpwd <queue/topicConnectionPassword> (Optional) Specifies the password to create the queue or topic connection. For example:
-qpwd password
quser <queue/topicConnectionUsername> (Required if qpwd is specified.) Specifies the username for queue or topic connection. For example:
-quser userName
RECONNECT_ATTEMPTS (Optional) Specifies number of accessmodule JMS reconnection attempts with FollowTheMaster option in the AccessModuleJMS
rwait <maxSeconds> (Optional) Specifies the wait time in seconds if no load message is immediately available. The default value is 1 second. Valid values for an unlimited wait time are one of the following:
  • 1 to 600 seconds
  • -1

For example:

-rwait 500
-rwait -1
When you specify RWAIT -1 and a time out value in the utility script, Teradata Access Module for JMS returns control to the application at the expiration of the time out value.
SAG_FOLLOWTHEMASTER (Optional) <YES/NO> To enable/disables the followthemaster feature of SoftwareAG in the AccessModuleJMS

Default: NO

SECURITY_AUTHENTICATION <security_level> (Optional) Context property that specifies the security level for data transfer. The behavior is determined by the service provider. Valid values are as follows:
  • none
  • simple
  • strong

For example:

-SECURITY_AUTHENTICATION none
-SECURITY_AUTHENTICATION simple
-SECURITY_AUTHENTICATION strong
SECURITY_CREDENTIALS <password> (Optional) Context property that specifies the credentials of the principal for authenticating the caller to the service for data transfer. The value depends on the authentication scheme of the service provider. For example, it could be any of the following or more:
  • hashed password
  • clear-text password
  • key
  • certificate
SECURITY_PRINCIPAL <username> (Optional) Context property that specifies the identity of the principal for authenticating the caller to the service for data transfer. The format depends on the authentication scheme of the service provider.
SECURITY_PROTOCOL <type> (Optional) Specifies the security protocol for data transfer. The value is a string determined by the service provider, such as ssl. For example:
-SERVICE_PROTOCOL ssl
-SSL_KEYSTORE_LOCATION <ssl keystore certificate location> (Optional) Provides the SSL Keystore Certificate. Example:

/home/sslcerts/client.ks

-SSL_KEYSTORE_PASSWORD <ssl truststore password> (Optional) Provides the SSL Keystore Certificate Password.
-SSL_TRACE <yes/no> (Optional) When "yes", Teradata Access Module for JMS displays the SSL Debug Trace.
-SSL_TRUSTSTORE_LOCATION <ssl truststore location> (Optional) Provides the SSL Trustore Certificate. Example:

/home/sslcerts/client.ts

-SSL_TRUSTSTORE_PASSWORD <ssl truststore password> (Optional) Provides the SSL Truststore Certificate Password.
tcf <topicConnectionFactoryName> (Required if qcf is not specified.) Provides the topic connection factory name. For example:
-tcf sampleTCF
tdm yes/no (Optional) Terminates duplicate load messages. Default value is yes. For example:
-tdm no
tlf yes/no (Optional) Specifies that a log failure will cause a fatal error. Default value is yes. For example:
-tlf no
tnm <TopicName> (Required if tcf is defined.) Specifies the topic name. For example:
-tnm myTopic
transx <numberMessages> (Required) Specifies the number of messages in a transaction. For example:
-transx 4
trcl <level><fileName> (Optional) Specifies the trace level and file name of diagnostic activities. The trace level record these events:
  • 1=No diagnostic trace
  • 2=Job events
  • 3=I/ O events
  • 4=I/O buffers
  • 5=Detailed trace information
The default trace level is 1. For example:
-trcl 4 myFileName
url <providerUrl> (Required) Specifies the JNDI location of the administered objects. For example:
-url iiop: //myhost:9001 (from IBM Webshere MQ)
-url t3://myhost:7001 (from BEA WebLogic JMS)
-url file:/support/jms/samplet3 (file system context)
-url opmn:ormi://<hostname>:<opmn-request-port>:<oc4j-instance-name>/<application-name>