Job Settings in Administrator
Enterprise Users will be able to view and interact with pages. Performance Managers/Modellers can edit pages and objects, and Model Administrators have full permissions.
You will still need to check your personal permissions to access this area with your site Administrator.
From Ideagen Healthcare Guardian Enterprise
From Ideagen Healthcare Guardian Designer
Within an Ideagen Healthcare Guardian installation, there can be a number of models. These are displayed in the model dropdown list. There can be different configuration settings set up in different Ideagen Healthcare Guardian models.
The model initially displayed will be the model you were in before you opened the Ideagen Healthcare Guardian Administrator Application.
Job Settings
A Job comprises one or more distinct steps that should be processed in the order. Each step defines the action to take and enables particular parameters relevant to the step to be defined. Any number of jobs can be created. Each step must perform one of the following actions:
• Aggregation - Aggregate the specified objects for the specified date range
• Direct Data Import - Import data from associated data files
• Notification - Process and send email notifications.
When you define a step for a job, there are options that allow you to control which days of the week or month the step will run on. This provides the ability, for example, to schedule a job that automatically runs daily but ensures that some of the job steps run on some days but not on others.
Jobs Panel
The Jobs panel lets users view all the current jobs defined within the model and their current state (running, stopped, %complete etc.). The panel also enables job maintenance (creation, updating, and deletion). The details of the column information are as follows:
• Name - The name of the job
• Description - Descriptive text detailing the purpose of the job
• Status Type – The status of the job (stopped, starting, running, stopping). A coloured indicator is also displayed (red - stopped, yellow - starting/stopping, green - running).
• Enabled - Identifies if the job is currently enabled or disabled. If a job is disabled, it cannot be run. This feature is particularly useful if you have a job scheduled to run a number of times, and you need to temporarily ensure that the job will not run.
• Category - A user-defined entry enabling the “grouping” of a set of jobs under a common term.
• %Complete (step) - If the job is currently running, this column will display the %Complete for the step currently being processed.
Note: if you have jobs running, you can press F5 or refresh the browser session to refresh the current progress of the jobs.
Creating a Job
To create a new job, click on the +. Enter the job name (and optionally, category and description) in the quick edit panel and then add the job's steps (detailed below).
Note: It is best to leave the logging level as ‘not set’ for optimal results. This reduces the overhead of logging the job's details while running. With logging turned off, you will still receive log entries in the application log on the application (web) server in the unlikely event of a failure while running the job.
Defining the Job Steps
To create a new job step, click the Steps + button in the quick edit panel. The Create Step dialogue will now be displayed. Select the action the step will perform from the “Step Type” drop-down box.
Creating an Aggregation Step:
• Select a step type
• Enter the name for the step.
• Choose the Object or Object measure pair combination to start the aggregation.
• Choose the range of periods that should be aggregated by selecting an appropriate date range.
• Choose the verbosity of entries in the log file:
- None - will give optimal performance.
- Process Level - will log entries for when the aggregation step started/completed.
- Objective Level - will log entries for each individual object that is aggregated.
- Measure Level - will log entries for each measure that is aggregated.
• Set Execute options if you wish to restrict the days of the week or month that the step should execute. See the help topic Restricting Job Step Execution to Certain Days of the Week or Month for additional details on this
• When satisfied, click Save (or cancel to return without creating the step).
Creating a Notification Step:
• Select a step type
• Enter the name for the step.
• Choose the date to run notifications against.
• Choose the verbosity of entries in the log file:
- None - will give optimal performance.
- Process Level - will log entries for when the notification step started/completed.
- Objective Level - will log entries for each individual object that is notified.
- Measure Level - will log entries for each measure that is notified.
• Set Execute options if you wish to restrict the days of the week or month that the step should execute. See the help topic Restricting Job Step Execution to Certain Days of the Week or Month for additional details on this
• When satisfied, click Save (or cancel to return without creating the step).
Restricting Job Step Execution to Certain Days of the Week or Month
When defining a job step, you can set options that restrict or limit the execution of the step so that it will only run on specific days of the week or month. To do this, specify Execute options for the job step. The screenshot below illustrates these options for a Notification job step.
Editing a Job
To edit an existing job, click on the required job to open the quick edit panel. From this point on, Editing the job and the steps it contains is the same process as creating a job.
Running a Job
To run a job, click on the required job and select the ‘play’ icon in the quick edit panel. The Job will now start. The job is actually run by the Web application. When the application is installed, it is configured to run as a specific Windows user. If the job includes steps that load data from fixed format files, definable import files or Direct data import, this user must have permission to read data from the appropriate files and/or data sources; otherwise, the job step(s) will fail. See the installation manual for additional information.
If the job has been disabled, you will not be able to run the job. If the job is already running, you will not be able to run another instance of the job. Individual job steps will only run if the current date matches the Execute options defined for the step. See restricting job step execution to specific days of the week or month for further information.
Stopping/Aborting a Job
To stop a running job (prior to completion), click on the required job and select the ‘stop’ icon in the quick edit panel. The Job will now stop in an orderly fashion - this may take a few minutes. While the job is trying to stop, the Status of the job will show a yellow indicator and the text “stopping”.
Enabling/Disabling a Job
To enable/disable a job, click on the required job and select Enabled, so that it becomes selected/unselected. Disabled jobs cannot be run (unless they are re-enabled).
Deleting a Job
To delete a job, click on the required job and click the ‘bin’ icon in the quick edit panel.
Viewing the history of a job
To view the history for a job, click on the required job and select Job History in the quick edit panel. The Job History dialogue will be displayed, showing the details of each time the job has been run and whether it was successful or failed. If the job had logging enabled when it was run, you could view the log file details by clicking on the required job history item.
Email Notifications of Job Execution
When a job executes, it always runs as a specific employee. If this employee has a valid email address and you have correctly configured an SMTP email server, then the employee will be sent an email notification when the job finishes.
See the topic Notifications: SMTP Server for information on configuring an SMTP server.
It is possible to configure the application in the following ways:
• No email notification is ever sent
• Notification is sent only on the success or failure of a job
• Emails are sent to a specific email address rather than to the employee that executed the job
• Emails are CC’d to another email address
Contact support@inphase.com if you need information on how to do this.