Skip to content

Commit 45d15d0

Browse files
ThaminduRclaude
andauthored
Add flow context cleanup documentation for IS 7.2.0 and next (#5961)
Documents how to periodically clean up the IDN_FLOW_CONTEXT_STORE table using database-specific stored procedure scripts. Placed under Setup > Secure in the nav and referenced from the Flows Get Started page. Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
1 parent 921cb8e commit 45d15d0

6 files changed

Lines changed: 35 additions & 1 deletion

File tree

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{% include "../../../../includes/deploy/flow-context-cleanup.md" %}

en/identity-server/7.2.0/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1038,6 +1038,7 @@ nav:
10381038
- Manage keystores: deploy/security/keystores/configure-keystores.md
10391039
- Manage CA-Signed certificates in a keystore: deploy/security/keystores/manage-ca-signed-certificates-in-a-keystore.md
10401040
- Configure custom keystores for authentication protocols: deploy/security/keystores/configure-custom-keystores.md
1041+
- Clean up flow context: deploy/flow-context-cleanup.md
10411042
- Deploy:
10421043
- Deployment overview:
10431044
- Deployment Patterns: deploy/deployment-guide.md
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{% include "../../../../includes/deploy/flow-context-cleanup.md" %}

en/identity-server/next/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1050,6 +1050,7 @@ nav:
10501050
- Manage keystores: deploy/security/keystores/configure-keystores.md
10511051
- Manage CA-Signed certificates in a keystore: deploy/security/keystores/manage-ca-signed-certificates-in-a-keystore.md
10521052
- Configure custom keystores for authentication protocols: deploy/security/keystores/configure-custom-keystores.md
1053+
- Clean up flow context: deploy/flow-context-cleanup.md
10531054
- Deploy:
10541055
- Deployment overview:
10551056
- Deployment Patterns: deploy/deployment-guide.md
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Clean Up Flow Context
2+
3+
As you use WSO2 Identity Server (WSO2 IS), flow context records accumulate in the `IDN_FLOW_CONTEXT_STORE` table. Without periodic cleanup, this table can grow over time and negatively impact server performance.
4+
5+
Therefore, it is recommended to clean up flow context records periodically.
6+
7+
## Use the stored procedure for flow context cleanup
8+
9+
Follow the steps below to run the appropriate stored procedure script for your database.
10+
11+
!!! tip
12+
It is recommended to run these scripts during a time when traffic on the server is low. You can also set `backupTables` to `TRUE` in the script to back up the records before deletion, enabling a restore if needed.
13+
14+
1. Depending on your database, select the appropriate flow context cleanup script from the links below and run it on the database.
15+
16+
- [DB2](https://github.com/wso2/carbon-identity-framework/blob/master/features/identity-core/org.wso2.carbon.identity.core.server.feature/resources/dbscripts/stored-procedures/db2/flow-context-cleanup/){:target="_blank"}
17+
- [MSSQL](https://github.com/wso2/carbon-identity-framework/blob/master/features/identity-core/org.wso2.carbon.identity.core.server.feature/resources/dbscripts/stored-procedures/mssql/flow-context-cleanup/){:target="_blank"}
18+
- [MySQL](https://github.com/wso2/carbon-identity-framework/blob/master/features/identity-core/org.wso2.carbon.identity.core.server.feature/resources/dbscripts/stored-procedures/mysql/flow-context-cleanup/){:target="_blank"}
19+
- [Oracle](https://github.com/wso2/carbon-identity-framework/blob/master/features/identity-core/org.wso2.carbon.identity.core.server.feature/resources/dbscripts/stored-procedures/oracle/flow-context-cleanup/){:target="_blank"}
20+
- [PostgreSQL 11.X to 17.X](https://github.com/wso2/carbon-identity-framework/blob/master/features/identity-core/org.wso2.carbon.identity.core.server.feature/resources/dbscripts/stored-procedures/postgresql/postgre-11x/flow-context-cleanup/){:target="_blank"}
21+
22+
2. Once the cleanup is complete, you can schedule a periodic cleanup task to automate future runs.

en/includes/guides/flows/build-a-flow.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -93,4 +93,12 @@ Components are the individual UI elements placed inside a step, such as input fi
9393

9494
- From the **Attribute** dropdown, select the relevant attribute. Only attributes **displayed in user profiles** are available for mapping. Learn how to [display attributes in user profiles]({{base_path}}/guides/users/attributes/manage-attributes/#configure-attributes).
9595

96-
![Components]({{base_path}}/assets/img/guides/flows/flow-builder-components.gif){: width="auto" style="display: block; margin: 0;"}
96+
![Components]({{base_path}}/assets/img/guides/flows/flow-builder-components.gif){: width="auto" style="display: block; margin: 0;"}
97+
98+
{% if product_name == "WSO2 Identity Server" %}
99+
100+
## Manage flow context data
101+
102+
Flow context records are stored in the `IDN_FLOW_CONTEXT_STORE` database table and accumulate over time. To prevent this from affecting server performance, periodically clean up the table using the provided stored procedure scripts. See [Clean up flow context]({{base_path}}/deploy/flow-context-cleanup/) for instructions.
103+
104+
{% endif %}

0 commit comments

Comments
 (0)