Chapter 2. Communication

Table of Contents

1. Mail Attributes
1.1. Document.canResponse
1.2. Document.mail.header
1.3. Document.responseID
1.4. Document.responseTo
1.5. Document.responseFrom
2. Action Objects
2.1. Display URL
2.2. New Scan Job
2.3. Display Message Box
2.4. Clean Cache
2.5. Update Tahiti

Tahiti is using communication protocol DEP2. There is description of attributes and objects send over this protocol. Specification of DEP2 is available as a separate document.

1. Mail Attributes

Tahiti can be used as a mail reader and also can be used to write answer on such email. There is description of attributes used to direct Tahiti behaviour.

1.1. Document.canResponse

Attribute Document.canResponse is voluntary. Possible values: 0|1.

If this attribute is set and value is 1 user is allowed to write response on given document/mail. If this attribute is not set or value is 0 user cannot response such email.

Response on email or new email has mime/type Tahiti.ComposeMail.

1.2. Document.mail.header

Header of the mail based on which the document was created. If this attribute is present Tahiti assumes that document is based on mail. Header has same format as the mail (rfc822) and contains only body of the email (no attachments) and should be limited on some reasonable size e.g.16kb. If this attribute is not present and first page of the document is email Tahiti will treat such document as an email and will use information from the header of such email.

1.3. Document.responseID

Attribute Document.responseID is voluntary. Attribute is id of the original document on which is current document respons. This attribute is send by Tahiti to the server when user responding to the email.

1.4. Document.responseTo

Attribute Document.responseTo is voluntary. Attribute can be used only when Document.canResponse=1. Attribute contains target address/addresses to be used when user respons to the email. If this attribute is not set address from the email header will be used.

1.5. Document.responseFrom

Attribute Document.responseFrom is voluntary. If this attribute is present it contains address to be used as a sender of the email in response. If this attribute is not present Tahiti will set sender to the receiver of the original mail (from the Document.mail.header or from the original email).

2. Action Objects

There is list of objects which can be send over protocol DEP2 using method pushObject. Such objects can be send to the Tahiti or from Tahiti to the server. Support for other objects can be easily added using XPCOM API.

2.1. Display URL

Type: Tahiti.System.DisplayURL

Dispatch URL from the Document Management System to the Tahiti. It will call system handler for this URL and display it.

Table 2.1. Attributes of Tahiti.System.DisplayURL

AttributeDescription

URL

URL which will be opened


2.2. New Scan Job

Type: Tahiti.DistrIdent.DocSet.Open

Notification about new scan job. Tahiti should download list of objects for identification from the server.

Table 2.2. Attributes of Tahiti.DistrIdent.DocSet.Open

AttributeDescription

ServerName

name of the server (defined in Damis.xml)

DocSetId

id of document set

AllowReinsert

value 0|1, allow to re-insert documents to the DAMIS Server (check Damis documentation for more information).


2.3. Display Message Box

Type: Tahiti.System.Message

Display message box to the user. System can notify user about some state changes etc. This message box can be only confirmed by user (button OK).

Table 2.3. Attributes of Tahiti.System.Message

AttributeDescription

Type

Type of the message:

  • 0 - information

  • 1 - warning

  • 2 - error

Text

Displayed text

Description

Detail description (technical information)


2.4. Clean Cache

Type: Tahiti.System.CleanCache

Object clean cache in running Tahiti. All pages in the cache are invalidated.

2.5. Update Tahiti

Type: Tahiti.Update.Start

Start update. This object force Tahiti to check if there is newer version. It is possible to specify file to be used for update configuration.

Table 2.4. Attributes of Tahiti.Update.Start

AttributeDescription

UpdateFile

File to be used for update. If this attribute is empty default file will be used.