10.1 About Record Manager Services

A typical service call is similar to the following:

LIST_DISPOSITION_RECORDS
Service 33 PENDING_REVIEW_LIST null null !csUnableToGetRecordsList
3:hasRmaRights:admin.performactions:0:null 
3:checkRecordsFoldersMap::0:null 
3:setLocalValuesAfterEval:dRequestedUser,<$dUser$>::null 
3:setLocalValues:IsNavigation,1::null

In this example:

• The first line indicates the service name: LIST_DISPOSITION_RECORDS

• The second line lists the service's attributes:

  • Service class: service (generic service)

  • Access level: 33

  • Template: PENDING_REVIEW_LIST

  • Service type: null

  • Subjects Notified: null

  • Error message: Unable to get records list

• 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, hasRmaRights

  • action parameters: for example, dRequestUser. If no parameters are specified, :: are included.

  • action control mask: for example, 1, indicating "Ignore error". If no control mask is specified, :: is included.

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

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

All services have at least one required parameter. The IdcService parameter takes the name of the service as its argument. If any 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.