Skip to content

Chat field

Communication around documents is very important, being notified about changes or additional information is key. Sending instant messages to other users to inform them can now be handled with the chat type field.


Setting Required Description
Label Yes The label is used for users of BizzStream. The label is shown in documents left to the value of the field. Labels can always be edited.
Translation key No Can be used to replace the field label with a translation. If set, BizzStream will try find the translation associated with the key set in this field. If no translation can be found, the label set in the Label field will be used.
Name Yes The name is a BizzStream system field. Once the Document Definition is persisted, this field cannot be edited anymore. Unless there are no documents based on this document definition.
Required No By checking the Required-option, you force the user to fill out the field. By not checking this option, the option to fill out the field is to the discretion of the user.
Default Subscribers No Select the access group(s) that contain the default subscribers. Default subscribers get notified when a new message appears.

Chat Field icons

After opening a chat field for the first type, BizzStream will show a notification for new messages that have been posted after you last viewed the chat field:

This chat is empty

There are messages in this chat, however you've read them all

There are 5 new messages in this chat

Permissions on Chat fields

As the chat is just field, you can use the BizzStream permission structure. For example, you may want an employee chat and an admin chat, you can set permissions to the admin chat to be accessible only to admins and to the employee chat so it can be accessible only to employees.

Subscriptons and Notifications

Users get a notification when a new message is posted in a chat stream to which they are subscribed. There are two ways in which the user can be subscribed:

  • Users who are member of one of the default subscribers access groups in the document that contains the chat field are automatically subscribed. Note: BizzStream checks the access groups in the document itself for membership and not the default access group members set in the document definition.
  • The user opens the chat field and selects the Subscribe checkbox. By checking and unchecking a checkbox, a user can determine whether he wants to (continue) seeing notifications when a new chat message is posted.

The notification of new messages comes in the form of an icon that is located next to the user's avatar. When you click on the icon, a window will open with an overview of all the documents that contain unread messages.

There are new messages for you

When you click on this link, BizzStream will open the document using the first document page layout in the menu that:

  • Belongs to the document definition that contains the chat field
  • Contains the chat field that was used to post the message