Hi, Is there any Documentation which describes how to use AnnouncementBannerPage methods?

[Preethihr]

com.atlassian.jira.pageobjects.pages.admin

Class AnnouncementBannerPage

I am working on this, I am not getting any proper documentation or demo codes to work with this class. Please anyone reply me if you know about usage of methods in this class.

[Earl McCutcheon · Accepted solution]

HI @Preethihr ,

Thanks for the confirmation on the platform, and while this cannot be done on the cloud platform it absolutely can be done on the Data Center platform.  You can insert and use HTML/Javascript in Announcement Banner to make changes to the application front end, However as customizations are not covered under Atlassian Support Offerings we do not have much in the form of tutorials on how to do so.

So a basic example is to simply insert a script like the following using CSS or javascript as your type:

<script type="script type here">
your script here
</script>

The code you insert into the page banner will be accessed on page load and inject the script into the page, but do use caution as it is a use at your one risk option, as it can lead to page load errors, where removing the customization is required which can only be accomplished from the database in some cases, effectively locking you out of the application front end.

As noted there are some examples given in KB articles for specific use cases, for applying UI tweaks, workarounds for bugs, or for troubleshooting purposes but no detailed breakdowns or tutorials on advanced methods some examples can be found at the following links for ideas on how to get started on building out a custom banner script:

• https://confluence.atlassian.com/jirakb/how-to-hide-elements-in-jira-using-css-or-javascript-958774526.html
• https://confluence.atlassian.com/jirakb/populate-a-field-based-on-another-field-s-content-in-jira-server-649921383.html
• https://confluence.atlassian.com/jirakb/how-to-change-text-box-length-on-a-screen-ui-in-jira-732399321.html
• https://confluence.atlassian.com/jirakb/how-to-hide-the-priority-icon-in-agile-plan-and-work-modes-705790197.html
• https://confluence.atlassian.com/jirakb/how-to-troubleshoot-client-side-problems-when-editing-an-issue-1047535975.html
• https://confluence.atlassian.com/jirakb/how-to-hide-the-export-buttons-in-jira-server-856835486.html
• https://confluence.atlassian.com/jirakb/the-announcement-banner-is-moving-all-page-content-at-least-17px-to-the-bottom-1044777068.html

Regards,
Earl

[Preethihr]

Thank you @Earl McCutcheon for all the hyperlinks. This will surely help me.

[Daniel Ebers]

Hi @Preethihr

could you please be so kind and confirm if you are using

• Jira Server
• Jira Data Center
• Jira Cloud

As Earl mentioned there is no possibility to achieve the desired on Cloud, however in your tags you stated you would be using Jira Cloud.
In your last reply you linked documentation to Jira Server - so it could be Community members cannot determine how to advise further because your deployment strategy (on-premise with Server or Datacenter 'OR' Cloud) is not clear.

Happy for any clarification.

Regards,
Daniel

[Preethihr]

Hi @Daniel Ebers I am working on Jira Data Center.

[Daniel Ebers]

Thanks for clarification. I can see Earl answered with a great and detailed follow-up which is meanwhile an accepted answer - just in case somebody else is looking for the same and reading here.

Regards,
Daniel

[Earl McCutcheon]

Hello @Preethihr ,

Adding scripted code to the announcement banner or any Jira fields is a restricted function in the Jira Cloud platform, and only available to the data Center platform, as enabling javascript injection in the UI creates a Cross-Site Scripting (XSS) vulnerability that could allow malicious users to gain elevated permissions to the system.

Some additional details can be found in:

• Functional differences in Jira Cloud products 
• Atlassian Trust Center 

Regards,
Earl

[Preethihr]

Hi @Earl McCutcheon According to Jira Documentation in link

https://docs.atlassian.com/software/jira/docs/api/7.0.9/index.html?com/atlassian/jira/pageobjects/pages/admin/AnnouncementBannerPage.html

The class AnnouncementBannerPage has methods to get and set Announcement Banners in Jira for System admins. They are not restricted for admins.

Is there any example demos of implementation of this class or any proper documentation on explaining about these?

[Dave F]

Hi @Earl McCutcheon , "For more details click here" is a common inclusion in announcement text. While I understand the XSS risk, couldn't Atlassian at least provide a field to allow admins to provide their users with a single link along with the announcement text in the banner?  The field could be validated as a genuine URL and not code easily enough, and admins could then direct their users/customers to better descriptions than they can fit into the default banner size