How to display the Help Center's services as modules on your Android app?

How to display the Help Center's services as modules on your Android app?

In this help article, we will learn how to display the individual help center services as modules on the ASAP help Widget. The modules can be viewed based on their default configuration and the settings configured in your Zoho Desk portal. It's important to note that the default configuration of modules may differ depending on the edition of your Zoho Desk account.


To display the SDK Dashboard

The SDK dashboard is the screen through which end-users access your help center services. This dashboard displays icons or buttons that provide access to your Knowledge Base, Community Forums, Support Team (through the ticket submission form), tickets list (a list of tickets submitted by users who are logged in), and Chat (to interact with a customer support agent in real-time).
The SDK UI does not default to enabling the Chat module. You must first enable it on your Zoho Desk portal.
Include the following code in your chosen method to display the SDK dashboard:
  1. ZDPortalHome.show(MainActivity.this);

To display the SDK Dashboard with overridden configuration

    I    Display selected modules in the SDK dashboard

The SDK enables you to embed your preferred help center services as modules in your application, excluding the other modules.
By default, the modules will be shown based on the portal's and module's configuration. If we need to override those settings on the Android app alone, we can use the following method.

The following method displays the SDK dashboard with its configuration overridden:
  1. ZDPHomeConfiguration config = new ZDPHomeConfiguration.Builder()
        .isKBEnabled(true)
        .isCommunityEnabled(true)
        .isLiveChatEnabled(true)
        .isMyTicketsEnabled(true).build();
    ZDPortalHome.setConfiguration(config);
    ZDPortalHome.show(activity);

    II    Display individual modules without displaying the SDK dashboard

You also have the option to provide access to individual help center services as modules without displaying the SDK dashboard on your application.

The following methods help you display the individual modules with their default configuration:

SalesIQ Chat Module 

Chat provides a real-time communication channel for end-users to interact with a customer support agents.

The following method displays the Chat module:
  1. ZohoDeskPortalSalesIQ.show(activity);
activity is the activity instance that triggers the Chat module.

Knowledge Base Module

The Knowledge Base module enables end-users to access through help articles.

The following method display the Knowledge Base:
  1. ZDPortalKB.show(activity);
activity is the activity instance that triggers the Knowledge Base module.

Submit Tickets 

Submit Ticket is the screen through which end-users can submit their questions/requests as support tickets. It allows support agents to view, track, prioritize, and respond to customer tickets in one place.

The following methods display the Submit Ticket screen.
  1. ZDPortalSubmitTicket.show(activity);
activity is the activity instance that triggers the Submit Ticket module.

My Tickets 

My Tickets is the screen through which end-users can access, track, and edit their submitted tickets.

The following method display the My Tickets screen.
  1. ZDPortalTickets.show(activity);
activity is the activity instance that triggers the My Tickets module.

User Community Module 

User Community is the module through which end-users can access discussion forums and interact with other users to share knowledge.

The following method displays the User Community:
  1. ZDPortalCommunity.show(activity);
activity is the activity instance that triggers the User Community module.

Guided Conversations Module 

Guided Conversations helps end-users find answers themselves or perform a standard process without an agent's assistance by following a pre-built conversation flow.

The following methods display the Guided Conversations:
  1. ZohoDeskPortalChatKit.showGC(activity);

activity is the activity instance that triggers the Guided Conversations module.

Session Variables

These variables are dynamically retrieved during the bot conversations. These variables are org-specific and accessible across GC flows.
You can perform these actions with the session variable as mentioned:

Set Session Variable:

  1. val sessionVariables = arrayListOf(
                hashMapOf<String, Any>("name" to "YOUR VARIABLE NAME", "value" to "YOUR VARIABLE VALUE"),
                hashMapOf<String, Any>("name" to "YOUR SECOND VARIABLE NAME", "value" to "YOUR VARIABLE VALUE")
            )
    ZohoDeskPortalChatKit.setGCSessionVariable(this, sessionVariables)

Update Session Variable:

  1. val sessionVariables = arrayListOf(
                hashMapOf<String, Any>("name" to "YOUR VARIABLE NAME", "value" to "YOUR VARIABLE VALUE"),
                hashMapOf<String, Any>("name" to "YOUR SECOND VARIABLE NAME", "value" to "YOUR VARIABLE VALUE")
            )
    ZohoDeskPortalChatKit.updateGCSessionVariable(this, sessionVariables)

Answer Bot Module

Answer Bot helps end-users find answers from a bot trained on the available articles in the portal's KB module.


The following methods display the Answer Bot:
  1. ZohoDeskPortalChatKit.showAnswerBot(activity);
activity is the activity instance that triggers the Answer Bot module.


Business Messaging Module

Business Messaging helps end-users chat with agents directly or with a guided conversation flow.


The following methods display the Business Messaging:
  1. ZohoDeskPortalChatKit.showBM(activity);
activity is the activity instance that triggers the Business Messenger module.

Set Session Variables

