DocRead Notification Scheduler Knowledgebase | Collaboris https://www.collaboris.com/category/knowledgebase/notificationscheduler-kb/ We make compliance simple Mon, 26 Sep 2022 14:58:14 +0000 en-GB hourly 1 https://www.collaboris.com/wp-content/uploads/2016/07/collaboris_favicon.png DocRead Notification Scheduler Knowledgebase | Collaboris https://www.collaboris.com/category/knowledgebase/notificationscheduler-kb/ 32 32 Why don’t I receive emails? https://www.collaboris.com/why-dont-i-receive-emails/ Fri, 17 Jun 2016 15:51:35 +0000 http://collaboriscom.wpengine.com/?p=1547 Why don’t I receive emails?All emails sent out by DocRead are sent using a separate application called the Collaboris Notification Scheduler. If you aren't receiving emails it's highly likely to be one of the following reasons :The Collaboris Notification Service isn't installed and / or configured. Please read this the section on the Scheduler towards […]

The post Why don’t I receive emails? appeared first on Collaboris.

]]>

Why don’t I receive emails?

All emails sent out by DocRead are sent using a separate application called the Collaboris Notification Scheduler. If you aren't receiving emails it's highly likely to be one of the following reasons :

  • The Collaboris Notification Service isn't installed and / or configured. Please read this the section on the Scheduler towards the end of the Administrators User Guide found in the Documentation Center.
  • The Collaboris Notification Service isn't started. To start load the 'Collaboris Scheduling Configuration Tool' and click 'Start' (see image below).
  • The SMTP Server isn't responding or access is denied. (Check connectivity and access). To test connectivity, please refer to this article : http://support.microsoft.com/kb/153119
  • The Email account configured doesn't have permission to send out an e-mail or doesn't have an Exchange mailbox. Please check the user can send mail through Exchange.
  • The Collaboris Notification Scheduler cannot connect to the Scheduler or DocRead databases, or access is denied. The scheduler service needs connectivity to both the DocRead database and the Scheduler database, please verify that a connection to the SQL Server can be established. Please also ensure that the account (that the scheduler service runs as), has read and write permissions over the databases. To test connectivity to SQL Server, please refer to this article : http://blogs.msdn.com/b/sql_protocols/archive/2008/04/30/steps-to-troubleshoot-connectivity-issues.aspx
  • The user doesn't have a valid email address. DocRead uses the email that is stored against the user's profile in SharePoint. Please ensure the users have email addresses associated with the profile. Please note: for SharePoint server this will more than likely be propagated from Active Directory by the User Profile Sync service. For Foundation, this will be brought in ONCE only when the user logs in. If the email was empty at this time, then you will need to create a script to re-import it, or do it manually.
  • The SMTP server requires authentication. Your SMTP server may require a user id and password to send email. Please try adding credentials the Email Settings screen.

Extra Troubleshooting

To help troubleshoot problems with email, a log is also produced in your 'programdata' directory. This will more than likely be here : "%ProgramData%\Collaboris\DocRead Scheduler\Logs".  A log is produced for each day.

How to start the scheduler

Please ensure the Collaboris Notification Service is started :

The post Why don’t I receive emails? appeared first on Collaboris.

]]>
How to adjust the timing of DocRead notification emails https://www.collaboris.com/how-to-adjust-the-timing-of-docread-notification-emails/ Tue, 26 Oct 2021 11:13:02 +0000 https://www.collaboris.com/?p=1369440 How to adjust the timing of DocRead notification emails The DocRead Notification Scheduler oversees the sending of emails within DocRead. Three timer jobs are used to schedule and issue emails associated with DocRead tasks, they are: 1) New Tasks Job – Responsible for sending emails for new reading tasks. This job, by default, runs once per […]

The post How to adjust the timing of DocRead notification emails appeared first on Collaboris.

]]>

How to adjust the timing of DocRead notification emails

The DocRead Notification Scheduler oversees the sending of emails within DocRead. Three timer jobs are used to schedule and issue emails associated with DocRead tasks, they are:

1) New Tasks Job – Responsible for sending emails for new reading tasks. This job, by default, runs once per hour every day

