Designing the Interface

About the Create App window

The Create App window consists of four distinct sections:

  • The section on the left side contains the different app items that can be added to your interface. To add an app item, select the one to use (hover over the object name for a brief description) and drag it into position in the middle section.
    Once dropped into a group, the properties that are available for that type are displayed in the Properties section on the right. As you add and design the argument, the Command line view section at the bottom of the window displays the commands for the object, and the middle section updates interactively to display the argument. You can also preview it to see how the whole app looks and functions.
  • The middle section is the landing place for the objects you dragged and dropped from the left section, and it updates to display how the object looks as you define it in the Details section on the right.
  • The Details section on the right displays all of the available properties for the selected item. As you customize the app in the Details section, the middle section updates dynamically so you can see how it will look and act.
  • The Command line view at the bottom contains the command-line commands for the current item's properties. As you update the properties in the Details section, the Command line view updates as well.
  • At the top of the window are icons to save the app, preview the UI or JSON script, and set the argument order.

About designing the interface

Creating a new app interface is a basic process. You'll need to know how to use the tool — the executable or binary upon which the app is based. With that knowledge, you create the interface according to how you want it to be used in the DE.

An app interface in the DE is arranged in a hierarchy of two main pieces:

  • The framework consists of one or more groups. A group creates a conceptual boundary in the interface into which you add the relevant user input settings in the order and with the field names you want, as displayed when the app is viewed in the DE. For example, many DE apps have a first panel called File Inputs.
  • Inside each group, you add those user interface objects you need to facilitate the collection of user inputs. There are a number of different user interface objects from which to select, including input file fields, selection and checkbox fields, text and numerical input fields, and output file fields.

In the following example, we see three groups, with the Select input data group, as defined by the integrator, expanded:

Helpful Links

On This Page:


Related Pages:

Next steps

See pages in this section to help you design the interface:

Unable to render {include} The included page could not be found.