Agent Jobs: Difference between revisions

From Pro 9 Wiki
Jump to navigation Jump to search
(Created page with "<translate> == Scheduled Jobs == In the ''Scheduled jobs'' view you get an overview of the [[{{Link}}Scheduled Job|scheduled jobs]], and you can create new jobs or edit the existing ones. The scheduled jobs are only used when Pro 9 is installed in a cloud environment, to handle the scheduling of regularly recurring jobs, e.g. the [[{{Link}}AD HR Integration|AD/HR integration]] or the [[{{Link}}Aggregation|aggregation]]. Normally you set up a schedule for the job, def...")
 
(Marked this version for translation)
 
Line 1: Line 1:
<translate>
<translate>
== Scheduled Jobs ==  
== Scheduled Jobs == <!--T:18-->


<!--T:19-->
In the ''Scheduled jobs'' view you get an overview of the [[{{Link}}Scheduled Job|scheduled jobs]], and you can create new jobs or edit the existing ones. The scheduled jobs are only used when Pro 9 is installed in a cloud environment, to handle the scheduling of regularly recurring jobs, e.g. the [[{{Link}}AD HR Integration|AD/HR integration]] or the [[{{Link}}Aggregation|aggregation]].  
In the ''Scheduled jobs'' view you get an overview of the [[{{Link}}Scheduled Job|scheduled jobs]], and you can create new jobs or edit the existing ones. The scheduled jobs are only used when Pro 9 is installed in a cloud environment, to handle the scheduling of regularly recurring jobs, e.g. the [[{{Link}}AD HR Integration|AD/HR integration]] or the [[{{Link}}Aggregation|aggregation]].  


<!--T:20-->
Normally you set up a schedule for the job, defining when and how often the job is to be run, but it's also possible to run the job manually.  
Normally you set up a schedule for the job, defining when and how often the job is to be run, but it's also possible to run the job manually.  


<!--T:21-->
If you want to stop a job, there are different ways to do it depending on what you want to achieve. If it's temporary, you can either disable the job totally or disable one or more of the job schedules. If it's permanent, you can delete the whole job.  
If you want to stop a job, there are different ways to do it depending on what you want to achieve. If it's temporary, you can either disable the job totally or disable one or more of the job schedules. If it's permanent, you can delete the whole job.  




<!--T:22-->
'''Note:''' The scheduled jobs functionality is used by advanced users, e.g. Enghouse technical consultants.  
'''Note:''' The scheduled jobs functionality is used by advanced users, e.g. Enghouse technical consultants.  




=== How to - Show Scheduled Jobs ===  
=== How to - Show Scheduled Jobs === <!--T:23-->


<!--T:24-->
# Click the [[{{Link}}ApplikationAdmin Default|role Application Maintenance]]
# Click the [[{{Link}}ApplikationAdmin Default|role Application Maintenance]]
# Click '''System monitoring > Scheduled jobs'''
# Click '''System monitoring > Scheduled jobs'''
Line 19: Line 24:




=== How to - Add a New Job ===
=== How to - Add a New Job === <!--T:25-->


<!--T:26-->
# Click '''add''' [[Image:Icon Add.png]]
# Click '''add''' [[Image:Icon Add.png]]
# The ''edit'' section below the table opens
# The ''edit'' section below the table opens
Line 43: Line 49:




=== How to - Edit a Job ===  
=== How to - Edit a Job === <!--T:27-->


<!--T:28-->
# Click '''edit''' [[Image:Icon Edit.png]] for the job you want to edit
# Click '''edit''' [[Image:Icon Edit.png]] for the job you want to edit
# The ''edit'' section below the table opens, showing the current settings
# The ''edit'' section below the table opens, showing the current settings
Line 52: Line 59:
   
   


=== How to - Disable/Enable a Job ===  
=== How to - Disable/Enable a Job === <!--T:29-->


<!--T:30-->
# Click '''edit''' [[Image:Icon Edit.png]] for the job you want to disable/enable
# Click '''edit''' [[Image:Icon Edit.png]] for the job you want to disable/enable
# Change the '''enable''' setting for the job
# Change the '''enable''' setting for the job
Line 61: Line 69:




<!--T:31-->
'''Note:''' You can still run a job manually, even if it is disabled.
'''Note:''' You can still run a job manually, even if it is disabled.




=== How to - Delete a Job ===  
=== How to - Delete a Job === <!--T:32-->


<!--T:33-->
# Check the box for each job you want to delete  
# Check the box for each job you want to delete  
# Click the icon [[Image:Icon Links.png]] to open the action menu in the toolbar above the table, and select delete
# Click the icon [[Image:Icon Links.png]] to open the action menu in the toolbar above the table, and select delete
Line 75: Line 85:




