com.strsoftware.axtko.delivery.aventx
Interface AventXPropertyDefinitions
- All Superinterfaces:
- oracle.apps.xdo.delivery.CommonPropertyDefinitions
- public interface AventXPropertyDefinitions
- extends oracle.apps.xdo.delivery.CommonPropertyDefinitions
|
Field Summary |
static java.lang.String |
AVENTX_ACKFILE
The ACKFILE command is very useful in returning an acknowledgement
to customer written application programs. |
static java.lang.String |
AVENTX_ACKFILEFORMAT
The ACKFILE command is very useful in returning an acknowledgement
to customer written application programs. |
static java.lang.String |
AVENTX_ACKFILELEVEL
The ACKFILE command is very useful in returning an acknowledgement
to customer written application programs. |
static java.lang.String |
AVENTX_AMOUNT
You may wish to specify the total amount for this document
so this information is available at-a-glance. |
static java.lang.String |
AVENTX_BUYERNAME
You may wish to specify the name of the buyer associated
with this document. |
static java.lang.String |
AVENTX_CONFIRMEMAIL1
You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. |
static java.lang.String |
AVENTX_CONFIRMEMAIL2
You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. |
static java.lang.String |
AVENTX_CONFIRMEMAIL3
You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. |
static java.lang.String |
AVENTX_CONFIRMEMAIL4
You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. |
static java.lang.String |
AVENTX_CONFIRMEMAIL5
You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. |
static java.lang.String |
AVENTX_CONFIRMLEVEL1
You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. |
static java.lang.String |
AVENTX_CONFIRMLEVEL2
You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. |
static java.lang.String |
AVENTX_CONFIRMLEVEL3
You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. |
static java.lang.String |
AVENTX_CONFIRMLEVEL4
You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. |
static java.lang.String |
AVENTX_CONFIRMLEVEL5
You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. |
static java.lang.String |
AVENTX_COVERPAGE
By default, AventX UNIX creates a cover page automatically
for each document delivery. |
static java.lang.String |
AVENTX_DATE
You may delay the transmission of a document to a future date
with the DATE command. |
static java.lang.String |
AVENTX_DELIVER
You may wish to provide a set of delivery instructions on
your delivered documents with the DELIVER command. |
static java.lang.String |
AVENTX_DESTINATION
This is a REQUIRED property. |
static java.lang.String |
AVENTX_DEVICE
Specifies a particular delivery server [and line, if required] to be used
for delivery of the document. |
static java.lang.String |
AVENTX_DOCID
You may wish to include the actual document ID (such as a
Purchase Order, Sales Order, or Invoice number) as a way to easily
identify this document in the transmission queue or completed document
list. |
static java.lang.String |
AVENTX_DOCREV
You may wish to identify the revision code (e.g., 0.1) for a
particular document using the DOCREV command. |
static java.lang.String |
AVENTX_DOCTYPE
You may wish to identify the type of document being delivered
by AventX UNIX using the DOCTYPE command. |
static java.lang.String |
AVENTX_ERPLOGIN
You may wish to include the actual login identification of
the ERP user who submitted this document, using the ERPLOGIN command. |
static java.lang.String |
AVENTX_ERPTRACKNO
Most ERP packages assign a unique ID to each document
processed through the system. |
static java.lang.String |
AVENTX_FILE
You may specify either a secondary or alternate source for the
AventX UNIX document commands with the FILE command. |
static java.lang.String |
AVENTX_FROMCOMPANY
Specifies a 40-character string of the sender's company name, which
may be inserted into the cover page and the transmission status reports. |
static java.lang.String |
AVENTX_FROMEMAIL
The FROMEMAIL command is used to identify the sender's return email address
when AventX UNIX is delivering a document to an email address. |
static java.lang.String |
AVENTX_FROMNAME
The FROMNAME command is used for each user to personalize the coverpage within
the document or set who an email is from. |
static java.lang.String |
AVENTX_GROUPSEND
Specifies whether a document must be delivered as an individual
transmission or that it may be grouped along with other documents
destined for the same remote fax machine. |
static java.lang.String |
AVENTX_HEADER
Specifies a 32-character string to be placed at the top of
each transmitted page of the document. |
static java.lang.String |
AVENTX_HOLD
Requests that the document be placed on hold in the transmission
queue until it is released with operator intervention. |
static java.lang.String |
AVENTX_LOGIN
You may wish to assign specific ownership of a document to a
particular Unix login account or value (especially for documents
originating from an ERP application). |
static java.lang.String |
AVENTX_MODE
Specifies the transmission resolution of either fine or
draft mode and overrides the global default value. |
static java.lang.String |
AVENTX_ORGID
Your company may contain several divisions, all using the
same instance of AventX UNIX. |
static java.lang.String |
AVENTX_OUTPUTDIR
You may specify where the AventX UNIX command and data files are written on the file system. |
static java.lang.String |
AVENTX_PRIMARYATTACHMENTLANG
PRIMARYATTACHMENTLANG is a REQUIRED property that allows you to set the language
of the document created by BI/XML Publisher (The document you set using deliveryRequest.setDocument(). |
static java.lang.String |
AVENTX_PRIMARYATTACHMENTNAME
PRIMARYATTACHMENTNAME is a REQUIRED property that allows you to name the
document created by BI/XML Publisher (The document you set using deliveryRequest.setDocument(). |
static java.lang.String |
AVENTX_PRIORITY
All documents are initially queued in AventX UNIX with a
default value of 5000. |
static java.lang.String |
AVENTX_REMARKS
In many customer environments, users wish to place comments
or remarks on the cover page. |
static java.lang.String |
AVENTX_REQUESTOR
Specifies the name of the requestor associated with this
document. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTFILE1
The SECONDARYATTACHMENTFILE is a file to be delivered along with the fax or email. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTFILE2
The SECONDARYATTACHMENTFILE is a file to be delivered along with the fax or email. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTFILE3
The SECONDARYATTACHMENTFILE is a file to be delivered along with the fax or email. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTFILE4
The SECONDARYATTACHMENTFILE is a file to be delivered along with the fax or email. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTFILE5
The SECONDARYATTACHMENTFILE is a file to be delivered along with the fax or email. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTLANG1
The SECONDARYATTACHMENTLANG is the language of the SECONDARYATTACHMENTFILE that is specified. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTLANG2
The SECONDARYATTACHMENTLANG is the language of the SECONDARYATTACHMENTFILE that is specified. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTLANG3
The SECONDARYATTACHMENTLANG is the language of the SECONDARYATTACHMENTFILE that is specified. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTLANG4
The SECONDARYATTACHMENTLANG is the language of the SECONDARYATTACHMENTFILE that is specified. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTLANG5
The SECONDARYATTACHMENTLANG is the language of the SECONDARYATTACHMENTFILE that is specified. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTNAME1
The SECONDARYATTACHMENTNAME is the name to be used for the attachment for email delivery only. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTNAME2
The SECONDARYATTACHMENTNAME is the name to be used for the attachment for email delivery only. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTNAME3
The SECONDARYATTACHMENTNAME is the name to be used for the attachment for email delivery only. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTNAME4
The SECONDARYATTACHMENTNAME is the name to be used for the attachment for email delivery only. |
static java.lang.String |
AVENTX_SECONDARYATTACHMENTNAME5
The SECONDARYATTACHMENTNAME is the name to be used for the attachment for email delivery only. |
static java.lang.String |
AVENTX_SUBJECT
You may personalize your transmissions with the SUBJECT
command. |
static java.lang.String |
AVENTX_SYSTEM
For companies with several Unix hosts running ERP packages,
keeping track of the system that created the original document may be
an important factor. |
static java.lang.String |
AVENTX_TIME
You may delay the delivery of a document to a future time with
the TIME command. |
static java.lang.String |
AVENTX_TOCOMPANY
The TOCOMPANY command is used for each user to personalize
the cover page within this document. |
static java.lang.String |
AVENTX_TONAME
The TO command is used for each user to personalize the cover
page within his document. |
static java.lang.String |
AVENTX_USERDATA1
Generic field that may contain any type of information you wish. |
static java.lang.String |
AVENTX_USERDATA2
Generic field that may contain any type of information you wish. |
static java.lang.String |
AVENTX_USERDATA3
Generic field that may contain any type of information you wish. |
static java.lang.String |
AVENTX_USERDATA4
Generic field that may contain any type of information you wish. |
static java.lang.String |
AVENTX_USERDATA5
Generic field that may contain any type of information you wish. |
static java.lang.String |
AVENTX_USERDATA6
Generic field that may contain any type of information you wish. |
static java.lang.String |
AVENTX_USERDATA7
Generic field that may contain any type of information you wish. |
static java.lang.String |
AVENTX_USERDATA8
Generic field that may contain any type of information you wish. |
static java.lang.String |
AVENTX_USERID
You may personalize how your document is identified in the
log with the USERID command. |
static java.lang.String |
AVENTX_VENDORNAME
Specifies the name of the vendor associated with this
document. |
| Fields inherited from interface oracle.apps.xdo.delivery.CommonPropertyDefinitions |
AUTHTYPE, AUTHTYPE_BASIC, AUTHTYPE_DIGEST, AUTHTYPE_NONE, CONTENT_TYPE_EXCEL, CONTENT_TYPE_OCTETSTREAM, CONTENT_TYPE_PDF, CONTENT_TYPE_POSTSCRIPT, CONTENT_TYPE_RTF, CONTENT_TYPE_TEXT, CONTENT_TYPE_XML, ENCTYPE, ENCTYPE_NONE, ENCTYPE_SSL, FILTER, HOST, LOG_INSTANCE, PASSWORD, PORT, PROXY_AUTHTYPE, PROXY_HOST, PROXY_PASSWORD, PROXY_PORT, PROXY_USERNAME, RCS_ID, RCS_ID_RECORDED, SSL_LIBRARY, SSL_LIBRARY_JSSE, SSL_LIBRARY_ORACLE, TIMEOUT, URI, URL_CHARACTER_ENCODING, USERNAME |
AVENTX_ACKFILE
public static final java.lang.String AVENTX_ACKFILE
- The ACKFILE command is very useful in returning an acknowledgement
to customer written application programs.
This value specifies the name of the disk file
where the acknowledgement records will be written. AventX UNIX will
automatically format a buffer of data to this disk file when the document
has completed delivery, either successfully or unsuccessfully.
- See Also:
AVENTX_ACKFILEFORMAT,
AVENTX_ACKFILELEVEL,
Constant Field Values
AVENTX_ACKFILEFORMAT
public static final java.lang.String AVENTX_ACKFILEFORMAT
- The ACKFILE command is very useful in returning an acknowledgement
to customer written application programs.
Several types of buffer formats are available. Selection of the
buffer is made with the format parameter above. If no format is
specified, then the default buffer format is one (1). The format number
is always returned as the first word of the buffer itself. This
is necessary in order for the receiving program to interpret the
buffer of data.
You must specify a value for AVENTX_ACKFILE in order to utilize this property.
Valid values include 1 - 12, also see the AventX UNIX Reference Guide (ACKFILE) for
the description of the formats. If the value specified is outside the range
of 1-12, it will be ignored and a warning written to the log.
- See Also:
AVENTX_ACKFILE,
AVENTX_ACKFILELEVEL,
Constant Field Values
AVENTX_ACKFILELEVEL
public static final java.lang.String AVENTX_ACKFILELEVEL
- The ACKFILE command is very useful in returning an acknowledgement
to customer written application programs.
You may specify at which point(s) during the processing of the document
by AventX UNIX that you want the record written to the file.
The default level is when the document completes delivery. You can
specify to receive an acknowledgement when the document is placed in
the transmission queue with the value of Q. You can specify to receive
an acknowledgement when the document encounters a recoverable
transmission error with the value of R. You can specify to receive
an acknowledgement when the document encounters a fatal transmission
error with the value of F. Finally, you can specify to receive an
acknowledgement for all conditions with the value of A.
If an invalid value is specified, this property will be ignored.
You must specify a value for AVENTX_ACKFILE in order to utilize this property.
Also see the AventX UNIX Reference Guide (ACKFILE) for the description of the
formats.
- See Also:
AVENTX_ACKFILE,
AVENTX_ACKFILEFORMAT,
Constant Field Values
AVENTX_AMOUNT
public static final java.lang.String AVENTX_AMOUNT
- You may wish to specify the total amount for this document
so this information is available at-a-glance. This command is used
to store dollar amounts for such documents as Purchase Orders, Invoices
Sales Orders, etc.
The value provided will be truncated to 16 characters.
- See Also:
- Constant Field Values
AVENTX_BUYERNAME
public static final java.lang.String AVENTX_BUYERNAME
- You may wish to specify the name of the buyer associated
with this document.
The value provided will be truncated to 80 characters.
- See Also:
- Constant Field Values
AVENTX_COVERPAGE
public static final java.lang.String AVENTX_COVERPAGE
- By default, AventX UNIX creates a cover page automatically
for each document delivery. This feature can be overridden on a global
al basis by setting the COVERPAGE to null in the global configuration
tion. (see the SET command in Chapter 18, fcmgr of this reference
guide). On first installation, the default cover page is named COVRPCL
which is located in the $FCHOME/cfg/covers directory.
The specification of the cover page can be No, Yes for the
default value specified in the global configuration (see
Important Note below), or a file name. The file name may
be an ASCII file found only in the $FCHOME/cfg/covers
directory, and is limited to 16 characters.
Important Note: Please note that setting filename to Yes
will take the default value specified in the global configuration
for CoverPage. Therefore, if the default global
value for CoverPage is set to COVRPAGE, you will get a cover
page based upon the COVRPAGE template. However, if the
default global value is set to NO, you will get no cover
page!
If no cover command is included with your document and you reference
an area defined for remarks, then AventX UNIX considers this an error
ror, because without a cover page the remarks would not be printed.
If a cover page specification is made, either for YES, NO, or file-
name, this specification overrides the value configured for each entry
of the phonebook.
Please see the AventX UNIX Reference Guide for an exhaustive
discussion on Coverpages.
- See Also:
AVENTX_REMARKS,
Constant Field Values
AVENTX_DATE
public static final java.lang.String AVENTX_DATE
- You may delay the transmission of a document to a future date
with the DATE command. This command requires the transmission date
in MMDDYY format. Valid entries may contain delimiters such as
/ or - between the month, day, and year.
If no date command is found in the document, then the scheduled date
is defined by the current system date. In addition, if no TIme command
mand is found, then the transmission time is assigned the current
time.
- See Also:
AVENTX_TIME,
Constant Field Values
AVENTX_DELIVER
public static final java.lang.String AVENTX_DELIVER
- You may wish to provide a set of delivery instructions on
your delivered documents with the DELIVER command. This command may
specify any string of characters, up to 80 characters in length for
placement on the cover page. The most often used string is "ASAP"
for as soon as possible.
- See Also:
- Constant Field Values
AVENTX_DESTINATION
public static final java.lang.String AVENTX_DESTINATION
- This is a REQUIRED property.
The DESTINATION command specifies the destination address for the
document, either a fax number or email address.
The email address must be provided as a string of up to 255 characters
Some phone systems require an access code to be included as part of a
phone number for long distance dialing. AventX UNIX supports this
feature by allowing the user to supply an access code at the end of a
phone number. This is accomplished by delimiting the code with either
quotes or apostrophes. The access code will not be displayed in
any of the reports or fcmgr output, with the exception of a confirmation
tion report for successful entries (e.g., Status : *** Transmitted
ok to 804-897-1638 12345 on 03/09/05 at 17:13). The code is
passed to the delivery server when the call is placed.
Additionally, some remote fax numbers contain an extension number, as
the remote fax machine is placed on an extension to an automated
telephone system. AventX UNIX supports the blind dial character of
B, used to wait for 2.5 seconds before continuing the dialing sequence
Since every telephone system may vary, you may need to experiment
iment with the number of B characters to provide the proper delay.
- See Also:
- Constant Field Values
AVENTX_DEVICE
public static final java.lang.String AVENTX_DEVICE
- Specifies a particular delivery server [and line, if required] to be used
for delivery of the document. For those customers who have more than one delivery server
attached to their Unix Host, you may wish to restrict which delivery
servers are to transmit a specific kind of document.
Valid values include ny string of up to 16 characters, indicating the server name,
as configured in fcmgr using the DEVICE command.
- See Also:
- Constant Field Values
AVENTX_DOCID
public static final java.lang.String AVENTX_DOCID
- You may wish to include the actual document ID (such as a
Purchase Order, Sales Order, or Invoice number) as a way to easily
identify this document in the transmission queue or completed document
list. This information is included on AventX UNIX standard reports
and the output of the fcmgr LISTQUEUE and LISTFAX commands.
The value can include any string up to 16 characters.
- See Also:
- Constant Field Values
AVENTX_DOCREV
public static final java.lang.String AVENTX_DOCREV
- You may wish to identify the revision code (e.g., 0.1) for a
particular document using the DOCREV command.
The value can include any string up to 4 characters.
- See Also:
- Constant Field Values
AVENTX_DOCTYPE
public static final java.lang.String AVENTX_DOCTYPE
- You may wish to identify the type of document being delivered
by AventX UNIX using the DOCTYPE command. For example, you may
wish to distinguish at-a-glance, Purchase Orders from Invoices in the
transmission queue, completed lists, and standard reports.
The value can include any string up to 4 characters.
- See Also:
- Constant Field Values
AVENTX_ERPLOGIN
public static final java.lang.String AVENTX_ERPLOGIN
- You may wish to include the actual login identification of
the ERP user who submitted this document, using the ERPLOGIN command.
This provides a way to easily identify this document in the transmission
queue or completed document list. This information is included
on AventX UNIX standard reports and the output of the fcmgr ListQueue
and ListFax commands.
This value can include any string up to 16 characters.
- See Also:
- Constant Field Values
AVENTX_ERPTRACKNO
public static final java.lang.String AVENTX_ERPTRACKNO
- Most ERP packages assign a unique ID to each document
processed through the system. You may wish to use this ID to quickly
locate this specific document in the transmission queue, completed
list, or standard AventX UNIX reports.
This value can include any string up to 16 characters.
- See Also:
- Constant Field Values
AVENTX_FILE
public static final java.lang.String AVENTX_FILE
- You may specify either a secondary or alternate source for the
AventX UNIX document commands with the FILE command.
The FILE command cannot reference a file name that also has a FILE
command within it. In this case, the embedded FILE command is ignored.
This value is a properly qualified file name which contains document commands
or blank lines. The fileref may use environment variables,
document key data, or directives. See Chapter 7 of the AventX UNIX Reference Guide,
Advanced Features for more details.
- See Also:
- Constant Field Values
AVENTX_FROMCOMPANY
public static final java.lang.String AVENTX_FROMCOMPANY
- Specifies a 40-character string of the sender's company name, which
may be inserted into the cover page and the transmission status reports.
- See Also:
- Constant Field Values
AVENTX_FROMNAME
public static final java.lang.String AVENTX_FROMNAME
- The FROMNAME command is used for each user to personalize the coverpage within
the document or set who an email is from. This value can include any
string up to 40 characters.
- See Also:
AVENTX_FROMEMAIL,
Constant Field Values
AVENTX_FROMEMAIL
public static final java.lang.String AVENTX_FROMEMAIL
- The FROMEMAIL command is used to identify the sender's return email address
when AventX UNIX is delivering a document to an email address. This makes
for easy recognition of the document when delivered. This value can include
any string up to 255 characters.
- See Also:
AVENTX_FROMNAME,
Constant Field Values
AVENTX_GROUPSEND
public static final java.lang.String AVENTX_GROUPSEND
- Specifies whether a document must be delivered as an individual
transmission or that it may be grouped along with other documents
destined for the same remote fax machine. This command applies
to FAXCOM delivery server fax transmissions only and does not apply
for Easylink delivery servers.
Please consult the AventX UNIX Reference Guide for further detail
on the behavior of GROUPSEND.
This value can either be true or false. If any other value is
provided, it will be interpreted as false.
- See Also:
- Constant Field Values
AVENTX_HEADER
public static final java.lang.String AVENTX_HEADER
- Specifies a 32-character string to be placed at the top of
each transmitted page of the document. This command applies to fax
transmissions via FAXCOM delivery servers only.
- See Also:
- Constant Field Values
AVENTX_HOLD
public static final java.lang.String AVENTX_HOLD
- Requests that the document be placed on hold in the transmission
queue until it is released with operator intervention.
This value can either be true or false. If any other value is
provided, it will be interpreted as false.
- See Also:
- Constant Field Values
AVENTX_LOGIN
public static final java.lang.String AVENTX_LOGIN
- You may wish to assign specific ownership of a document to a
particular Unix login account or value (especially for documents
originating from an ERP application). This command allows the owner
of the document to be defined on a per document basis. If the LOGIN
command is used in the document, ownership of the document is specifically
assigned; if not, ownership is given to the submitting login
account. AventX UNIX considers the owner of the documents to be the
process or person that submitted the documents. It is important to
note that AventX UNIX allows users without FaxAdmin privileges to operate
only on documents that they own. In the preceding example, only
users with a login which matches that of the process that submitted
the documents would have access to them for operations such as
ChangeQueue, QueueFax, DeleteFax etc.
This value can be any string of up to 256 characters.
- See Also:
- Constant Field Values
AVENTX_MODE
public static final java.lang.String AVENTX_MODE
- Specifies the transmission resolution of either fine or
draft mode and overrides the global default value. This command applies
to fax transmissions only.
This value can either be "fine" or "draft". If no transmit mode
is specified, then the default value specified in the global configuration
is used. If a value other than fine or draft is specified it will be ignored.
- See Also:
- Constant Field Values
AVENTX_ORGID
public static final java.lang.String AVENTX_ORGID
- Your company may contain several divisions, all using the
same instance of AventX UNIX. This is a very familiar concept when
integrating with ERP Packages. The ORGID command allows you to identify
from which division this document was generated. This information
can then be used as a key to search for documents in the AventX
UNIX transmission queue, completed lists, or standard reports.
This value can be any string up to 8 characters.
- See Also:
- Constant Field Values
AVENTX_PRIORITY
public static final java.lang.String AVENTX_PRIORITY
- All documents are initially queued in AventX UNIX with a
default value of 5000. You may alter this initial value using the
PRIORITY command. Values range from 1 to 9999. Lower values indicate
a higher transmission priority. If the value specified is not in the
range of 1 to 9999, the priority specified will be ignored.
- See Also:
- Constant Field Values
AVENTX_REMARKS
public static final java.lang.String AVENTX_REMARKS
- In many customer environments, users wish to place comments
or remarks on the cover page. The number of lines of text for remarks cannot
exceed the defined remarks area for the referenced cover page template
Please see the AventX UNIX Reference Guide for more information on using
Remarks in a coverpage.
This value can be any string up to 3200 characters.
- See Also:
AVENTX_COVERPAGE,
Constant Field Values
AVENTX_REQUESTOR
public static final java.lang.String AVENTX_REQUESTOR
- Specifies the name of the requestor associated with this
document.
This value can be any string up to 40 characters.
- See Also:
- Constant Field Values
AVENTX_SUBJECT
public static final java.lang.String AVENTX_SUBJECT
- You may personalize your transmissions with the SUBJECT
command. Any string may be placed in the SUBJECT command to denote
your document in the transmission progress messages to the system
console and in the Summary and Detail reports.
Subject values can be the customer name, a PO number, a memo, a bill
of lading number, etc.
The Subject value is displayed in all reports and messages within
AventX UNIX.
For email transmissions, this command is used to populate the Subject
of the email as viewed by the recipient.
- See Also:
- Constant Field Values
AVENTX_SYSTEM
public static final java.lang.String AVENTX_SYSTEM
- For companies with several Unix hosts running ERP packages,
keeping track of the system that created the original document may be
an important factor. Using the SYSTEM command specifies that this
document was generated from the Unix hostname.
This value can be any string up to 16 characters.
- See Also:
- Constant Field Values
AVENTX_TIME
public static final java.lang.String AVENTX_TIME
- You may delay the delivery of a document to a future time with
the TIME command. This command requires the transmission time as either
NOW or in HHMM format.
If no time command is included with your document, then the current
time is assumed. Addtionally, if no DATE command is found, then the
date is assigned the current date.
- See Also:
AVENTX_TIME,
Constant Field Values
AVENTX_TOCOMPANY
public static final java.lang.String AVENTX_TOCOMPANY
- The TOCOMPANY command is used for each user to personalize
the cover page within this document. This value can be inserted
in the tocompany token on the cover page and the transmission status
reports. This provides for easy recognition of the document when
transmitted.
This value can be any string up to 40 characters.
- See Also:
AVENTX_TONAME,
Constant Field Values
AVENTX_TONAME
public static final java.lang.String AVENTX_TONAME
- The TO command is used for each user to personalize the cover
page within his document. This makes for easy recognition of the
document when transmitted.
This value can be any string up to 40 characters.
- See Also:
AVENTX_TOCOMPANY,
Constant Field Values
AVENTX_USERDATA1
public static final java.lang.String AVENTX_USERDATA1
- Generic field that may contain any type of information you wish.
These fields can also be included on cover pages and can be used to
search for your document in the AventX UNIX transmission queue or
completed lists.
This value can be any string up to 255 characters.
- See Also:
AVENTX_USERDATA2,
AVENTX_USERDATA3,
AVENTX_USERDATA4,
AVENTX_USERDATA5,
AVENTX_USERDATA6,
AVENTX_USERDATA7,
AVENTX_USERDATA8,
Constant Field Values
AVENTX_USERDATA2
public static final java.lang.String AVENTX_USERDATA2
- Generic field that may contain any type of information you wish.
These fields can also be included on cover pages and can be used to
search for your document in the AventX UNIX transmission queue or
completed lists.
This value can be any string up to 255 characters.
- See Also:
AVENTX_USERDATA1,
AVENTX_USERDATA3,
AVENTX_USERDATA4,
AVENTX_USERDATA5,
AVENTX_USERDATA6,
AVENTX_USERDATA7,
AVENTX_USERDATA8,
Constant Field Values
AVENTX_USERDATA3
public static final java.lang.String AVENTX_USERDATA3
- Generic field that may contain any type of information you wish.
These fields can also be included on cover pages and can be used to
search for your document in the AventX UNIX transmission queue or
completed lists.
This value can be any string up to 255 characters.
- See Also:
AVENTX_USERDATA1,
AVENTX_USERDATA2,
AVENTX_USERDATA4,
AVENTX_USERDATA5,
AVENTX_USERDATA6,
AVENTX_USERDATA7,
AVENTX_USERDATA8,
Constant Field Values
AVENTX_USERDATA4
public static final java.lang.String AVENTX_USERDATA4
- Generic field that may contain any type of information you wish.
These fields can also be included on cover pages and can be used to
search for your document in the AventX UNIX transmission queue or
completed lists.
This value can be any string up to 255 characters.
- See Also:
AVENTX_USERDATA1,
AVENTX_USERDATA2,
AVENTX_USERDATA3,
AVENTX_USERDATA5,
AVENTX_USERDATA6,
AVENTX_USERDATA7,
AVENTX_USERDATA8,
Constant Field Values
AVENTX_USERDATA5
public static final java.lang.String AVENTX_USERDATA5
- Generic field that may contain any type of information you wish.
These fields can also be included on cover pages and can be used to
search for your document in the AventX UNIX transmission queue or
completed lists.
This value can be any string up to 255 characters.
- See Also:
AVENTX_USERDATA1,
AVENTX_USERDATA2,
AVENTX_USERDATA3,
AVENTX_USERDATA4,
AVENTX_USERDATA6,
AVENTX_USERDATA7,
AVENTX_USERDATA8,
Constant Field Values
AVENTX_USERDATA6
public static final java.lang.String AVENTX_USERDATA6
- Generic field that may contain any type of information you wish.
These fields can also be included on cover pages and can be used to
search for your document in the AventX UNIX transmission queue or
completed lists.
This value can be any string up to 255 characters.
- See Also:
AVENTX_USERDATA1,
AVENTX_USERDATA2,
AVENTX_USERDATA3,
AVENTX_USERDATA4,
AVENTX_USERDATA5,
AVENTX_USERDATA7,
AVENTX_USERDATA8,
Constant Field Values
AVENTX_USERDATA7
public static final java.lang.String AVENTX_USERDATA7
- Generic field that may contain any type of information you wish.
These fields can also be included on cover pages and can be used to
search for your document in the AventX UNIX transmission queue or
completed lists.
This value can be any string up to 255 characters.
- See Also:
AVENTX_USERDATA1,
AVENTX_USERDATA2,
AVENTX_USERDATA3,
AVENTX_USERDATA4,
AVENTX_USERDATA5,
AVENTX_USERDATA6,
AVENTX_USERDATA8,
Constant Field Values
AVENTX_USERDATA8
public static final java.lang.String AVENTX_USERDATA8
- Generic field that may contain any type of information you wish.
These fields can also be included on cover pages and can be used to
search for your document in the AventX UNIX transmission queue or
completed lists.
This value can be any string up to 255 characters.
- See Also:
AVENTX_USERDATA1,
AVENTX_USERDATA2,
AVENTX_USERDATA3,
AVENTX_USERDATA4,
AVENTX_USERDATA5,
AVENTX_USERDATA6,
AVENTX_USERDATA7,
Constant Field Values
AVENTX_USERID
public static final java.lang.String AVENTX_USERID
- You may personalize how your document is identified in the
log with the USERID command. Any string of up 40 characters may be
used. You may easily distinguish your document in the AventX UNIX
transmission queue or completed list by using the USERID as a search
item. For example, if the USERID stores the Purchase Order number,
you can search for the document based on this number.
It is important to note that this value has no relevance to the user
submitting the report.
- See Also:
- Constant Field Values
AVENTX_VENDORNAME
public static final java.lang.String AVENTX_VENDORNAME
- Specifies the name of the vendor associated with this
document.
This value may be any string up to 80 characters.
- See Also:
- Constant Field Values
AVENTX_PRIMARYATTACHMENTNAME
public static final java.lang.String AVENTX_PRIMARYATTACHMENTNAME
- PRIMARYATTACHMENTNAME is a REQUIRED property that allows you to name the
document created by BI/XML Publisher (The document you set using deliveryRequest.setDocument().
For emails, this will be the name of the primary attachment.
An example of this would be: Purchase_Order_#897.pdf
This value may be any string up to 255 characters and all spaces will be
replaced with underscores.
- See Also:
AVENTX_PRIMARYATTACHMENTLANG,
Constant Field Values
AVENTX_PRIMARYATTACHMENTLANG
public static final java.lang.String AVENTX_PRIMARYATTACHMENTLANG
- PRIMARYATTACHMENTLANG is a REQUIRED property that allows you to set the language
of the document created by BI/XML Publisher (The document you set using deliveryRequest.setDocument().
This value tells the Delivery Server how to translate the document. Acceptable values
can be the actual MIME type (e.g. application/pdf) or a mapped abbreviation (e.g. pdf). All known
supported languages are defined in the $FCHOME/cfg/mime.types file.
- See Also:
AVENTX_PRIMARYATTACHMENTNAME,
Constant Field Values
AVENTX_SECONDARYATTACHMENTFILE1
public static final java.lang.String AVENTX_SECONDARYATTACHMENTFILE1
- The SECONDARYATTACHMENTFILE is a file to be delivered along with the fax or email. Perhaps a
company would like terms and conditions delivered with the primary document.
This value may be a string of up to 255 characters in length containing the fully
qualified pathname of the file to be attached. Environment variables (such as $FCHOME,
for example) may be included in the filename. Use this property in conjunction with
with AVENTX_SECONDARYATTACHMENTLANG1 and AVENTX_SECONDARYATTACHMENTNAME1.
- See Also:
AVENTX_SECONDARYATTACHMENTLANG1,
AVENTX_SECONDARYATTACHMENTNAME1,
Constant Field Values
AVENTX_SECONDARYATTACHMENTLANG1
public static final java.lang.String AVENTX_SECONDARYATTACHMENTLANG1
- The SECONDARYATTACHMENTLANG is the language of the SECONDARYATTACHMENTFILE that is specified.
This value tells the Delivery Server how to translate the document. Acceptable values
can be the actual MIME type (e.g. application/pdf) or a mapped abbreviation (e.g. pdf). All known
supported languages are defined in the $FCHOME/cfg/mime.types file.
If this value is not specified for an attachment, the file extension for SECONDARYATTACHMENTNAME (or
SECONDARYATTACHMENTFILE if SECONDARYATTACHMENTNAME is blank) will be used to determine
the appropriate MIME type. This extension will be compared to the $FCHOME/cfg/mime.types list to
find the matching MIME type.
- See Also:
AVENTX_SECONDARYATTACHMENTFILE1,
AVENTX_SECONDARYATTACHMENTNAME1,
Constant Field Values
AVENTX_SECONDARYATTACHMENTNAME1
public static final java.lang.String AVENTX_SECONDARYATTACHMENTNAME1
- The SECONDARYATTACHMENTNAME is the name to be used for the attachment for email delivery only.
An example of this would be: Terms_and_Conditions.pdf
This value may be any string up to 255 characters and all spaces will be
replaced with underscores.
If attachmentname is left blank, the attachment will be given
the same name as filename.
- See Also:
AVENTX_SECONDARYATTACHMENTFILE1,
AVENTX_SECONDARYATTACHMENTLANG1,
Constant Field Values
AVENTX_SECONDARYATTACHMENTFILE2
public static final java.lang.String AVENTX_SECONDARYATTACHMENTFILE2
- The SECONDARYATTACHMENTFILE is a file to be delivered along with the fax or email. Perhaps a
company would like terms and conditions delivered with the primary document.
This value may be a string of up to 255 characters in length containing the fully
qualified pathname of the file to be attached. Environment variables (such as $FCHOME,
for example) may be included in the filename. Use this property in conjunction with
with AVENTX_SECONDARYATTACHMENTLANG2 and AVENTX_SECONDARYATTACHMENTNAME2.
- See Also:
AVENTX_SECONDARYATTACHMENTLANG2,
AVENTX_SECONDARYATTACHMENTNAME2,
Constant Field Values
AVENTX_SECONDARYATTACHMENTLANG2
public static final java.lang.String AVENTX_SECONDARYATTACHMENTLANG2
- The SECONDARYATTACHMENTLANG is the language of the SECONDARYATTACHMENTFILE that is specified.
This value tells the Delivery Server how to translate the document. Acceptable values
can be the actual MIME type (e.g. application/pdf) or a mapped abbreviation (e.g. pdf). All known
supported languages are defined in the $FCHOME/cfg/mime.types file.
If this value is not specified for an attachment, the file extension for SECONDARYATTACHMENTNAME (or
SECONDARYATTACHMENTFILE if SECONDARYATTACHMENTNAME is blank) will be used to determine
the appropriate MIME type. This extension will be compared to the $FCHOME/cfg/mime.types list to
find the matching MIME type.
- See Also:
AVENTX_SECONDARYATTACHMENTFILE2,
AVENTX_SECONDARYATTACHMENTNAME2,
Constant Field Values
AVENTX_SECONDARYATTACHMENTNAME2
public static final java.lang.String AVENTX_SECONDARYATTACHMENTNAME2
- The SECONDARYATTACHMENTNAME is the name to be used for the attachment for email delivery only.
An example of this would be: Terms_and_Conditions.pdf
This value may be any string up to 255 characters and all spaces will be
replaced with underscores.
If attachmentname is left blank, the attachment will be given
the same name as filename.
- See Also:
AVENTX_SECONDARYATTACHMENTFILE2,
AVENTX_SECONDARYATTACHMENTLANG2,
Constant Field Values
AVENTX_SECONDARYATTACHMENTFILE3
public static final java.lang.String AVENTX_SECONDARYATTACHMENTFILE3
- The SECONDARYATTACHMENTFILE is a file to be delivered along with the fax or email. Perhaps a
company would like terms and conditions delivered with the primary document.
This value may be a string of up to 255 characters in length containing the fully
qualified pathname of the file to be attached. Environment variables (such as $FCHOME,
for example) may be included in the filename. Use this property in conjunction with
with AVENTX_SECONDARYATTACHMENTLANG3 and AVENTX_SECONDARYATTACHMENTNAME3.
- See Also:
AVENTX_SECONDARYATTACHMENTLANG3,
AVENTX_SECONDARYATTACHMENTNAME3,
Constant Field Values
AVENTX_SECONDARYATTACHMENTLANG3
public static final java.lang.String AVENTX_SECONDARYATTACHMENTLANG3
- The SECONDARYATTACHMENTLANG is the language of the SECONDARYATTACHMENTFILE that is specified.
This value tells the Delivery Server how to translate the document. Acceptable values
can be the actual MIME type (e.g. application/pdf) or a mapped abbreviation (e.g. pdf). All known
supported languages are defined in the $FCHOME/cfg/mime.types file.
If this value is not specified for an attachment, the file extension for SECONDARYATTACHMENTNAME (or
SECONDARYATTACHMENTFILE if SECONDARYATTACHMENTNAME is blank) will be used to determine
the appropriate MIME type. This extension will be compared to the $FCHOME/cfg/mime.types list to
find the matching MIME type.
- See Also:
AVENTX_SECONDARYATTACHMENTFILE3,
AVENTX_SECONDARYATTACHMENTNAME3,
Constant Field Values
AVENTX_SECONDARYATTACHMENTNAME3
public static final java.lang.String AVENTX_SECONDARYATTACHMENTNAME3
- The SECONDARYATTACHMENTNAME is the name to be used for the attachment for email delivery only.
An example of this would be: Terms_and_Conditions.pdf
This value may be any string up to 255 characters and all spaces will be
replaced with underscores.
If attachmentname is left blank, the attachment will be given
the same name as filename.
- See Also:
AVENTX_SECONDARYATTACHMENTFILE3,
AVENTX_SECONDARYATTACHMENTLANG3,
Constant Field Values
AVENTX_SECONDARYATTACHMENTFILE4
public static final java.lang.String AVENTX_SECONDARYATTACHMENTFILE4
- The SECONDARYATTACHMENTFILE is a file to be delivered along with the fax or email. Perhaps a
company would like terms and conditions delivered with the primary document.
This value may be a string of up to 255 characters in length containing the fully
qualified pathname of the file to be attached. Environment variables (such as $FCHOME,
for example) may be included in the filename. Use this property in conjunction with
with AVENTX_SECONDARYATTACHMENTLANG4 and AVENTX_SECONDARYATTACHMENTNAME4.
- See Also:
AVENTX_SECONDARYATTACHMENTLANG4,
AVENTX_SECONDARYATTACHMENTNAME4,
Constant Field Values
AVENTX_SECONDARYATTACHMENTLANG4
public static final java.lang.String AVENTX_SECONDARYATTACHMENTLANG4
- The SECONDARYATTACHMENTLANG is the language of the SECONDARYATTACHMENTFILE that is specified.
This value tells the Delivery Server how to translate the document. Acceptable values
can be the actual MIME type (e.g. application/pdf) or a mapped abbreviation (e.g. pdf). All known
supported languages are defined in the $FCHOME/cfg/mime.types file.
If this value is not specified for an attachment, the file extension for SECONDARYATTACHMENTNAME (or
SECONDARYATTACHMENTFILE if SECONDARYATTACHMENTNAME is blank) will be used to determine
the appropriate MIME type. This extension will be compared to the $FCHOME/cfg/mime.types list to
find the matching MIME type.
- See Also:
AVENTX_SECONDARYATTACHMENTFILE4,
AVENTX_SECONDARYATTACHMENTNAME4,
Constant Field Values
AVENTX_SECONDARYATTACHMENTNAME4
public static final java.lang.String AVENTX_SECONDARYATTACHMENTNAME4
- The SECONDARYATTACHMENTNAME is the name to be used for the attachment for email delivery only.
An example of this would be: Terms_and_Conditions.pdf
This value may be any string up to 255 characters and all spaces will be
replaced with underscores.
If attachmentname is left blank, the attachment will be given
the same name as filename.
- See Also:
AVENTX_SECONDARYATTACHMENTFILE4,
AVENTX_SECONDARYATTACHMENTLANG4,
Constant Field Values
AVENTX_SECONDARYATTACHMENTFILE5
public static final java.lang.String AVENTX_SECONDARYATTACHMENTFILE5
- The SECONDARYATTACHMENTFILE is a file to be delivered along with the fax or email. Perhaps a
company would like terms and conditions delivered with the primary document.
This value may be a string of up to 255 characters in length containing the fully
qualified pathname of the file to be attached. Environment variables (such as $FCHOME,
for example) may be included in the filename. Use this property in conjunction with
with AVENTX_SECONDARYATTACHMENTLANG5 and AVENTX_SECONDARYATTACHMENTNAME5.
- See Also:
AVENTX_SECONDARYATTACHMENTLANG5,
AVENTX_SECONDARYATTACHMENTNAME5,
Constant Field Values
AVENTX_SECONDARYATTACHMENTLANG5
public static final java.lang.String AVENTX_SECONDARYATTACHMENTLANG5
- The SECONDARYATTACHMENTLANG is the language of the SECONDARYATTACHMENTFILE that is specified.
This value tells the Delivery Server how to translate the document. Acceptable values
can be the actual MIME type (e.g. application/pdf) or a mapped abbreviation (e.g. pdf). All known
supported languages are defined in the $FCHOME/cfg/mime.types file.
If this value is not specified for an attachment, the file extension for SECONDARYATTACHMENTNAME (or
SECONDARYATTACHMENTFILE if SECONDARYATTACHMENTNAME is blank) will be used to determine
the appropriate MIME type. This extension will be compared to the $FCHOME/cfg/mime.types list to
find the matching MIME type.
- See Also:
AVENTX_SECONDARYATTACHMENTFILE5,
AVENTX_SECONDARYATTACHMENTNAME5,
Constant Field Values
AVENTX_SECONDARYATTACHMENTNAME5
public static final java.lang.String AVENTX_SECONDARYATTACHMENTNAME5
- The SECONDARYATTACHMENTNAME is the name to be used for the attachment for email delivery only.
An example of this would be: Terms_and_Conditions.pdf
This value may be any string up to 255 characters and all spaces will be
replaced with underscores.
If attachmentname is left blank, the attachment will be given
the same name as filename.
- See Also:
AVENTX_SECONDARYATTACHMENTFILE5,
AVENTX_SECONDARYATTACHMENTLANG5,
Constant Field Values
AVENTX_CONFIRMEMAIL1
public static final java.lang.String AVENTX_CONFIRMEMAIL1
- You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property.
The email address can be any string up to 255 characters.
- See Also:
AVENTX_CONFIRMLEVEL1,
Constant Field Values
AVENTX_CONFIRMLEVEL1
public static final java.lang.String AVENTX_CONFIRMLEVEL1
- You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. This property defines WHEN the confirmation will be sent.
This value may be All, Success, Failure, or None. Default value is that specified in the
AventX UNIX global configuration for ConfirmationLevel.
If this value is set, but no corresponding AVENTX_CONFIRMEMAIL, a confirmation will NOT be
sent.
If this value is not in the range of acceptable values, it will be ignored.
- See Also:
AVENTX_CONFIRMEMAIL1,
Constant Field Values
AVENTX_CONFIRMEMAIL2
public static final java.lang.String AVENTX_CONFIRMEMAIL2
- You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property.
The email address can be any string up to 255 characters.
- See Also:
AVENTX_CONFIRMLEVEL2,
Constant Field Values
AVENTX_CONFIRMLEVEL2
public static final java.lang.String AVENTX_CONFIRMLEVEL2
- You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. This property defines WHEN the confirmation will be sent.
This value may be All, Success, Failure, or None. Default value is that specified in the
AventX UNIX global configuration for ConfirmationLevel.
If this value is set, but no corresponding AVENTX_CONFIRMEMAIL, a confirmation will NOT be
sent.
If this value is not in the range of acceptable values, it will be ignored.
- See Also:
AVENTX_CONFIRMEMAIL2,
Constant Field Values
AVENTX_CONFIRMEMAIL3
public static final java.lang.String AVENTX_CONFIRMEMAIL3
- You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property.
The email address can be any string up to 255 characters.
- See Also:
AVENTX_CONFIRMLEVEL3,
Constant Field Values
AVENTX_CONFIRMLEVEL3
public static final java.lang.String AVENTX_CONFIRMLEVEL3
- You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. This property defines WHEN the confirmation will be sent.
This value may be All, Success, Failure, or None. Default value is that specified in the
AventX UNIX global configuration for ConfirmationLevel.
If this value is set, but no corresponding AVENTX_CONFIRMEMAIL, a confirmation will NOT be
sent.
If this value is not in the range of acceptable values, it will be ignored.
- See Also:
AVENTX_CONFIRMEMAIL3,
Constant Field Values
AVENTX_CONFIRMEMAIL4
public static final java.lang.String AVENTX_CONFIRMEMAIL4
- You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property.
The email address can be any string up to 255 characters.
- See Also:
AVENTX_CONFIRMLEVEL4,
Constant Field Values
AVENTX_CONFIRMLEVEL4
public static final java.lang.String AVENTX_CONFIRMLEVEL4
- You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. This property defines WHEN the confirmation will be sent.
This value may be All, Success, Failure, or None. Default value is that specified in the
AventX UNIX global configuration for ConfirmationLevel.
If this value is set, but no corresponding AVENTX_CONFIRMEMAIL, a confirmation will NOT be
sent.
If this value is not in the range of acceptable values, it will be ignored.
- See Also:
AVENTX_CONFIRMEMAIL4,
Constant Field Values
AVENTX_CONFIRMEMAIL5
public static final java.lang.String AVENTX_CONFIRMEMAIL5
- You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property.
The email address can be any string up to 255 characters.
- See Also:
AVENTX_CONFIRMLEVEL5,
Constant Field Values
AVENTX_CONFIRMLEVEL5
public static final java.lang.String AVENTX_CONFIRMLEVEL5
- You may request a confirmation of document delivery sent to an email address using the
AVENTX_CONFIRMEMAIL property. This property defines WHEN the confirmation will be sent.
This value may be All, Success, Failure, or None. Default value is that specified in the
AventX UNIX global configuration for ConfirmationLevel.
If this value is set, but no corresponding AVENTX_CONFIRMEMAIL, a confirmation will NOT be
sent.
If this value is not in the range of acceptable values, it will be ignored.
- See Also:
AVENTX_CONFIRMEMAIL5,
Constant Field Values
AVENTX_OUTPUTDIR
public static final java.lang.String AVENTX_OUTPUTDIR
- You may specify where the AventX UNIX command and data files are written on the file system.
By default, the files will be written to /tmp. Use this property to change that location.
This is a REQUIRED property.
Valid values are any valid system path.
- See Also:
- Constant Field Values