4.4
This topic identifies how the application template information is organized and the available fields and functions available when creating or editing an application template.
On the Application Templates page, click CREATE APPLICATION TEMPLATE or click on an application template name in the list to open the Create/Edit Application Templates page. The following is an example of the Create Application Template page. This page displays if you clicked CREATE TEMPLATE. If you clicked on an application template name, the page displays as Edit Application Template.
|
|
Click to enlarge |
In this topic:
- 4.4.1 Page Actions and Navigation - Provides information about navigating the Template Details page.
- 4.4.2 Application Template Name – Identifies the name for the application template.
- 4.4.3 Application Template Type - Identifies the type for the application template.
- 4.4.4 Template History - Identifies the version for the application template. Provides information on saving a template as a new view version, viewing a template's history, and reverting to previous template versions.
- 4.4.5 Available Fields – Provides information on the available fields and how the fields are organized.
- 4.4.6 Field Information and Actions – Provides a general explanation of the field functions; including how to show or hide fields.
- 4.4.7 Application Template Permissions – Provides information on how to restrict the users who have access to this application template.
- 4.4.8 Published/Unpublished Application Template – Provides information regarding the difference between published and unpublished application templates.
- 4.4.9 Job Submission Script – Explains how to access and use the Script Builder window to manage the job submission script for the application template.
4.4.1 Page Actions and Navigation
These buttons let you perform actions on this page:
- EXPORT TEMPLATE – Export the current template for use.
- SAVE TEMPLATE – Save any changes made to the current template.
- SAVE AND CLOSE – Save any changes made to the current template and return to the Template Page.
At the right of the page there are two floating buttons that can be pressed to navigate to the top and the bottom of the page.
Click 
to navigate to the top of the page.
Click 
to navigate to the bottom of the page.
4.4.2 Application Template Name
The name of the application template appears towards the top of this page. Using the example in this topic, the application template title is "Untitled Application Template". The application template name is displayed in the application template list shown in the Application Templates page.
To edit the template name, click on the name label and enter the desired name.
4.4.3 Application Template Type
Directly under the application template name, you can specify the template type. To choose, select one of the options from the drop-down menu. The available template types are:
- HPC Application
- Job Array
- Remote Visualization
- Nitro Application
When editing an existing application template, you can modify the template to create job arrays by changing the template type to Job Array.
To the right of the template type drop-down, you can provide a version description. To specify your version, click inside of the version description box, and edit it accordingly.
Every time a template is saved, a new version is created. When a template has been saved at least once since it's initial creation, a new button appears in the editing field labeled HISTORY. The following image is an example of an application template header after it has been saved at least once.
|
|
Click to enlarge |
To view the template history, click on the HISTORY button (which is only visible if the template has been modified). A window will open displaying details on each of the changes made to the template.
You can edit the description of a template version by clicking on the description of the version you wish to change.
|
|
Click to enlarge |
From this menu, you can choose any of the following options:
- Restore a previous version of the template by clicking the
icon. - Delete a template version by clicking the
icon. - Export a template version by clicking the
icon.
The available fields used for creating/editing application templates are grouped into five areas. Specifically:
- 4.4.5.A Application Description
- 4.4.5.B Basic Settings
- 4.4.5.C Advanced Settings
- 4.4.5.D Node Policy Settings
- 4.4.5.E Custom Settings
Expand an area to view its fields. This section provides information on these different areas and their associated fields. See 4.4.6 Field Information and Actions for information on using the fields.
4.4.5.A Application Description
This area allows you to provide a description for your application template. Use this area to tell users any necessary information to use or access this template. This field provides multiple options for styling and formatting, among other ways to make your description more detailed.
The following image shows the Application Description area.
|
|
Click to enlarge |
This area, as well as the Advanced Settings area, contains Moab-specific input for the job. If the template will be used for creating job arrays, the Basic Settings area also specifies starting and ending job indexes.
This area breaks the basic setting information into functional groups. The information will also be grouped similarly on the Job Details page.
The following images are examples of the functional groups.
- Basic Job – contains settings for basic information like the name assigned to jobs created with this template and the submission script used to submit jobs.
- Time Management – contains delay start and job duration settings.
Click to enlarge
- Credentials – settings for specifying job ownership, resource usage, policy enforcement, etc. For more information, see 1.1 Credential Overview.
Click to enlarge
- Resources – contains architecture, memory, and core settings.
- Data Management – settings for job execution directory, output, and error reporting. Check the Use execution path box to use the execution path for the output path or error path.
Click to enlarge
|
|
Click to enlarge |
If the Template Type for the application template is set to Job Array, the Basic Settings area also contains settings for job indexes.
|
|
Click to enlarge |
|
|
Click to enlarge |
This area contains advanced inputs that can be requested to Moab for the job such as whether to include Moab environment variables at job submission time. You can also define job environment variables that can be used when creating submission scripts.
The following image is an example of the Advanced Settings area.
|
|
Click to enlarge |
When enabled, the User Priority field requires the Moab ENABLENEGJOBPRIORITY server parameter set to "TRUE". This Moab parameter should have been set when Viewpoint was installed. See Moab Parameters in the Moab Workload Manager Administrator Guide for more information on this parameter.
This area contains policies that can be requested to Moab for the job such as whether to include Moab environment variables at job submission time.
The following image is an example of the Node Policies Settings area.
|
|
Click to enlarge |
This area lets you add any custom settings to a template.
|
|
Click to enlarge |
4.4.6 Field Information and Actions
This section describes the different information and actions available for the fields in the Basic Settings, Advanced Settings, and Custom Settings areas of the application template.
- Label – User-friendly name shown for the field on the Create/Edit Job page. This is typically similar to the variable name.
- Variable Name – Actual name of the variable widget that will contain the user’s input. For Basic and Advanced Settings areas, this is the Moab variable for that field and cannot be changed. For the Custom Settings area, this variable can be any name that does not conflict with a Moab input variable. See 4.4.9 Job Submission Script for a list of Moab variable widgets.
- Default Value – Lets you specify a default value that will be used when creating/editing a job. Depending on the type of variable for this field, this can be a selection list, a drop-down to select a date/time, or a space to write in the value. If it is a date/time or write-in value, leave this empty if you do not want to assign a default value to the widget's variable and input fields.
- Enabled, Visible, Editable check boxes – These three check boxes control if and how fields are used in the application template.
- Enabled – When checked, this field is activated; meaning that this information is reported. At this time only two fields (Job Arrays and User Priority) require activation. If Job Arrays is enabled, then only job arrays can be created using this application template. If User Priority is enabled, users are able to make changes to the user priority information for the job (this option requires additional configuration, see 4.4.5.C Advanced Settings).
- Visible – When checked, this field will be displayed on the Create/Edit Job page. This check box requires the Enabled check box, if present, to be checked.
- Editable – When checked, users can provide information for this field when creating/editing a job. This check box requires the Visible check box to be checked.
4.4.7 Application Template Permissions
In addition to being able to restrict which fields the user may see or edit, you can also restrict who has access to the application template itself. This is done using the Permissions area at the top right of the page.
The following image is an example of the Permissions area.
|
|
Click to enlarge |
Using this area you can restrict access by:
- Users. In the Users field, type the IDs of the users. Viewpoint will check if the users you added are valid; that is, has a valid operating system account. If the user is valid, the user name turns green; otherwise it turns red. Use "ALL" to remove restrictions.
- Group associations. In the Groups field, type the IDs of the groups. Viewpoint will check if the groups you added are valid; that is, has a valid operating system account. If the group is valid, the group ID turns green; otherwise it turns red. Use "ALL" to remove restrictions.
- Account associations. In the Accounts field, select from the available accounts listed in the drop-down. Leave blank to remove restrictions.
4.4.8 Published/Unpublished Application Template
Viewpoint also lets you configure whether this application template is available (published) for use.
When an application template is marked "Unpublished" only the creator of the application template or template admins can view/edit the application template; regardless of the Permissions settings. In addition, the application template does not appear in the application templates list when a user creates a job.
On the Create/Application Template page, under the "Permissions" area, select the appropriate radio button for the publish status.
You can also change the publish status directly from the drop-down menu in the Application Templates page. See 4.1.3 Additional Functions.
Viewpoint provides a Submission Script widget on the Application Template Details page (in the Basic Job Settings area). This widget provides a Script Builder window where you can create/edit, upload, or export the script information.
In order for users to submit jobs using the application template, the application template must have a defined job submission script. As with any field in the application template, you can choose whether to make the script visible and editable by the user when creating a job.
Click Customize Script (located in the Default Value area in the Submission Script field) to access the Script Builder window.
The following image is an example of the Script Builder window.
|
|
Click to enlarge |
Using this window you can:
- Create/edit a script.
- Add/edit the lines for the script in the left pane.
- You can drag and drop the available variables from the right pane into the left pane. Hover the mouse over the variable to view its description. The right pane includes Moab inputs, Moab environment variables, and job environment variables defined in the Advanced Settings area. When used in the script, the variables shown in the right pane are highlighted and the number of times the variable is used in this script is displayed.
- From inside the left pane, click Ctrl+Space to access to a list of variables. You can select the variables directly in this list instead of having to drag them from the right pane.
- Click DONE EDITING to save the script and close the window.
- Add/edit the lines for the script in the left pane.
- Import an existing script. You can import a script from your local computer or from your RFS.
- Export the script. Exporting a script lets you export a copy of your script to your RFS. Then you can import the script for a additional application templates to use.
Related Topics