Uploaded image for project: 'Camunda Optimize'
  1. Camunda Optimize
  2. OPT-974 Update user guide documentation to Optimize 2.0 version
  3. OPT-1166

Document the alerting

XMLWordPrintable

    • Icon: Sub-task Sub-task
    • Resolution: Fixed
    • Icon: L3 - Default L3 - Default
    • 2.1.0-alpha1, 2.1.0
    • None
    • documentation
    • None

      AT:

      • in the alerting section of the user guide, I can read about:
        • what an alert can be used for
        • a screenshot of a defined alert
        • how to create, delete and edit an alert
        • alert modal:
          • what the notification mean when no email service is configured
          • time/report value dependence graph, which shows when the notifications are sent (when the alert triggers, resolves and sends reminders)
          • which report I can set an alert for

        This is the controller panel for Smart Panels app

            [OPT-1166] Document the alerting

            Johannes added a comment -

            Review hint:

            • I really like your diagram! Maybe you can add a horizontal line to make the threshold more clear. Which tool did you use? Is it possible to add the file in github, just in case we want to make adjustments.
            • the second sentence is a bit redundant, as you mention that in detail. So I would remove this one:

              After defining an Alert, the user will be notified via email when the value of a Number report becomes greater (or lower) than the predefined threshold.

            • again, I wouldn't use any bold or italic here.
            • the following sentence belongs to the first image and thus should be placed next to it:

              After creating an Alert you can manage it by pressing the Edit or Delete buttons next to it.

            • I don't know if that works, but we have a certain way of showing notes: see here

            Johannes added a comment - Review hint: I really like your diagram! Maybe you can add a horizontal line to make the threshold more clear. Which tool did you use? Is it possible to add the file in github, just in case we want to make adjustments. the second sentence is a bit redundant, as you mention that in detail. So I would remove this one: After defining an Alert, the user will be notified via email when the value of a Number report becomes greater (or lower) than the predefined threshold. again, I wouldn't use any bold or italic here. the following sentence belongs to the first image and thus should be placed next to it: After creating an Alert you can manage it by pressing the Edit or Delete buttons next to it. I don't know if that works, but we have a certain way of showing notes: see here

            Kyrylo Zakurdaiev added a comment -

            johannes.heinemann I used google sheets for creating the graph + google drawings for adding those points and lines. I think I can share the document via link and post here. What do you think?

            Kyrylo Zakurdaiev added a comment - johannes.heinemann I used google sheets for creating the graph + google drawings for adding those points and lines. I think I can share the document via link and post here. What do you think?

            Johannes added a comment -

            kyrylo.zakurdaiev: If you can share it then let's do it.

            Johannes added a comment - kyrylo.zakurdaiev : If you can share it then let's do it.

            Kyrylo Zakurdaiev added a comment -

            alert-notificantions-graph

            Kyrylo Zakurdaiev added a comment - alert-notificantions-graph

              Unassigned Unassigned
              johannes.heinemann Johannes
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: