5.1 About Core Content Server Services

The most commonly used services have more extensive descriptions.

A typical service entry is similar to the following:

REMOVE_METAFILE_SUB
DocService 0 null SubService null !csDocumentNotDeleted(dDocName)
3:deleteRevFiles::0:!csUpdateFileDeleteFailed(dDocName)
2:Ddocument::0:null

In this example:

• The first line indicates the service name: REMOVE_METAFILE_SUB

• The second line lists the service's attributes:

  • Service class: DocService

  • Access level: 0

  • Template: null (none used)

  • Service type: SubService

  • Subjects Notified: null

  • Error message: Document Not Deleted

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

  • action type: for example, 3, indicating a Java method.

  • action name: for example, deleteRevFiles

  • action parameters: if no parameters are specified, double-colons (::) are included.

  • action control mask: for example, 0, indicating no control mask. The double-colon indicator (::) can also be included.

  • action error message, or null if no message is available.

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

Caution: All services have at least one required parameter. The IdcService parameter takes the name of the service as its argument. If other parameters are required, they are noted in the description of the service.

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