Skip to main content
Version: 2.0.0

Email Service

Purpose​

Define a service to interface with Email.

Prerequisites​

For this to work, you need a configured Email Connection.

Configuration​

Name & Description​

Teams Email NameAndDescription

  • Name : Name of the Asset. Spaces are not allowed in the name.

  • Description : Enter a description.

The Asset Usage box shows how many times this Asset is used and which parts are referencing it. Click to expand and then click to follow, if any.

Required roles​

In case you are deploying to a Cluster which is running (a) Reactive Engine Nodes which have (b) specific Roles configured, then you can restrict use of this Asset to those Nodes with matching roles. If you want this restriction, then enter the names of the Required Roles here. Otherwise, leave empty to match all Nodes (no restriction).

Email Service Settings​

Configure the parameters for your Email Service:

Email Service Settings

Connection​

Email Connection drop-down list

Use the drop-down list to select a Email Connection that should support this Email Service. If it does not exist, you need to create it first.

More Settings​

The Email Service allows two functions: Send and SendAndForget. Regardless of which function is used, the emails always go to into a queue that sends the email with a throttle setting defined by Max messages per time unit. With Send you only get a response when the email has actually been sent (or in case of an error). With SendAndForget you only get an error in case the queue reaches the limit defined in Send queue size. An attempt is then made to send the email, but you would no longer get an error.

Email Service More Settings

  • Send queue size : Defines the maximum number of messages waiting to be send out before a further send request leads to a failure.
  • Max. messages / per : defines the throttle setting as explained above.

Example: Using the Email Service​

The Email Service can be used from within a JavaScript Asset. In our example we have a simple Workflow which reads an input file with some data (1), then in a next step (2) sends a simple message via Email (only on the StreamEnd event), and simply outputs the incoming data back to an output file again. There is no other purpose in this Workflow than to demonstrate how to use the Service.

Example Workflow (Service Email)

In the middle of the Workflow we find a JavaScript Processor by the name of “SendEmail”. This Processor prepares a message to be send via Email as configured in the Service Email asset.

How is it configured?

To use the Email Service in the JavaScript Processor, we first have to assign the Service within the JavaScript Processor like so:

Link Service to JavaScript Asset (Service Email)

  • Physical Service (1): The Email Service which we have configured above.

  • Logical Service Name (2): The name by which we want to use the Service within JavaScript. This could be the exact same name as the Service or a name which you can choose. Must not include whitespaces.

Access the Service from within JavaScript​

Now let’s finally use the service within JavaScript:

Preparing Message to be Send via Email​
const OUTPUT_PORT = processor.getOutputPort('Output-1');

// We are defining a function "sendEmail" that will take emailMessage parameters 
// as input parameters
function sendEmail(emailMessage) {
    services.EmailService.Send({
        From: {
            Address: emailMessage.from
        },
        ToList:     emailMessage.to,
        Subject:    emailMessage.subject,
        Text:       emailMessage.body
    });  
}

/**
 * Handle a message
 */
export function onMessage() {
    stream.emit(message, OUTPUT_PORT);
}

// the onStreamEnd function will send an email about the  
// processing of a file including its name
export function onStreamEnd() {
    // populate the emailMessage structure to hand over input parameters for "sendEmail" function
    let emailMessage = {
        from:       "user@email.com",
        to:         "recipient@email.com",
        subject:    "Processing for Stream " + stream.getName(),
        body:       "The subject mentioned file has been processed"
    }
    // call function "sendEmail"
    sendEmail(email);
}

Service Testing​

layline.io provides a test facility for testing your Services before you deploy them. In this way, you save time and effort by testing your Services without having to deploy and activate a whole Project with Workflows.

Once you have configured your Service(s), you can test them: Within your Asset Configuration tab (1), switch to the Test tab (2) to test your Service.

Test Facility Toolbar​

The toolbar provides the following options:

The Testing tab provides two major views:

  1. Testcase configuration: This is where you define the testcases to be executed.
  2. Testcase execution: This is where you can execute the testcases and see the results.

You switch between these two views by clicking on the leftmost icon in the toolbar (1).

Let's start with the Testcase configuration view.

Testcase Configuration​

The concept of the Testing is to define a set of Testcases which can be executed in a batch or individually. For this purpose, you can define multiple Testcases and configure them individually. I.e. each Testcase groups a number of indidivual tests which can be executed individually or in a batch.

Adding a Testcase​

Click Add Testcase in the toolbar to add a new testcase:

A new Testcase is added. It is automatically named New<Service Asset Name>Test (3) and added to the list of Testcases (2).

  • Service test name (3): You can change the name of the Testcase here.
  • Service test description (4): You can add a description to the Testcase here.

Test Case Setup​

Basics​

In this section you define the individual tests to be executed for this Testcase.

To start, click # END in the toolbar:

A new test is added to the list of tests (1), and the test is opened for configuration (2).

Next we fill in the details:

  • Test name (3): You can change the name of the Test here.

  • Test description (4): You can add a description to the Test here.

  • Service function to test (5): Select the Service function to test here.

    This list contains all Service functions which are defined in the Service Asset. Pick the one you want to test.

    Once a Service function is selected, the system will automatically create a skeleton to fill in the respective parameters for the selected Service function.

Service Function Input Parameters​

  • Service Function Input Parameters (6): Fill in the respective parameters for the selected Service function.

    In our example we have a function GetAlertsForSite which takes two parameters baseurl and riskId. If we click on Add member in the skeleton table the system will allow you to select the respective parameter from the list of available parameters:

    Once you have selected the parameter, the system will automatically add the respective parameter name. You then add the respective value for the parameter:

Service Function Evaluation Parameters​

To automatically evaluate the result, you can add a script which analyzes the results.

Testcase Execution​

Once you have configured your Testcases, you can execute them.

There are two ways on how to trigger execution:

  • Option 1: Select Run selected test in the toolbar (1) to execute the currently selected Testcase.

    Executing a test this way will switch the tab to the Testcase execution view, execute the test and show the results.

  • Option 2: Switch to the Testcase execution view by clicking on the leftmost icon in the toolbar (1) select the test to execute, and then hit the play button next to the test.

Each option will take us to the Testcase execution view:

In this view you can find the Testcase (1) and the Tests (2) we have created. If we had created additional tests for this Testcase, they would be listed here as well.

Question marks indicate that the test has not yet been executed.

We can now either execute all tests, or run them individually:

  • Run all Tests (1): Click this button to execute all tests.

  • Run Testcase (2): Click this button to a Testcase with all its underlying individual tests.

  • Run individual Test (3): Click this button next to a test to execute this individual test.

Once a test has been executed, the question mark will be replaced by a green check mark or a red cross depending on whether the test was successful or not.

The right hand-panel will show the results of the test execution respectively:

In case of errors, the system will show the error message for further investigation.

Can't find what you are looking for?

Please note, that the creation of the online documentation is Work-In-Progress. It is constantly being updated. should you have questions or suggestions, please don't hesitate to contact us at support@layline.io .