|
|
|
Queue Schedule
The Scheduling function allows you to run routines at various times and frequencies. This could be (for example) to run End of Day
Statistics, Inventory Replenishment Runs, etc. The Queue Service covers the following styles of Events
|
• |
Email Report: Used for regular emailing of reports (i.e. send the Weekly Sales report to the Sales Manager every Friday Night). You’ll also notice there is the ability to enter the recipients, the body, the selection criteria for the report, CC & BCC email address, and any file attachments you wish to include with the email. Considerations where using Selection Criteria:
Alternative Method: If your report has Date Selection Criteria or needs to evaluate data in order to determine a condition, it is suggested you consider running the report from a Script using the OstendoReport function, then create a Queue Schedule to run that Script. This way the script can determine these variables before the report is run. |
|
• |
Print Report: Used for regular printing of reports (i.e. print the previous days orders in, every morning). It should be noted there is a new rule in Sales Rules allowing One Step Invoice printing to use the Queue Service – this can alleviate the need to wait while the invoice is being sent to the printer before starting the next order. |
|
• |
Email: Used for sending out regular emails (This feature is very useful for sending emails based on triggered events - i.e. email a customer once a sales delivery has been shipped – see ‘Using Events with Queue Services’ below |
|
• |
Script: This is designed for executing/running standard scripts at regular/fixed times (i.e. collate Business Key Performance data and email it to senior management every week night, run the Inventory Replenishment once a week, etc...). |
|
• |
DataSheet: Used for generating a pdf of completed datasheet and updating the document links to the appropriate Job/Assembly/Sales/Purchase/Invoice. |
|
• |
This only happens if the Parent Folder Path is defined in General Rules and the "Create Data Sheet Linked Docs From" is defined in Mobility Rules.. |
|
• |
Accounting Link: Allows for the automated running of the Accounting Link screen within Ostendo (see the ‘Run’ option for executing the Ostendo-Accounting System automatically as well) |
|
• |
Run: This option allows the regular/fixed execution of external applications. This is useful for running the Ostendo-MYOB, Ostendo-QB, or the Ostendo-Evolution links automatically – note that you need to pass a command line parameter ‘background’ for the programs to run in none visual mode. |
|
• |
Auto Email: This is used to run Auto Email actions set up in Email Services. |
|
• |
Receive Email POP3: This reads emails sent to the specified POP3 email address and processes them according to the style specified in Email Services - Email Addresses. |
|
• |
Receive Email IMAP: This reads emails sent to the specified IMAP email address and processes them according to the style specified in Email Services - Email Addresses. |
Using Events with Queue Services
There are numerous times when changes in the database require further action (i.e. email the Customer when a Sales Delivery has been shipped, email the Sales Manager if an order is greater than a certain value or margin, email the Project Manager if the job/project is going off track, etc...). To accommodate this Ostendo contains a database table called ‘OUTPUTQUEUE’. This could be written to (via say a Database Trigger) when that event occurs. The Queue Service will then action that request.
List Tab
Display fields
The displayed fields are taken from the Item information entered into the ‘Detail’ tab. The selection of which fields to display is at the user’s discretion. To select the fields to display simply ‘right mouse’ in the main panel and select ‘Customise List Fields’. On the displayed panel you can:
|
• |
Click on the ‘Show field’ checkbox to display the field |
|
• |
Amend the column heading by changing the content of ‘Display Label’ |
|
• |
Define the sort sequence of the records by going to the lower panel and dragging the field from ‘Available Fields’ to ‘Sort By’. |
|
• |
Click the ‘Save’ Button when done. |
Data Display Options
Field Position - On the List screen you can move the field position by dragging the column heading left or right to the position where you want it to appear.
Filtering and Sorting - If you ‘check’ the checkbox then the displayed data is available for filtering and sorting:
|
• |
To sort the data in a selected column simply click on the column heading. Clicking against will sort in descending order. |
|
• |
Click on the black ‘down arrow’ to the right of your selected column heading and you can either select a specific entry to display all records containing that entry, or you can select (Custom ) to enter detailed selection criteria. |
Searching - If you enter some text into the ‘Search’ field and click on the ‘binoculars’ Icon then all records will be interrogated and those records that contain the entered text will be displayed. To revert back to displaying all records click on the ‘Eraser’ Icon
Buttons
Close: This will close the Queue Schedule screen. If you have any unsaved data then you will be asked if you wish to save it before the screen is closed.
Add: This will bring up the 'Detail' Tab ready for entry of a new Schedule
Save: Not applicable to the List panel
Cancel: Not applicable to the List panel
Delete: This removes the current Schedule
Detail Tab
Entry and Display fields
Schedule Type: From the drop-down list identify whether it is to be run:
Fixed - At a fixed time of day
Interval - At a defined Interval
Fixed Date - On a Fixed Date
Active: 'Check' this checkbox to make this Schedule active
Days: This is only visible if the Schedule Type is either Fixed or Interval. When visible 'Check' the days when it is to be run
Fixed Date: This is only visible if the Schedule Type is Fixed Date. When visible select the specific Date from the drop-down calendar
Fixed Hrs/Fixed Mins: This is only visible if the Schedule Type is either Fixed or Fixed Date. When visible enter the Time (Hours and Minutes) within the day that this is to be run
Interval (min): This is only visible if the Schedule Type is Interval. When visible enter the Frequency (in Minutes) that this is to be run
General sub Tab
Output Type: From the drop-down list identify the type of output required: The options are
Email Report - Email the selected Report. The following parameters are required. You can identify the Recipients, enter information for the email Body, add selection Criteria, add CC's and BCC's to the Email and make attachments using the remaining sub-tabs in this screen
Report Name - From the drop-down list select the Report to be emailed
Subject - In up to 50 characters enter the text that will appear in the Subject line of the email
From Email - The sender of the email. Example info@development-x.com
Host - The email server account name that services the emails. For Example: smtp.youremailserver.com
User - The User Name for access to Host.
Password - The password for access to Host.
Use SSL - If you are using a Secure Socket Layer (SSL) connection then 'Check' this checkbox .
Port - The Port defined by your email provider
Print Report - Print the selected Report. The following parameters are required. You can identify the Recipients, enter information for the email Body, add selection Criteria, add CC's and BCC's to the Email and make attachments using the remaining sub-tabs in this screen
Report Name - From the drop-down list select the Report to be emailed
Subject - In up to 50 characters enter the text that will appear in the Subject line of the email
From Email - The sender of the email. Example info@development-x.com
Host - The email server account name that services the emails. For Example: smtp.youremailserver.com
User - The User Name for access to Host.
Password - The password for access to Host.
Use SSL - If you are using a Secure Socket Layer (SSL) connection then 'Check' this checkbox .
Port - The Port defined by your email provider
Email - Send an email. The following parameters are required. You can identify the Recipients, enter information for the email Body, add selection Criteria, add CC's and BCC's to the Email and make attachments using the remaining sub-tabs in this screen
Report Name - From the drop-down list select the Report to be emailed
Description - Enter a description that will be output with the Report
From Email - The sender of the email. Example info@development-x.com
Host - The email server account name that services the emails. For Example: smtp.youremailserver.com
User - The User Name for access to Host.
Password - The password for access to Host.
Use SSL - If you are using a Secure Socket Layer (SSL) connection then 'Check' this checkbox .
Port - The Port defined by your email provider
Script - Run the selected Script
Script Name - From the drop-down list select the Script
DataSheet: Used for generating a pdf of completed datasheet and updating the document links to the appropriate Job/Assembly/Sales/Purchase/Invoice.
This only happens if the Parent Folder Path is defined in General Rules and the "Create Data Sheet Linked Docs From" is defined in Mobility Rules..
Accounting Link - Runs the Accounting Link using the Script defined in Files>System Configuration>System Settings>Accounting Link
Description - Enter a brief description to identify the link. No checks are made on this entry
Link Mode - From the drop-down list select the Mode of this link. The options are:
|
• |
Import |
|
• |
Export |
|
• |
Import and Export |
Run - Runs the routine identified in the 'Filename' selection
Description - Enter a brief description to identify this run. No checks are made on this entry
Filename - From the drop-down list select the routine to be run
Parameters - Enter any parameter values required by this run file
Auto Email - Runs the Email Actions specified in Email Services - Auto Email.
Description - Enter a brief description to identify this run. No checks are made on this entry
Receive Email POP3 - reads emails sent to the specified POP3 email address and processes them according to the style specified in Email Services - Email Addresses.
Sub-Folder - The folder path for received emails is already specified in Queue Settings. Here you can enter a specific folder name to hold the attachments brought in by this Receive Email function.
Host - enter the email host name here.
User - enter the email address here.
Password - enter the email account password here.
Use SSL - Tick this box if SSL authentication is required.
Port - Enter the receive email port number here.
Receive Email IMAP - reads emails sent to the specified IMAP email address and processes them according to the style specified in Email Services - Email Addresses.
Sub-Folder - The folder path for received emails is already specified in Queue Settings. Here you can enter a specific folder name to hold the attachments brought in by this Receive Email function.
Host - enter the email host name here.
User - enter the email address here.
Password - enter the email account password here.
Use SSL - Tick this box if SSL authentication is required.
Port - Enter the receive email port number here.
Recipients sub Tab
Only available to the Email Report, Print Report, and Email output options. Enter the full Email Address of the Recipient. You may enter more than one recipient but the entries must be separated by a semi-colon
Body sub Tab
Only available to the Email Report, Print Report, and Email output options. Enter the text that will become the 'Body' of the generated email
Selection Criteria sub Tab
Only available to the Email Report, Print Report, and Email output options.
CC sub Tab
Only available to the Email Report, Print Report, and Email output options. Enter the full Email Address of any Recipient that is being given a copy of this email You may enter more than one recipient but the entries must be separated by a semi-colon
BCC sub Tab
Only available to the Email Report, Print Report, and Email output options. Enter the full Email Address of any Recipient that is being given a Blind copy of this email You may enter more than one recipient but the entries must be separated by a semi-colon
Attachments sub Tab
Only available to the Email Report, Print Report, and Email output options. Click on the 'Add Attachment' button to locate the attachment. Repeat this for all attachments
Buttons
Close: This will close the Queue Schedule screen. If you have any unsaved data then you will be asked if you wish to save it before the screen is closed.
Add: This will bring up the 'Detail' Tab ready for entry of a new Schedule
Save: Not applicable to the List panel
Cancel: Not applicable to the List panel
Delete: This removes the current Schedule