Archive
Ometa Case Archiving
The Ometa framework offers the option to archive cases. This sets aside the case while keeping case data intact, the framework will not process or return the record any longer. This will improve performance in particular for customers with a large backlog of cases accumulated over the years, optimizing query performance by focusing only on active cases.
Archived cases can be recognized by the Archived
flag on the database record. Cases can be unarchived at will by resetting this flag. The framework method Unarchive Case
from the DCS.System
object can be used to achieve this through the framework.
Automatic Case Archiving
A common use case for automatic archiving is to enable it on the last state of the lifecycle, when the case is processed and no further actions are required on the case. Upon reaching a state succesfully with the setting Auto Archive Cases
configured, the case is automatically marked as archived.
When archiving a case, the Archived
flag is set which excludes the record from most queries.
Overview
Below is the overview where archived case data can be returned.
Data Source | Can Return Archived Cases |
---|---|
SQL View VW_AllCasesLifecycle | |
SQL View VW_AllCases | |
SQL View VW_AllArchivedCases | |
SQL View VW_AllRemovedCases | |
SQL View VW_Memberships | |
Core Service/dynamic-odata/Lifecycle | |
Core Service/dynamic-odata/Lifecycle(id) | |
Core Service/dynamic-odata/Lifecycle/Ometa.Dynamic.Lifecycles/GetArchived() | |
Core Service/dynamic-odata/Lifecycle/Ometa.Dynamic.Lifecycles/GetRemoved() | |
DCSClient.GetCases() | |
DCSClient.GetCase(long id) | |
DCSClient.GetFirstCaseOfLifecycle(int lifecycleId) | |
DCSClient.GetCaseIdsOfLifecycle(int lifecycleId) | |
DCSClient.GetFailedCaseIds(List |
|
Lifecycle.GetAllCaseData() | |
Lifecycle.GetCaseData(int caseId) |
And below is how the framework will interact with archived cases.
Case Management Action | Allowed on Archived Cases |
---|---|
Refresh Case | |
Validate Case | |
Process State Transition | |
Process Permissions | |
Process Actions | |
Remove Case | |
Soft Remove Case | |
Unarchive Case | |
Add new state permissions to archived cases | |
Queue Entries Processing (BCSP) |
If one of these actions are required on archived cases, see below to temporarily unarchive the cases.
Unarchiving
Cases can be freely unarchived by people with membership to the case, since the archiving mechanism is entirely driven by the Archived
flag onto a case.
Unarchiving a case to process a new state action or add new state permissions can be done following these steps:
- Configure Case Management to invoke the action.
- For example: adding a new state action
- Unarchive the case using the
Unarchive Case
method- Case management will remove the
Archived
flag. - The case will be transitioned to the given state, or refresh in its current state if not specified.
- The state configuration will be reprocessed by the refresh or state transition.
- Case management will remove the
- If case management ends up succesfully transitioning the case back to the
Auto Archive Case
state, it will be automatically rearchived.
External Archiving
Cases usually have a SharePoint site containing files or another system linked containing files. The archive system allows the user to archive the documents linked to the case.
The archive system can be configured to archive a specific list, filter the document on field values, etc.
The following external archiving systems are currently supported:
- Digitaal Archief Vlaanderen
- Corsa (legacy archive system)