Generic Information

When creating a document definition in BizzStream Aero, there are several generic properties that an administrator can configure to tailor the behavior of the documents. These properties include the name of the document definition, whether it contains master data, its availability for analytics, and whether history tracking should be enabled for the documents.

Master Data

Document definitions of the type master data serve a crucial role in defining documents that store essential master data. Unlike regular documents, master data documents cannot be edited through the BizzStream Aero user interface. Instead, external systems interact with them through REST calls. Master data documents typically remain relatively static over time and represent key actors within a business process. Examples of master data documents include projects, resources, employees, locations, products, and more.

Expose as SQL and History Tracking

BizzStream Aero empowers users to create insightful reports and dashboards based on documents. To enable this functionality, a document definition must be marked as Expose as SQL. Additionally, for historical reporting purposes, the Enable History Tracking checkbox should also be selected. It’s important to note that Enable History Tracking can only be activated if the document definition is set to Expose as SQL. This ensures that document data is available for analytics and historical reporting.

Offline Cache

If the offline functionality is required for a document definition, it can be easily configured. The Offline Cache Limit is a mandatory setting for offline functionality. By specifying a numeric value for the cache limit, such as five (5), the first five documents will be made available offline for users.

For more precise control over the offline documents, administrators can define a cache filter using the Offline Cache Filter property. This filter allows the selection of specific documents that need to be accessible offline. For example, an offline cache filter could be defined as user = {{USER["name"]}} AND price > 10, where price is one of the fields in the document definition. The user field, being a common element, does not require further explanation.

Whenever users trigger actions on offline documents, the document will be placed in a queue. Under Document Identifier you can use a BizzStream expression to provide a readable label for the user to recognize or identify the document by.

For additional information on offline functionality, you can refer to the background information provided.