Jobs

Complete

The Jobs screen allows:

background jobs to be scheduled
jobs to be run on demand

Medical Record Locker

Complete

The Medical Record Locker is a scheduled job that periodically locks patient medical records based on the Practice Record Lock Period setting.
A default instance of this job will be created when the Record Lock Period is set.

The fields are as follows:

Name	The job name
Description	The job description
Active	This schedules the job to run if checked, or prevents it from being run if unchecked. Note that preventing it from running does not completely disable locking, as locking is also determined by the creation date of the record and the Record Lock Period.
Batch Size	The number of records to lock in a single batch
Max Records	The maximum number of records to lock in a single scheduled run. Should be greater or equal to the Batch Size.
Minutes	See Cron Expression
Hours	See Cron Expression
Day Of Month	See Cron Expression
Month	See Cron Expression
Day Of Week	See Cron Expression
Run As	Specifies the user to run the job as. This user is required to have permissions to: send notification messages
Notify	Specifies the user or user group to notify when locking has completed. Notification only occurs when at least one record is locked, or errors are encountered. You may want to use a 'real' user or group of real users, or you may want to create a user such as 'Jobs Message Receiver' used only for these notifications.

The Batch Size and Max Records fields can be used to limit resource utilisation. If enabling locking for the first time, set Max Records to a suitably large value so that the backlog of records can be cleared.

Cron Expression

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:

Field	Allowed Values	Allowed Special Characters
Minutes	0-59	, - * /
Hours	0-23	, - * /
Day Of Month	1-31	, - * ? /
Month	1-12 or JAN-DEC	, - * /
Day Of Week	1-7 or SUN-SAT	, - * ? /

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Description	Minutes	Hours	Day Of Month	Month	Day Of Week
Run at 8am every weekday	0	8	?	*	mon-fri
Run every 30 minutes	*/30	*	*	*	?
Run every 2 hours	0	*/2	*	*	?
Run every 15 mins between 8am and 6pm on weekdays	*/15	8-18	?	*	mon-fri

Document Loader

Complete

The Document Loader is a scheduled job that periodically load files from a directory and attaches them to documents or investigations.

Files are associated with documents or investigations by parsing their identifier from the file name.

The Active field:

schedules the job to run if checked; or
prevents it from being run if unchecked

The Source Directory is the directory to load files from.

The Destination Directory is the directory to move successfully loaded files to.

The Error Directory is the directory to move files to that couldn't be loaded.

Note that the Tomcat application must have write access to Destination and Error directories.

(nb. on linux servers you must use the direct path, not a symbolic link and the group that owns the the source and destination directories must have read and write permissions and the tomcat user must belong to that group eg. use 'sudo usermod -a -G group tomcat7')

The Id Pattern is a regular expression that enables the document identifier to be parsed from the file name. The default expression is [^\d]*(\d+).* - this looks for the first digit string in the file name. For example, the following file names all have the ID 3035108:
DAO DAO_TSANG_ _3035108_20150226_115435_4762.pdf
3035108 CBC test.jpg
Xray DAO DAO_TSANG 3035108.jpg

The Overwrite field determines if files should be loaded if one already exists. If selected, the existing content will be replaced, if it doesn't duplicate the existing content. For documents that support versioning*, the existing content will be saved as a version. The following table indicates the behaviour if a document has been previously loaded:

Case	File	Ovewrite=n	Overwrite=y
1	Same name, same content	Skipped	Skipped
2	Same name, different content	Skipped	Loaded
3	Different name	Skipped	Loaded

Note that in case 2 & 3, if the document supports versioning, then the previous document is set as a version, and the primary document is replaced.

In case 2, if the previous document already exists in the Destination Directory, then the loader will fail and terminate. The file in the Destination Directory needs to be manually moved aside.

* all of the standard document archetypes with the exception of act.documentTemplate in OpenVPMS support versioning. The Document Loader cannot be used to load act.documentTemplate instances.

The Recurse Subdirectories field determines if subdirectories of the source directory should be searched for documents to load.

The Archetypes field is a comma separated list of archetype short names, identifying the document archetypes that may be loaded to. These may include wild cards. Use of wildcards is NOT recommended, as malformed file names may result in files being loaded to incorrect documents. For Investigations, use act.patientInvestigation.

The Enable Logging field determines if loading should be logged. This can be used to help track down problems. The information is written to the OpenVPMS logs in <TOMCAT-HOME>/logs.

