App Builder User Interface
Last updated
Was this helpful?
Last updated
Was this helpful?
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
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.mdfile contained within the capsule. It is recommended to create aREADME.mdfile 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.
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.
You can add a Data Asset that is already attached to the capsule to this session as a default dataset.
Click Add
Provide the information for the:
Label
Default Data
Description
Click Save
App Panel supports three types of input parameters. The icons at the top of the Parameters panel represent each type:
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
Fill in the fields:
Label (required) should inform the viewer of the meaning of this parameter, for example, Title.
Default Value (optional) is the value for the parameter for example, “Hello Code Ocean”.
Description (optional) is a brief description of the parameter, this will appear as a hover-over explanation for the information icon, for example, This sets the title for the output plots.
Click Save to create this parameter.
The result of the saved text parameter.
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.
Click on in the Parameters section to add a new Text Parameter.
Click to add a new List Parameter section.
Click in the Parameter panel to create a new file parameter section.
To swap the order that the App Panel Parameters are displayed. In Build Mode select the six ellipses . Drag and drop the Parameters into the required order.
