Feature allows long-running processes to run in the background while the user continues to work on other tasks within Q360.  User will receive a notification when the process has completed.

Prerequisites:

• To enable Background Job feature on a database, a setup script must be run once to configure the BACKGROUNDJOB_OWNERID config item, and to create a SQL Agent Job Category for that database. The OwnerID should be the SQL User that connects the web client to the database, and that user must be granted: Server > Security > Logins > The Web Client User (Q360WEB) > User Mapping > msdb > SQLAgentUserRole.  For assistance with this process, please contact Q360 Customer Care Team.

Admins:

Set up a background job:

1. Go to Maintenance menu > Background Job Administration.
2. On the Background job Search form, click on Add + button to add a new job.
3. Click the pencil icon next to the Job SQL text field.
4. A pop-up box will appear “Select Procedure to Add.”
   • Select the process you would like to be a background job.
   • Note: the processes listed on this dropdown are core processes that will have been set up as part of your initial software installation.
   • This part of the setup process will be used if user is attempting to create alternative access points for these background jobs.
5. Choose job from list and click Update SQL. Job name will be transferred into the Name field, but may be edited.
6. Choose desired Frequency Type from the dropdown menu and enter Frequency Interval into the Frequency Interval field.
   • E.g. Frequency Type = minutes, Frequency Interval = 5 (for a job that should run every five minutes).
   • Note: If Frequency Type = Manually Run, the process will not be automated.
7. Choose Notification type: Email, Pop-up or Both.
8. From Extended Menu, select Install SQL Agent Job.

Edit user permissions on a background job:

1. Go to Maintenance menu > Background Job Administration.
2. Use Search field at top of Background Job Search form or press Enter to view a list of all available background jobs.
3. Select desired job from the grid by clicking on the corresponding magnifying glass icon.
4. Open the Permissions tab of the Background Job form.
   • Add users to the User grid by selecting users from the Add User or Group drop-down list and then clicking on the Add + icon within the User grid.
   • Save new user or group by clicking Save icon within User grid.
   • Users granted this background job permission will see the background job appear in the associated Main Menu (typically File or Projects) and will be able to run the job by clicking on it.
   • Note: this permission only impacts ability to run the background job; it does not grant Background Job Admin permissions.

Edit an existing background job:

1. Go to Maintenance menu > Background Job Administration.
2. Use Search field at top of Background Job Search form or press Enter to view a list of all available background jobs.
3. Select desired job from the grid by clicking on the corresponding magnifying glass icon.
4. On the Background Job form, open the Extended Menu and select Uninstall SQL Agent Job. This will allow the job to be edited.
5. Click on the form Edit icon and make the desired changes to the form inputs. When finished, click the Save
6. Open the Extended Menu again and select Install SQL Agent Job.

Users:

• Users who have been granted permission to run background jobs manually will see these jobs listed in their main Q360 menus (typically, File and Projects).
• To manually force a recurring background job to run at a time other than that defined in the Background Job set up, simply open the Main Menu containing the background job listing and click on the job.
  • A pop-up message will appear stating that the job has been successfully started and that you will receive a notification upon completion.
  • Based on the notification settings chosen during the background job set up, you will receive a completion notification via a pop-up in the lower right corner of the Q360 screen, or via email, or both.
  • If the background job has errors, the notification will state this.
    • If you receive notifications by email, any error details will be listed in the email.
    • If you receive notifications by pop-up only, error details will be recorded in the Background Job form Error Log (bottom of Log Tab).  You will need to contact Admin for this information.