IBM Enterprise Records, Version 5.1.2    

Methods defined in the RM_operations component queue

The RM_Operations component queue contains a variety of methods.

The RM_Operations component queue defines the following methods:

createRMFolder

This method creates an RM folder, such as a record folder and volume, at the specified destination, but does not apply to categories. See createRMFolder1 for the method that creates categories. The following table lists the parameters passed in the createRMFolder method.

Parameter Description
aoHomeLocationAttachment Indicates the location of the folder to be created. If it is a physical or hybrid folder, this parameter indicates the original location of the entity. If it is an electronic folder, it passes a null value.
aoRecordCategoryAttachment Indicates the record category under which the record folder has to be created. The record category is passed as an attachment to the createRMFolder method.
asArrPropertyName[] A String array that contains the names of the properties required for the folder to be created. These names are symbolic names and should be consistent with the names specified in the DoD and PRO standards.
asArrPropertyValue[] A String array that contains the values for the properties required for the folder to be created. These values correspond to the property names that are passed in the asArrPropertyName parameter.
asEntityName Indicates the name of the RM folder to be created.
aiRMType An integer value that indicates the type of RM folder to be created: electronic folder, physical container, and so on.
Return Value: XML in String If creation succeeded:
<RMFolder><ID>createdFolderId</ID><Name>createdFolderName</Name><Status>Successful</Status><ErrorMessage></ErrorMessage></RMFolder>
If creation failed:
<RMFolder><ID> </ID><Name></Name><Status>Error
</Status><ErrorMessage>Possible Error Message</ErrorMessage></RMFolder>

createRMFolder1

This method creates an RM folder, such as a record category, record folder, and volume, at the specified destination. The following table lists the parameters passed in the createRMFolder1 method.

Parameter Description
aoRecordCategoryAttachment Indicates the record category under which the record folder has to be created. The record category is passed as an attachment to the createRMFolder1 method.
asArrPropertyName[] A String array that contains the names of the properties required for the folder to be created. These names are symbolic names and should be consistent with the names specified in the DoD and PRO standards. For Base model, they should include: RecordCategoryName, RecordCategoryIdentifier and Reviewer.
asArrPropertyValue[] A String array that contains the values for the properties required for the folder to be created. These values correspond to the property names that are passed in the asArrPropertyName parameter.
aiRMType An integer value that indicates the type of RM folder to be created: electronic folder, physical container, and so on. For Record Category, the value is 101.
asCustomFolderClassGUID If the container to be created is a customized class, asCustomFolderClassGUID is the class GUID. Otherwise leave it empty or null.
Return Value: XML in String If creation succeeded:
<RMFolder><ID>createdFolderId</ID><Name>createdFolderName</Name><Status>Successful</Status><ErrorMessage></ErrorMessage></RMFolder>
If creation failed:
<RMFolder><ID> </ID><Name></Name><Status>Error
</Status><ErrorMessage>Possible Error Message</ErrorMessage></RMFolder>

declareRecord

This method creates a record, corresponding to a document stored in the ROS. The following table lists the parameters passed in the declareRecord method. This method returns the ID of the record that has been declared.

Parameter Description
aoFolderAttachment Indicates the record folder in which the record has to be declared. The record folder is passed as an attachment to the aoFolderAttachment method.
aoDocumentAttachment Represents the FileNet P8 document, which is to be declared as a record. This document is passed as an attachment to the aoDocumentAttachment() parameter.
asRMType Represents the RMType of the record to be created - electronic, email, and marker. The value of this parameter is represented in String format.
asArrPropertyName[] A String array that contains the names of the properties required for the record to be declared. These names should be consistent with the names specified in the DoD and PRO standards.
asArrPropertyValue[] A String array that contains the values for the properties required for the record to be declared. These values correspond to the property names that are passed in the asArrPropertyName parameter.

destroy

This method performs the destroy action at the end of the retention period of an entity. After destruction, depending upon the value of the RetainMetadata property of the classification scheme, the minimum metadata for the record will be retained. This method returns a TranscriptXML file that contains information about whether the entity has been successfully destroyed. If the entity has not been destroyed, a reason for the unsuccessful completion of the operation is entered in the file. This method returns the updated TranscriptXML in String format.

The following table lists the parameters passed in the destroy method.

