- Introduction
- Installation
- Self Service Licensing Guide Updated
- Prerequisites
- Decisions License Updated
- Basic
- Advanced
- Enterprise
- Containers
- Containers Overview
- Decisions Container Updated
- Decisions Environment Variables
- Deploying Containers on Docker
- Deploying Containers on Azure
- Deploying Containers on Amazon ECS
- Deploying Containers on GCP
- Deploying Azure Kubernetes Services (AKS) Updated
- Deploying an AWS Kubernetes Cluster
- Securing Decisions Container Environment
- Clustering
- Multi Tenancy
- Containers
- Upgrading
- Getting Started
- Data Structures
- Starting with Data Structures
- Creating Data Structures
- Creating Case Entities
- Creating Entities
- Creating Leased Entities
- Creating External Entities
- Creating Entity Extensions
- Creating Folder Extension Data Structures
- Creating Flow Execution Extension Data Structures
- Creating Flow Structures
- Creating Defined Data Structures
- Creating Database Structures
- Creating Value Lists
- Creating a CSV Data Structure
- Creating Types From JSON Schema
- Creating Types From XSD
- Creating Types From JSON
- Data Fields
- Building Data Structures CRUD Actions
- Data Structure CRUD Overview
- Case Entity CRUD Actions
- Database Structure CRUD Actions
- Defined Data Structure CRUD Actions
- Entity Structure CRUD Actions
- Entity Extension CRUD Actions Updated
- External Entity CRUD Actions
- Flow Execution Extension CRUD Actions Updated
- Folder Extension CRUD Actions Updated
- Managing Data Structures
- Flows
- Create Flows
- Flow Behaviors
- About Flow Behaviors Updated
- Building and Using Converter Flows
- Flow Step Trigger (After, Before, Error) Flow Behavior
- Folder Count Flow Behavior
- Login User Flow Behavior
- Post to Flow Handler Behavior
- Login User UI Flow Behavior
- Tile Source Flow Behavior
- Turn Flow Statistics On
- Get Page Variable Updated
- Report Field Action Handler Flow
- Password Reset Flow
- Creating a BPMN Flow
- Exporting BPMN Flow
- Report Group Action Flow
- Steps
- Simple Flows
- Sub Flows
- Flow Behaviors
- Configure Flows
- Debug Flows
- Implement Flows
- Best Practices
- Create Flows
- Forms
- Create Forms
- Form Controls
- Form Control Comparison
- Data Grids
- Data Repeaters
- Dropdown Lists
- Javascript Controls
- Form Control Glossary
- Form Control Behavior Overview
- Form Control Key Triggers
- Adding a Timeline to a Series of Forms
- Color Picker
- Copy-able Label
- Creating Help Text Messages for Form Fields
- Masked Textbox Control
- Currency Box and Number Box/Spinner
- Document Viewer
- Multiple File Upload and Download Controls
- Tree View Control
- User Controls
- Video Control
- Latitude and Longitude Control Updated
- HTML Display Control
- Create Form with Property Grid
- Editing Data Objects in a Wizard Property Grid
- Progress Bar Overview
- Editing CSV Records in a Form
- Simple Forms
- Form Controls
- Configure Forms
- Layout & Design
- Creating Form Backgrounds
- Layouts Overview
- Form Organization
- Grid Layout
- Canvas Layout
- Header Container Layout
- Horizontal and Vertical Stacks
- Split Panel Layout
- Responsive Containers and Grids
- Tabs Container Layout
- Using the Tab Editor to Set Tab Order
- Side Menu Containers
- Creating End Forms Updated
- Data & Logic
- CSS
- Form Settings in the Flow Designer
- Layout & Design
- Implement Forms
- Create Forms
- Rules
- Create Rules
- Creating Statement Rules
- Creating an Expression Rule
- Creating a Truth Table
- Creating an External Truth Table
- Creating a Rule Table
- Creating a Matrix Rule
- Creating a Tree Rule
- Creating a Rule Set
- Creating an Interceptor Rule
- Creating a Rule Chain
- Creating a Sequential Rule
- Leveraging Default Rules
- Rule Verbs
- Configure Rules
- Debug Rules
- Implement Rules
- Create Rules
- Reports Updated
- Pages / Dashboards
- Create Page / Dashboard
- Page Controls
- Charts
- Tiles
- Selecting a Data Drill View for the Report Viewer
- Report Viewer Control
- Flow Run Part Updated
- Folder Activity Panel
- Folder Viewer
- Tag Browser
- Adding Folder Navigation Buttons to a Page
- Horizontal Folder Timeline
- Adding Run Flow Links or Buttons to a Page
- Adding User Actions with a Page/Dashboard with the Action Bars Component
- Date Range Filter on Pages
- Filtering Reports via Page Control
- Adding an Image to a Page/Dashboard
- Page Controls
- Configure Page
- Implement Page
- Create Page / Dashboard
- Networking
- Integrations
- Azure Account and Group Sync
- Starting with Integrations
- Agents
- Database Integrations
- Integrating an External Database with a Flow
- Creating Database Table Relationships
- Creating a Database in MSSQL for Decisions
- External Database Integration
- Advanced Postgres Connection
- Integrate with Database Table
- Fetching External Data to a CSV
- Connecting with an ODBC
- Return Dynamic Data Rows When Fetching Data From Database
- Creating Access Pattern For Table Integrations
- Using Stored Procedure in Flows
- Raw SQL Step
- Integrating Decisions with External Oracle Database
- Connect to MySQL
- External Service for OData
- Adding a Query to a Database
- Add Query (Parameterized Queries)
- Using Transaction Steps
- Connecting to Amazon Redshift
- Integrating with Snowflake
- Managing Database Connection Timeouts
- Troubleshooting Database Connection Response Times
- External Webservices
- JWT
- OAuth
- REST Service Integration
- Using Decisions in External Applications
- Services
- Query Editor
- Decisions Backend
- Process Mining
- Modules
- About Modules
- Available Modules Updated
- Installing Modules
- Modules in GitHub
- Uploading and Installing Custom Modules
- Updating Custom Modules
- Generating Certificates with OpenSSL
- Active Directory
- Adobe Sign
- AI.Common
- AWS
- AWS Bedrock
- Azure
- Box Module
- Datamatics
- Docker
- Docusign
- Dropbox
- Enterprise Module
- Equifax
- Exchange Web Services
- Experian
- FHIR
- Financial
- Foreign Exchange
- Google Cloud
- Google Drive
- HL7
- HubSpot
- iCal
- Jira
- Logging.WindowsEvent
- Messaging
- MongoDB
- MSMQ
- MS OneDrive
- Okta
- OpenAI
- OpenID
- PGP
- Plaid
- PowerShell
- Python
- QR Codes
- Remedy
- R Module
- Salesforce
- SAML
- Sharepoint
- Slack
- SSH
- Symantec
- Telephony
- UnitTestCore
- USPS
- Word To PDF
- X12
- Advanced
- API and Authentication
- Troubleshooting
- Using Selenium and NUnit for Front-end Testing
- Understanding Thread Jobs and Processes
- Logging & Auditing
- Logging Overview Updated
- Logging Settings
- Reading Logs
- Using the Log Step
- Writing To Log Files
- Creating Custom Log Files
- Setting up AWS Cloudwatch Logging
- Setting Up Azure Log Analytics Integration
- Enabling W3C Logging
- Enabling Auditing
- Viewing Audit History
- Troubleshooting Using the Profiler
- Configuring Decisions with Grafana Loki
- Decisions Disaster Recovery Architecture
- SDK
- Administrators
- User Management
- Deployment
- Import & Export
- Best Practices for Decisions Deployment
- Repository
- Repository Overview
- Repository Installation
- Connecting a Decisions Server to a Repository Server
- Repository Settings
- Using The Repository
- Configuring CICD Process Using Azure DevOps
- Configuring Repository with Repo-SSO
- Repository Features and Functions
- Troubleshooting Repository
- Repository Revisions
- Repository Branches
- Sub Project Overview
- Repository Action Flows
- Customization
- Permissions
- System Folders
- System Settings
- System Folders Tree
- Customizing System Page
- Controlling Assignment Notification Types for Server
- Creating Custom Modes of Notification with Notification Flows
- Event Viewer
- Flow Management Dashboard
- System Validation Folder
- Turn Portal Statistics On
- Configuring Locations
- Stored Workflows
- Setting Up Notifications for Events
- Toolbox Visibility Rules
- Email and SMTP in Decisions
- File Archiving and Deletion
- Integration Activities
Overview
Feature Details | |
Introduced in Version | 8.9 |
Modified in Version | 8.11 |
Location | System > Settings > Archive Entities Settings |
The primary purpose of this feature is to delete or move the old, inactive, process-completed data to a separate database or warehouse. This allows the primary database to focus on managing the essential data for current operations. At the same time, the archived data can be used for compliance, auditing, historical analysis, etc.
Users with Administrator Permissions and Can Administrate Permissions to the folders can mark entities archived using the Archive Entity action. Once an entity is marked as archived, it is not moved or deleted immediately; instead, the "Archive Entities Settings" allows administrators to configure the duration for which entities remain in the system before being deleted or moved to an external database.
This document demonstrates the following topics,
- Configuring the Archive Entities Settings
- User actions to Archive the Entities
- Automating Archiving of Case Folder
- Generate a Report of the entities that have been archived
- Archiving of Entities is an irreversible process. Retrieval of data is not supported after the archival of any entities.
- Decisions using Postgres Database does not support the moving of entities to an external database.
Type of Entities that can be archived
Only transactional data can be archived.
Configuring Archive Entities Settings
Navigate to System (Gear Icon) > Settings > Archive Entities settings. A dialog box appears to edit the archive entities settings.
For all the configurations and a detailed description, please refer to the following table,
Archive Settings
Configuration | Description |
---|---|
Enable | Enabling this setting will allow the manual archiving of all the entities. |
Process After Days | This allows administrators to configure a time limit (in days) for how long an entity can be marked as archived. |
Archiving Strategy | Currently, there are two Archiving Strategies, |
Archive Strategy Settings
When using an archiving strategy that involves moving data, the administrators must set up the connection to the external database.
- When connecting to an external database, it is recommended to create a new database.
- Moving Entities to Postgres is not supported.
Configuration | Description |
---|---|
Server Name | The DNS name or IP of the server running the Database. |
Database Name | Name of database. |
Windows Authentication | Checking this box will use the windows login to access the Database. |
User Name | Username of the SQL account used to access the Database. |
Password | The password of the SQL account access the Database. |
Use an Encrypted Connection | Enabling will encrypt the connection between the client and the server. Ensure to configure the database server to use trusted certificates. |
Trust Server Certificate | Enabling will bypass the 3rd party trusted certificate and will use the server's own trusted certificate. |
Timeout | The timeout setting sets the maximum time limit, in seconds, for the transfer of entities between databases, after which the process gets terminated. |
Archive Settings Calendar
Admins must configure the calendar information to schedule a job. This scheduled job will automatically archive all the entities which are already marked as archived and also surpassed the number of days configured in Process After Days. Refer to Understanding Scheduled Job articles for a detailed description of all the calendar settings.
When the folder is marked as archived, all the child entities (comments, folder assignments, and documents) within the folder get marked as archived simultaneously. Thus the child entities will follow the same archiving strategy configured in the Archive Entities settings.
However, if a parent folder is marked as archived and a child entity is added later, the parent folder will get archived, leaving the child in the primary database.
User actions to archive the Entities
Archiving can be done manually on demand via folder actions (right-click on the entities) or through Flow Steps.
- Archiving through Folder actions:
- After configuring the settings for archiving. Navigate to the decisions studio. Navigate to the process folder that you wish to archive.
- Right-click on the folder > Manage > Archive Folder. A confirmatory dialog box will open. Click OK.
- Hence, the folder will be marked as archived.
- It is possible to select multiple entities at the same time and mark them as archived simultaneously by using a multi-select feature. Press "Ctrl" and click on the entity to enable the multi-select.
- After configuring the settings for archiving. Navigate to the decisions studio. Navigate to the process folder that you wish to archive.
- Un-Archiving through Folder Actions:
Navigate to the folder that is already marked as Archived. Right-click on the folder > Manage > Un-Archive Folder. A confirmatory dialog box will open. Click OK. - Archiving through Flow Steps:
Users can mark "archive" to the Case folders or the Process folders by using the "Archive Folder" step within a Flow. The Archive Folder step takes the Folder ID as input and marks the Folder as Archived, similar to the one we mark manually. Refer to the Archive FolderStep Article for detailed information about the step.Note:From the System settings, if Archive Entities Settings is disabled, the Step will throw a "Business Rule Exception" stating thatNot allowed to Archive {Folder Name}.
Automating Archiving of Case Folder
When a case folder reaches the closed state, it will be automatically marked as archived after a specified number of days, as configured by the administrator in the case management settings.
Configuring Case Management Settings
Navigate to System (Gear Icon) > Settings > Case Management Settings. A dialog box appears. Click on ADD to add the type of case.
Configuration | Description |
---|---|
Type Name | From the drop-down, choose the type of Case Entity you wish to enable for archiving. |
Archive After Days (on reaching closed state) | This allows administrators to configure a time limit (in days) after how long an entity can be marked as archived. Once the entities have reached the closed state and also surpassed the time limit, the scheduled job will follow the archiving strategy configured in the Archive Entities settings to move or delete it. To mark an entity as a closed state, refer to the "Case Entities" article. |
After Adding the case type, it will expose the calendar information to configure the scheduled job. Refer Archive Settings Calendar for more information.
Decisions Data on External Database (Warehouse)
When connecting to an external database, it is recommended to either create a new database or use a database that was not used by any decision instance.
When the data is moved to the external database (warehouse), a database schema is automatically created only for the entities being moved, and all archived data is moved to the respective tables.
For example,
- folders will be moved to dbo.entity_folder
- comments will be moved to dbo.comments_folder
Generating Report of Archived Entities
Users can generate a Report of all the archived entities by integrating with the external database (warehouse) that has been used to archive the entities.
Example
- Integrating with external database(warehouse)
- Follow steps 1 and 2 from the following article to integrate with an external database. Ensure to use the same credentials that were used to connect to the warehouse.
- In this example, we have named the external database Archivied_Entities_DB
- Follow steps 1 and 2 from the following article to integrate with an external database. Ensure to use the same credentials that were used to connect to the warehouse.
- Integrate with the Database Table.
- Click on the newly created database connection. From the top action bar, click on Add Table, and a database integration dialog appears.
- From the drop-down, select dbo.entity_folder and click on Next-Next-Save.
- Click on the newly created database connection. From the top action bar, click on Add Table, and a database integration dialog appears.
- Creating the Report.
- Navigate to the Designer Folder and create a new Report Archivied Entities.
- Under Data Sources > Add > Common > Archivied_Entities_DB [name of the database] > dbo.entity_folder [name of the table].
- Under Data Fileds > Add > entity_name, archivied_by etc. Save and close the Report.
- Navigate to the Designer Folder and create a new Report Archivied Entities.
- Refer to the following article to Add Report to Page.
Similarly, users can create multiple reports after adding multiple tables from the database. Refer to the following articles to build more complex reports.Configuring the Archive Entities Settings
Table of contents
Related articles