Apty Client (Player)

Apty Client is the key element of the Apty Suite, which makes the navigational and instructional materials created with the Apty Studio tool visible to the end users of your hosting application. There are two ways to implement Apty Client with your application: you can install it as a browser extension in a couple of clicks or add it to the source code of the hosting application as a JavaScript code snippet. Both methods imply the same logic of injecting simple code of Apty Client to the hosting application. To learn more about the use cases for each scenario, refer to this article.

Once successfully implemented, the Apty Client is displayed as a widget within the browser window of a hosting application based on the designated position defined at:

Apty Admin > select application > Customization > User Interface > Player Position.

The Apty Client widget consists of 3 basic elements:

1.   Search bar: The intelligent Search feature allows a user to filter all available instructional information by keywords and focus on relevant information only. Each Workflow and instructional element is uniquely identified within the system by its name. If an end user knows the Name of the Workflow required for performing  a specific task, they use it to search for the Workflow from this field.

Alternatively, Workflows can be searched by the descriptive keywords. Such keywords are defined by the Workflow author while creating it in the Apty Studio.  For example, for the Workflow describing the procedure of editing customer address, a Workflow author may add keywords like: "customer", "address", "zip", "home address", "state", etc. 

2.   Help tab: Apty Client Help tab connects an end user wit the context sensitive instructional materials, such as: Workflows, Videos, and other resources available in the Knowledge Center. 

3.   Onboarding tab: lists procedures consisting of multiple tasks  for new users of the hosting application.

The direct functionality of the Apty Client is to launch Workflows and access content in the Knowledge Center. Apty Client also runs indirect functionality loads other key features, which are independent of the Workflows and are always running in the background like Validations, Tooltips, and Announcements.

How it works

The Apty Client is implemented as a multi-platform browser extension and is available for the majority of modern browsers. In order to fulfil this requirement the extension is designed as a very simple piece of code that injects application's JavaScript directly to the target application. This means that there is no background script and the whole Player runs directly in the context of the end application.

When the Apty Client is loaded into the application, it contacts the server via REST API and downloads the list of flows, theme settings and other data required for seamless integration. Downloaded data are cached so that the Client has no need to make multiple requests to the server to repeatedly access the same piece of information, which is a key benefit for faster performance.

Most of the application logic is focused around querying the element to which the bubble should be attached from the application UI and injecting and positioning the bubble's HTML into the page. However, the Apty Studio also allows to inject custom JavaScript into the application, which can be used to extend the normal behavior of the flows. Typical use case is implementing enhanced Validation rules of the input fields of the hosting application.

Did you find it helpful? Yes No

Send feedback
Sorry we couldn't be helpful. Help us improve this article with your feedback.