10.2 Record Manager Services

The following services are used in Record Management functions:

• "ACTIVATE_SERVICE"

• "APPROVE_DELETE_SERVICE"

• "BROWSE_CATEGORY_FORM"

• "BROWSE_FOLDER_FORM"

• "BROWSE_SERIES_FORM"

• "CHECKIN_NEW_REVISION_SERVICE"

• "CHECKIN_SIMILAR_FORM"

• "CLEAR_FOLDER_CANCELLED_DATE"

• "CLEAR_FOLDER_EXPIRATION_DATE"

• "CLEAR_FOLDER_OSBOLETE_DATE"

• "CLEAR_FOLDER_RESCINDED_DATE"

• "CLEAR_FOLDER_REVIEW_DATE"

• "CLEAR_RECORD_CANCELLED_DATE"

• "CLEAR_RECORD_EXPIRATION_DATE"

• "CLEAR_RECORD_OBSOLETE_DATE"

• "CLOSE_FOLDER"

• "CREATE_FOLDER"

• "CREATE_FOLDER_FORM"

• "DELETE_ALL_BUT_LAST_N_REVISIONS_ SERVICE"

• "DELETE_FOLDER"

• "DELETE_REVISION_SERVICE"

• "EDIT_FOLDER"

• "EDIT_FOLDER_FORM"

• "FREEZE_FOLDER"

• "FREEZE_RECORD"

• "INFO_CATEGORY_FORM"

• "INFO_FOLDER_FORM"

• "INFO_FOLDER_LIFECYCLE"

• "INFO_FOLDER_METADATA_HISTORY"

• "INFO_FOLDER_REVIEW_HISTORY"

• "INFO_RECORD_LIFECYCLE"

• "INFO_RECORD_METADATA_HISTORY"

• "INFO_RECORD_REVIEW_HISTORY"

• "INFO_SERIES_FORM"

• "MARK_FOLDER_ACTIVATION_DATE"

• "MARK_FOLDER_CANCELLED_DATE"

• "MARK_FOLDER_EXPIRATION_DATE"

• "MARK_FOLDER_OBSOLETE_DATE"

• "MARK_FOLDER_RESCINDED_DATE"

• "MARK_FOLDER_REVIEW_DATE"

• "MARK_FOLDER_REVIEW_DATE_ RECURSIVE"

• "MARK_RECORD_CANCELLED_DATE"

• "MARK_RECORD_EXPIRATION_DATE"

• "MARK_RECORD_OBSOLETE_DATE"

• "MARK_RECORD_RESCINDED_DATE"

• "MARK_RECORD_REVIEW_DATE"

• "MOVE_FOLDER"

• "PREVIEW_RECORD_LIFECYCLE"

• "RMA_CLOSE_SERVICE"

• "RMA_CUTOFF_SERVICE"

• "RMA_DESTROY_SERVICE"

• "RMA_EXPORT_ARCHIVE_SERVICE"

• "RMA_EXPORT_SERVICE"

• "RMA_MARK_COMPLETED"

• "RMA_NO_ACTION_SERVICE"

• "RMA_OBSOLETE_SERVICE"

• "RMA_SCRUB_SERVICE"

• "RMA_SUPERSEDE_SERVICE"

• "UNCLOSE_FOLDER"

• "UNFREEZE_FOLDER"

• "UNFREEZE_RECORD"

10.2.1 ACTIVATE_SERVICE

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.

10.2.2 APPROVE_DELETE_SERVICE

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.

10.2.3 BROWSE_CATEGORY_FORM

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.

10.2.4 BROWSE_FOLDER_FORM

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.

10.2.5 BROWSE_SERIES_FORM

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.

10.2.6 CHECKIN_NEW_REVISION_SERVICE

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.

10.2.7 CHECKIN_SIMILAR_FORM

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.

10.2.8 CLEAR_FOLDER_CANCELLED_DATE

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.

10.2.9 CLEAR_FOLDER_EXPIRATION_DATE

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.

10.2.10 CLEAR_FOLDER_OSBOLETE_DATE

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.

10.2.11 CLEAR_FOLDER_RESCINDED_DATE

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.