If Stop On Error is selected, the loader will stop on the first error it encounters. Note that this means 'stop this run', it does not 'stop all future scheduled runs'. For normal operation, you should leave this unticked, otherwise, it is possible that an error with one document (say because it has a name that does not contain an ID) will prevent other documents being loaded.

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run. [Note that if you change the schedule, the new schedule will take effect immediately.]

These are a defined using a simplified version of a Cron expression:

Field	Allowed Values	Allowed Special Characters
Minutes	0-59	, - * /
Hours	0-23	, - * /
Day Of Month	1-31	, - * ? /
Month	1-12 or JAN-DEC	, - * /
Day Of Week	1-7 or SUN-SAT	, - * ? /

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

Examples

Description	Minutes	Hours	Day Of Month	Month	Day Of Week
Run at 8am every weekday	0	8	?	*	mon-fri
Run every 30 minutes	*/30	*	*	*	?
Run every 2 hours	0	*/2	*	*	?
Run every 15 mins between 8am and 6pm on weekdays	*/15	8-18	?	*	mon-fri

The Run As field specifies the user to run the job as. This user is required to establish the permissions to:

create and update the specified archetypes
send notification messages

The Notify field specifies the user or user group to notify when a load has completed. Notification only occurs when documents are loaded, or errors are encountered. You may want to use a 'real' user or group of real users, or you may want to create a user such as 'Document Loader Message Receiver' used only for these notifications.

ESCI Inbox Reader

Complete

The ESCI Inbox Reader is a scheduled job that periodically checks ESCI Inboxes for messages from suppliers.

The Active field:

schedules the job to run if checked; or
prevents it from being run if unchecked

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run.

These are a defined using a simplified version of a Cron expression:

Field	Allowed Values	Allowed Special Characters
Minutes	0-59	, - * /
Hours	0-23	, - * /
Day Of Month	1-31	, - * ? /
Month	1-12 or JAN-DEC	, - * /
Day Of Week	1-7 or SUN-SAT	, - * ? /

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Description	Minutes	Hours	Day Of Month	Month	Day Of Week
Run at 8am every weekday	0	8	?	*	mon-fri
Run every 30 minutes	*/30	*	*	*	?
Run every 2 hours	0	*/2	*	*	?
Run every 15 mins between 8am and 6pm on weekdays	*/15	8-18	?	*	mon-fri

The Run As field specifies the user to run the job as. The selected user must have permissions to:

update Orders
create Supplier Deliveries
create System Messages

Appointment Reminder Sender

Complete

The Appointment Reminder Sender is a scheduled job that periodically sends SMS appointment reminders.

The fields are as follows:

Name	The job name
Description	The job description
Active	This schedules the job to run if checked, or prevents it from being run if unchecked
SMS Before	This determines how long prior to an appointment that the reminder will be sent. It will never be sent before this, but may be sent after, if the Reminder Sender did not run when the reminder first became due.
No SMS Before	This prevents the Reminder Sender sending reminders for appointments that are in the near future, i.e. appointments which start less than the specified interval ahead in time. It must be less than the SMS Before interval. For both the above, an interval of N days means Nx24 hours and similarly a week means 7x24 hours. Thus if the job runs at 13:00, an interval of 1 day covers the period up to 13:00 the next day, not 23:59 the next day.
No Reminder	This interval is checked when the appointment is created. If the appointment is less than this interval in the future, then the Send Reminder flag will not be set for the appointment.
Minutes	See Cron Expression
Hours	See Cron Expression
Day Of Month	See Cron Expression
Month	See Cron Expression
Day Of Week	See Cron Expression
Run As	Specifies the user to run the job as. This user is required to have permissions to: save appointments send notification messages
Notify	Specifies the user or user group to notify when sending has completed. Notification only occurs when SMS message are sent, or errors are encountered. You may want to use a 'real' user or group of real users, or you may want to create a user such as 'Reminder Jobs Message Receiver' used only for these notifications.

Cron Expression

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:

Field	Allowed Values	Allowed Special Characters
Minutes	0-59	, - * /
Hours	0-23	, - * /
Day Of Month	1-31	, - * ? /
Month	1-12 or JAN-DEC	, - * /
Day Of Week	1-7 or SUN-SAT	, - * ? /

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Description	Minutes	Hours	Day Of Month	Month	Day Of Week
Run at 8am every weekday	0	8	?	*	mon-fri
Run every 30 minutes	*/30	*	*	*	?
Run every 2 hours	0	*/2	*	*	?
Run every 15 mins between 8am and 6pm on weekdays	*/15	8-18	?	*	mon-fri

