9.1 About Content Publisher Services

A typical Content Publisher service entry is similar to the following:

GET_FILE
FileService 3 null null null !csUnableToDownloadFile
3:computeDocID::0:!csUnableToDownload(dDocName)
5:QdocInfo:FILE_DOC_INFO:2:!csItemNoLongerInSystem
3:checkSecurity:FILE_DOC_INFO:0:!csUnableToDownload(dDocName)
3:createFileName:FILE_DOC_INFO:0:null</td><ADD EXAMPLE

  • The first line indicates the service name: GET_FILE

  • The second line lists the service's attributes:

    • Service class: FileService

    • Access level: 3

    • Template: null (none used)

    • Service type: null (not a subservice)

    • Subjects Notified: null

    • 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, 3, indicating a Java method.

    • action name: for example, checkSecurity

    • action parameters: for example, FILE_DOC_INFO. 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: for example, Unable to Download (dDocName), or null if no message is available.

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

Important:

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.