You can perform these actions with the session variable as mentioned:
  1. val sessionVariables = arrayListOf(
                hashMapOf<String, Any>("name" to "YOUR VARIABLE NAME", "value" to "YOUR VARIABLE VALUE"),
                hashMapOf<String, Any>("name" to "YOUR SECOND VARIABLE NAME", "value" to "YOUR VARIABLE VALUE")
            )
    ZohoDeskPortalChatKit.setBMSessionVariable(this, sessionVariables)

Update Session Variable:

  1. val sessionVariables = arrayListOf(
                hashMapOf<String, Any>("name" to "YOUR VARIABLE NAME", "value" to "YOUR VARIABLE VALUE"),
                hashMapOf<String, Any>("name" to "YOUR SECOND VARIABLE NAME", "value" to "YOUR VARIABLE VALUE")
            )
    ZohoDeskPortalChatKit.updateBMSessionVariable(this, sessionVariables)

    Access your files securely from anywhere

      Zoho CRM Training Programs

      Learn how to use the best tools for sales force automation and better customer engagement from Zoho's implementation specialists.

      Zoho CRM Training
        Redefine the way you work
        with Zoho Workplace

          Zoho DataPrep Personalized Demo

          If you'd like a personalized walk-through of our data preparation tool, please request a demo and we'll be happy to show you how to get the best out of Zoho DataPrep.

          Zoho CRM Training

            Create, share, and deliver

            beautiful slides from anywhere.

            Get Started Now


              Zoho Sign now offers specialized one-on-one training for both administrators and developers.

              BOOK A SESSION









                                            You are currently viewing the help pages of Qntrl’s earlier version. Click here to view our latest version—Qntrl 3.0's help articles.




                                                Manage your brands on social media

                                                  Zoho Desk Resources

                                                  • Desk Community Learning Series


                                                  • Digest


                                                  • Functions


                                                  • Meetups


                                                  • Kbase


                                                  • Resources


                                                  • Glossary


                                                  • Desk Marketplace


                                                  • MVP Corner


                                                  • Word of the Day


                                                    Zoho Marketing Automation

                                                      Zoho Sheet Resources

                                                       

                                                          Zoho Forms Resources


                                                            Secure your business
                                                            communication with Zoho Mail


                                                            Mail on the move with
                                                            Zoho Mail mobile application

                                                              Stay on top of your schedule
                                                              at all times


                                                              Carry your calendar with you
                                                              Anytime, anywhere




                                                                    Zoho Sign Resources

                                                                      Sign, Paperless!

                                                                      Sign and send business documents on the go!

                                                                      Get Started Now




                                                                              Zoho TeamInbox Resources



                                                                                      Zoho DataPrep Resources



                                                                                        Zoho DataPrep Demo

                                                                                        Get a personalized demo or POC

                                                                                        REGISTER NOW


                                                                                          Design. Discuss. Deliver.

                                                                                          Create visually engaging stories with Zoho Show.

                                                                                          Get Started Now









                                                                                                              • Related Articles

                                                                                                              • Setting up the ASAP Help Widget on the Web

                                                                                                                Introduction The ASAP help widget for websites makes your help center easily available for your end-customers. By embedding this widget with your website, you can provide your customers with easy access to your: Customer support team (to raise ...
                                                                                                              • Introducing ASAP Android SDK

                                                                                                                This document pertains explicitly to help widgets created using the updated new ASAP Setup. Please note that if you are using an older version of ASAP, the help widgets will be read-only. To enable the new ASAP widgets on your app, use the latest ...
                                                                                                              • How to display the Help Center's services as modules on your flutter apps?

                                                                                                                In this help article, we will learn how to display the individual help center services as modules on the ASAP help Widget. The modules can be viewed based on their default configuration and the settings configured in your Zoho Desk portal. It's ...
                                                                                                              • How to install an ASAP Help Widget

                                                                                                                The ASAP (App Support Across Platforms) help widget in Zoho Desk is a stand-alone application that provides users with an in-app self-service platform. It works in tandem with your business and allows you to to integrate help center features directly ...
                                                                                                              • ASAP SDK Android - Release Notes

                                                                                                                4.0.1 If users want to use/show the chat kit (GC, BM and Answer Bot). They can also integrate the ASAP Chat Kit separately. Refer here for more details. We have removed the ASAP chat-kit bundle from the asap bundle. Integrated the latest version of ...
                                                                                                                Wherever you are is as good as
                                                                                                                your workplace

                                                                                                                  Resources

                                                                                                                  Videos

                                                                                                                  Watch comprehensive videos on features and other important topics that will help you master Zoho CRM.



                                                                                                                  eBooks

                                                                                                                  Download free eBooks and access a range of topics to get deeper insight on successfully using Zoho CRM.



                                                                                                                  Webinars

                                                                                                                  Sign up for our webinars and learn the Zoho CRM basics, from customization to sales force automation and more.



                                                                                                                  CRM Tips

                                                                                                                  Make the most of Zoho CRM with these useful tips.



                                                                                                                    Zoho Show Resources