User Guide: Add-In - Activity Progress Banner

Add-Ins Overview

The Cireson Service Manager Portal Add-In feature is a location for pre-packaged solutions. Simply toggle a solution on, and it is active. Toggle any solution off if you no longer wish to use it. This approach allows for a streamlined, no-code approach to extensibility in the Cireson Service Manager Portal.

Note: For information about the Service Manager Portal Add-In feature and installation process, view the overview article here.

 

Activity Progress Banner Download Link

The latest version 1.4.0 of this Add-In can be downloaded here.

Note: This version of the Add-In is built and tested against version 10.2.0 of the Cireson Portal. It is recommended you are using that version or higher with this Add-In

 

Activity Progress Banner Summary

The Activity Progress Banner Add-In allows organizations to see the progress of a SR, CR, or RR in the form of a banner at the top of the page based on the Activity Title or Stage.

Each setting for the Add-In is as follows:

Key Description Default Value TitlesOrStagesThis can be set to "Titles" or "Stages" and will determine what is shown on the banner for the Activity
"Titles" will show the Activity Title
"Stages" will show the Activity Stage
It needs the exact value of "Titles" or "Stages", if it is given any other value, you will get no banner.TitlesShowOnSRSetting this to true will show the banner for Service RequeststrueShowOnCRSetting this to true will show the banner for Change RequeststrueShowOnRRSetting this to true will show the banner for Release RecordstrueCheckMarkColorColor of the check mark in the banner for completed Activities.#00aaffMaxCharactersSpecifies the maximum number of characters to display in the banner for each item
This is to avoid titles wrapping onto a second line and not displaying properly
If the title is truncated to meet this maximum, an ellipsis (…) is appended30CollapseActivityCountCount of activities on the Work Item at which point the Activity Banner uses Collapsed Mode
If the total number of activities on the Work Item is greater than this, all the but previous, current and next activity will be collapsed without a title displayed6AnalystOnlyShow the Activity Banner only for Analysts
Setting to false will show it for everyonefalse

 

Testing and Validation

  1. If experiencing issues, refer to KB Article 2568 here for overall Add-Ins troubleshooting steps
  2. Run through the Add-In’s functionality with default settings.
    1. Verify the following:
      1. In the developer console (open up a browser > dev tools > console), you see that the Activity Progress Banner Add-In is loaded
      2. Verify that the Activity Titles are showing in the banner for SR, CR, and RR
      3. There is a white check mark in the banner for a completed Activity
      4. The maximum number of characters displaying for each Activity Title is limited to 20
  3. As you change settings, go through the above again with browser console open
    1. Verify no error messages
    2. Verify your changed settings behave as expected

 

Examples

Activity Progress Banner on a Service Request

 

The Activity Progress Banner matches the Activities

 

Check Mark Color

 

Note: The color can be respesented by a css color eg red or purple, rgb value eg rgb(136,22,189) or a hex value eg #8816bd.

 

Max Characters

 

Collapse Activity Count

 

Versions

Version Release Notes Link1.1.0First ReleaseDownload1.2.0IE Support AddedDownload1.3.0Auto Colapse Mode Added 1.4.0Analyst Only Setting AddedDownload