10.2.12 CLEAR_FOLDER_REVIEW_DATE

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.

10.2.13 CLEAR_RECORD_CANCELLED_DATE

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.

10.2.14 CLEAR_RECORD_EXPIRATION_DATE

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.

10.2.15 CLEAR_RECORD_OBSOLETE_DATE

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.

10.2.16 CLOSE_FOLDER

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.

10.2.17 CREATE_FOLDER

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.

10.2.18 CREATE_FOLDER_FORM

This service is used to call CREATE_FOLDER to create a new record folder in the retention schedule.

10.2.19 DELETE_ALL_BUT_LAST_N_REVISIONS_ SERVICE

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.

10.2.20 DELETE_FOLDER

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.

10.2.21 DELETE_REVISION_SERVICE

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.

10.2.22 EDIT_FOLDER

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.

10.2.23 EDIT_FOLDER_FORM

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.

10.2.24 FREEZE_FOLDER

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.

10.2.25 FREEZE_RECORD

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.

10.2.26 INFO_CATEGORY_FORM

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.

10.2.27 INFO_FOLDER_FORM

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.

10.2.28 INFO_FOLDER_LIFECYCLE

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.

10.2.29 INFO_FOLDER_METADATA_HISTORY

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.

10.2.30 INFO_FOLDER_REVIEW_HISTORY

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.

10.2.31 INFO_RECORD_LIFECYCLE

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.

10.2.32 INFO_RECORD_METADATA_HISTORY

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.

10.2.33 INFO_RECORD_REVIEW_HISTORY

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.

10.2.34 INFO_SERIES_FORM

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.

10.2.35 MARK_FOLDER_ACTIVATION_DATE

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.

10.2.36 MARK_FOLDER_CANCELLED_DATE

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.

10.2.37 MARK_FOLDER_EXPIRATION_DATE

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.

10.2.38 MARK_FOLDER_OBSOLETE_DATE

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.

10.2.39 MARK_FOLDER_RESCINDED_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.

10.2.40 MARK_FOLDER_REVIEW_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.

10.2.41 MARK_FOLDER_REVIEW_DATE_ RECURSIVE

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.

10.2.42 MARK_RECORD_CANCELLED_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.

10.2.43 MARK_RECORD_EXPIRATION_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.

10.2.44 MARK_RECORD_OBSOLETE_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.

10.2.45 MARK_RECORD_RESCINDED_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.

10.2.46 MARK_RECORD_REVIEW_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.

10.2.47 MOVE_FOLDER

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.

10.2.48 PREVIEW_RECORD_LIFECYCLE

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.

10.2.49 RMA_CLOSE_SERVICE

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.

10.2.50 RMA_CUTOFF_SERVICE

This service is used to process a Cutoff disposition action.

Additional Required Service Parameters

• dDispositionID: The unique identifier of the disposition action.

10.2.51 RMA_DESTROY_SERVICE

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.

10.2.52 RMA_EXPORT_ARCHIVE_SERVICE

This service is used to add a Records Manager archive to a Content Server archive.

Additional Required Service Parameters

• dDispositionID: The unique identifier of the disposition action.

10.2.53 RMA_EXPORT_SERVICE

This service is used to create a zip archive.

Additional Required Service Parameters

• dDispositionID: The unique identifier of the disposition action.

10.2.54 RMA_MARK_COMPLETED

This service is used to mark the completion of an action.

Additional Required Service Parameters

• dDispositionID: The unique identifier of the disposition action.

10.2.55 RMA_NO_ACTION_SERVICE

This service is used to process a No Action disposition action.

Additional Required Service Parameters

• dDispositionID: The unique identifier of the disposition action.

10.2.56 RMA_OBSOLETE_SERVICE

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.

10.2.57 RMA_SCRUB_SERVICE

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.

10.2.58 RMA_SUPERSEDE_SERVICE

This service is used to process a Supersede disposition action.

Additional Required Service Parameters

• dDispositionID: The unique identifier of the disposition action.

10.2.59 UNCLOSE_FOLDER

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.

10.2.60 UNFREEZE_FOLDER

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.

10.2.61 UNFREEZE_RECORD

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.