Account Reminder Sender

Complete

The Account Reminder Sender is a scheduled job that periodically sends SMS reminders for unpaid invoices or counter sales.
Reminders are sent for unpaid invoices and counter sales where:

the charge Send Reminder flag is selected; and
the customer is active; and
has a mobile telephone; and
the charge was finalised within one of the reminder intervals; and
the charge is newer than than interval specified by the Ignore charges older than field

The fields are as follows:

Name	The job name
Description	The job description
Active	This schedules the job to run if checked, or prevents it from being run if unchecked
Minimum Balance	Exclude charges with a balance less than this amount.
Ignore charges older than	Any charges finalised before this period will be ignored.
Minutes	See Cron Expression
Hours	See Cron Expression
Day Of Month	See Cron Expression
Month	See Cron Expression
Day Of Week	See Cron Expression
Run As	Specifies the user to run the job as. This user is required to have permissions to: save charges send notification messages
Notify	Specifies the user or user group to notify when sending has completed. Notification only occurs when SMS message are sent, or errors are encountered. You may want to use a 'real' user or group of real users, or you may want to create a user such as 'Reminder Jobs Message Receiver' used only for these notifications.

Reminders

Multiple reminders can be sent based on the interval when the charge was finalised.
Each interval has an associated template which determines the content of the SMS.
E.g. given:

Ignore charges older than: 1 year

Interval	SMS Template
2 days	Template 1
1 month	Template 2
6 weeks	Template 3

Any invoice or counter sale that was finalised:

2 days and up to 1 month ago will receive an SMS generated from Template 1
1 month and up to 6 weeks ago will receive an SMS generated from Template 2
6 weeks ago up to 1 year ago will receive an SMS generated from Template 3

Cron Expression

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:

Field	Allowed Values	Allowed Special Characters
Minutes	0-59	, - * /
Hours	0-23	, - * /
Day Of Month	1-31	, - * ? /
Month	1-12 or JAN-DEC	, - * /
Day Of Week	1-7 or SUN-SAT	, - * ? /

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Description	Minutes	Hours	Day Of Month	Month	Day Of Week
Run at 8am every weekday	0	8	?	*	mon-fri
Run every 30 minutes	*/30	*	*	*	?
Run every 2 hours	0	*/2	*	*	?
Run every 15 mins between 8am and 6pm on weekdays	*/15	8-18	?	*	mon-fri

Email Document Loader Job

Complete

The Email Document Loader is a scheduled job that loads mail attachments from emails to existing patient Investigations.

Attachments are associated with Investigations by parsing their identifier from the attachment file name.

Emails can be read from mail servers that support IMAP.

Guidelines for Use

The job is intended to be used to load Investigations results from emails, where a laboratory doesn't directly integrate with OpenVPMS.

It is recommended that a dedicated email folder for results is used to:

limit the possibility that attachments will be loaded to incorrect Investigations
avoid errors for emails not associated with results

Users can:

set up an email account solely for processing attachments
set up a folder for attachments and manually move emails into it to be processed by the job

Emails must be marked unread in order to be processed by the job.

Job Execution

When the job runs, it searches for unread emails from the specified Source Folder.
If From is specified, only those emails with a matching From address will be processed.

The job examines each email for attachments.
If it finds an attachment with an identifier that matches an Investigation, it loads it.

Once processed, emails are marked read so they aren't processed again when the job next runs.

Emails that have been processed successfully will be moved to the Target Folder, if it has been specified.
Emails that can't be processed will be moved to the Error Folder, if it has been specified.

On completion, a summary message will be sent to the user or group specified by Notify.

Job Configuration

The fields are as follows:

Name

The job name.

Description

The job description.

Active

Schedules the job to run if checked, or prevents it from being run if unchecked.

Host

The mail server host. E.g. imap.gmail.com

Port

The mail server port. E.g. 993

Timeout

The timeout, in seconds for sending and receiving data from the mail server.
A value of 0 indicates no timeout.
This can be used to prevent the job waiting indefinitely if there are mail server or network problems.

From

A comma separated list of From addresses. Optional.
If specified, only messages from the specified addresses will be processed.

Source Folder

The folder to read emails from.

Target Folder

