Whenever a roster change is made or when you release the roster, emails and messages can be manually and automatically to a crewmember. A number of settings need to be adjusted prior to sending an Email.
COM channel
Field | Description |
Name | This is a mandatory field. |
In/Out | Should be set as OUT. |
Host | These are details from provide as an email provider. Set as Provider Address. |
SSL | SSL stands for Secured Socket Layer . It is a secure way of providing authentication and encryption during communication online between your computer and the mail server. |
User | Set as Sleipner. |
User Name & Password | Username and password to your email account. |
Communication Type | Set as Email. |
File Type | Set as Email. |
Setup parameters: To be setup in SETUP
Field | Description |
DefaultEmailSender | Default email sender is used when no user email is provided. The Email sender is called the ORIGINATOR. The Email of the logged in user will be used. |
EmailReceiversOnComChannelFailure | Add emails for receivers of Com Channel failures. Separate emails with ";". |
EmailReceiversOnRaidoAPIFailure | Email receivers for RaidoAPI failures. |
UseDefaultEmailSender | If the setting UseDefaultEmailSender is set to TRUE, Sleipner will send all outgoing emails from the "DefaultEmailSender" address and not the user email address. |
Template
There are four templates made in the Integration factory:
- Two for Roster Releases (Body and Subject) that will send an Email when you release the roster.
- Two for Roster Revision notifications (Body and Subject) that are used every time you make a revision.
To change a Body or Subject, click the text and change. You can also Copy to create a new one by using an existing template.
Creating a new message from scratch
Revision Notification
- Click the NEW button.FieldDescription
Name Enter a descriptive name. This is a mandatory field. DataType This must be set to the Human Resources type. - In the Data Element, you will set it to Text and click the ADD button. You can insert data information from the Gantt, such as the Name. Use CRFL for a line break.
- Test your message using the TEST RUN button to see how it will be presented and change accordingly. Click the FINISH button.
Note: Follow the same process for the Header.
Roster Release
The process is the same as for Revision Notification.
Events: The Events are created in the Automation factory. When an event like a roster revision happens, the Event is triggered and Sleipner sends the message to the COM and the message is sent out.
Example: We created the two notifications in the Events section: RosterRelease and RevisionNotification. The way the two events are set up is the same, except for the Event type and the template.
- Enter the information in the appropriate fields of the Event and Data.
Field Description Event The system has a long list of built in events. For this exercise we use Roster REV and ROSTER PUBL. DataType Set this to Human Resources. Filter None, but you could use any of the HR Filters. Station None, but you could use Station specific messages. Bounce Message Isn't used for SMS. - Select the Template Type.FieldDescription
Template Type Set to OwnMessage. Template Set to Roster Revision - Body. Criteria Set to None. Header Template Set to Roster Revision - Subject. - Fill in the appropriate fields and click the FINISH button.
Field Description Com Channel Set to Email. Com Channel Instance Select your COM Email instance. Address Write the Email Address types you want to include, multiple addresses can be separated by semicolon (see Email Types). The system will look after the Email type on the crew (must be defined as work) and send the email to the corresponding email address. Send as unique If the COM Channel is EMAIL, you have the option to send as unique which will send individual emails.
Manual Email
From the Roster Gantt, you can send Email directly to a crew member.
- Right-click the crew you want to send an email to.
- Select the EMail icon.
- The Originator is the email of the user logged in. The Receiver is the email address of the email you are send the email to.
Note: You can send the message to multiple crew by marking the crew.
Manual Email to Contacts
From the Search button, you can send an email to a user that is not loaded into the Gantt.
- Click the email address in the EMAIL column.
- The email dialog will open.