Folder Operation Procedures

AddEventMessage

Add error message to CaseEvent so that error message is handled by the platform. This should be used in Before event handlers to stop execution and display the message to users

AddJournalEntry

Add a journal entry to the folder with specified comments. Folder Id and comments should be provided

ChangeFolderNumber

Changes the folder number for a specified folder. New folder number should be provided and should not be a duplicate folder number

ChangeFolderOffice

Change folder's Action Office. Folder Id and New Office Id should be provided

ChangeFolderOwner

Change folder's Owner. Folder Id and new Owner (User) Id should be provided

CloseFolder

Closes the specified folder by logged in user with specified journal notes

CreateFolder

Creates new case folder with specified Case Type Id, Owner Id and Action Office Id. Returns folder number

CreateSubFolder

Creates new case sub folder with specified Case Type Id, Owner Id and Action Office Id for the parent folder. Returns folder number

DeleteFolder

Recursively deletes the folder with all its sub folders. The list of all folders deleted thru recursive execution (folder, folder's sub folders etc.) are captured in the parameter deletedFolders

DeleteRecord

Deletes the repeating record from the folder. Folder Id, Group name and Record Id should be provided

EvalFilingStructId

Evaluates the filing structure rules for a CaseFolder object and returns the Filing Structure Id

GetCaseFolder

Get CaseFolder object for a specified folder number

GetCaseFolderById

Get CaseFolder object for a specified folder Id

GetFieldValue

Gets specified non-repeating field value in a string format from a CaseFolder object. Field Name and CaseFolder object should be provided

GetFolderBase

Gets folder basic information object for a specified folder number

GetFolderBaseById

Gets folder basic information object for a specified folder Id

GetFolderId

Get folder Id for a specified folder number

GetFolderNumber

Get folder number for a specified folder Id

GetLinkedFolderNumbers

Get all linked folder numbers for a specified CaseFolder

GetRecord

Gets Record object from a specified folder, repeating Group name and Record Id

GetRecordFieldValue

Gets specified field value in a string format from a Record object. Field Name and Record object should be provided

GetRecords

Gets the list of Record objects for a specified repeating Group name from CaseFolder object

IsFolderExists

Returns true if a folder already exists with specified folder number, otherwise returns false

LinkFolder

Links a folder. Link folder Id will be linked to folder Id with journal notes

MergeRecord

Merges Record object with CaseFolder. Changes from Record are merged to CaseFolder so that records are either update or inserted. When Record Id is matching to existing records then it will be updated otherwise new record will be inserted when CaseFolder is saved

MergeRecords

Merges List of Record objects with CaseFolder. Changes from Record are merged to CaseFolder so that records are either update or inserted. When Record Id is matching to existing records then it will be updated otherwise new record will be inserted when CaseFolder is saved

NewRecord

Create new Record object for specified folder Id, Case Type Id and repeating Group name

RemoveRecord

Remove Record object from CaseFolder object. Record will be identified in CaseFolder object using Record Id and repeating Group name. Record will be deleted in system only when CaseFolder is saved

SendMail

Sends specified email message to recipient email address. Folder Id, Sender User Id or From email address, semi colon separated recipient email address, subject and body should be provided. If Sender User Id is zero then From email address will be used as sender, otherwise sender user email address will be used

SetFieldValue

Sets non-repeating field value for CaseFolder object. CaseFolder object, field name and value should be provided. Value should be provided in eCASE data serialized format based on field type

UnlinkFolder

Unlinks a folder. Unlink folder Id will be unlinked to folder Id with journal notes

UpdateFilingStructId

Updates the filing structure Id for the specified folder

UpdateFolder

Saves the changes in CaseFolder object

UpdateFolderStatus

Updates Folder Status

UpdateRecord

Save the changes in Record object