Creating an App Module

An App Module is a container for all the configuration items required to configure an extension/integration to a partner portal, adding JavaScript code and optionally connecting to an external application and pulling its data in for use:

• Service Authentication for holding credentials and security information for any external application
• Data Connectors for API calls to a target application to extract data
• Components for defining how code and extracted data will be used in the portal

This is a summary of the steps required to create a new App Module. Other articles give more information on each step.

1. Navigate to   > Settings > App Modules.

2. Click Create new App Module.

   

3. In Create new App Module, enter a name for the App Module then click Save.

4. [Optional] Define any variables that will be referenced in your Data Connector or Component code. Click Modify App Module Settings and add the variables in these fields, as applicable:

   • Global Variables - variables you want to make available to all components in the App Module
   • Test Variables - variables to be populated with actual data when you’re testing your data connection. For example, you may need to use a valid username.

   List the variables in separate rows in the fields, using valid JavaScript code.

   

5. [Optional] Navigate to the Service Authentication tab to configure the credentials and security information required to access an external application.

   For more information, see Adding Service Authentication to an App Module.

   

6. [Optional] Navigate to the Data Connectors tab to set up the API calls to an target application.

   Test the API call to ensure you’re getting the expected response.

   For more information, see Managing Data Connectors for an App Module.

   

7. Navigate to the Components tab to provide code and define how any the code and any retrieved data will be used in the portal.

   Test the component to ensure it’s giving the required functionality.

   For more information, see Adding a Component to an App Module.

   

8. When you’ve tested the data connection and its output and are happy that it is giving the expected results, toggle the Active? option to On. You may need to click Modify App Module Settings to expose the setting. This activates the app connection and any configured functionality in the partner portal.