Oracle® Fusion Middleware Services Reference Guide for Oracle Universal Content Management 11g Release 1 (11.1.1) E11011-03 |
|
![]() Previous |
![]() Next |
The following sections describe the available Oracle Universal Records Management (Oracle URM) 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 a service 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.
For details about a service's attributes and actions, see Section 3, "Customizing Services."
The following services are used in Oracle Universal Records Management (Oracle URM) functions:
This service is used to set an Activate disposition action date.
Additional Required Service Parameters
dDispositionID: The unique identifier of the disposition action to be processed.
This service is used to an Approve Delete disposition action date.
Additional Required Service Parameters
dDispositionID: The unique identifier of the disposition action to be processed.
This service is used to retrieve a page used to browse the contents of a retention category in the retention schedule.
Additional Required Service Parameters
dCategoryID: The unique identifier of the retention category to be retrieved.
This service is used to retrieve a page used to browse the contents of a record folder in the retention schedule.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be retrieved.
This service is used to retrieve a page used to browse the contents of a series in the retention schedule.
Additional Required Service Parameters
dSeriesID: The unique identifier of the series to be retrieved.
This service is used to check in the latest revision of a content item as a new revision. This is usually used to trigger a workflow.
This service is used to retrieve the Check In Similar page. This is a check-in page with metadata fields already filled in based on the previous content item checked in.
Additional Required Service Parameters
dID: The unique content ID for the item already checked in.
This service is used to clear the date for a canceled record folder.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
This service is used to clear the expiration date for a canceled record folder.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
This service is used to clear the date at which a record folder becomes obsolete.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
This service is used to clear the date at which a record folder is rescinded.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
This service is used to clear the date at which a record folder was last reviewed.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
This service is used to clear the date at which a content item was canceled.
Additional Required Service Parameters
dID: The unique identifier of the content to be processed.
This service is used to clear the date at which an item was expired.
Additional Required Service Parameters
dID: The unique identifier of the item to be processed.
This service is used to clear the date at which an item becomes obsolete.
Additional Required Service Parameters
dID: The unique identifier of the item to be processed.
This service is used to close an existing record folder in the retention schedule. No further content items can be checked into the closed record folder or its subfolders unless the user has the Folder.Open/Close right or is the author of the closed folder.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
This service is used to create a new record folder in the retention schedule. This service is usually called from the CREATE_FOLDER_FORM page.
Additional Required Service Parameters
dFolderID: A unique identifier of the new record folder.
dFolderName: A name for the new record folder.
dSecurityGroup: The security group to be associated with the new record folder.
dDocAuthor: The person creating the new record folder.
dCategoryID: The unique identifier of the retention category to be associated with the record folder.
This service is used to call CREATE_FOLDER to create a new record folder in the retention schedule.
This service is used to process a Delete All But Last N Revisions disposition action. The administrator sets n, which is a variable.
Additional Required Service Parameters
dDispositionID: The unique identifier of the disposition action to be processed.
This service is used to delete an existing record folder from the retention schedule.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
This service is used to delete the latest revision of a content item.
Additional Required Service Parameters
dDispositionID: The unique identifier of the disposition action to be processed.
This service is called by EDIT_FOLDER_FORM to update the (modified) properties of an existing record folder in the retention schedule.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be edited.
dFolderName: The name of the record folder to be edited.
dSecurityGroup: The security group associated with the record folder.
dDocAuthor: The owner of the record folder.
This service is used to call EDIT_FOLDER to edit a folder in the retention schedule.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be edited.
This service is used to freeze an existing record folder in the retention schedule. Freezing a folder pauses any processing of disposition rules associated with the folder until the UNFREEZE_FOLDER service is called.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be frozen.
dCategoryID: The unique identifier of the retention category associated with the record folder.
auditComments: The freeze name.
auditComments2: The freeze reason.
This service is used to freeze an existing content item. Freezing a content item pauses any processing of disposition rules associated with the content item until the UNFREEZE_RECORD service is called.
Additional Required Service Parameters
dID: The content ID of the content item to be frozen.
auditComments: The freeze name.
auditComments2: The freeze reason.
This service is used to retrieve the information page of a retention category.
Additional Required Service Parameters
dCategoryID: The unique identifier of the retention category to be retrieved.
This service is used to retrieve the metadata information page and related content for a record folder in the retention schedule.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be retrieved.
This service is used to retrieve the lifecycle information page for a record folder.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder.
This service is used to retrieve the metadata history of a record folder.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder.
This service is used to retrieve the review history of a record folder.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder.
This service is used to retrieve the lifecycle information page for a content item.
Additional Required Service Parameters
dID: The content ID of the item.
dCategoryID: The unique identifier of the retention category associated with the item.
This service is used to retrieve the metadata history of a content item.
Additional Required Service Parameters
dID: The content ID of the content item.
This service is used to retrieve the review history of a content item.
Additional Required Service Parameters
dID: The content ID of the content item.
This service is used to retrieve the information page for a series in the retention schedule.
Additional Required Service Parameters
dSeriesID: The unique identifier of the series.
This service is used to set the current date for when a record folder will be activated.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
currentDate: The date to be used for activation.
This service is used to set the current date for when a record folder will be canceled.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
currentDate: The date to be used for cancellation.
This service is used to set the current date for the expiration date for a record folder.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
currentDate: The date to be used for expiration.
This service is used to set the current date for when a record folder becomes obsolete.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
currentDate: The date to be used as the obsolete date.
This service is used to set the current date for when a record folder will be rescinded.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
currentDate: The date to be used as the rescinded date.
This service is used to set the current date for when a record folder will be reviewed.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
currentDate: The date to be used as the review date.
This service is used to set the current date for when a record folder, including all of its child folders, will be reviewed.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
currentDate: The date to be used as the review date.
This service is used to set the current date for when a content item will be canceled.
Additional Required Service Parameters
dID: The content ID of the content item to be processed.
currentDate: The date to be used as the cancellation date.
This service is used to set the current date for when an item will expire.
Additional Required Service Parameters
dID: The content ID of the item to be processed.
currentDate: The date to be used as the expiration date.
This service is used to set the current date to be used to make an item obsolete.
Additional Required Service Parameters
dID: The content ID of the item to be processed.
currentDate: The date to be used as the obsolete date.
This service is used to set the current date for when an item will be rescinded.
Additional Required Service Parameters
dID: The content ID of the item to be processed.
currentDate: The date to be used as the rescinded date.
This service is used to set the current date for when a content item will be reviewed.
Additional Required Service Parameters
dID: The content ID of the content item to be processed.
currentDate: The date to be used as the review date.
This service is used to move a record folder from one location in the retention schedule to another.
Additional Required Service Parameters
dFolderID: The folder ID of the folder to be processed.
dCategoryID: The folder category.
This service is used to retrieve the lifecycle preview of a content item.
Additional Required Service Parameters
dID: The content ID of the content item to be processed.
This service is used to process a Close disposition action on a folder. This service calls the CLOSE_FOLDER service.
Additional Required Service Parameters
dDispositionID: The unique identifier of the disposition action.
This service is used to process a Cutoff disposition action.
Additional Required Service Parameters
dDispositionID: The unique identifier of the disposition action.
This service is used to process a Destroy disposition action. All revisions of content or folders are destroyed unless other disposition rules take precedence.
Additional Required Service Parameters
dDispositionID: The unique identifier of the disposition action.
This service is used to add an Oracle Universal Records Management archive to an Oracle Content Server archive.
Additional Required Service Parameters
dDispositionID: The unique identifier of the disposition action.
This service is used to create a zip archive.
Additional Required Service Parameters
dDispositionID: The unique identifier of the disposition action.
This service is used to mark the completion of an action.
Additional Required Service Parameters
dDispositionID: The unique identifier of the disposition action.
This service is used to process a No Action disposition action.
Additional Required Service Parameters
dDispositionID: The unique identifier of the disposition action.
This service is used to process an Obsolete disposition action. This service calls MARK_FOLDER_OBSOLETE_DATE or MARK_RECORD_OBSOLETE_DATE.
Additional Required Service Parameters
dDispositionID: The unique identifier of the disposition action.
This service is used to securely delete record folders or content item so they cannot be recovered.
Additional Required Service Parameters
dDispositionID: The unique identifier of the disposition action.
This service is used to process a Supersede disposition action.
Additional Required Service Parameters
dDispositionID: The unique identifier of the disposition action.
This service is used to revoke the closed status of an existing record folder in the retention schedule. Unclosing a folder allows content to be checked into the closed record folder or its subfolders.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
This service is used to unfreeze an existing record folder in the retention schedule. Unfreezing a folder releases the folder for processing of its associated disposition rules.
Additional Required Service Parameters
dFolderID: The unique identifier of the record folder to be processed.
auditComments: The unfreeze name.
auditComments2: The unfreeze reason.
This service is used to unfreeze an existing content item. Unfreezing releases the content item for processing of its associated disposition rules.
Additional Required Service Parameters
dFolderID: The unique identifier of the content item to be processed.
auditComments: The unfreeze name.
auditComments2: The unfreeze reason.