Thank you for your feedback.
Form temporarily unavailable. Please try again or contact to submit your comments.

Widget scripting

Log in to subscribe to topics and get notified when content changes.

Widget scripting

Widgets run on both the client and server so you can get data from the database, show it to the user, and save changes with very little code.

The following image illustrates what variables are globally available in each scripting environment and how they are initialized.

Figure 1. Available Variables
Available variables in server and client script global

Client Script

  1. Everything from the server’s data object can be accessed via or $
  2. If you change a value in the data model, use server.update() to post the entire data object to the server script as input.
    Note: After calling server.update() the client script’s data object is automatically overwritten with the server’s data object.
  3. Use c.options or scope.options to see what values were used to invoke the widget. This object is read-only and making changes will not be visible in the server script.
Note: Only client scripts set with the UI type as Both or Mobile run in Service Portal.

Server Script

  1. An empty data object is initialized.
  2. Use the input or options objects to get any data that was sent from the client controller or used to initialize the widget from the server.
  3. After the server script executes, the data object is json serialized and sent to the client controller.

Additional Concepts

<input class="form-control" type="search" placeholder="Start typing here to search 
the list of catalog items" ng-model="" ng-change="c.server.update()" 
ng-model-options="{debounce: 250}" />
The search field in the example above uses 3 different angular directives:
Angular Directive Example Functionality
ng-model Automatically read and write value changes to the model variable
ng-model-options Configure how ng-model works, in this example only update the model after a user has stopped typing for 250 milliseconds
ng-change After the model value changes, execute c.server.update()


By default widgets are automatically created with an anonymous client controller function and the controller_as value of “c”. So c = the instance of the client script controller.

Calling c.server.update() will post the data object to the server script. After the server script is executed the data object is automatically updated with the new values from the server’s generated data object.


<li class="list-group-item" ng-repeat="item in">    
    <a ng-href="#">{{}}</a><span class="pull-right">{{item.price}}</span> 
If you’ve used angular before then you are already familiar with the ngRepeat directive but just in case you’re not here’s what’s going on:
  1. ng-repeat creates a template from the element it’s applied to, including child elements.
  2. For each item in an instance of that template is created and the expressions {{}} and {{item.price}} are replaced with the values from the item.