Documentation Index

Fetch the complete documentation index at: https://help.idibilling.com/llms.txt

Use this file to discover all available pages before exploring further.

IDI version 26.8 is now available.  Click here for details: IDI Updates.

Communications – Message and Notification Storage (Cleanup and Lifecycle Management)

Prev Next

IDI uses Azure Search to index the body property of messages and notifications for full text searches. This enables rapid searching and retrieval of these items in Communications. The data contained in the search index grows exponentially as these items are created and saved to the database.

To help make storage more efficient, the IDI platform no longer stores body text for Notifications in Azure Search, and periodically purges body text for aged messages. Messages are considered aged when they’re older than an established retention period.

Note:

This means you cannot search for Notifications and aged messages by body text. Body text remains intact and is viewable when you use other search criteria.

Data Lifecycle Management for Message Body Text

IDI automatically removes body text from the Azure search index for aged messages related to Workflow, Customer Care, Tickets and Communications after a set number of days. A Body search against an aged message will return no results. Instead users will get a warning indicating body text search is not available for aged messages.

  • Retention period for message body text in search index is set to 365 days. This applies to all messages system-wide. The setting is not accessible to IDI platform users.

  • The ArchiveMessage Communications web service operation removes body text from aged messages in the Azure Search index.

  • Workflow actions find aged messages and call the ArchiveMessage web service operation to clear the message bodies from the Azure Search index.

    Note:

    These actions are set up specifically for Data Lifecycle Management. They are not intended for any other purpose and do not require configuration by CostGuard users.
    Archive Linked Workflow Messages for messages associated to Workflow instances with a completion date older than the configured retention period.
    Archive Linked Customer Messages for messages associated to customer accounts with a disconnect date older than the configured retention period.
    Archive Linked Ticket Messages for messages associated to Tickets with a closed date older than the configured retention period.
    Archive Unlinked Messages for unlinked messages not associated with other objects with a sent date older than the configured retention period.

  • Informational text in the respective applications lets users know the Body field cannot be used to search messages older than the established retention period.

Notifications Cleanup

A one-time process removes all existing notification bodies from the index. The Body field is disabled when Notifications are selected as the Type in Communications search. An information icon informs users that body searches only apply to Messages.

A screenshot of a cell phone Description automatically generated