{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"section","parameters":{"macroParams":{},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Section"}}},"content":[{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"cxhtml":"65%

Each app in the DE is built on one tool (executable or binary), but each tool can have more than one app interface. You can create your own app interface, or workflow based on a sequence of different apps, for the tool you want, right within the DE, using the WYSIWYG (What You See Is What You Get) interface. This interface allows you to drag and drop items into the interface.

If you're new to this process, you may want to watch the YouTube video, Creating and Modifying Apps: Customizing your tools.

Step 1: Complete the steps for Dockerizing your tool for use in the DE

All tools are now Dockerized so they run faster and more efficiently in the DE. For instructions on how to do so, see . For steps on creating a new tool or requesting installation of a new tool, see NEED

Step 2: Decide how you want to create the app and open the Create Apps window

Before you begin, you might want to to see if the tool (executable or binary) you want to use for your app interface is available in the DE. If the tool or tool version you want to use is not listed, you must first .

The first step in creating a new app interface for an available tool is deciding which method you want to use to create the interface. There are three ways in which you can create an interface for a tool that is available for use in the DE:

Copy and edit an existing app: This method is useful if you want to create a similar app based on the same tool or if you want to see how someone else created theirs.
Edit an app in your Apps under development folder: Use this method to change settings for an app you created that is still in your Apps under development folder (because it has not yet been shared, you can still edit it). This is a useful way to create different variants of your app for different uses, as well as fine-tune or change settings and layout.
Create a new app from scratch: This method allows you to create an app from the beginning with no preconceived notion.
You also can "jump-start" your new app by clicking to select the tool name in the window.

To learn how to use each of these methods, see .

Step 3: Select the tool

Select the tool and version to use and then enter the app's name and description. For more information, see .

Step 4: Design the interface for your app

This is the meat and potatoes of creating the app interface. There are a number of different field types you can add to the interface. You can customize field names, specify the number and type of input files, add descriptive text, and much more. As you move through the process, it is a good idea to preview the app and test it out to make sure it's doing what you want to do and looking how you want it to look. Remember to save frequently. Once saved, your app is available in your Apps under development workspace folder, where you can edit it at any time. For more information, see .

Step 5: Test the app

Once you've finished designing and saved the app, it is immediately available in your Apps under development folder. From there, you can test it — see how it works, which fields are required, how it functions — and then edit it some more if you like and try it out on some analyses. In short, this is the time to put yourself in a new user's shoes and make sure your app is useful to users and a good example of your work.

Remember: Once you've shared the app, you won't be able to edit the app again; you can at any time. Now's the time to make sure it really works and works well.

Step 6: Share your app

After you're sure the app is the way you want it, you can publish it and create the user manual page to help CyVerse users learn how to use it, or keep it unpublished and share it with selected users.

Need assistance?

If you have problems or need assistance, you can right within the DE.

","nestedContent":{"type":"doc","content":[{"type":"bodiedExtension","attrs":{"extensionType":"com.atlassian.confluence.macro.core","extensionKey":"column","parameters":{"macroParams":{"width":{"value":"65%"}},"macroMetadata":{"schemaVersion":{"value":"1"},"title":"Column"}}},"content":[{"type":"paragraph","content":[{"text":"Each app in the DE is built on one tool (executable or binary), but each tool can have more than one app interface. You can create your own app interface, or workflow based on a sequence of different apps, for the tool you want, right within the DE, using the WYSIWYG (What You See Is What You Get) interface. This interface allows you to drag and drop items into the interface.","type":"text"}]},{"type":"paragraph","content":[{"text":"If you're new to this process, you may want to watch the YouTube video, ","type":"text"},{"text":"Creating and Modifying Apps: Customizing your tools","type":"text","marks":[{"type":"link","attrs":{"href":"http://www.youtube.com/watch?v=yTcqH-6wB-Q&feature=em-uploademail"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Step 1: Complete the steps for Dockerizing your tool for use in the DE","type":"text"}]},{"type":"paragraph","content":[{"text":"All tools are now Dockerized so they run faster and more efficiently in the DE. For instructions on how to do so, see ","type":"text"},{"text":"Dockerizing Your Tools for the CyVerse Discovery Environment","type":"text","marks":[{"type":"link","attrs":{"href":"https://cyverse.atlassian.net/wiki/spaces/DEmanual/pages/242027007"}}]},{"text":". For steps on creating a new tool or requesting installation of a new tool, see NEED","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Step 2: Decide how you want to create the app and open the Create Apps window","type":"text"}]},{"type":"paragraph","content":[{"text":"Before you begin, you might want to ","type":"text"},{"text":"search the list of available tools","type":"text","marks":[{"type":"link","attrs":{"href":"https://cyverse.atlassian.net/wiki/spaces/DEmanual/pages/242027031"}}]},{"text":" to see if the tool (executable or binary) you want to use for your app interface is available in the DE. If the tool or tool version you want to use is not listed, you must first ","type":"text"},{"text":"request that the tool be installed","type":"text","marks":[{"type":"link","attrs":{"href":"https://cyverse.atlassian.net/wiki/spaces/DEmanual/pages/242027036"}}]},{"text":".","type":"text"}]},{"type":"paragraph","content":[{"text":"The first step in creating a new app interface for an available tool is deciding which method you want to use to create the interface. There are three ways in which you can create an interface for a tool that is available for use in the DE:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Copy and edit an existing app:","type":"text","marks":[{"type":"strong"}]},{"text":" This method is useful if you want to create a similar app based on the same tool or if you want to see how someone else created theirs.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Edit an app in your Apps under development folder:","type":"text","marks":[{"type":"strong"}]},{"text":" Use this method to change settings for an app you created that is still in your Apps under development folder (because it has not yet been shared, you can still edit it). This is a useful way to create different variants of your app for different uses, as well as fine-tune or change settings and layout.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Create a new app from scratch:","type":"text","marks":[{"type":"strong"}]},{"text":" This method allows you to create an app from the beginning with no preconceived notion.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"You also can \"jump-start\" your new app by clicking to select the tool name in the ","type":"text"},{"text":"Manage Tools","type":"text","marks":[{"type":"link","attrs":{"href":"https://cyverse.atlassian.net/wiki/spaces/DEmanual/pages/242027157"}}]},{"text":" window.","type":"text"}]}]}]},{"type":"paragraph","content":[{"text":"To learn how to use each of these methods, see ","type":"text"},{"text":"Creating, Copying, and Editing DE Apps","type":"text","marks":[{"type":"link","attrs":{"href":"https://cyverse.atlassian.net/wiki/spaces/DEmanual/pages/242027138"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Step 3: Select the tool","type":"text"}]},{"type":"paragraph","content":[{"text":"Select the tool and version to use and then enter the app's name and description. For more information, see ","type":"text"},{"text":"Selecting the Tool and Naming the App","type":"text","marks":[{"type":"link","attrs":{"href":"https://cyverse.atlassian.net/wiki/spaces/DEmanual/pages/242027119"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Step 4: Design the interface for your app","type":"text"}]},{"type":"paragraph","content":[{"text":"This is the meat and potatoes of creating the app interface. There are a number of different field types you can add to the interface. You can customize field names, specify the number and type of input files, add descriptive text, and much more. As you move through the process, it is a good idea to preview the app and test it out to make sure it's doing what you want to do and looking how you want it to look. Remember to save frequently. Once saved, your app is available in your ","type":"text"},{"text":"Apps under development","type":"text","marks":[{"type":"strong"}]},{"text":" workspace folder, where you can edit it at any time. For more information, see ","type":"text"},{"text":"Designing the Interface","type":"text","marks":[{"type":"link","attrs":{"href":"https://cyverse.atlassian.net/wiki/spaces/DEmanual/pages/242027107"}}]},{"text":".","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Step 5: Test the app","type":"text"}]},{"type":"paragraph","content":[{"text":"Once you've finished designing and saved the app, it is immediately available in your ","type":"text"},{"text":"Apps under development","type":"text","marks":[{"type":"strong"}]},{"text":" folder. From there, you can test it — see how it works, which fields are required, how it functions — and then edit it some more if you like and try it out on some analyses. In short, this is the time to put yourself in a new user's shoes and make sure your app is useful to users and a good example of your work.","type":"text"}]},{"type":"paragraph","content":[{"text":"Remember: Once you've shared the app, you won't be able to edit the app again; you can ","type":"text"},{"text":"edit the user manual","type":"text","marks":[{"type":"link","attrs":{"href":"https://cyverse.atlassian.net/wiki/spaces/DEmanual/pages/242027073"}}]},{"text":" at any time. Now's the time to make sure it really works and works well.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Step 6: Share your app","type":"text"}]},{"type":"paragraph","content":[{"text":"After you're sure the app is the way you want it, you can","type":"text"},{"text":" ","type":"text"},{"text":"publish it","type":"text","marks":[{"type":"link","attrs":{"href":"https://pods.iplantcollaborative.org/wiki/display/DEmanual/Sharing+your+App+or+Workflow+and+Editing+the+User+Manual#Publish"}}]},{"text":" ","type":"text","marks":[{"type":"link","attrs":{"href":"https://pods.iplantcollaborative.org/wiki/display/DEmanual/Sharing+your+App+or+Workflow+and+Editing+the+User+Manual#Publish"}}]},{"text":"and create the ","type":"text"},{"text":"user manual","type":"text"},{"text":" page","type":"text"},{"text":" to help CyVerse users learn how to use it, or keep it unpublished and ","type":"text"},{"text":"share it with selected users","type":"text","marks":[{"type":"link","attrs":{"href":"https://pods.iplantcollaborative.org/wiki/display/DEmanual/Sharing+your+App+or+Workflow+and+Editing+the+User+Manual#ShareApp"}}]},{"text":".","type":"text"},{"text":" ","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Need assistance?","type":"text"}]},{"type":"paragraph","content":[{"text":"If you have problems or need assistance, you can ","type":"text"},{"text":"submit feedback","type":"text","marks":[{"type":"link","attrs":{"href":"https://cyverse.atlassian.net/wiki/spaces/DEmanual/pages/242026995"}}]},{"text":" right within the DE.","type":"text"}]}]}],"version":1},"reason":"A column macro in a rich body macro can't be created or edited in the new editor."}}},{"type":"extension","attrs":{"extensionType":"com.atlassian.confluence.migration","extensionKey":"legacy-content","text":"","parameters":{"cxhtml":"35%

WhiteSmokeSteelBlueHelpful Links1pxWhite

On this page:

Prerequisite pages:

In This Section:

Creating a New App Interface