2) Overdue Tasks Job – Responsible for sending emails for overdue tasks. This job runs by default once per day

3) Completed Tasks Job – Responsible for sending emails for completed tasks. This job runs by default every 15 minutes

You can configure the frequency of the above jobs (and change these default values) by updating the “jobs.config” file under the “[Program Files]CollaborisDocReadScheduler”. Each job contain a “repeat-interval” element that is specified in milliseconds. Just remember that, after changing the file, you will need to restart the scheduler service ( which can be done via the “DocRead Scheduler” tool )

You also need to back up all of the .config files prior to an upgrade as these will be overwritten. Once the upgrade is completed you can then merge your changes back in.

Important considerations:

One thing to be mindful of is setting the Overdue job to a shorter frequency. If, for example, you set it to run every hour then anyone who has overdue reading tasks will be emailed every hour.

If you set any of the timer jobs to a longer frequency (e.g. weekly) then no emails for those tasks will be sent out until the timer job runs. For example, if you set the overdue notice to send emails weekly, and that job normally runs at 12 noon on Monday, then the first email notification to be sent for a task that falls overdue at 1pm on Monday afternoon will be issued at 12 noon on Monday of the following week.

If you are wondering how many milliseconds there are in minutes, or wanting to convert minutes to milliseconds, then here are some options to help you:

Minute to millisecond conversions:

15 minutes = 900000 milliseconds

30 minutes = 1800000 milliseconds

1 hour = 3600000 milliseconds

12 hours = 43200000 milliseconds

1 day = 86400000 milliseconds

1 week = 604800000 milliseconds

I hope these help!

The post How to adjust the timing of DocRead notification emails appeared first on Collaboris.

]]>
How to display a comment to users as they complete a reading assignment https://www.collaboris.com/how-to-display-a-comment-to-users-as-they-complete-a-reading-assignment/ Mon, 15 Dec 2014 07:00:19 +0000 http://collaboriscom.wpengine.com/?p=432 How to display a comment to users as they complete a reading assignment DocRead can be used to create specific tasks for users requesting that they read and acknowledge key documents. The tasks can relate to policies, procedures or other important information. DocRead is particularly useful where compliance with these documents is essential for legal […]

The post How to display a comment to users as they complete a reading assignment appeared first on Collaboris.

]]>

How to display a comment to users as they complete a reading assignment

DocRead can be used to create specific tasks for users requesting that they read and acknowledge key documents. The tasks can relate to policies, procedures or other important information. DocRead is particularly useful where compliance with these documents is essential for legal or other business requirements.

DocRead can send emails when these compliance tasks are created to notify the users. Default email templates are provided, but can also be amended to reflect corporate branding.

The default DocRead email templates and Task notification panel provide a space for specific comments or notes relating to a DocRead task to be displayed to the end user. This could be a helpful tip about the task they need to complete or a note explaining what changes have been made in this particular version of a policy.

To add a comment relevant to a document that you want users to see on DocRead emails or task notifications you must first select a text column to use (or create a new one)

Note: The information in this post relates to DocRead for on-premises SharePoint only. 

How to select the comments field

  1. Go to the DocRead Site Settings page:         222-1
  2. In the Document Library section select the site document library you wish to use.
  3. Then select a text field from the drop down list provided as a ‘Comments Column’.
  4. In this example I have created a new column called ‘DocRead comments’.
  5. Click ‘OK’ to save your changes.

Please note that when an item from this document library is assigned to users by DocRead the entry made into this field will be displayed to the users in their email notifications and in the ‘three tab reading window’.

222-2

When assigning a particular document from this document library, this field will now be displayed in the ‘edit properties’ screen as shown below.

222-3

The post How to display a comment to users as they complete a reading assignment appeared first on Collaboris.

]]>
How to customize the DocRead Emails https://www.collaboris.com/how-to-customize-the-docread-emails/ Mon, 15 Dec 2014 06:20:15 +0000 http://collaboriscom.wpengine.com/?p=541 How to customize the DocRead EmailsNote: The information in this post relates to DocRead for on-premises SharePoint only. Note: This Knowledge base article is relevant for DocRead version 2.x. If you are using DocRead version 3 or above, please refer to posts on the email template functionality.To amend the e-mails that get sent out with DocRead, follow […]

