7.1 About Archiving Services

A typical service entry is similar to the following:

GET_ARCHIVED_FILE
FileService 34 null null null !csUnableToDownloadFile
3:computeDocID::0:!csUnableToDownload(dDocName)
5:QarchivedDoc:FILE_DOC_INFO:2:!csItemNoLongerInHistory
3:checkSecurity:FILE_DOC_INFO:0:!csUnableToDownload(dDocName)
3:createArchiveFileName::0:null

In this example:

• the first line indicates the service name: GET_ARCHIVED_FILE.

• The second line lists the service's attributes:

  • Service class: FileService. When using the Archiver, this is frequently ArchiveService.

  • Access level: 34, indicating this is Scriptable and Writeable.

  • Template: null

  • Service type: null

  • Subjects Notified: null

  • Error message and parameter used for error message: Unable to Download File

• The remainder of the entry lists the service's actions, each line designating one action:

  • action type: for example, 5, indicating a Select Cache Query, which specifies a query to retrieve information from the database and store it for later use. This example also shows a type of 3, indicating a Java method.

  • action name: for example, QarchivedDoc or computeDocID

  • action parameters: for example, FILE_DOC_INFO. If no parameters are specified, double colons (::) are included.

  • action control mask: for example, 0, indicating 'Ignore error' or 2, indicating 'Must exist (at least one record must be returned by the query). If no control mask is specified, double colons (::) or 0 are included.

  • action error message, such as Item No Longer In History, or null if no message is available.

Each element of the service's action is separated by a colon (:).

See "Customizing Services" for details about a service's attributes and actions.