Modal Windows in Service Portal

Modal windows in Service Portal are based on the BootstrapUI directives. For further documentation see: https://angular-ui.github.io/bootstrap/#/modal

Below is a simple example of how to open up a modal window:

Controller:

HTML:

Notes:

  • Make sure the $uibModal service and $scope is included in the controller.
  • In this example the modal template is just included in the HTML, but you could also set the “templateURL” property to an ng-template associated with this widget.
  • You can manually pass in the scope to the template using the “scope” property.

51 comments

    1. If you wish to have a separate controller for the contents of the modal, just embed another widget as the content within the modal.

      1. Thanks for the answer! I will for sure try it within a couple of weeks and write a small tutorial which I’ll link here!

  1. Hi Nathan,

    Is there the possibility to pass some arguments to the modal window? I want it’s body to change based on an argument. I tried passing an object to the c.openModal function but when I tried to log it, it always logs undefined.

    Thanks

    1. Nevermind that question Nathan, it was my bad. I can send the argument (an object). But now how can I use on the object’s properites (a String) as the content in the body of the modal window?

  2. Dear Nathan,

    First, thank you very much for your site and articles. Really valuable content!

    Then, I am trying to understand why sn portal is triggering a request as soon as I open a modal just like you have described it.

    This is the (anonymised) url of my page opening the modal

    https://my-instance-name.service-now.com/bms/bms?id=name_of_my_page&url_param_one=f12ba5ba4f4366004f32bc511310c7d6&url_param_two=de

    as soon as the modal is opened, this request is performed.
    Noteworthy imho is the resource /api/now/sp/page, the time and portal_id url parameters and the fact that the url of my page is repeated twice.
    The content is some json containing quite some stuff about my page/portal (81kB)

    https://my-instance-name.service-now.com/api/now/sp/page?id=name_of_my_page&url_param_one=f12ba5ba4f4366004f32bc511310c7d6&url_param_two=de&time=1479727550061&portal_id=daca4c67378ce20003271d8643990e18&request_uri=%2Fbms%2Fbms%3Fid%3Dname_of_my_page%26url_param_one%3Df12ba5ba4f4366004f32bc511310c7d6%26url_param_two%3Dde

    More interesting is that this request is performed only once when the modal is opened for the first time after a fresh login. Later on, this request is no longer made.

    My problem is that upon return of this request, the ng-model of my page gets reset to its initial value, thus loosing any field changes that might have been entered prior to opening the modal.

    Any idea on what’s going on here? Why is sn portal performing this request?

  3. Hi Nathan,

    I would like to know how I can add dynamic content to the modal body.
    I look for ward to your help!

    All the best,
    Srikha

    1. Of course. On line 7 of the controller you are passing in the scope. So based on the above, whatever is on scope in the controller will also be in scope in the modal.

  4. Thanks! This is what I was looking for as a starting point. We have a long (1.5 pages in Word) license agreement to display, so it seems to make sense to put this in an ng-template instead of the widget html. I have an ng-template associated with the widget, but am having trouble getting the syntax correct to set the templateURL property.

  5. Can we use uiv modal in catalog client script. If no, then what is the alternative for GlideDialogWindow for service portal.

    1. So here is how you could do this… you’ll need to embed a widget in the item as a variable that contains the modal window code and that is listening for an event. You could then trigger the event from the catalog client script.

      1. Hi Nathan, good stuff thanks. I have same question as Malvi. I wonder if we can invoke the widget’s URL in catalog client script replacing the GlideDialogWindow?

  6. Hello I have tried to dd a modal button to a widget but i just get sort of redirected to another page. If your adding a modal to a widget that already had Client Controller script in it do you copy and paste the entire script you put or do you remove parts of it. Also in the CSS portion of it do you have to add anything ?

    1. You controller should consist of a single wrapping function, so you would just bring in the openModal and closeModal methods. No additional CSS needed.

      1. Instead of Hello, I want to pass data into the modal window , I have tried putting in variables but they never show up… Wondering do i edit the html portion, do i edit the client controller portion?

  7. Hi Nathan,

    I have a drop down variable on catalog form and I need to call a pop up on one of the drop down option onchange.

    As the jelly script will not work on service portal . Can you please let me know if we can call widget pop onChange in client script or any other alternative.

    Thanks,
    Shailesh

    1. Yes, this can be accomplished by creating a widget that is listening for the “field.change” event and adding the widget as a variable on the catalog item.

      1. Thanks for your update Nathan.
        I’m new to service portal. Can you please explain with some example.

        I have variable name:- as ‘computer’ which is having two option.
        1.mac
        2.win

        I want to configure a pop up which will come up once mac option is selected.

        Your help is very much appreciated.

        Regards,
        Shailesh

  8. Do you know the Client Controller script syntax for a show/hide text button. So instead of a modal coming up, the widget I am looking at would expand to show the additional text I pass through. Now I was able to get this to work on one widget using the html area but when i try to scale and add more show info buttons, they expand only the original more info button so I think i need to somehow dynamically pass everything thru the client controller ? Thank you in advance.

  9. Hi Nathan,

    How we can increase the size of modal dialog, rather how to add class modal-lg along with modal-dialog..

    Thanks,
    Girish

  10. I have a widget being displayed inside a modal. The widget is a clone of the approvals widget (list of item with approve/reject buttons). The modal appears with the correct approvals listed, and when I click reject, the info message that should appear at the top of the screen doesn’t. What do I need to do to allow infoMessages to appear?

    1. I have not seen this before… can you confirm that the widget generates the info messages if used directly on the page outside of the modal. It also could depend on how you’re embedding the widget, but in general the info messages should render regardless of it’s it’s embedded or used in a modal as long as the server script is being called. Feel free to email me if you’re not able to resolve: nathan.firth@newrocket.com

  11. Hi Nathan,

    Thanks for the content. It is wonderful read. I’m trying to accomplish similar thing but in the back-end admin users.

    I have a UI Action button that opens a pop-up window that loads another widget that supposed to query different tables and display values. I tried GlideDialogWindow(“widget-name”), but my widget does not work properly in the pop-up, but it works fine when you load the widget in the portal and I also, tried with GlideModal, but GlideModal does not load my widget at all…

    I was wondering if you have built similar functionality.

    Your help is greatly appreciated.
    Dave

  12. Hi Nathan,

    I am trying to open a modal popup over a popup.
    ex: when a request is submitted I get a success popup. in that popup, I have a button which will open another popup for the survey.
    I can open the modal, but it’s failing to load all the bootstraps.

    in my first modal popup i have
    TAKE A SURVEY

    for the second popup my script will be

    FeedbackX

    Please enter mandatory fields.

    Thank you for your feedback!

    I am calling my second script by
    $scope.openFeedbackModal = function() {
    showModal(‘OneClick’);
    }

    can you suggest me how can I close the first popup when I click the button and this button should enable the second popup

  13. Hi Nathan, I have somewhat of a unique situation that I may be over analyzing but could use some clarity on. I have a modal that is called from a widget just like you have described above. However, my modal contains an embedded widget. I need to pass the data from the embedded widget inside the modal back to the original calling form. How would i go about doing this? Thanks!

  14. Hey Nathan, I am using your provided example, but am getting a strange TypeError when I close the modal. The console says “TypeError: Cannot read property ‘close’ of undefined”. Any thoughts on why this is showing up? Thanks!

    1. That means you never assigned the modal to an object. In the above example, see in the controller on line 5 how we attach the modal to an object on “c”. If you did that, you will also have access to the “close” method. If you are getting an undefined error, that’s saying that object does not exist.

  15. Hello Nathan,

    I have written the below Catalog Client Script to open a PopUp Window.

    function onSubmit() {

    spModal.open({
    title: ‘Dialog Window’,
    content: ” +
    ‘Your name:’ +
    ” +
    ‘Your email:’ +
    ” +
    ‘Your message:’ +
    ” +
    ”,
    buttons: [{
    label:’Yes’, primary: true,
    },
    {
    label: ‘No’, primary: true,
    }]
    });
    }

    Can you help me to accomplish below requirements?

    1> popup window is opening without displaying form on it which i defined in “content” of spModal.
    2> how can we pass value of fields from catalog item form to spModal Popup Window?

  16. Hi Nathan, Thanks for this custom modal. I am facing some strange issue where the modal opens on first click and from the second click the BG screen fades out but modal doesn’t openup.

    I had a button in the modal, on-click of it I call the server script and immediately after response from server I close the modal. But no luck.

    Please help me solve this issue.

  17. Can you use an angular modal pop up from within regular servicenow? I tried, using an angular UI page but the angular components don’t render (showing as {{variable}}) as the controller never seems to come to life (if I put console.log statements outside and inside the controller script it never gets within).

    I’d much rather use some angular in a UI page than go back to the convoluted jelly method

    Any thoughts?

    1. To use Angular.js in a UI page you will need to manually include the Angular.js files and set it up as a new Angular application.

  18. Nathan,

    I want to display a modal on the Service Catalog item. I have your example here in a widget and have referenced it in a catalog item as a Macro.

    The issue is that the modal does not load the first time I click on “Open Modal”. It starts working when I click the second time. It looks as if the “modalTemplate” does not exist onLoad. Do you have any thoughts on how to tackle this? Thanks for your time.

      1. Nathan,

        We tried it as a inline HTML as well as a ng-template. In both the cases, the modal does not popup the first time, it pops up only the second time when the button is clicked.

  19. I have a requirement to auto close the modal window once a record producer is submitted, as users are missing the ootb message that the ticket is submitted, heres the number and go to requests type message. How can we auto close the modal window after record producer is submitted?

    1. Modify the Instance JSON for the catalog item widget and add the following property:
      “auto_redirect”: {
      “value”: “false”,
      “displayValue”: “false”
      }
      Now instead of redirecting to the ticket page, it will trigger the following event: “$sp.sc_cat_item.submitted”. Update your modal widget to close when this event is fired.

  20. Can I open a modal window from the Servicenow Header menu? How?

    I have a custom menu called Contact and it has to pull some information from a table and display on the screen. On submit of that modal, it has to redirect to another Widget.

  21. Hi,

    Am adding a record producer in the modal, but whenever i load the modal again without refreshing the page I want the record producer fields to be empty but it is taking the values from the last request.
    Please let me know, how I can achieve this?

  22. Hi Nathan,

    This really helped me with modal implementation. Need your help on one more thing.
    On click of “Close Model” button I want to create request that means it should directly get redirect to order details page. How can I implement it?
    Thanks in advance.

    1. Yes, this should be pretty simple to do. Simple use GlideRecord to fetch the article and place it in scope and then you can display it in the modal content. Another way to do it would be to embed the kb article widget directly in the modal and pass in the sys_id via “options”

  23. I have implemented this successfully, but it is not working on a Mac running Safari. Do you know why that might be and how it could be resolved? Thanks!

  24. Does anyone know how to apply CSS to the popup? Any CSS I try to apply to the HTML inside the script tag does not render.

    Thanks!

    1. Hi Matt,

      when the modal is triggered, it is actually being added at the top of the page body which is why none of the styles seem to work since the CSS is “scoped” to just that widget’s HTML.

      To work around this, you can either use: inline styles, place the CSS inside the HTML of the widget using

Leave a Reply

Your email address will not be published. Required fields are marked *