The post How to customize the DocRead Emails appeared first on Collaboris.

]]>

How to customize the DocRead Emails

Note: The information in this post relates to DocRead for on-premises SharePoint only. 

Note: This Knowledge base article is relevant for DocRead version 2.x. If you are using DocRead version 3 or above, please refer to posts on the email template functionality.

To amend the e-mails that get sent out with DocRead, follow these instructions. Please try this first on a “test” or “development” farm because any changes you make are immediate and will affect every e-mail (of that type) that gets sent out. It is also important not to amend any other tables directly (or amend the schema of the DocRead database in any way), as these changes will be lost during an upgrade. We plan to make a management screen for this in a subsequent release of DocRead.

Steps to amend the template :

  • In “SQL Server Management Studio” navigate to your DocRead database. (To find out what your database is called, look at the ‘Database Settings’ under the ‘DocRead Database Name’ (Highlighted below)
416-1
  • Find the database table called ‘Readership.EmailTemplate’ and select ‘Edit Top 200 Rows

416-2

The table contains columns that map to the email. As follows :

  • TitleImportant : don’t change this! This is used by DocRead to identify the correct email to send.
  • Subject. Appears on the subject line of the email.
  • Description. Not used in this release.
  • Body. The main body of the e-mail.

416-3

  • To edit a particular type of email, click into the appropriate row and change either the ‘Subject’ and/or the ‘Body’. Once you have made the necessary changes, click out of the row. At this point your changes will be saved and are effectively live.
  • The ‘Body’ column should contain HTML. It is advisable to make a copy of the existing HTML and amend that, with your favourite HTML E-mail editor. You can also embed a number of tokens that will be replaced with the real value when the email is created. (I haven’t sent you the HTML for the newer, shorter version. If you require this – just shout).

The tokens are fairly self-explanatory, as follows :

  1. {TaskPanelUrl} (The url to open the task information panel for the document, so the user can confirm)
  2. {CreationDate}
  3. {DueDate}
  4. {Period}
  5. {DocumentVersion}
  6. {CompletionDate}
  7. {CompanyName}
  8. {TaskStatus}
  9. {DocumentName}
  10. {DocumentId}
  11. {DocumentTitle}
  12. {UserName}
  13. {DocumentUrl}
  14. {ReadershipType} (Required / Recommended)
  15. {ReceiptUrl}
  16. {ChangeComments} (If a comments column is registered in the DocRead enabled library, the value typed here will be used).
  • To test your changes, use DocRead to configure a task to the new status (assignedoverdue or completed), then restart the email service which will cause the email to be sent immediately.

The post How to customize the DocRead Emails appeared first on Collaboris.

]]>
How do I disable DocRead emails? https://www.collaboris.com/how-do-i-disable-docread-emails/ Mon, 15 Dec 2014 06:09:34 +0000 http://collaboriscom.wpengine.com/?p=566 Note: The information in this post relates to DocRead for on-premises SharePoint only. If you wish to prevent DocRead from sending emails, then follow these steps… On the server that you installed the ‘DocRead Notification Scheduler’ load the ‘Windows Services’ mmc and locate the service that is called ‘Collaboris Scheduling Service’, then right click and select ‘properties’. On the properties […]

The post How do I disable DocRead emails? appeared first on Collaboris.

]]>
Note: The information in this post relates to DocRead for on-premises SharePoint only. 

If you wish to prevent DocRead from sending emails, then follow these steps…

On the server that you installed the ‘DocRead Notification Scheduler’ load the ‘Windows Services’ mmc and locate the service that is called ‘Collaboris Scheduling Service’, then right click and select ‘properties’.

500-1

On the properties dialog, set the service to ‘Disable’ and also click ‘Stop’ as highlighted below. Once this is done click ‘Ok’.

500-2

The service should now be stopped. To restart it repeat these steps and change the service to ‘Automatic’ and then click ‘Start’.

If you wish to know what happens to emails when you enable / disable the scheduler refer to this KB article :

what-happens-if-i-enable-disable-the-email-scheduler

Recent posts you may find interesting:

