16.10 - Syntax - Access Module

Teradata Tools and Utilities Access Module Reference

Access Module
July 2017
Programming Reference

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.

where the following is true:

Export Syntax 
Syntax Element Description
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
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:
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
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
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
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, Teradarata Access Module for JMS returns control to the application at the expiration of the time out value.
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_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:
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>