Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 5 Next »

image-20240502-095716.png

Getting started

Utilizing the chat functionality is an out-of-the-box experience, with a few requirements to begin.

  1. Start by downloading the module from the Marketplace.

  2. Then, download the dependencies as mentioned in the 'Dependencies' section.

  3. Add the 'ASU_Websockets' microflow to your main application after startup microflow.

  4. Configure the security settings as per your requirements.

  5. Finally, add the snippet 'SNIP_Chat_And_Channel' to your desired page, and you're all set to go!
    -> Add full example (with chat context) (so -> create chat, etc.)

    image-20240503-065236.png

    6. optional → tailerfit/configure you chat experience → screenshot is outdated now

image-20240502-095431.png

Dependencies

  • Bizzomate websockets

  • Encryption (Optional: references to this module can be deleted when encryption is disabled)

  • Icons (Optional: can be replaced with your own icons in the snippets)

    • Icon collection Atlas

    • Icon collection Atlas_Filled

Module roles suggestions

The module offers various module roles that can be assigned to user roles according to your preferences. To be able to chat you’ll need the user role: ReadWrite_OwnChats. From there you can add additional privilages as needed:

  • Actions_CreateNewChats

  • Actions_DeleteOwnChats

  • Actions_WriteOwnAvatar

  • Actions_WriteOwnUsername

There are also some admin privilages:

  • Read_AllMessages - Like the name implies, you’ll be able to read all messages of all users

  • Read(Write)_AllOtherData - This is all non message data. It’s a useful for admins to allow them to read and write data that is not AVG sensitive.

  • Config - Useful for Administrators (e.g. manage scheduled events)

image-20240502-095855.png

License

Experimenting with the Chat widget locally on your PC or within a Mendix sandbox environment doesn't require a license. However, a license is required for a production build.

Additionally, a license is unnecessary when the app is in production but the Chat widget isn't utilized on any pages. In such instances, you can merely provide an empty variable or constant.

license.png

  • No labels