The post How do I disable DocRead emails? appeared first on Collaboris.

]]>
How to Set Up and Refine Email and Web Part Templates in DocRead https://www.collaboris.com/how-to-set-up-and-refine-templates-in-docread/ Mon, 11 Jul 2016 14:52:47 +0000 https://www.collaboris.com/?p=1999 How to Set Up and Refine Templates in DocReadNote: The information in this post relates to DocRead for on-premises SharePoint only. In DocRead version 3.0 one of the new features is the ability to assign tasks to users with different messages that you can create and specify e.g. “please read this document”, “please watch this video” or […]

The post How to Set Up and Refine Email and Web Part Templates in DocRead appeared first on Collaboris.

]]>

How to Set Up and Refine Templates in DocRead

Note: The information in this post relates to DocRead for on-premises SharePoint only. 

In DocRead version 3.0 one of the new features is the ability to assign tasks to users with different messages that you can create and specify e.g. “please read this document”, “please watch this video” or “please complete this questionnaire”. This feature also makes it possible to create templates and send messages in different languages.

Creating a new Template

You can create templates at site level and use them for any task that you assign from DocRead enabled libraries and lists in that Site.  Options to amend the Email Templates, Task panel messages and Terms and Conditions are all available.

You may find it useful to create a new default set of templates to include organisational images,logos and standard phrases and then clone the basic set (i.e. opening the basic set up and saving with a new template name) before amending it for specific task messages.

To get started, just follow the steps below. We are always on hand to help if you get stuck but hopefully this article will share the basis principles.

Please note, you need to be a member of the 'Site Owners' group to see all of the DocRead menu options shown below:

  • Navigate to the site where you want to create specific templates and go to ‘Site Settings’.
  • From the DocRead ‘Manage Templates’ option, existing templates will be listed on this page
  • Select ‘Create Template’.

The first step is to give your new template a Name and a Description.  You can then go ahead and configure the 'Emails', the 'Task Panel' and the overarching 'Terms and Conditions

You can begin to create a full set of standardised email templates and Web part messages that suit both your corporate look and feel and also the task at hand. 

What Elements Can Be Changed?

As mentioned above, there are three key areas that we would advise you adapt to suit your specific needs.

  • Emails 
  • Task Panel information 
  • Terms and Conditions

As the person entrusted to send tasks to staff using DocRead, you can change each of these areas for an individual task that you are sending out or - as we would recommend -  you can create standard templates that you may re-use again and again. In doing so, you will save countless hours as you refine and improve your messaging to create the impact you are looking for. 

Email Templates

DocRead ships with three basic email templates which are used when ‘Required’ tasks are assigned, 'Completed' or fall 'Overdue'. You can use as starting points for any template amendments you wish to make or just dive in and create yours from scratch. You can also copy existing templates for emails so long as they are in HTML format. 

Note: Emails are NOT sent for Recommended items. They are only triggered if you distribute a 'Required' task

To change the email that is sent upon assigning a DocRead task to a 'Required Audience' use the drop down arrow and select "Required"

Once the template loads up, enter an appropriate subject, amend the body of the email and adapt the out of the box look and feel to suit your business. You can include links, add images and essentially do anything you can normally do with any HTML format email.

If you are a more advanced HTML user, you can access all of the content direct from the html editor option on the template screen (see the image on the left).

You can use pre-configured 'Tokens' in your emails to embed items like the recipients name, the date of the task, the due date and other items directly into your emails. 

In this same manner, you can also update and refine the emails that are sent when a person Completes a task or the DocRead task falls Overdue (according to the deadline that you have set).

The Task Panel

As with email templates, you can very quickly and very easily adapt the messages and instructions that will be seen by a staff member if they access their DocRead tasks from the web part. 

The title and message fields shown on the ‘Task’ and ‘Confirmation’ tabs on the Task Panel can be amended as required. You may wish to change the text to state ‘You are required to read and follow this policy’ for example

This will amend the text viewed by the user here:

You can adapt many parts of the template  for each stage of the process to suit the messaging you wish to present.

Another great example you might use is to change the "View Document" button to become "Watch Video" when you are sending out training materials to staff as described in this blog post - Send Video as a DocRead Task