Parameter Description
asObjectStoreName Denotes the name of the object store where the record that is to be destroyed is currently located.
asArrGUID[] A String array that contains the GUIDs of the records that are to be destroyed.
aiArrMinimumMetadataRequired[] An Integer array that determines whether or not the minimum metadata for the record to be destroyed should be retained.
asTranscriptXML Represents the TranscriptXML file that contains information about the workflow status, the action performed, and the status of the records to be destroyed.

export

This method exports entities to the server location that is specified for the entity. This method returns the updated TranscriptXML file in String format. The following table lists the parameters passed in the export method.

Parameter Description
asObjectStoreName Denotes the name of the object store where the entity is located.
asArrGUID[] A String array that contains the GUIDs of the entities that are to be exported.
asTranscriptXML Represents the TranscriptXML file that contains information about the workflow status, the action performed, and the status of the entities to be exported.

getRMEntityAsAttachment

This method returns an RM entity as an attachment, which can be passed to other methods such as createRMFolder. The following table lists the parameters passed in the getRMEntityAsAttachment method.

Parameter Description
asObjectStoreName Denotes the name of the object store where the entity is located.
asArrGUID[] A String array that accepts the GUIDs of the entities that are to be retrieved.

getTranscriptAsFile

This method retrieves the TranscriptXML file as a document, in the form of an attachment. The following table lists the parameters passed in the getTranscriptAsFile method.

Parameter Description
asTranscriptDocId Represents the unique GUID of the document that contains the contents of the TranscriptXML file.
asObjectStoreName Denotes the object store name where the document is located.

interimTransfer()

This method calls the executeInterimTransfer method of the DisposalObject in the RM Java™ API to update the Home Location metadata of the physical entity and the Location metadata of an electronic entity. This method returns the updated TranscriptXML file. The following table lists the parameters passed in the InterimTransfer method.

Parameter Description
asObjectStoreID Denotes the id of the object store where the entity/entities due for interim transfer are currently located.
asArrEntityGUID[] A String array that contains the GUIDs of the entities due for interim transfer.
aoArrLocation[] A String array that contains the destination locations to which the entities are to be transferred.
asTranscriptXML Represents the TranscriptXML file that contains information about workflow status, the action performed, and the status of the entities that are due for interim transfer.

launchWorkflow

This method launches the workflow associated with the current phase of the entity. The following table lists the parameters passed in the launchWorkflow method.

Parameter Description
asObjectStoreID Denotes the name of the object store where the entity/entities are located.
asArrEntityGUID[] A String array that contains the GUIDs of the entities associated with a particular workflow.

setCutoffDate

This method updates the cutoff date of an entity requested for cutoff approval with the new date. Using the existing workflows, an end user can change the cutoff date only at the time of review. You can use this method to customize the update of the cutoff workflow. The following table lists the parameters passed in the setCutoffDate method.

Parameter Description
asArrEntityGUID[] A String array that contains the GUIDs of the entities whose cutoff date needs to be set.
aoCutoffDate[] Indicates the cutoff date that is to be set on the entity.
asObjectStoreName Represents the object store name where the entity is stored.

setNextVitalReviewDate

This method determines the next vital review date of the entity/entities. The following table lists the parameters passed in the setNextVitalReviewDate method.

Parameter Description
asArrEntityGUID[] Denotes the GUIDs of the entity/entities whose next vital review date needs to be set.
adNextVitalRecordReviewDate[] Contains the next vital review date that is to be applied on the entity/entities.
asObjectStoreName Represents the object store name where the entity/entities whose next vital review date needs to be set.

setProperties

This method sets the properties to be defined for an entity. The following table lists the parameters passed in the setProperties method.

Parameter Description
asObjectStoreName Denotes the name of the object store where the entity is stored.
asGUID A String that contains the GUID of the entity.
asArrPropertyName[] A String array of property names of the entity.
AsArrPropertyValue[] A String array of property values of the entity.

Transfer

This method transfers the entities to the location set on the entity and destroy the metadata.

Parameter Description
asObjectStoreName Denotes the name of the object store where entity/entities due for transfer are stored.
asArrGUID[] A String array that contains the GUIDs of the entities on which the transfer action is to be taken.
aiArrMinimumMetadataRequired[] An Integer array that determines whether or not the minimum metadata should be retrained for the entities on which the transfer action is to be taken.
AsArrPropertyValue[] A String array of property values of the entity.
asTranscriptXML Represents the TranscriptXML file that contains information about the workflow status, the action performed, and the status of the entities whose properties are to be set.


Feedback

Last updated: November 2013
ierdg015.htm

© Copyright IBM Corporation 2013