Lesson 1

2. Widgets controller

In the Service Portal Framework, a widget is a reusable component that performs a specific function (like displaying a catalog item, knowledge article, or chart). Each widget has a controller that handles its logic and behavior.

Here’s a breakdown of the client controller’s role:

1. Interacting with the User:

The client controller receives user input from the HTML template (e.g., button clicks, form submissions).
It then processes this input, potentially performing calculations, validations, or other logic.
For instance, it might update data displayed in the widget or prepare data to be sent to the server.

2. Managing Data Flow:

The client controller uses c.server.get() to retrieve data from the server-side script, often passing an object as input to the server.
It then handles the promise returned by c.server.get(), processing the data received from the server.
It uses c.data to pass data to the HTML template for rendering.
When the user interacts with the widget and changes data, the client controller can use c.server.update() to send updated data back to the server.

3. Communicating with the Server:

The client controller utilizes c.server.get() and c.server.update() to communicate with the server.
These methods send requests to the server-side script and handle the responses.
c.server.get() is used to fetch data from the server, while c.server.update() is used to send updated data to the server.

4. Interacting with the HTML Template:

The client controller updates the c.data object with the data it receives from the server or processes locally.
This updated c.data is then used by the HTML template to render the widget’s content.
The client controller can also call functions defined in the HTML template using c.func().

Key Concepts:

c variable:

In Service Portal widgets, the c variable (often aliased as this) is used to access the client controller’s scope. It provides access to the widget’s properties and methods.
$scope variable:

While c is preferred, $scope is also available and can be used, especially when dealing with multiple scopes or needing to target a specific scope.
data object:

The data object is used to pass data between the client controller and the HTML template. The server script populates the data object, and the client controller can modify it before passing it to the template.
input object:

The input object is used to pass data from the client controller to the server script, often via c.server.get() or c.server.update().
c.server.get():

This method sends a request to the server-side script and returns a promise that resolves with the data.
c.server.update():

This method sends updated data to the server-side script.
$rootScope.$broadcast():

This method is used for cross-widget communication, broadcasting an event that can be listened to by other widgets.

Service Portal Framework

Curriculum

Lesson 1

2. Widgets controller

Leave a ReplyCancel Reply

Modal title