Version History Best Practices for WorkPoint Business Modules

Version history is an important part of a WorkPoint solution. WorkPoint uses version history when processing entity changes through webhooks, as previous versions are used to determine the values of an entity before a change.

For this reason, version history must remain enabled on WorkPoint Business Module lists. However, it is equally important that version history is configured with an appropriate maximum limit.

Business Module lists should never be configured with unlimited version history

When configuring a WorkPoint solution:

1. Enable version history on all Business Module lists.
2. Always configure a maximum number of versions.
3. Never configure Business Module lists with unlimited version history.
4. Use the WorkPoint default version limit of 50, unless there is a documented requirement for a different value.
5. Include versioning settings as part of the standard solution configuration and regular health checks.

When deciding whether a different version limit is required, consider:

• How frequently entities are updated
• How many entities the Business Module contains
• Storage consumption
• Customer retention requirements
• Audit or compliance requirements

A higher version limit should be a deliberate solution decision based on customer requirements rather than leaving version history unlimited.

Version history is required, but unlimited version history is not.

Configure a maximum version limit on all WorkPoint Business Module lists. The WorkPoint default is 50 versions and should be used unless there is a documented requirement for a different limit.

This ensures that WorkPoint has the version history required to retrieve previous entity values when processing changes, while preventing unnecessary version history from accumulating over time.