Configure Data Retention

 stores data for the CA Jarvis component. Stored data includes Elasticsearch indexes and document types.
doi13
 
DX Operational Intelligence
 stores data for the CA Jarvis component. Stored data includes Elasticsearch indexes and document types.
You can configure the data retention period for stored data as follows: 
  • (Default) Change the data retention period for all tenants. This option affects all tenants and document types. 
  • Change the data retention period for specific tenants. This option affects all document types for specific tenants. 
  • Change the data retention period for specific tenants and specific document types. 
 
Required Role
: OpenShift project administrator
Configure Data Retention for All Tenants
You configure the default retention period in the DOI-Readserver container in the OpenShift project. 
Changes to the default retention period (45 days) affects new tenants. To change the data retention period for existing tenants, see Configure Data Retention for Specific Tenants and Document Types.
  1. In the OpenShift Web Console, go to the 
    DX Operational Intelligence
     project that you created when you installed the product. 
  2. Go to 
    Applications
    Deployments
    doireadserver
    .
  3. Select 
    Environment 
    to view the environment variables. 
  4. Set the value of 
    JARVIS_TENANT_RETENTION_PERIOD
     as needed. 
  5. Click 
    Save
Configure Data Retention for Specific Tenants and Document Types
To configure the data retention period for a specific tenant or set of document types, use REST API calls. 
 
Set a different retention period for 
all
 document types for a specific tenant:  
curl -v -X PATCH -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"product_id" : "ao",
"tenant_id": "<
TENANT-ID
>",
"retention_period": 25
}
' http://<
JARVIS_OPENSHIFT_ROUTE
>/onboarding/tenants
 
Set a different retention period for 
specific
 document types for a specific tenant: 
 
curl -v -X PATCH -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"product_id" : "ao",
"tenant_id": "<
TENANT-ID
>",
"retention_period": 25,
tenant_doc_type_details: [{"doc_type_id":"<
doc_type_a
>","doc_type_version":"1","retention_period":
<retention_period_in_days>
>}, {"doc_type_id":"
doc_type_b
","doc_type_version":"1","retention_period":
<retention_period_in_days>
}]
}
' http://<JARVIS_OPENSHIFT_ROUTE>/onboarding/tenants
 
Example:
 
curl -v -X PATCH -H "Content-Type: application/json" -H "Cache-Control: no-cache" -d '{
"product_id" : "ao",
"tenant_id": "MyTenant1",
"retention_period": 25,
tenant_doc_type_details: [{"doc_type_id":"itoa_metrics_uim","doc_type_version":"1","retention_period": 15}, {"doc_type_id":"itoa_alarms_uim","doc_type_version":"1","retention_period": 25}]
}
' http://<JARVIS_OPENSHIFT_ROUTE>/onboarding/tenants