1 Using the JOBMANAGER GUI
2 ========================
4 Job management with the GUI
5 ---------------------------
7 This section describes the parts 1 and 2 (described in the introduction section) of the JOBMANAGER GUI
8 dedicated to the management of jobs.
10 JOBMANAGER provides some buttons to manage the user job list (see figure :ref:`figure_jobmanager_main_buttons`).
12 .. _figure_jobmanager_main_buttons:
14 .. figure:: images/jobmanager_main_buttons.png
17 **Main buttons for job management and job list**
19 The description of each button (framed in blue in the figure) is given in the table below.
21 ======================== ============================ ================================================================ ===================
22 **Button** **Condition of activation** **Description** **Multi Selection**
23 ======================== ============================ ================================================================ ===================
24 **Create** Always activated Launch the job wizard to create a job. Not matter
25 **Start** Job selected and job state Start a job. No
27 **Get Results** Job selected and job state Get job results in the result directory. Yes
30 **Stop** Job selected and job state Stop the job. If the job is registered into a remote batch Yes
31 equals to *Queued* or manager, it is removed from it.
33 **Delete** Job selected Delete a job. If the job is registered into a remote batch Yes
34 manager, it is removed from it.
35 **Restart** Job selected and job state Restart a job. No
38 **Edit/Clone** Job selected Edit a job in *created* or *Error* or *Failed* or *Not Created* No
39 state. Clone a job in other state.
40 **Refresh jobs** Always activated Update jobs states. Not matter
41 ======================== ============================ ================================================================ ===================
43 **Tip:** You could use the **Auto Refresh** button in GUI part 3 to enable an automatic refresh.
45 When a job is selected, the part 2 is filled with all the information that the JOBMANAGER has on the job. The figure
46 :ref:`figure_jobmanager_job_focus` shows this part of the GUI. It contains two tabs. The first tab provides the main
47 information and the run information. The second tab shows the input and output file list of the job.
49 .. _figure_jobmanager_job_focus:
51 .. figure:: images/jobmanager_job_focus.png
54 **Job widget information**
59 This section describes the workflow when a job is created. The jobmanager uses a wizard to create a job.
61 The first page (see :ref:`figure_jobmanager_job_workflow_1`) of the wizard permits to define the **job name**
62 and the **job type**. For each job type, the page provides an explanation of what job type refers.
64 .. _figure_jobmanager_job_workflow_1:
66 .. figure:: images/jobmanager_job_workflow_1.png
69 **Create wizard page 1**
71 The second page (see :ref:`figure_jobmanager_job_workflow_2`) permits to add two files, the main job file
72 (in this example a command file). You could also add an environment file that is not mandatory.
74 .. _figure_jobmanager_job_workflow_2:
76 .. figure:: images/jobmanager_job_workflow_2.png
79 **Create wizard page 2**
81 The third page (see :ref:`figure_jobmanager_job_workflow_5`) permits to choose the resource where the job
82 will be executed. You can also define the batch queue that you want to use.
84 .. _figure_jobmanager_job_workflow_5:
86 .. figure:: images/jobmanager_job_workflow_5.png
89 **Create wizard page 3**
91 The fourth page (see :ref:`figure_jobmanager_job_workflow_3`) permits to define the batch parameters related
92 to the job. It's mandatory to define the *Remote work directory* that is the directory where the job will be executed.
93 Note that if a work directory is defined for the selected resource, the work directory for the job will be
94 created as a subdirectory of the resource work directory by default. The name of this subdirectory will
95 contain the current date and time. Of course, you can override this default value.
96 Input files defined in page 4 will be copied in this work directory. You also have to define the maximum duration
97 (set 0 hours and 0 minutes to use the default value for the queue),
98 the amount of memory needed and the number of processors/cores of the job.
100 .. _figure_jobmanager_job_workflow_3:
102 .. figure:: images/jobmanager_job_workflow_3.png
105 **Create wizard page 4**
107 The fifth page (see :ref:`figure_jobmanager_job_workflow_4`) permits to add the input and output files.
108 Input files are files located into the user
109 computer that have to be transferred into the execution resource. In this page, you could also define the result
110 directory where job's results and logs will be copied.
112 .. _figure_jobmanager_job_workflow_4:
114 .. figure:: images/jobmanager_job_workflow_4.png
117 **Create wizard page 5**
119 The last page (see :ref:`figure_jobmanager_job_workflow_6`) finalizes the job creation. You could choose
120 if you want or not start the job at the end of the wizard.
122 .. _figure_jobmanager_job_workflow_6:
124 .. figure:: images/jobmanager_job_workflow_6.png
127 **Create wizard page 6**
129 Loading and saving job list
130 ---------------------------
132 The JOBMANAGER permits to save and load the job list.
133 For some jobs, this feature permits to follow the execution of a job
134 into a different SALOME session by loading the list.
136 The figure :ref:`figure_jobmanager_load_save_buttons` shows where are located
137 the load and save buttons in the JOBMANAGER GUI.
139 .. _figure_jobmanager_load_save_buttons:
141 .. figure:: images/jobmanager_load_save_buttons.png
144 **Location of load and save job list buttons**
146 All jobs cannot be followed between two SALOME sessions. Indeed, It's the *batch* type
147 of the resource that allows to know if you can or not follow a job. Currently, resources
148 that use **ssh** for batch configuration cannot be followed. In this case, when the JOBMANAGER
149 load the job, it will set this kind of job in the **Error** state.