With Apty Assist users get easy-to-follow, step-by-step guidance that helps them quickly navigate through a Web Application resulting in a simplified learning process and full utilization of the software application saving the business both time and money.
Using Apty Assist expertise, users never waste time or energy in watching time-consuming video tutorials or pouring over manuals and FAQ pages. All the information users need is right in front of them, helping to get them where they need to go with efficiency and accuracy.
Apty is specific to each user role, needs, goals, and device; quickly and accurately adapting to any screen size and resolution. All this, without the need for any changes or integration with your software, also helps maintain your data quality by preventing users from entering bad data into the system in a unique way prompting users when a mistake is made.
Additionally, there are many other very useful features like Workflows, Validations, Announcement, Launchers, Tooltips, Permalinks, and many more which can be used to facilitate the resources' experience and accomplish their day to day tasks.
This document covers the entire features of Apty that help to enhance User Experience on any web-based application through applying Workflows, guidance, and data governance concepts to it, which consists of three main components, each exercising specific functions for seamless integration with the hosting application: Admin Console, Apty Studio, Apty Player/Widget.
- Apty Admin Console
- Apty Usage
- Manage Contents
- Manage Current Application
- System Settings
- Account Settings
- Apty Studio
- Apty Widget
Apty Admin Console
Admin Console is a web-based tool that hosts the Apty content including Workflows, Validations, Tooltips, Launchers, and Announcements, and is used for Apty Content Delivery (controlling the publishing the status of the instructional content).
The Admin Console is a cloud-based tool hosted on the AWS platform and is compliant with the latest security policies. Admin Console also hosts the Analytics to view the ROI and effectiveness of the Apty content.
Log in to Admin Console where the user can perform key functionalities such as: managing hosting applications, Apty Content, access to Analytics of tools, and element usage.
|What can you use Apty Admin Console for?|
Apty Insights transforms your usage data into tactics for improving your productivity. Apty’s AI engine continuously analyzes your usage data in real-time to help identify where users are struggling with the software and processes and how to solve the problem.
Apty’s deep learning algorithm builds upon your usage patterns as well as other companies using the same software to provide the most advanced look at how to improve your application.
The Apty Insights Admin Panel is a web-based tool that maps the Activities predefined by the Admin user in the Apty Activity Tracking and the actual actions of end-users to analyze the significance of the difference between them. It is cloud-based and hosted on Amazon Web Services (AWS).
|How do Apty Insights support you?|
Refers to a wide variety of methods for you to deliver training, support, and promotion to your users via Apty Assist.
Engagement metrices provide insights and showcase widgets containing quantitative changes which include Unique Users, Unique Sessions, Average Session Duration, and a set of graphs showing the trends for Users by Country, Device Distribution.
Activity Engagement provides visual representations of how often activities are performed by end-users, as well as how often they are completed. Each data point represents a given activity and is labelled as a respective Activity title. Activity Engagement helps in:
- having a bird-view of user engagement in all the created activities,
- easy estimation of least and most used activities (the more activity is used, the further to the right on the graph it is going to appear)
- which activates take the longest for a user to complete (the higher on the graph the activity is located, the longer it takes users to complete it)
|How Apty Engagements & Activities helps you?|
Analytics is the study of past Historical data and current data to examine the potential trends, to analyze the effects of certain decisions or events or even to evaluate the performance of any tool or situation.The goal of analytics is to improve the business by gaining knowledge which can be used to make improvements or changes. Data collected from the flows and validations will be used to show the ROI the organization can get based on the current implementation and thereby enhancing the business.
Apty Usage helps our customers to understand overall feature usage or how a specific persona is adopting your product.
Apty Usage provides a detailed analysis of how well the tool is adapted to the insights to where help was accessed to complete a certain task based on individual segments.
With the help of the Apty Analytics, you get valuable insight into how the users are interacting with the underlying application and where they are requiring maximum help or where they are making the most mistakes. This insight will help you make the most informed decisions when educating your users.
Once instructional materials in the form of Workflows, Validations, Tooltips, etc. are created and published on the hosting application, it is a high time to see whether they are helpful for end users and adapt or polish them for better performance. Various quantitative measurements provide insights on the level of user engagement, as well as overall usage of the hosting application.
Overall Apty Usage is helpful for:
- Providing quantitative measurement of User Engagement
- Identifying user roadblocks
- Reducing support and training costs
Focus on creating reports to track your most important metrics, then save them to a dashboard for convenient reporting and analysis.
The Assist Usage Dashboard gives users quick access to the latest updates on the number of used Workflows, Validations, Launchers, Tooltips, Announcements, Knowledge Center Content, and Content Search and the ratio of completed / accepted / actioned items vs dropped or not accepted ones. Apty provides a general snapshot in the form of interactive dashboards, based on the information collected from the real-time user engagement data. Read more
The best way to determine if an application has been profitable to your organization is to understand the usage of it. Analytical statistics are an invaluable functionality of Apty Assist.
The Workflow Statistics provide insights into the effectiveness of Workflows as instructional materials by showing the number of times workflows have been used, including stats for fully completed flows and flows with early exit.
- Completed Workflows: defines the number of Workflows that have been initiated and completed successfully over a course of time.
- Workflows with Early Exit: defines number of Workflows that have been initiated but were dropped on a certain step over a course of time. Read more
Apty plays a major role in warning and correcting the user to enter appropriate data. The Validation Statistics indicate the number of times Validations are executed, including stats with Data Corrections and Data Warnings.
- Data Corrections: defines number of Validation rules that have been triggered by incorrect user entries over a course of time.
- Data Warnings: defines number of Validation rules that have been displayed as warning messages over a course of time. Read more
As Tooltips provide in-place help for the end users, the Dashboard provides the statistics for Tooltips to track the usage of Tooltips based on the action performed by the end users and Tooltips available to the end users.
- Displayed: defines the number of times the Tooltips were displayed when the user visited the respective page.
- Actioned: defines the number of times the Tooltips were used to seek help over a course of time. Read more
Launchers enable administrators to create in-place actionable icons through which the users can start a Workflow, show a video or a document. Launchers are rendered when the Frame is identified by the Player from the application page. These Launchers provide in-place help whenever and wherever needed. Launcher statistics dashboard provides the stats of the number of times the Launchers are used, as well as stats for the commonly used Launchers. Read more
Announcements enable the Admin to announce any information when the end user visits the designated page. The Announcements dial shows the statistics for Announcements actioned or displayed to the end users.
- Displayed: defines the number of times the Announcement shown on the screen was displayed by the end user over a course of time.
- Accepted: defines the number of times the Announcement shown on the screen was accepted by the end user over a course of time. Read more
Permalinks are direct links to your website that automatically start a Workflow , Video or an Announcement when clicked. These links can be embedded within training resources, emails, or social media posts in order to immediately give users guidance.
If you are building Workflows targeted to users who are not already on your site, Permalinks can provide a highly effective method to engage your users or drive adoption of new features in your software. When your users click the Permalink, they will be redirected to your site, with a Workflows automatically running on the relevant page. Read more
Checklists/User Onboarding Statistics
It is designed to help users direct to some critical business processes. Each Checklist has a set of tasks inside which need to be executed successfully to complete the business process. A task can imply completing a workflow, going through some Knowledge Content such as texts files, videos, images, or opening a link to another website. Read more
Player and Search Statistics
Showcases overall analytics of user engagement of Player, which provides an idea on how much the player is useful for every actions performed through the player. and thereby helps the user to measure and improve the ways the player is being used.
- Actioned Items: displays the number of items executed in the player
- Searches: displays the number of terms searched in the player
- Widget Activations: displays the number of times the player opened. Read more
Goals are essential for a company's success. It is also critical to keep tabs on the whereabouts of goals. Not to undermine the fact that many things can go wrong when it comes to a goal involving digital adoption or any digital process completion, resulting in the goal failure. That is where Apty's Goals feature comes into play. Goals feature aims to assist you in completing a digital process correctly. It is very crucial to complete a business process on time, but it is equally important to complete it with correctness, and at Apty we understand that. Your employees complete the task, or they complete the task correctly - completion and correctness - these two are the principal determinants of Apty's Goals feature. Read more
|Learn more about Goals|
Through the Admin Console, you can effectively manage all the content that has been created. Following are the operations that can be performed in Manage content feature:
- Create/ modify/delete the content as needed.
- Add additional information for the content as documents, images, videos.
- Categorize the content using some Tags for effective flow content management.
Apty helps you to first analyze user behaviour, understand where they are struggling while using an application and then suggest workflows. Workflows provide step-by-step guidance within an application. They act like a GPS that takes you on a journey to complete your day-to-day activities. Workflows are a recommended solution in the following cases:
- a user is not familiar with the process
- a process that involves multiple steps that should be performed in a specific order
- rarely used process.
|Learn how to manage Workflows|
Apty pursues multiple goals: it navigates end users through the complex processes in the hosting application via Workflows, reminds them about important events through Announcements, provides valuable tips and tricks via Tooltips, and verifies that the data that users provide is clear and useful via Validations. The latter is achieved by adding sufficient instructions and rules on what can and cannot be accepted as input to the page of a hosting application.
Validations provide a way to test user input and ensure that the data provided by the user is clean, correct, and useful. Validation scope may be as simple as checking whether the field is empty, or provide complex checks including powerful regular expressions and custom validations.
Validations are advanced Tooltips that provide prompts whether the data entered is correct or not.
Through Admin console, user has the provision to View validations List, Add language to validations, Delete validation.
|Learn how to manage Validations|
Tooltips provide contextual information on the application to assist and inform the end users. These information icons can give you tips/suggestions or more information about anything on the page. Tooltips can provide additional information for confusing elements on the site. User will need to hover over the Tooltip icon to see the "tip"
Tooltips are optimal for users who may need additional information on demand for some of the more complex elements.
Through Admin console, user can add language to already created tooltips.
|Learn how to manage Tooltips|
Launchers enable admins to create in-place actionable icons through which the users can start a Workflow, show a video, image or a document. Use launchers when you identify a common action (on a specific page) that may not be easily accessible as it may be hidden among other available options.
Launchers are actionable icons/buttons that provide access to a specific action within one click. The stated action can be represented as one of the following:
|Lear how to manage Launchers|
Announcements are custom pop-ups designed to announce any new feature, version release, or to provide information to the end-users. An Announcement can be built with Custom buttons that can launch a Workflow, Video, or a Document and can be displayed with respect to the following conditions: specific time frame presents of certain elements on the page of the hosting application, label or field comparison, and other criteria that can be specified in the custom script.
- Inform users of upcoming features
- Inform users about the expected maintenance and downtime of the application
- Promote new Software practices, events, or services
- Remind expiration of licenses of the application, etc.
Through the Admin Console, users can add language to already created announcements.
|Learn how to manage Announcements|
Manage Knowledge Center
Knowledge Center is the repository where links to the documents, videos, images, and Q&As are stored. These items can be accessed by the users:
- as an item in the Apty Widget
- as a part of Onboarding collection of tasks,
- or as an element started by a Launcher.
|Learn how to manage Knowledge Center|
Manage Search Terms
List out all the search terms entered by the user over the results received. Admin user can edit/manage language/delete search terms inside Manage Search Terms
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.
In order to provide easy access to related content, a feature is enabled to group similar content based on labels. where user can create a label and list out the related content, Labels help you to group and categorize Workflows, Links, Images, Videos, and Texts. This will allow the user to track, filter, and sort based on a Label.
|Learn how to manage Labels|
Manage Checklists/User Onboarding
User Onboarding is a powerful tool for creating a set of tasks for new users to get accustomed to the features and procedures offered by the hosting application. The list of Onboarding tasks may consist of going through previously created Workflows or referring an end user to a piece of related Knowledge Content (such as a video or a link to an external article). User Onboarding feature acts like a tutor that guides an employee through a set of exercises necessary for completing initial training, forming consistent usage patterns of a hosting application, and helping them to focus on their key responsibilities without triggering anxiety of not being able to cope with technical specifications of the system they use.
|Learn how to manage User Onboarding|
Manage User Segments
Segmentation is a practice of assigning users to specific groups based on characteristics they share, such as role, department, division, etc.
Apty provides integration with third party applications like Salesforce, Workday, CA PPM, etc. This allows using application data (for example, user attributes like 'division', 'role' or custom ones) for segmenting content in Apty; meaning, a user with specific attributes may be shown content assigned specifically for them.
Segmentation use cases include the following:
- Shoot an enhancement or change only to the relevant audience.
- Encourage end-users who haven’t yet updated your web-app to do so.
|Learn how to manage User Segments|
Apty Player offers seamless integration into the hosted application, as well as it is highly customizable to match the look and feel of application they are laid over.
Admin Users can customize the Player according to the application's UI and/or personal preference through Admin Console.
Admins can create new themes as well as add custom CSS in the Admin portal. The newly created themes and customized CSS reflect in the application’s workflows and are applied to the exported workflows as well. Read more
If the hosting application is translated into multiple languages, Apty Player can also be customized to provide access to translated Workflows, Tooltips, and other navigation content to match the languages of the hosting application for a better user experience. Read more
Apty Assist is compliant with Voluntary Product Accessibility (VPA) including Revised 508 Standards related to the user interface requirements. Section 1194.21 (a) of the VPA Template states: "When software is designed to run on a system that has a keyboard, product functions shall be executable from a keyboard where the function itself or the result of performing a function can be discerned textually." (source) All Apty Assist functions can fully be used in a mouseless, keyboard-only mode. Read more
Time Zones page allows customizing selected applications for displaying Announcements at the appropriate time across a global organization. As employees in the organization work in different time zones, it is equally important to broadcast the information according to their specific time zone. In the context of Apty Assist instructional elements, customizing Time zones affects the choice of scheduling options for Announcements if multiple global time zones are characteristic of the way your company works. Read more
Publishing makes the items built with the apty Editor available in the Player of the development and production environment.
The Publishing state defines the content accessibility settings and results in the following use cases:
- Test your instructional content on the development/test environment.
- Publish content for end users to use in production environment.
- Organize your content the way it is displayed at the hosting application.
|Learn more about Publishing|
Manage Current Application
Apty may be connected to multiple applications that require navigational assistance, instructional materials, as well as analysis of overall usage. For example, your organization may be using a customer relationship management system like Salesforce, along with a project management system and another third-party software for helping your team to cope with their daily tasks. To add instructional tools to all of these applications, your organization requires only one instance of Apty, which will serve as a hub for all of the third-party applications you are using, including custom ones. Read more
Managing Apty Users
User Management allows system administrators to maintain users by adding/removing them. Users can also be added as a System Administrator and every user added here can also log into the Apty Studio. Following are the details that are required to add a new user
- User Active: Check the box to define whether this user account and its credentials should be active for login and other procedures.
- NAME: Define the name of a user in the system.
- USERID: Define the email for this user. Once the procedure of adding this user to the system is completed, an email with instructions on how to reset the password is going to be sent to the email of this user.
- SSO authentication only: Check SSO authentication only if you wish to login with SSO. Read more
To provide authorization for specific feature(s) of Apty, we have implemented roles. Every user will have a role and each role will have specific set of permission(s) allowing access to the respective feature(s). Role assignment must be done based on the access desired. Web services and user interfaces have been Implemented with the access restrictions. A user can also have individual application access, instead of all the applications.
Roles are a set of permissions that will help a user to perform a task successfully. Read more
Apty supports single sign-on authentication, which is a process that allows a user to access multiple applications with one set of login credentials. Apty supports 2 types of SSO Authentication: OAuth 2.0 and SAML 2.0.
OAuth 2 is an authorization framework that enables applications to obtain limited access to user accounts on an HTTP service, such as Facebook, GitHub, and DigitalOcean. It works by delegating user authentication to the service that hosts the user account and authorizing third-party applications to access the user account. OAuth 2 provides authorization flows for web and desktop applications, and mobile devices.
SAML SSO works by transferring the user’s identity from one place (the identity provider) to another (the service provider). This is done through an exchange of digitally signed XML documents. Consider the following scenario: A user is logged into a system that acts as an identity provider. The user wants to log in to a remote application, such as a support or accounting application (the service provider). Read more
To start working with Apty Studio, Administrators and instructional content creators need to install the desktop editor application available for download from the Admin Console.
To install Apty Studio, In the Desktop Editor section install both of the following:
- Application: represents the tool for creating instructional content.
- Editor Extension for Google Chrome(a component that connects a browser with the above-mentioned Application)
To install Apty Client:
The Client is a piece of code that runs instructional materials in the hosting application. Apty offers extensions for all modern browsers such as Google Chrome, Mozilla Firefox, Internet Explorer, Microsoft Edge. Read more
Branding is critical for any business to establish a loyal consumer base. Having the company’s branding consistent across all applications boosts trust and credibility in the eyes of customers and viewers. At Apty, we care about our partners’ brand. White labeling ensures that our partners get the best of Apty without compromising their brand identity.
Branding aims to provide improvement in branding and to enhance user experience to Apty partners. Read more
Inorder to provide improvement in branding of partners or clients, Custom White Labeling is also introduced.
In the wake of globalization, a brand must have the ability to translate its content automatically. Apty brings you this feature via Google API to give Auto Translation the prominence it deserves which allows Admins to translate the content within Workflows, Tooltips, Launchers, Announcements with only a few clicks. Read more
User / Account Settings can be managed through the Admin Console. Password resets can be done through the Account Settings feature. Read more
Apty Studio is a desktop native application that offers a user interface for creating / editing / deleting navigation instructions implemented as Workflows and other instructional elements, such as Announcements, Launchers, Tooltips, and Validations that are laid over the surface of a hosting app to help end users learn new procedures, or perform their daily tasks in a more effective and precise way.
Apty Studio offers a robust mechanism for identifying the web pages and starting the Workflows from the page where the end user is located. It connects to the opened window of a web browser and implements the interaction with the hosting application for which the Workflows or other instructional elements are being created, allowing picking the elements directly in the live application, displaying live bubble preview, taking screenshots for PDF documentation, etc. The logic of the extension is split into two parts:
- Content script that provides the interaction with the HTML of the hosting application (picking elements, highlighting hovered elements, reacting on scroll and navigation).
- Background script that provides advanced features like taking screenshot of the target application, filtering its web requests or listening for Chrome tabs updates (for example, for knowing about open instances of the hosting application).
User can Login to Apty Studio and create most of the instructional content which does not require any coding skills and is performed within a couple of clicks due to the intuitive user interface. The look and position of the elements added to the hosting application are previewed in the live mode.
|How does Apty Studio help you?|
Have you ever helped your friend or family member to register in a new application, complete transaction, or successfully perform any other action online? If your answer is "yes", you were probably guiding them through the process step by step and maybe explained certain tricky parts along the way. Apty Workflows do exactly the same by patiently guiding users through system settings, helping them to create new entities specific to the hosting system, and guiding them through complex daily tasks while also ensuring that no important steps are missed. Apty is there to help end users no matter the scale: instructional content can be seamlessly embedded into the enterprise applications like Salesforce through the browser extension or literally become a part of your web app by a adding several new lines to the source code of the hosting application. Read more
|Learn how to create a Workflow|
Validations represent a comprehensive set of rules for checking the data that end users provide when filling out the input fields. They are critical for ensuring that the data received from the user is correct and can be further used for other system processes. For example, if the user provided the email in an invalid format, this email address will not be a reliable source of communication with this user; therefore, if you need to share news, warnings, instructions with this user, they will not receive system messages due to invalid format of email address. Read more
|Learn how to create a Validation|
Launchers are actionable help icons / buttons that trigger predefined Workflows or redirect end users to additional useful content that can assist with completing their day-to-day tasks. Launchers can be positioned anywhere within a page of a hosting application and upon clicking on them they start a specified Workflow or its fragment, play a a Video or redirect a user to a URL which may connect a user to some educational resource, such as another application page, knowledge base article, assisting service, etc. Read more
|Learn how to create a Launcher|
Tooltips provide contextual information on the application to assist and inform the end users. These information icons can give you tips/suggestions or more information about anything on the page. Tooltips can provide additional information for confusing elements on the site. User will need to hover over the Tooltip icon to see the "tip". Read more
|Learn how to create a Tooltip|
Announcements are custom pop-ups designed to announce any new feature, version release, or to provide information to the End Users. An announcement can be built with custom buttons that can launch a Workflow, Video or Document. Announcements enable the admin to make announcements to the user when they go to the specific page. The Announcement can be for specified period and (or) when certain UI conditions are matched. Read more
|Learn how to create an Announcement|
Any enterprise-level application consists of a number of pages (login, registration, home page, etc.).
To help Apty distinguish each page from the others and place the live-guidance content elements on each screen, a page Frame should be created. For example, by anchoring username and password fields to the Login Frame, Apty will easily identify this page within the hosting application code and show all instructional elements that belong to it.
Apty uses Frames to identify each screen by using a combination of elements present on the screen. All the features provided by Apty, such as Validations, Launchers, Tooltips, Announcements can be added to the Frame which ensures that the help provided is unique to that particular page.
Any number of the Frames can be created on a page depending on the requirements.
|Learn how to Create/Delete/Publish/Unpublish a Frame|
Apty Insights functionality can be summarized in 3 main steps:
- Define how a certain use case is expected to be performed,
- let users complete the use case without assistance, then
- Compare the expected actions vs. actual user behaviour. Read more
|What data is collected by Activity Tracking?|
Key functions: providing access to the content built with Assist Studio, listening to the events, and collecting data for Insights and Analytics.
Admin users can manage the contents inside the widget by Ordering the content within a Widget, Hiding a Widget on the pages with no applicable content, Frequently Used, Favorite Contents &Group Contents based on Labels.