The folder to move processed emails to. If unspecified, emails will remain in the Source Folder.

Error Folder

The folder to move emails that can't be processed. If unspecified, emails will remain in the Source Folder.

Id Pattern

A regular expression that enables the document identifier to be parsed from the file name. The default expression is [^\d]*(\d+).*
This looks for the first digit string in the file name. For example, the following file names all have the ID 3035108:

DAO DAO_TSANG_ _3035108_20150226_115435_4762.pdf
3035108 CBC test.jpg
Xray DAO DAO_TSANG 3035108.jpg

Enable Logging

Determines if loading should be logged. This can be used to help track down problems. The information is written to the OpenVPMS logs in <TOMCAT-HOME>/logs.

Minutes
Hours
Day Of Month
Month
Day Of Week

These determine when the job is run.

These are a defined using a simplified version of a Cron expression:

Field	Allowed Values	Allowed Special Characters
Minutes	0-59	, - * /
Hours	0-23	, - * /
Day Of Month	1-31	, - * ? /
Month	1-12 or JAN-DEC	, - * /
Day Of Week	1-7 or SUN-SAT	, - * ? /

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?

Run As

The field specifies the user to run the job as. This user is required to establish the permissions to:

update Investigations
send notification messages

Notify

The field specifies the user or user group to notify when a load has completed. Notification only occurs when documents are loaded, or errors are encountered.

Security Settings

Connection Security

Set to None, SSL/TLS, or STARTTLS as required by the mail server.

Authentication Method

One of:

Username & Password
OAuth2

Username

The server user name. Editable when Username & Password is selected as the Authentication Method. When OAuth2 is selected, this displays the authenticated user.

Password

The server password. Only applicable when Username & Password is selected as the Authentication Method.

OAuth2

OpenVPMS supports authentication using OAuth2 for Gmail and Microsoft Outlook.
Consult the relevant How To documents on how to configure these:

Examples

Description	Minutes	Hours	Day Of Month	Month	Day Of Week
Run at 8am every weekday	0	8	?	*	mon-fri
Run every 30 minutes	*/30	*	*	*	?
Run every 2 hours	0	*/2	*	*	?
Run every 15 mins between 8am and 6pm on weekdays	*/15	8-18	?	*	mon-fri

End Period

Complete

The End Period job performs end-of-period processing for all customers.

This can be used in place of the manual End Period process in Reporting - Debtors.

It should be run prior to sending statements using Send All in Reporting - Debtors.

End-of-period processing occurs for the last day of the month prior to the job being run. It includes:

the addition of accounting fees, if a customer has overdue balances that incur a fee; and
the creation of Closing and Opening Balances

End-of-period processing only occurs if:

there are Completed charges to be Finalised and Finalise Completed Charges is selected; or
there is a non-zero balance; or
there is a zero balance but there has been account activity since the last opening balance

The fields are as follows:

Name

The job name.

Description

The job description.

Active

Schedules the job to run if checked, or prevents it from being run if unchecked.

Finalise Completed Charges

If selected, any charge that has Completed status will be automatically set to Finalised.
If unselected, any charges that aren't Finalised won't be included in the closing balance.

Minutes
Hours
Day Of Month
Month
Day Of Week

These determine when the job is run.

These are a defined using a simplified version of a Cron expression:

Field	Allowed Values	Allowed Special Characters
Minutes	0-59	, - * /
Hours	0-23	, - * /
Day Of Month	1-31	, - * ? /
Month	1-12 or JAN-DEC	, - * /
Day Of Week	1-7 or SUN-SAT	, - * ? /

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?

Run As

The field specifies the user to run the job as. This user is required to establish the permissions to:

create Closing and Opening balances
send notification messages

Notify

The field specifies the user or user group to notify when the job has completed.

Examples

Description	Minutes	Hours	Day Of Month	Month	Day Of Week
Run at 2 AM on the first day of the month, every month	0	2	1	*	?

Patient Reminder Queue

Complete

The Patient Reminder Queue is a scheduled job used to:

queue patient reminders for sending
cancel reminders that are no longer applicable.

It should be scheduled to run daily, preferably outside of business hours.

On completion, reminders may be manually sent via Reporting - Reminders.
Email and SMS reminders may be automatically sent by the Patient Reminder Sender.

Queueing

Reminders are selected for queueing if they have:

a Next Due Date less than or equal to the current date; and
an In Progress status; and
no associated Items with Pending or Error status

