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 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 one of your solutions to store the app under, then create
Step 2: Fill in app info
1. Click the Edit Basic Info button under your newly created app
2. Fill in all basic info fields
Select which Sector (Category) you app belongs to, or leave as Default. Apps can be viewed by Category in App Library
Give your app a good description for anyone viewing it from the App Library. Be as informative as possible.
Add How To Use steps to explain any setup requirements
Upload an image for your app logo
3. Save changes
Step 3: 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 4: Create any settings (not required)
1. Select the Settings tab
2 .Click the Add button to create a new App Setting
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: 'Inactivate Customers with no sales for X days' app would have X number of days as a setting, and each site will set this value on install)
3. See the How to use App Settings help resource for more on how to use setting values in Fusion Reports
Step 5: Test your app
1. With your app in Testing status, navitage to the App Library
2. Scroll to the bottom of the page
3. Click the Test Applications link
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. You can also see them here on any test site you may have.
Step 6: Contact Support to publish
1. Create a task through the Support portal to have your app reviewed by Encompass and published to the App Library.
2. Once published, all sites that install the app will be automatically billed through Encompass. There is a 20% app hosting fee for apps published to the App Library. The additional 80% will be credited to the app owner's Encompass account.
Step 7: Track analytics
1. Check the Analytics tab in App Manager to track metrics including total installs and total API costs.