Skip to main content

How to create apps with custom tables

Distributor steps for building an app with custom tables in Encompass App Manager: add components and settings, test, and publish to the App Library. Needs APISolutionAdmin permission and v23.02+.

B
Written by Bailey Naas-Thornton

Minimum Version Required: 23.02

Pre-Conditions

  • Requires APISolutionAdmin permission to be able to create new apps
    ​
    ​

  • Requires a Solution Authentication for the Solution where your apps will be stored

Steps

Step 1: Create a new schema structure

  1. Contact Encompass Support to create a new Schema structure
    ​
    ​

Step 2: Create an app
​
​

  1. Navigate to the App Manager dashboard by searching "App Manager" in the universal search bar
    ​
    ​

  2. Click the Create New App button in the top right corner (*requires APISolutionAdmin permission)
    ​
    ​

  3. Give your app a name, select your solution to store the app under, then create
    ​
    ​

Step 3: Fill in app info
​

  1. Click the Edit Basic Info button under your newly created app
    ​
    ​

  2. Fill in all basic info fields
    ​
    a. Select which Sector (Category) you app belongs to, or leave as Default. Apps can be viewed by Category in App Library
    ​
    b. Give your app a good description for anyone viewing it from the App Library. Be as informative as possible.
    ​
    c. Add How To Use steps to explain any setup requirements
    ​
    d. Upload an image for your app logo
    ​
    ​

  3. Save changes
    ​
    ​

Step 4: Make custom tables

  1. Navigate to Table Map
    ​
    ​

  2. Click Create New Custom Table
    ​
    ​

  3. Expand the top menu and set the Application on the Custom Table to your Application (this must be set before saving the table for the first time to get the proper Schema prefix)
    ​
    ​

  4. Create desired columns for the table
    ​
    ​

Step 5: Attach components

  1. Select the Components tab
    ​
    ​

  2. Click the Add button and add your components to the app. This can include API commands, dashboards, reports, and import projects
    ​
    ​

Step 6: Create any settings (not required)

  1. Select the Settings tab
    ​
    ​

  2. Click the Add button to create a new App Setting
    ​
    a. App Settings are set for each site by the user on installation. They can be referenced in Fusion reports or dashboards and used to define custom values for each site where they're installed
    ​
    (Example: 'Number of days without an invoice before a customer will be inactivated' is a setting for 'Inactivate Customers with no sales for X days' app)
    ​
    ​

  3. See the How to use App Settings help resource for more on how to use setting values in Fusion Reports

Step 7: Test your app

  1. With your app in Testing status (this is the status by default), navitage to the App Library
    ​
    ​

  2. Scroll to the bottom of the page
    ​
    ​

  3. Click the Test Applications link
    ​
    a. On the Test Applications tab you can preview all Testing apps you have a Solution Authentication for and install them on your site for testing

Step 8: Publish custom tables

  1. Navigate to the App Manager dashboard
    ​
    ​

  2. Select the Schema tab
    ​
    ​

  3. Publish the Schema by clicking the cloud icon. This will auto create Schema Updates (App must be installed on current site to see this option)

Step 9: Contact Support to publish

  1. Create a ticket through the Support Pourtal to have your app reviewed by Encompass and published to the App Library.

Step 10: Track analytics

  1. Check the Analytics tab in App Manager to track metrics including total installs and total API costs.

Did this answer your question?