It will cancel reminders if:

the patient is deceased or inactive; or
the Next Due Date + the Reminder Type's Cancel Time is less than the current date

For each reminder that matches the criteria, one or more Patient Reminder Items will be created according to its Reminder Type's rules, and the associated customer's contacts.

Note that the queue is not rebuilt each time the job runs. Reminders that have been previously added to the queue are left unaltered. This does mean that if you change say the Lead Times, reminders already in the queue will not affected.

The fields are as follows:

Name	The job name
Description	The job description
Active	This schedules the job to run if checked, or prevents it from being run if unchecked.
Minutes	See Cron Expression
Hours	See Cron Expression
Day Of Month	See Cron Expression
Month	See Cron Expression
Day Of Week	See Cron Expression
Run As	Specifies the user to run the job as. This user is required to have permissions to: send notification messages update patient reminders update patient reminder items
Notify	Specifies the user or user group to notify when queuing has completed. Notification only occurs when at least one reminder has been queued or cancelled, or an error has occurred. You may want to use a 'real' user or group of real users, or you may want to create a user such as 'Reminder Jobs Message Receiver' used only for these notifications.

Cron Expression

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:

Field	Allowed Values	Allowed Special Characters
Minutes	0-59	, - * /
Hours	0-23	, - * /
Day Of Month	1-31	, - * ? /
Month	1-12 or JAN-DEC	, - * /
Day Of Week	1-7 or SUN-SAT	, - * ? /

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Description	Minutes	Hours	Day Of Month	Month	Day Of Week
Run at 5am every day	0	5	?	*	*
Run at 7:30 on weekdays	30	7	?	*	mon-fri

Patient Reminder Sender

Complete

The Patient Reminder Sender is a scheduled job that sends Email and SMS reminders queued by the Patient Reminder Queue job.

It should be scheduled to run during business hours.

You do not have to use the Patient Reminder Sender job. If you do not, then Email and SMS reminders will be sent as part of the Reporting|Reminders|Send|Send All processing.

However, since you probably want to send out Email and SMS reminders more often than printed, listed, and exported reminders, then it is convenient to set up a Patient Reminder job to do this on say a daily basis.

The create/edit/view screen is as follows:

The fields are as follows:

Name	The job name
Description	The job description
Active	This schedules the job to run if checked, or prevents it from being run if unchecked.
Minutes	See Cron Expression
Hours	See Cron Expression
Day Of Month	See Cron Expression
Month	See Cron Expression
Day Of Week	See Cron Expression
Run As	Specifies the user to run the job as. This user is required to have permissions to: send notification messages update patient reminders update patient reminder items
Notify	Specifies the user or user group to notify when sending has completed. Notification only occurs when at least one reminder has been sent, or an error has occurred. You may want to use a 'real' user or group of real users, or you may want to create a user such as 'Reminder Jobs Message Receiver' used only for these notifications.

Cron Expression

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:

Field	Allowed Values	Allowed Special Characters
Minutes	0-59	, - * /
Hours	0-23	, - * /
Day Of Month	1-31	, - * ? /
Month	1-12 or JAN-DEC	, - * /
Day Of Week	1-7 or SUN-SAT	, - * ? /

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Description	Minutes	Hours	Day Of Month	Month	Day Of Week
Run at 8am every day	0	8	?	*	*
Run at 8:30 on weekdays	30	8	?	*	mon-fri

Pharmacy Order Discontinuation

Complete

This job is automatically scheduled by setting the Pharmacy Order Discontinuation Period option on the Practice.

The fields are as follows:

Name	The job name
Description	The job description
Active	This schedules the job to run if checked, or prevents it from being run if unchecked.
Batch Size	The number of invoices to process in a single batch
Max Records	The maximum number of invoices to process in a single scheduled run. Should be greater or equal to the Batch Size.
Minutes	See Cron Expression
Hours	See Cron Expression
Day Of Month	See Cron Expression
Month	See Cron Expression
Day Of Week	See Cron Expression
Run As	Specifies the user to run the job as. This user is required to have permissions to: send notification messages
Notify	Specifies the user or user group to notify when locking has completed. Notification only occurs when at least one invoice is processed, or errors are encountered. You may want to use a 'real' user or group of real users, or you may want to create a user such as 'Jobs Message Receiver' used only for these notifications.

The Batch Size and Max Records fields can be used to limit resource utilisation.

Cron Expression

