► Fax method
4.6 Appli/Com mode (OfficeMaster)
The OfficeMaster Messaging Server File Gateway in the Appli/Com (OfficeMaster) mode is based on the Appli/COM interface described in the ITU's T.611 standard.
This File Gateway mode has been designed with separate target directo-ries for message documents, meta information and acknowledgements, making it extremely flexible and adaptable.
Figure 4.11: Appli/Com mode (OfficeMaster)
►
JobsIn the Job directory, send jobs are transferred to the Messaging Server.
Send jobs consist of text files that contain only the send attributes. A file with the file extension .job is stored in the Job directory for each job.
After the Messaging Server has read and evaluated this file, it removes it from the Job directory.
►
AcknowledgementThe Messaging Server writes receipt jobs and completed send jobs to the Ack directory. The job files stored in the Ack directory have the same file extension .job as the job files in the Job directory.
The document files that belong to the send jobs are deleted by the Mes-saging Server. Their names are deleted from the job files before these files are copied to the Ack directory. The document files associated with the receipt jobs are located in the In directory.
►
Out directoryThe Out directory is where the documents you want to send must be stored before their associated job files are moved to the job directory.
►
In directoryThe In directory is where the Messaging Server stores received docu-ments before it moves their associated job files to the Ack directory. You can modify this in greater detail in the input folders ... sub-menu.
►
Err directoryThe Err directory is where the job files that could not be read due to syntactical errors are stored.
►
Specify input folders ...System settingsYou can create specific rules for modifying the input folder. Initially, this is created without any entries.
Figure 4.12: Overview of input rules without any entries
Click Add to open a dialog where you can create a new, modified rule.
Figure 4.13: Creating a new receipt rule
►
Display nameYou can select any name to be displayed here, however it is a good idea to use one that reflects the contents of the file. The name is used for the overview in Figure 4.12 .
►
Base directoryYou can select a separate base directory for each input rule. The subdi-rectories described below are all based on this base directory.
►
FormatThe central converter makes the format specify here available to all the messages that match this set of rules.
►
AddThis adds individual rules to the set of rules.
Figure 4.14: Add a rule for DID numbers with 3xx to the set of rules
►
FilterIn this field you specify which messages are to be covered by this rule.
Use regular expressions to restrict the selection of messages. Click the button next to the input field to display a list of possible commands.
►
Job propertyHere you specify which job property the filter should apply to. Normally this is the recipient address. For example, you can call the mostly fre-quently used properties by clicking the button behind the input fields.
►
Basisverzeichnis erweitern umHere you specify the name of the additional subdirectory created for this rule. For example, the dynamic entry @@JobParamValue@@, is used to generate a sub-folder with the DID number for each destination number that matches this rule. The corresponding jobs send to this DID number are then stored there.
Job formats
Send and receipt jobs are text files that use the ASCII character set. The individual lines consist of a parameter name, a blank space (optional), a colon, a blank space (optional) and the parameter value. Comments start with a semicolon and can stand either at the beginning of a line or after a parameter value.
Send jobs
Send jobs contain the parameters described in the table below. You can add any number of other parameters to the jobs, as long as their names do not conflict with the parameters designed to be used for completed send jobs. Fields that are not required are not written to the job file.
Parameter
name Description Values
FUNCTION Defines the type of the job SENDACK
REQID The unique job ID Any
USERINFO User name: is used for display in the Messaging
Server Any
SERVICE Communications service FAX/SMS/SMTP
ADDRESS Telephone number of the recipient
FILELIST Description of the document that is to be sent:
consists of two, comma-separated parts.
Part 1: Format of the document file: {see follow-ing table
Part 2: Name of the document file without its path this can be repeated to describe jobs that contain more than one document files; it is missing, if the POLL parameter has the value YES
POLL Specifies if an on demand job is involved YES, NO
USEBPS Required transfer speed
2400, 4800, 7200, 9600, 12000, 14400, MAX
DISABLEECM Switch off ECM YES, NO
USEDPI Required resolution 100, 200
USET4MODE Required coding MH MR MMR
HEADER Header row
USECSID Sender CSID
Parameter
name Description Values
SENDER Sender address for SMTP
SUBJECT Subject line for SMTP
DSCOMPO-NENT Name of a Messaging Server component for the
digital signature e.g. signds0
SENDTIME Specifies the start and end of a time period duri-ng which the job is to be sent, format YYYY-MM-DD hh:mm:ss/YYYY-MM-YYYY-MM-DD hh:mm:ss
2004-06-02 22:00:00/2004-07-02 06:00:00
PRIORITY Priority, recommended values:
100: Bulk mailing{200: Low priority{300: Normal priority{400: High priority
100 … 400
KEEPFILES Optional parameter in Applicom mode (Office-Master): prevents documents that are to be sent
from being removed from the Out directory YES, NO OAD Optional: complete sender OAD
OADEXT Optional: DID number that is attached to a Base-OAD configured on the D channel
MAXPARTS Optional: specifies how many parts an SMS can be split into
NOTIFY-ADDRESS
E-mail address of the MAILGW user who is to be informed of the send status (only in Applicom mode (OfficeMaster))
NOTIFYNAME Name of the MAILGW user who is to be informed about the send status (only in Applicom mode (OfficeMaster)
COVERNAME Name of a cover sheet file in the Messaging Ser-ver coSer-ver sheet directory (only in Applicom mode (OfficeMaster))
COVERPAR
Placeholder definition for the cover sheet, with the format <name>=<value>. The COVERPAR parameter can occur more than once, to define multiple placeholder values (only in Applicom mode (OfficeMaster))
Table 4.3: Parameter of a send job in Applicom mode (OfficeMaster)
Descriptor Descriptions Supported services
Fax SMS SMTP
TXTUTF8 Text with UTF8 encoding X X X
TXTLATIN1 Text with ISO Latin 1 (Western Europe) or Win-dows Code Page 1252 (Western Europe)
enco-ding X X X
TXTLATIN2 Text with ISO Latin 2 (Eastern Europe) encoding X X X TXT-WIN1250 Text with Windows Code Page 1250 (Central
Europe) encoding X X X
BFF B/W graphic for fax transmission X X
BMP Microsoft bitmap format X
DCX_ANY DCX graphics file X
DCX_FAX DCX graphics file for fax transmission: b/w, 1728
pixels wide X X
DOC Microsoft Word (required for conversion, only
available under Windows) * X
FFF B/W graphic for fax transmission X X
GIF Graphic format for the WWW X
HTML WWW X
JPG Compressed graphic X
PCL HP printer language{(only available under
Win-dows) * X
PCX One-page b/w graphics file X X
PDF Adobe PDF (Acrobat Reader or Ghostscript
re-quired for conversion) * X
PNG Graphic format for the WWW X
PPT Microsoft PowerPoint X
PS Postscript printer language {(GhostScript required
for conversion) * X
Descriptor Descriptions Supported services
Fax SMS SMTP
RTF Microsoft Rich Text (MS Word is required for
con-version, only available under Windows) * X
SFF B/W graphic for fax transmission X X
TIF_MH B/W TIF file with Modified Huffman compression X X TIF_G3 B/W TIF file with compression (FAX Group 3) X X TIF_G4 B/W TIF file with compression (FAX Group 4) X X
TIF_UNCMP B/W TIF file without compression X X
XLS Microsoft Excel (is required for conversion, only
available under Windows) * X
ZIP X
Table 4.4: File formats in Applicom mode (OfficeMaster)
■
ExampleFUNCTION :SENDACK REQID :123
USERINFO :Joan Smith SERVICE :FAX
ADDRESS :03328455960
FILELIST :BFF,000000001.bff POLL :NO
USEBPS :MAX DISABLEECM :NO USEDPI :200 USET4MODE :MMR HEADER :ferrariFAX
USECSID :+49(3328)455-960
Figure 4.15: Send job in Applicom mode (OfficeMaster)
Completed send jobs
In addition to their original parameters, completed send jobs include a number of other entries that are described in the following table. The FI-LELIST parameter that is present in the original send job (apart from fax on demand) is also deleted by the Messaging Server in the same way as the files it specifies. In fax on demand jobs, the FILELIST parameter is set by the Messaging Server. In this case OfficeMaster must delete the file specified by this parameter.
Parameter name Description Values
BPSUSED Transfer speed used 2400, 4800,
7200, 9600, 12000, 14400
ECMUSED Use of ECM YES, NO
DPIUSED Resolution used 100, 200
T4MODEUSED Coding used MH MR MMR
REMOTECSID Recipient CSID
FILELIST
Description of the document received via a fax on demand transmission. Consists of two, comma-separated parts:
Part 1: Format of the document file: BFF; in Appli-com mode (OfficeMaster) also TIF
Part 2: Name of the document file without its path
STATUS Two numbers, separated by a backslash, which identify the general status and a status-specific error code
STATTXT An error text to suit the Status field
TRANSMISSI-ONTIME Transmission time in YYYY-MM-DD hh:mm:ss format
DURATION Duration of the transmission in seconds (for fax)
PAGESTRANS-FERRED Number of transferred pages (for fax)
Table 4.5: Additional parameters for completed send jobs in Applicom mode (OfficeMa-ster)
■
ExampleFUNCTION :SENDACK
REQID :123
USERINFO :Joan Smith
SERVICE :FAX
ADDRESS :03328455960
FILELIST :BFF,000000001.bff
POLL :NO
USEBPS :MAX
DISABLEECM :NO
USEDPI :200
USET4MODE :MMR
HEADER :ferrariFAX
USECSID :+49(3328)455-960
BPSUSED :14400
ECMUSED :YES
DPIUSED :200
T4MODEUSED :MMR
REMOTECSID :+49(3328)455-960
STATUS :0/0
STATTXT :NO ERROR
TRANSMISSIONTIME :2004-10-29 09:31:51
DURATION :29
PAGESTRANSFERRED :1
Figure 4.16: Send job completed in Applicom mode (OfficeMaster)
4.7 Webservices (FFWEBSVC)
Ferrari Electronic's OfficeMaster WebServices are additional compon-ents for the OfficeMaster Messaging Server which enable you to create, among other things, your own applications for sending and receiving faxes and SMS. They allow you to use any programming environment and programming language that support the standard XML, SOAP and WSDL protocols. .NET based Windows and web applications are the most commonly used webservice consumers, whereas Microsoft Internet Information Server is the most popular environment for running a web-service and its associated web applications. OfficeMaster WebServices have all successfully completed the Microsoft .NET Connected Logo Program and are therefore permitted to carry the .NET Connected Logo.
For more details about the prerequisites, installation/configuration steps, and to see sample applications, please refer to the OfficeMaster Web-Services White Paper on the Ferrari electronic web site:
www.officemaster.de.