Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Contents:

Table of Contents
minLevel1
maxLevel1

...

Introduction

Adonis Notification Service is a utility that enables you to set up periodical auto-generated emails and send them to different crew members. You can install multiple instances of Notification Service as well as simultaneously run them on your PC.

Housekeeping

Before getting started with the installation of the Adonis Notification Service, make sure .NET Framework 4.7 or higher is installed on your PC. Otherwise, follow the link below to access the installation package:
https://www.microsoft.com/en-US/download/details.aspx?id=42642

Besides, to install the application, you are required to have administrator rights on your computer. To check whether you are an Administrator, go to Settings > Accounts > Your info.

You can install the utility in less than ten steps. Let us start!

Step 1

To start the installation, locate and double-click the installation file provided by our support team.

Step 2

When the File Download dialog appears, click the Save button.

Step 3

Once the download is complete, go to the downloaded path and double-click the installation file to launch the setup wizard. Click Next to proceed.

Step 4

Specify the database settings:



To access the database settings, first, you need to run Adonis Personnel Manager and follow the prompts below:

  1. Go to the Service Desk ribbon tab and click the About button. In the dialog box that appears, click the System button to get access to the system information:

  2. In the System Information dialog, go to Adonis Personnel Manager > Database > Connection to locate the database and server names. Now, copy and paste the data to the correspondent fields in the setup wizard: Database name and Database server name.

  3. In the System Information dialog, switch to Environment where you can find Site Number. Now, copy and paste the value to the correspondent Site ID field in the setup wizard.

  4. In the Task table AutoRefresh Time (seconds) dialog, enter the number standing for the time interval in seconds based on which the Tasks table will be automatically refreshed.

  5. The Service instance name field allows you to define different Service names for several instances of Adonis Notification Service that you may want to install. The field is required if you have several databases on a single site.

    Info
     Avoid defining the same Service names for the instances which are to be installed on a single server.


    Once you have finished configuring the database settings, click Next in the setup wizard.

Step 5

Define the e-mail settings that will ensure a proper connection with your SMTP server:



Select the Use SMTP settings from the APM option to allow Adonis Notification Service to use the SMTP settings configured in Adonis Personnel Manager.

...

  • SMPT server. Enter a server name to which you want to get connected.

  • Port. Enter 25 as it is a default port number of an outgoing SMTP server.

  • Sender e-mail. Define the email address that will be used for sending notifications.

  • SMTP requires authentication. Select the checkbox to enable SMTP authentication Enter your credentials to log into the server.

Warning

By default, Adonis Notification Service uses the SMTP server settings configured in Adonis Personnel Portal.

Click Next to continue.

Step 6

When the Choose Install Location dialog appears, click Browse… and choose the folder to install Adonis Notification Service. The default destination folder is C:\Program Files\Adonis\NotificationService.


To proceed, click Install.

Step 7

You can see the Adonis Notification Service installation process in progress.



Click Next to finish the installation process.

Step 8

Once completed, Adonis Notification Service is successfully installed on your PC:



Click Finish to close the Adonis Notification Service setup wizard.


Functionality

In this section, we will walk you through the main principles under which Notification Service works.
By following the guidelines, you will get to know how to configure, create, edit and schedule tasks for sending notifications.

Get Started

Warning

Before starting to work with the Service, make sure the access right for the 824 Notification Service routine is granted to you in Adonis Control Centre.

...


Сlick New to create a notification task.
Click Open to edit an existing notification task.
Click Delete to remove a selected notification task.

Scheduled Task

The delivery of notifications is handled by the system based on the time and date values that you define.

...


Select the When finished send the log file to checkbox to enable the possibility to receive a log file after sending a notification. Once enabled, enter the email address.
Besides, you can reschedule the existing task. To do this, simply double-click the task you want to reschedule and define the time and date settings as mentioned above.

Set Email Address

In the Notification E-mail tab, you can define one or more email addresses to which a notification is to be sent.

...

In this section, we will show you how to proceed with the selected method.

Add Emails Manually

To manually enter one or more email addresses, navigate to the Notification E-mails tab in the Task Properties dialog and select the Fixed E-mail list option:



Now, fill in the fields as described below:

  1. Recipients. Enter one or more email addresses of the recipients.

    Warning
    iconfalse
    When entering multiple email addresses in a row, separate them with commas. Alternatively, you can organize email addresses in a list without using a delimiter.


  2. E-mail subject. Specify the main idea of the notification.

  3. E-mail body. Type the essence of the message you want to convey.

Retrieve Emails From Database

To enable the possibility to create a SQL statement for fetching email addresses from the database based on a preset condition, switch to the Notification E-mails tab in the Task Properties dialog and select the Dynamic from database option:



Now, fill in the fields as described below:

  1. In the Recipients box, write a SQL statement to fetch the required email addresses from the database. The statement will filter the crew members' emails that fit one or more conditions.

    Info
    iconfalse
    Below you can find several useful tips for writing the SQL statement:

    Use a hash symbol # as alias for fields from database tables.
    Each field should be defined only once inside the query.
    Avoid defining values like select pw001p01.pin as #PIN, 1020 as #PIN.


  2. In the Field identifying email address field, define one of the aliases that exist in the selection (e.g. #Email).

  3. Specify the main idea of the notification in the E-mail subject field.

  4. In the E-mail body field, type the text of the message to be sent. When entering field alias, wrap them in brackets, e.g. [#Pin]. This will reveal data as real database values corresponding to each selected person.

  5. Select the Distribute checkbox in case you want to send a personal notification (e.g. birthday card). As a result, the notification will be sent as an attachment as well as added to the Enclosed Documents related to a person.

  6. In the Document Type field, click the down caret to make the list of options appear. In the drop-down list, select a document type previously defined in General Codes (Setup > General Codes > Enclosed Documents).

Attach Report

When setting a notification task, you can add a report to be sent as an attachment in the notification email.

...

To prevent unauthorized users from accessing the data in the document, select the Protect PDF file with a password checkbox. This enables the options to be used for setting a password that corresponds to:

  • Personal ID

  • Birthdate

  • Personal ID (birthdate if empty)