And Finally ... Terms and Conditions. 

The last part of the puzzle when sending tasks to staff is to ensure they fully understand the requirements and implications of completing a DocRead task. This ultimately forms part of their contract with you and if written correctly, can help staff confirm their accountability for a particular DocRead task. 

As with all aspects of the template, it is very easy to update and maintain T's & C's to make sure that specific items are given the correct terms according to your requirements.

If you were to update the terms as above, it will amend the text viewed by the user here:

The receipt messages (both positive and negative) are displayed to the user on the Reading Receipt provided to the user when they either complete or fail to complete a task using DocRead.

Linking your new template to the DocRead task

Once you have your templates ready and you are happy that they are correct for the types of items you want to send out using DocRead, you can go ahead and link them to the items. When you assign an audience, these will automatically start to be received by the people you want to target.

To add a template, just select the document, click "DocRead Settings", then you can choose the template you just created (or one you made earlier). 

The template capability puts you in control of the messages that you send to your staff and allows you to continually improve and enhance them in real time - all of the time. 

 

 

The post How to Set Up and Refine Email and Web Part Templates in DocRead appeared first on Collaboris.

]]>
How to amend the dates displayed in DocRead emails https://www.collaboris.com/amend-dates-displayed-docread-emails/ Thu, 08 Dec 2016 12:19:47 +0000 https://www.collaboris.com/?p=2219 DocRead emails are sent by the DocRead Notification Scheduler windows service and date information that may be displayed will depend on the operating system regional settings specified on the server running that service. If dates being displayed in the DocRead emails are in the wrong format (e.g. dd/mm/yy or mm/dd/yy) you will need to check the server […]

The post How to amend the dates displayed in DocRead emails appeared first on Collaboris.

]]>

DocRead emails are sent by the DocRead Notification Scheduler windows service and date information that may be displayed will depend on the operating system regional settings specified on the server running that service.

If dates being displayed in the DocRead emails are in the wrong format (e.g. dd/mm/yy or mm/dd/yy) you will need to check the server running the scheduler and ensure that the regional settings are set to display dates in the format you prefer.

Recent posts you may also find interesting:

The post How to amend the dates displayed in DocRead emails appeared first on Collaboris.

]]>
What happens if I enable/disable the Email Scheduler? https://www.collaboris.com/what-happens-if-i-enabledisable-the-email-scheduler/ Mon, 15 Dec 2014 06:12:37 +0000 http://collaboriscom.wpengine.com/?p=598 What happens if I enable/disable the Email Scheduler?The DocRead Notification Scheduler is responsible for sending out email notifications on a scheduled basis. The scheduler sends out 3 types of emails : Task Assigned – sent to a recipient when they are required to read and confirm / acknowledge a document. Task Confirmed – sent to a recipient […]

The post What happens if I enable/disable the Email Scheduler? appeared first on Collaboris.

]]>

What happens if I enable/disable the Email Scheduler?

The DocRead Notification Scheduler is responsible for sending out email notifications on a scheduled basis. The scheduler sends out 3 types of emails :

  • Task Assigned – sent to a recipient when they are required to read and confirm / acknowledge a document.
  • Task Confirmed – sent to a recipient when they have confirmed / acknowledged a document.
  • Task Overdue – sent to a recipient if the ‘due date’ has passed on a document.

When a scheduled job runs, it will interrogate the DocRead Database and send the correct emails based on the current status of the tasks at that point in time.

The email timer jobs are set to run by default as follows:

  • Task Assigned – once per hour every day.
  • Task Confirmed – every 15 minutes.
  • Task Overdue – once per day.

The timings of these can be amended to suit your circumstances, find out how here:  How to adjust the timing of DocRead notification emails – Collaboris

What does this mean?

Imagine that a DocRead Publisher sent out a document to 100 staff members at 9am and by 10am 50 users confirmed reading, (by using a DocRead web part on their MySite). If the Scheduler was started (or scheduled to run) at 8pm that evening, then it would send out 50 ‘Assigned’ emails and 50 ‘Confirmed’ emails.

