The topic "Add the Bot to Student Portal" is not available in Version 1.0.0

Add the Bot to Student Portal

You can embed Anthology Digital Assistant in the Anthology Student Portal by adding a menu option and a custom page.

Custom pages can be added to new or existing menu groups. Custom pages need to be associated with the user's menu by enabling the menu transactions for given user roles.

Custom pages can include any type of web content such as text, links, images, and videos. The content is stored in a database table.

  1. Log in to the Portal Configuration Tool and access your campus.

  2. Navigate to Menu Groups.

  3. Right-click the Menu Group to which you want to add your custom HTML page and select New Menu Item.  Closed

    New Menu Item

  4. In the Add Menu Item form, specify the Menu Item Name.

  5. In the Menu Item Name drop-down list, select Custom HTML Page and click Add Menu Item.  Closed

  6. In the left pane, click the new item that was just created. The Menu Item Configuration page is displayed.

  7. Open another browser window and go to GitHub at https://github.com/anthology-inc/renee-integration-samples/tree/main/channels/webchat/src. You will download the src files in the following steps.

  8. If your Portal is installed locally on IIS, navigate to inetpub > wwwroot > your Portal name > Secure > Links, and create two folders named css and webfonts.  Closed

    • Download the all.min.css file from the css folder in GitHub and paste it into the css folder.

    • Download the webfonts from the webfonts folder in GitHub and paste them into the webfonts folder.

    inetpub

    alert If your Portal is hosted in a cloud environment, please contact Anthology Inc. Support (1-800-483-9106) to have the bot resources placed in the appropriate folder on the server. Ask Support for the path to those resources so that it is coded properly in your custom HTML pages.
  9. Return to the Portal Configuration tool and in the HTML Content field, paste the content of the Webchat-ui.html file from GitHub.  Closed

    menu item config

    Modify the code in the HTML Content field as follows:

    1. Since Portal expects an HTML fragment rather than a complete HTML page, remove the following tags from the code you just pasted into the HTML Content field:

      • <html>, </html>
      • <head>, </head>
      • <body>, </body>
    2. Find the iReneeBot section in the code you just pasted into the HTML Content field. Change the height value from 100% to a pixel value, e.g., 400px or any other pixel value as appropriate for your custom page.

      /* iframe size */
      #iReneeBot {
         width: 100%;
         height: 400px;
         border: 1px black solid;
      }
    3. If your custom page contains resources such as images or scripts, place those resources in the appropriate folder on your Portal server.

      Make sure the paths to those resources are coded properly. If there are errors on the custom HTML page, the functionality of the entire Portal can be impacted.

  10. Click Update Menu Item and External Link to save the custom HTML content.

    Ignore the message about tags/attributes containing non-trusted HTML.

  11. Navigate to Security Roles and select the Role that is supposed to have access to the custom HTML page (e.g., Active Student, Applicant).

  12. In the Menu Transactions and Quick Links Manager section, locate the custom HTML page, select the check boxes in the Add Menu and Quick Link columns (as applicable), and click the Update Transaction Security button.  Closed

    Security role

  13. Close all browsers and log back into Portal to get the new configuration.

  14. Select the appropriate role (e.g., Staff, Student, Applicant, Employer) and click the My Home Page link to refresh the pages.

  15. Select the new menu item for the custom HTML page and verify that the content is displayed as expected.

Check Internal Administration Portal Configuration

Before testing chat in Portal, make sure that the Internal Administration Portal is configured properly for the bot instance on the Portal page. In the Internal Administration Portal, you need to configure the following fields:

  • App Password

  • Client Secret

  • Web Chat Secret

  • Web Chat Domains (add the Portal domain)

For more information, see Web Chat Configuration.