Tasks App - Create New Tasks

Last Updated: Oct 10, 2015 04:52PM PDT

Summary: Creating a new task for the Tasks app is straightforward, but the process will be different depending on whether you are developing for the cloud or an on-premise server. These instructions assume you already have some experience both developing Pipeline Pilot protocols and using the Tasks app.

Prerequisites:

  • Pipeline Pilot Client access to the server where you will develop your task.
    • If you are developing in the cloud, the server is sandbox.sciencecloud.com:443
    • If you are developing on-premise, consult your Pipeline Pilot administrator for the name of your mobile development server and its HTTPS port.
Covered Topics

Clicking a link will scroll the page to the relevant section.

Cloud Development

If you are developing for the cloud, here are some terms that are useful to know:

  • Production server – Location where a Task app can connect to run the latest released tasks.
  • Publication – The process of taking a protocol and making it available on the production server.
  • Sandbox server – A server that is available to developers for authoring and testing protocols prior to publication. 

Note: For more information about cloud-specific development and publishing, see Publishing Protocols on ScienceCloud.

Protocols, Category Folders, and Root Folders

Each task displayed in the Tasks app is implemented as a Pipeline Pilot protocol (referred to as a "task protocol" in these instructions). A task protocol is saved under a "task root folder" in the Protocols tab in the Pipeline Pilot Client. It is best to save the protocol in a subfolder of the task root folder, since the subfolders appear as categories in the mobile Tasks app, and so represent a single level of organization for the tasks. The path to a task root folder can be used to set up an account on your mobile device using the Tasks app. When you switch to that account, the category folders will be shown as categories on the home screen, and the tasks protocols will be shown as tasks within the categories.

For example, here is the folder structure for the task root folder "Protocols/Mobile/Demo", with category folder "Audio and Video" opened to show its task protocols:

 mob_tasks_protocols_mobile_demo_folder_structure.png

Go to your mobile device and switch to an account with Task Root set to "Protocols/Mobile/Demo". Your Home screen should now look something like this:

 mob_tasks_mobile_device_category.png

Note: Each child folder in the task root folder is displayed as a category on the mobile device.

Notice that the subfolders of a task root folder appear as categories on the mobile device. If you press Audio and Video to open that category, the following information is displayed:

mob_tasks_audio_and_video_category.png

Opening the Audio and Video category shows four tasks, corresponding to four task protocols on the server.

Finally, the category folders themselves are optional. Protocols placed directly into the task root folder without an intervening category folder are displayed as tasks on the Home pane.  

Note: When the app user is creating an account on a mobile device, they can actually specify multiple root folder paths for the Task Root, each separated by a semi-colon. In this case, the root folder contents are merged and the app will show categories defined by the combination of subfolders from all of the specified root folders.

Creating Your Own Tasks Root

The following task root folders are included with the Mobile Collection:

  • Protocols/Mobile/Demo – A set of demo examples.
  • Protocols/Mobile/Developer – Simple component use examples for developers.

Guidelines for Working with Task Root Folders

If you are doing development, create your own task root folder in one of the following locations:

Development type Task root folder location
Cloud Protocols/ScienceCloud/<company>/Mobile
On-premises Protocols/Mobile

Tips:

After creating the new task root folder, perform the following tasks:

  • Create any required category folders within the task root folder.
  • Save test protocols in the task root folder or in the category folders.
  • Create an account on your mobile device to use that root (see below).

Configuring an Account on Your Mobile Device

To create an account on your mobile device to use the root:

  1. Open the Tasks app.
  2. Press scloud_gear_icon.png icon to open the Settings pane.
  3. Select Add Account.
  4. Fill in the required information, including the server name and port.
  5. Set the value of Task Root to the path of your newly-created task root folder.
  6. Save the account.
  7. Go to the Home pane to see your categories and tasks.

To add the task root to an existing account:

  1. Open the Tasks app.
  2. Press scloud_gear_icon.png icon to open the Settings pane.
  3. Click on the existing account to open its configuration information.
  4. Check that the account is connected to the correct server.
  5. Edit the value of Task Root to append a semi-colon character and then the path of your newly-created task root folder.
  6. Save the account.
  7. Go to the Home pane to see your updated categories and tasks, which now include items from the new task root.

Developing Tasks Protocols (Hello World)

Writing a new mobile protocol, or re-purposing an existing protocol for mobile, is easy. Nearly all existing protocols can run as mobilized task protocols by saving them into your task root folder. If your protocol contains any of the most commonly-used viewers (for example, HTML Table Viewer, Notepad Viewer, PDF Report Viewer, etc.), when the protocol is run from Tasks, the results will appear after the task is executed.  (More precisely, any files that are left in the job directory are treated as "results" and are displayed in the app when the task completes.)

Hello World

The following instructions walk you through the steps for creating your own "Hello World" task.

Creating the task in the Pipeline Pilot client:

  1. Select File > New Protocol.
  2. Add Generate Empty Data to the new protocol.
  3. Connect a Custom Manipulator (PilotScript) component.
  4. Set Expression to:
    "text := 'hello world!'"
  5. Add a Notepad Viewer.
  6. Run the protocol to test it.
  7. Create subfolder under your task root folder named "Training".
  8. Save the protocol in the Training folder as "Hello World".

Testing the new task on your mobile device:

  1. Run the Tasks app.
  2. Go to the Settings pane.
  3. Select the account whose Task Root is your task root folder. (This is useful even if it already is configured as the current account, because re-selecting it will refresh the task list.)
  4. Go to the Home pane.
  5. Open the Training category.
  6. Run the Hello World task.

Congratulations. You just created your first task.  See related articles below for where to go next.

Related

Tasks App (Tutorials)

Documenting Your Protocol

Tasks App (Input Components)

Tasks App (Output Components)


http://assets2.desk.com/
false
desk
Loading
seconds ago
a minute ago
minutes ago
an hour ago
hours ago
a day ago
days ago
about
false
Invalid characters found
/customer/en/portal/articles/autocomplete