Document tab Syntax Buttons

The Document tab syntax buttons indicate all the ways you can add a Document object to an expression. Clicking on one of the buttons adds the indicated syntax (minus the question marks) to your expression. In the spaces left by the question marks, enter the appropriate values. For operations you can perform on documents, see Operators Used with Prompts and Documents.

http://java.sun.com/j2se/1.4.2/docs/api/java/net/URL.html

Document Syntax Button Descriptions

Syntax Button

Document Type or Operation

Description

DOC[?]

user-defined literal

A user-defined document in the document repository. See Usesr Document Literals.

For example: 
DOC[AA\schedule.doc]
DOC[rootTemplateDir + "templateA.txt"]

DOC[?,?]

A user-defined document in the document repository with associated contact (additional arguments, more then one is allowed). The additional argument(s) is passed into the document template (if one or more are referenced) as initial arguments for evaluation by the document template. See User Document Literals.

For example: 
DOC["vxml\application1.vxml", mainCall]

URL[?]

URL document literal

See URL Document Literals.

For example: 
URL[http://www.cisco.com/index.html]
URL[http://evbuweb/mydoc.asp?number=23]

URL[?,?]

A URL document with output document and time out. See User Document Literals.

For example: 
URL[http://www.cisco.com/index.html,2000L]

The first operand is the URL as in the preceding example and the second operand is either an output document to be sent to the referenced URL as a post or a time out. The time out is used only in the case of HTTP URLs as defined in the CreateURLDoc step and is in milliseconds.

URL[?,?,?]

A URL document with output document and time out. See User Document Literals.

For example: 
URL[http://www.cisco.com/index.html, MyDoc, 2000L]

The first operand is the URL, the second is the output document to be sent to the referenced URL, and the third operand is the time out. The time out is used only in the case of HTTP URLs as defined in the CreateURLDoc step and is in milliseconds.

FILE[?]

file document literal

See File Document Literals.

For example: 
FILE[C:\Documents\mydoc.txt]

TEXT[?]

text document literal

See Text Document Literals.

For example: 
TEXT[Some text to be stored in a document]

BIN[?]

binary document literal

See Binary Document Literal.

For example: 
BIN[cafebabe34f3edca56b8001cdef]
BIN[myArrayOfBytes]

? + ?

Concatenation operation

Concatenates characters, strings, or documents. See Additive Operators, and Document Concatenation Operator +.

For example: 
DOC[rootTemplateDir + "templateA.txt"]

? || ?

document escalation operation

The document escalation operator enables you to add document options to an expression depending on the time of the week, the day of the week, and the time of day.

See Escalation Operator ||. See also Time of Week Document, Day of Week Document, or Time of Day Document.

For example: 
DOC[D1.txt] @ MON @ T[10:59 AM]
|| DOC[D2.txt] @ TUE @ T[11:58 PM]
|| DOC[] @ MON @ T[1:00 PM]

? @ ?

document qualification operation

The document qualification operator @ qualifies how a document is to be run. This operator expects a qualifying expression of the following type:
  • Language. Represents a language qualification and is used to temporary override the language associated with a given document. The expression must be of type Language. Qualifying a document more then once with a language results in only the last one to be kept as the overridden language for the document.
  • DayOfWeekLiteral. Represents a day of week qualification and is used to specify the starting day of a possible range when the document is to be used in a day of week document or time of week document expression. For example, the expression “DOC[D1.txt] @ MON” specifies that document D1.txt can be accessed on Monday:
  • Number. Represents the starting day of the week where its value must evaluate to 1 for Sunday, 2 for Monday, and so on to 7 for Saturday.
  • Time. Represents time qualification and is used to specify the starting time of a possible range when the document is to be used in a time of day document or time of week expression. For example, the expression “DOC[D1.txt] @ MON @ T[10:59 AM]” specifies that document D1.txt can be accessed on Monday from 10.59 AM:

See also Time of Week, Day of Week, and Time of Day Documents.

(String)?

cast conversion

Converts the specified document to a string. See Document Conversions.