Generic Information
When creating a document definition in BizzStream Aero, administrators can configure various properties to tailor the behavior and functionality of the documents. The following table provides a detailed overview of these settings:
| Setting Category | Setting Name | Description | Editable After Creation? | Notes |
|---|---|---|---|---|
| Generic Information | Label | A user-friendly, descriptive title for the document definition. | Yes | Helps identify the document type. |
| Name | A unique internal identifier for the document definition. | No | Can only be set when the definition is first created. | |
| Master Data | Designates the document definition to store essential master data. | Yes | Master data documents cannot be edited via the UI; primarily for REST interactions. Relatively static (e.g., projects, employees). | |
| Expose as SQL | Enables the document definition's data to be exposed for SQL queries. | Yes | Required for creating reports and dashboards. | |
| Enable History Tracking | Enables tracking of historical changes to documents. | Yes | Can only be activated if "Expose as SQL" is also selected. | |
| Offline Cache | Offline Cache Limit | A mandatory numeric value specifying the maximum number of documents made available offline. | Yes | E.g., '5' for the first five documents. |
| Offline Cache Filter | A BizzStream expression for precise control over which specific documents are made available offline. | Yes | E.g., user = {{USER["name"]}} AND price > 10. | |
| Document Identification | Document Identifier | A BizzStream expression providing a readable label for users to recognize or identify an offline document in a queue. | Yes | Helps identify documents when users trigger actions on them offline. |
| Timestamps | Created On | Timestamp of when a document was first created based on this definition. | - | Automatically set; cannot be manually changed. |
| Last Modified On | Timestamp of the last time a document was updated. | - | Automatically updated; cannot be manually changed. | |
| Autosave | Allow Autosave | Makes it possible to allow autosave on the fields within this document definition. | Yes | - |
| Save User Action | Sets the user save action for the autosave feature. | Yes | Used mostly for just the saving action. | |
| Cooperation | Cooperation Mode | Enables the ability to use copperation mode for layouts for the end-user. | Yes | Does not work in the Setup section. |
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.
Cooperation Mode
The Cooperation Mode setting, configured in the document definition settings, functions primarily as a presence indicator within BizzStream Aero. Its main purpose is to enhance user awareness by displaying which other end-users are currently working on the same document. This feature is active for end-users within the application and does not apply to the setup section.
Key aspects of Cooperation Mode:
When Cooperation Mode is enable for the document definition the following aspects will be changed:
- User Presence Indication: End-users can see the avatars and the names of the other users who are simultaneously viewing or interacting with the same document.
- Real-time Reactivity: This feature operates with real-time reactivity, meaning user presence updates are dynamically reflected as individuals access or leave the document.
- Mobile Support: The presence indication functionality is fully supported across the mobile platform, ensuring consistency in user awareness regardless of the device.
- Saving Implications: It is important to note the behavior when multiple users are active:
- Potential for Overwrites: When a user saves changes to a document, it is possible that modifications made by other concurrent users who have not yet saved their work may be overwritten. Meaning this mode does not include an automatic merge or conflict resolution system.
- Visibility of Saved Changes: After a user saves their changes, these modifications become visible to other active users using reactivity again.
Administrators should enable Cooperation Mode in the document definitions where it is beneficial for users to be aware of each others presence, particularly in scenarios where documents are frequently accessed by multiple individuals. However, given the potential for overwrites, clear communication and established team workflows are essential when using this feature in highly collaborative editing scenarios. Without this feature the other users can no longer save the document and need to refresh the whole page or leave and access the document again.