App Builder User Interface
Sections of the App Builder
The App Builder contains four separate sections.
General - covers basic information about the App
Data - enables the attaching of data assets that can be swapped out
Parameters - set configurable parameters that are sent as arguments to run the script
Display Result After Run - choose output files to display in the main window
General
This section allows you to set the title for the application along with a short description of the App usage. Once this section is filled out, it will include an automatic link to anyREADME.md
file contained within the capsule. It is recommended to create aREADME.md
file along with the application to help users understand the functionality of the tool, the inputs and outputs of the application, and any additional necessary information.
The example below shows the completion of the General section. This capsule plots a sine function.
This description will not appear outside of build mode until data or parameters have been added to the capsule.
Data
Data consists of any data assets that can be attached to the capsule.
The capsule should be coded using data found in the mount point of the data asset selected in build mode.
Data assets that have been attached and set up outside the App Panel in the sliding window, can be replaced or swapped out. Edit access to the capsule allows the attachment of new data assets using Managing Data Assets in the Files tab.
Attaching Data Assets to the App
You can add a Data Asset that is already attached to the capsule to this session as a default dataset.
If there is no Data Asset attached yet, you will see a reminder for attaching a Data Assets.
Click Add
Provide the information for the:
Label
Default Data
Description
Click Save
The data asset is not parameterizable via the app panel. If the capsule is a Release Capsule data assets cannot be added or removed using Managing Data Assets.
Parameters
App Panel supports three types of input parameters. The icons at the top of the Parameters panel represent each type:
Icon | Type | Functionality |
---|---|---|
Text Parameter | Enter any string or number. Input files using the file parameter are not tracked in the same manner as data assets. it is preferable to add data as a data asset when possible. | |
List Parameter | Select one value from a list | |
File Parameter | Select an existing file under /data folder or upload a file from local machine |
| |
The result of the saved text parameter. |
Swapping the Order of App Panel Parameters
Display Result after Run
This allows you to set results to display to the user after running the capsule. These are static paths, so the outputs will need to have the same name for every run.
Click on Add to add a file to display
Select a file from the drop-down. The list is from the latest run.
A reproducible run must be done in order to see available results files to display after the run.
Last updated