Defining Notification Message and Fax Header Text

 back  top  next

header

The Facsys server uses an embedded command syntax to create the notification messages and outbound fax headers defined for the fax server.

 

For a list and description of the valid tokens, refer to the table below. To prevent misinterpretation of any command, all tokens must be surrounded with the tilde (~) character. The simplest form of any token is as follows:

 

Example:   Fax was sent to ~n~ successfully!

Result:        Fax was sent to jeff smith successfully!

 

NOTES:

  • Notification messages and outbound fax header strings can be defined on the Options and Notifications tabs of the server's Properties

    •  

    Optional formatting is supported in addition to the embedded syntax. To produce a fixed output length, use the colon character ":".

     

    As illustrated in Example1 below, a colon followed by a number will cause any alpha-type output to be left-aligned in a fixed field length as defined by the number used. The name "Tom Smith" is left-aligned in a 20-character field. (You may have to enlarge the size of your Help window to see the alignment.)

    Example1:    Fax was sent to ~n:20~ successfully!

    Output1:        Fax was sent to Tom Smith          successfully!

     

    Example2 shows that omitting the optional formatting will cause numeric-type output to be left-aligned.

    Example2:    Pages transmitted: ~p~

    Output2:        Pages transmitted: 3

     

    In Example3, a colon followed by a number causes the numeric-type output to be right-aligned in the fixed field length (compare this with Example1 above).

    Example3:    Pages transmitted: ~p:10~

    Output3:        Pages transmitted:          3

     

    In Example4, a colon followed by a number that is preceded by a zero causes the numeric-type output to be right-aligned in a zero-filled fixed field length.

    Example4:    Pages transmitted: ~p:03~

    Output4:        Pages transmitted: 003

     

     

    The table below lists the valid command tokens and describes how they affect your messages and header contents.

     

    The Use column indicates where you can use the tokens: S=send notifications; R=receive notifications; and TTI=fax header message.

    The Type column indicates the type of output generated: a=alpha; or n=numeric.

     

    Token

    Description

    Use

    Type

    b or B

    Inserts a new line or double-line within a notification message. Uppercase is also supported.

    S, R

    a

    c

    CSI of the sending fax device. For receive events, this is the CSI for the originating fax machine.

    S, R, TTI

    a

    d

    Date formatted as DD/MM/YY or MM/DD/YY, depending on the format defined for the fax server (Properties/Options tab).

    TTI

    a

    e or E

    ASCII result/error message listed below. Uppercase is also supported.

    S, R

    a

    f

    Actual fax number dialed.

    S, TTI

    a

    h

    Hardware device number. Devices are numbered as 1, 2, 3…        

    S, R

    n

    i

    Transaction ID

    S,R

    a,n

    I or L

    Long fax name in the form of 'name @ fax number'. Uppercase is also supported.

    S, TTI

    a

    n or N

    Name of destination in the form of 'First Last' or company name. Uppercase is also supported.

    S, TTI

    a

    o

    Off-hook time (connect time) in the form of MM:SS or HH:MM:SS.  The HH will only show if there are 'hours' present.

    S, R

    a

    o

    Company Name

    TTI

    a

    p

    Total pages in file, including the cover page.

    S, R, TTI

    n

    r

    Number of re-dial attempts.

    S

    n

    s

    Sender name

    S, TTI

    a

    t

    Time formatted as 12 Hour or 24 Hour, depending on the format defined for the fax server (Properties/Options tab). 

    TTI

    a

    #

    Current page number.

    TTI

    n

     

    The ASCII error messages that can be displayed with the ~e~ token include:

    • Canceled by user

    • Local device error

    • Error unknown

    • No authorized to send fax

    • Incompatible fax system

    • No fax at destination

    • Internal file error

    • OK

    • Line busy or no answer

    • Remote fax error

    • Telephone line error

     

     

     

    Solgenia footer