=== How to - Run a Job Manually ===
=== How to - Run a Job Manually === <!--T:34-->


<!--T:35-->
# Click '''run''' [[Image:Icon Run.png]] for the job you want to run instantly
# Click '''run''' [[Image:Icon Run.png]] for the job you want to run instantly
#:* The job will be started and run according to the settings
#:* The job will be started and run according to the settings




<!--T:36-->
'''Note:''' Some scheduled jobs cause high load on the system server, and are therefore scheduled during the night. If you run them during day time, users may experience slow response from the system.
'''Note:''' Some scheduled jobs cause high load on the system server, and are therefore scheduled during the night. If you run them during day time, users may experience slow response from the system.




=== How to - Create or Edit the Job Schedule ===  
=== How to - Create or Edit the Job Schedule === <!--T:37-->


<!--T:38-->
# To edit the schedules of how often to run the job, click [[{{Link}}Agent Schedules|Links > Edit schedules]] [[Image:Icon Links.png]]
# To edit the schedules of how often to run the job, click [[{{Link}}Agent Schedules|Links > Edit schedules]] [[Image:Icon Links.png]]




=== How to - Check Job History ===  
=== How to - Check Job History === <!--T:39-->


<!--T:40-->
# To check the job history, click [[{{Link}}Agent JobsHistory|Links > History]] [[Image:Icon Links.png]]
# To check the job history, click [[{{Link}}Agent JobsHistory|Links > History]] [[Image:Icon Links.png]]



Latest revision as of 11:31, 13 February 2023

Scheduled Jobs

In the Scheduled jobs view you get an overview of the scheduled jobs, and you can create new jobs or edit the existing ones. The scheduled jobs are only used when Pro 9 is installed in a cloud environment, to handle the scheduling of regularly recurring jobs, e.g. the AD/HR integration or the aggregation.

Normally you set up a schedule for the job, defining when and how often the job is to be run, but it's also possible to run the job manually.

If you want to stop a job, there are different ways to do it depending on what you want to achieve. If it's temporary, you can either disable the job totally or disable one or more of the job schedules. If it's permanent, you can delete the whole job.


Note: The scheduled jobs functionality is used by advanced users, e.g. Enghouse technical consultants.


How to - Show Scheduled Jobs

  1. Click the role Application Maintenance
  2. Click System monitoring > Scheduled jobs
    • A list of all scheduled jobs is shown


How to - Add a New Job

  1. Click add Icon Add.png
  2. The edit section below the table opens
  3. Define a name for the job
  4. Check the enable box to be able to run the job with a schedule
  5. Click save
  6. Add steps to be executed in the job
    1. Click add Icon Add.png to add a new row
    2. Define the order of the steps by selecting the position for this step in the step menu
    3. Define a name for the step
    4. Enter one or more SQL commands (as you would in a SQL query window) in the command field
    5. Define what to do on success or failure action:
      1. Define what to do if the execution of the command(s) is a success in the on success action menu
      2. Define what to do if the execution of the command(s) is a failure in the on failure action menu
      3. The alternatives are:
        • Go to the next step - Continue with the next step in the list of steps in the job.
        • Quit reporting success - End the execution of the job and report it as successful.
        • Quit reporting failure - End the execution of the job and report it as a failure.
        • Go to a specific step - All steps in the job are listed. Select one to continue with that step.
    6. Click save
    7. Repeat to add more steps


How to - Edit a Job

  1. Click edit Icon Edit.png for the job you want to edit
  2. The edit section below the table opens, showing the current settings
  3. Edit the settings or add/remove steps
    • See the section How to - Add a new job for details on this
  4. Click save to save the changes


How to - Disable/Enable a Job

  1. Click edit Icon Edit.png for the job you want to disable/enable
  2. Change the enable setting for the job
    • To enable - ensure that the box is checked
    • To disable - ensure that the box is not checked
  3. Click save


Note: You can still run a job manually, even if it is disabled.


How to - Delete a Job

  1. Check the box for each job you want to delete
  2. Click the icon Icon Links.png to open the action menu in the toolbar above the table, and select delete
    • The job is immediately deleted


Note: Only user-defined jobs can be deleted.


How to - Run a Job Manually

  1. Click run Icon Run.png for the job you want to run instantly
    • The job will be started and run according to the settings


Note: Some scheduled jobs cause high load on the system server, and are therefore scheduled during the night. If you run them during day time, users may experience slow response from the system.


How to - Create or Edit the Job Schedule

  1. To edit the schedules of how often to run the job, click Links > Edit schedules Icon Links.png


How to - Check Job History

  1. To check the job history, click Links > History Icon Links.png