The post What happens if I enable/disable the Email Scheduler? appeared first on Collaboris.

]]>
How to send overdue reminders repeatedly with DocRead https://www.collaboris.com/how-to-send-overdue-reminders-repeatedly-with-docread/ Mon, 15 Dec 2014 06:13:38 +0000 http://collaboriscom.wpengine.com/?p=580 How to send overdue reminders repeatedly with DocReadThe DocRead notification scheduler is responsible for sending emails to users when tasks are assigned, completed or fall overdue. By default, after the DocRead Notification Scheduler is installed, when a reading task becomes overdue only 1 reminder email is sent. This article will illustrate how to change DocRead […]

The post How to send overdue reminders repeatedly with DocRead appeared first on Collaboris.

]]>

How to send overdue reminders repeatedly with DocRead

The DocRead notification scheduler is responsible for sending emails to users when tasks are assigned, completed or fall overdue.

By default, after the DocRead Notification Scheduler is installed, when a reading task becomes overdue only 1 reminder email is sent. This article will illustrate how to change DocRead so that you can send overdue reminders repeatedly until reading is confirmed.

Steps – versions prior to v2.0.

1. Navigate to the folder where the Notification Scheduler was installed. This is likely to be ‘C:\Program Files\Collaboris\DocRead\Scheduler’.

2. Edit ‘CollaborisSchedulingAgent.exe.config’ in Notepad.

3. Locate this line :

<add key=”AllwaysSendOverdue” value=”false” />

and change it to this :

<add key=”AllwaysSendOverdue” value=”true” />

4. Save the file.

5. Load the Notification Scheduler application and ‘Restart The Service’.

Steps – version 2.0 onwards.

1. Load the Notification Scheduler application.

2. Select “General Settings”

3. Check “Send Overdue Repeatedly”.

4. Click “Ok”.

Overdue emails will now be sent repeatedly once per day.

It is also possible to copy these overdue reminder emails to the users line manager. This can help escalate the requirement and ensure you stay compliant. To find out how to do this, please refer to section 2.9.3 of the DocRead System Administrators Guide

The post How to send overdue reminders repeatedly with DocRead appeared first on Collaboris.

]]>
How do I disable DocRead Completed Emails https://www.collaboris.com/how-do-i-disable-docread-completed-emails/ Mon, 15 Dec 2014 06:12:25 +0000 http://collaboriscom.wpengine.com/?p=561 How do I disable DocRead Completed EmailsThe DocRead Notification Scheduler is responsible for issuing emails to users when tasks are assigned to them, are completed by them or fall overdue. Depending on your situation, you may find it helpful to disable ‘task completed’ emails from being sent out with DocRead. To disable task completed emails […]

The post How do I disable DocRead Completed Emails appeared first on Collaboris.

]]>

How do I disable DocRead Completed Emails

The DocRead Notification Scheduler is responsible for issuing emails to users when tasks are assigned to them, are completed by them or fall overdue.

Depending on your situation, you may find it helpful to disable ‘task completed’ emails from being sent out with DocRead.

To disable task completed emails please follow these steps : 

  1. Navigate to the directory where you installed the DocRead Notification Scheduler. (This will probably be : C:\Program Files\Collaboris\DocRead\Scheduler\).
  2. Open ‘Jobs.Config’ in Notepad.
  3. Find the ‘Job’ Xml element that contains a ‘job-detail’ with the name DocReadCompletedNotifications. (e.g.'<name>DocReadCompletedNotifications.</name>’).
  4. Delete the entire ‘job’ section as shown in the figure below.434-1
  5. Save the file.
  6. Restart the scheduler.

If you may want to start these emails again in the future, rather than ‘delete’ the code that drives the completed emails I would recommend that you ‘comment them out’ so you can easily add them back again in the future.

Please note: any future updates / upgrades or re-installations of the Collaboris Notification Scheduler will overwrite the changes you make to this file.

We recommend that you do not ‘turn off’ the assigned or overdue email notifications as these are really helpful to ensure users keep up to date with their compliance responsibilities. However, if you would find this useful during an evaluation of DocRead, then you can follow the same procedure for the other email types.

The post How do I disable DocRead Completed Emails appeared first on Collaboris.

]]>