The Minutes and Hours fields will be populated automatically when the Pharmacy Order Discontinuation Period option on the Practice is set. The job will be scheduled to run twice during specified period.

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:

Field	Allowed Values	Allowed Special Characters
Minutes	0-59	, - * /
Hours	0-23	, - * /
Day Of Month	1-31	, - * ? /
Month	1-12 or JAN-DEC	, - * /
Day Of Week	1-7 or SUN-SAT	, - * ? /

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Description	Minutes	Hours	Day Of Month	Month	Day Of Week
Run every 30 minutes	*/30	*	*	*	?
Run every 2 hours	0	*/2	*	*	?
Run every 15 mins between 8am and 6pm on weekdays	*/15	8-18	?	*	mon-fri

Scheduled Report

Complete

Scheduled Report is a job that can be configured to periodically run a report and write the output to a file, email it, and/or print it.

The fields are as follows:

Report

The report to run.

Name

The job name. Defaults to the report name

Description

The job description. Defaults to the report description

Active

This schedules the job to run if checked, or prevents it from being run if unchecked.

Location

The location to pass to the report. Available via the OpenVPMS.location field.

Report Name

The name of the report, when it is written to a file, or emailed as an attachment. This can be further customised by specifying Report Name Format.
If not specified, the report name will be derived using Report.

Report Name Format

Used to format the Report Name, e.g. to append the current date.
If not specified, the File Name Format of the associated Report will be used. Available formats are determined by Administration - Lookups - File Name Format

File

If selected, writes the report as a file to the specified directory.

Directory

The directory to write the report to. Only valid when File is selected.

File Type

The type of file to write. Only valid when File is selected.

Email

If selected, emails the report.

Email From

The address to email the report from. Only valid when Email is selected.

Email To

The addresses to email the report to. Up to 5 addresses may be specified. Only valid when Email is selected.

Attachment Type

The type of the email attachment. Only valid when Email is selected.

Print

If selected, prints the report

Printer

The printer to print the report to. Only valid when Print is selected.

Minutes

See Cron Expression

Hours

See Cron Expression

Day Of Month

See Cron Expression

Month

See Cron Expression

Day Of Week

See Cron Expression

Run As

Specifies the user to run the job as. This user is required to have permissions to:

send notification messages

Notify

Specifies the user or user group to notify when reporting has completed.

Notify On Success

If deselected, notification only occurs when reporting fails.

If selected, notification also occurs when reporting is successful

Parameters

The report parameters, obtained from the report when it is first selected.

Date parameters may be fixed, or calculated. This is determined by a dropdown with the following options:

Date	use a fixed date
Now	use the current date and time
Today	use today's date
Tomorrow	use tomorrow's date
Yesterday	use yesterday's date
Start of Month	use the first day of the current month
End of Month	use the last day of the current month
Start of Last Month	use the first day of last month
End of Last Month	use the last day of last month
Start of Next Month	use the first day of next month
End of Next Month	use the last day of next month
Start Of Year	use the first day of the current year
End of Year	use the last day of the current year
Start of Last Year	use the first day of last year
End of Last Year	use the last day of last year
Start of Next Year	use the first day of next year
End of Next Year	use the last day of next year
June 30	use June 30th of the current year
June 30 - Last Year	use June 30th of last year
June 30 - Next Year	use June 30th of next year
July 1	use July 1st of the current year
July 1 - Last Year	use July 1st of last year
July 1 - Next Year	use July 1st of next year

Calculated date parameters may have an offset, expressed in days, weeks, months or years. E.g.:

Today - 3 Months	subtracts three months from the current date
Start Of Month + 1 Years	adds one year to the first day of the current month

Cron Expression

The Minutes, Hours, Day Of Month, Month, and Day Of Week fields determine when the job is run, using a simplified version of a Cron expression:

Field	Allowed Values	Allowed Special Characters
Minutes	0-59	, - * /
Hours	0-23	, - * /
Day Of Month	1-31	, - * ? /
Month	1-12 or JAN-DEC	, - * /
Day Of Week	1-7 or SUN-SAT	, - * ? /

Note that only one of Day Of Month and Day Of Week may be specified. If one is specified, the other must be set to ?.

If you change the schedule, the new schedule will take effect immediately.

Examples

Description	Minutes	Hours	Day Of Month	Month	Day Of Week
Run at 8am every day	0	8	?	*	*
Run at 8:30 on weekdays	30	8	?	*	mon-fri