Mail address company

See also: Mail address user value resolver

Value resolver – Abstract

Purpose: This value resolver searches the communication information attributes in the company address of the logged in or an explicitly selected company for entries for the Communication type 'E-mail' with the specified context and returns a list of the e-mail addresses found.


images/download/attachments/91132240/image2022-1-24_17-31-29-version-1-modificationdate-1643041890139-api-v2.png

The Mail address company value resolver searches the communication information attributes in the address of a given company account for entries of the 'E-mail' (EMAIL) Communication type with the specified 'Context'.

  • If the Company parameter refers to a specific company account (see Company accounts), its address (address) field is evaluated.

  • If there is no selection for the Company, then the evaluation is performed for the Company of session, which may differ from the actual login context within a Ausführen als event action.

  • The input value is irrelevant for this value resolver.

If successful, the return value of the value resolver is a list of strings (string[]) containing all non-empty values of communication information attributes of the searched address whose context (communicationContext) exactly matches (including case sensitivity) the value in the Context communication info parameter.

NOTE◄ Even a single match is returned as an element of a list, so a value resolver (e.g. List item or Rule list resolver) may be needed to directly access the single value. However, this does not matter in the typical environment within a E-Mail event action, since strings or lists of strings are accepted there when addressing e-mails (in the 'Recipient', 'CC' and 'BCC' parameters).

The return value of the value resolver, on the other hand, is 'No value' (null) if the stored address (address) for the evaluated company account does not have a communication information attribute that fulfills all of the following conditions:

  • The attribute refers to the Communication type 'E-mail' (EMAIL) in the 'Type' (communicationType) field.

  • The attribute refers exactly to the value in the Context parameter of the value resolver in the 'Context field' (communicationContext).

  • The attribute defines any text in the 'Value' field (communicationValue).
    NOTE◄ Whether this text meets formal criteria for an e-mail address is not examined.

NOTE◄ The evaluation of the user account address by the Mail address company value resolver is performed without any regard to access restrictions that apply in the execution context (Role of session, Company of session, Ausführen als) for the relevant company account. The value resolver can therefore also access the communication information of Company accounts that do not appear, for example, in a Search or overview with the same login data.

Configuration

The Context communication info parameter must be filled with any static text as a required field. The value resolver only returns values from communication information whose 'context' (communicationContext) matches the value specified here exactly (incl. upper/lower case).

NOTE◄ Since the parameter cannot be left 'empty', the value resolver categorically does not consider communication information without context.


The optional Company parameter allows a single selection from the Company accounts list. As can be seen in the image, the Combobox element supports a search function.

If no company is selected, then the evaluation refers to the Company of session valid in the context of the value resolver, which may differ from the session in the context of an Ausführen als event action.

►IMPORTANT◄ During configuration, only Company accounts with read-only access at the minimum in the current session appear in the drop-down list. If an existing configuration refers to a company for whom there is no read access in the current session, the label appears as 'hidden company account'. At runtime, read access is irrelevant for the configuration behaviour.

images/download/attachments/91132240/image2022-1-24_17-32-29-version-1-modificationdate-1643041949449-api-v2.png

Example

The company 'Xflow AG' operates a self-service portal based on Lobster Data Platform / Orchestration on which specific company accounts are maintained for suppliers and customers. In the case of certain events within the configured workflows, the system should automatically send e-mail notifications. 'Xflow AG' wants to be identified as the sender of these messages, but makes it clear that a reply to the sender's address is neither expected nor processed.

In the company account, under the Communication infos tab, a special e-mail address is stored for this purpose, for which the text 'noreply' is specified as the Context:

images/download/attachments/91132240/image2022-1-24_17-33-45-version-1-modificationdate-1643042025969-api-v2.png

The e-mail address stored centrally in Value is used in all relevant places as the sender address for e-mails sent by the system.

Configuration:

Whenever a E-Mail event action is used in an event handling to trigger the automatic sending of an e-mail, the system can – with the configuration shown on the right – access the noreply address centrally stored in the company account of 'Xflow AG' as the sender:

  • In the From tab of the E-Mail event action, the Mail address company value resolver is inserted and configured as follows:

    • The Context communication info parameter points to the noreply key value specified randomly in the company account for the Context.

    • In the Company parameter, the company account of 'Xflow AG' can be selected, if it is visible in the configuration session.

images/download/attachments/91132240/image2022-1-24_17-34-57-version-1-modificationdate-1643042097284-api-v2.png

NOTE◄ There are several ways to trigger the events which the system notifies by sending e-mails. These events can be triggered alternately by all participants in the respective workflows (suppliers, customers, Xflow AG). The event processing usually takes place in the context of a session, which refers to one of the companies involved as the Company of session. The Mail address company value resolver can evaluate the communication information in the company account of the 'Xflow AG' even if the Company of session has no read access for this company account.

IMPORTANT◄ If the E-Mail event action is configured in such a way that Lobster Data Platform / Orchestration also creates e-mail objects (see E-mails) for all generated mails, then – without any further precautions in the workflow – the Company of session in the respective context automatically becomes the owner of the created e-mail object.

Xflow AG, as the operator of the service portal, will always be registered as the owner of the E-mails, so that it can control the access of other companies by means of Company authorizations.

This is ensured with the following alternative configuration:

A Ausführen als event action is used here to temporarily change the login context for the E-Mail from the actually logged in company to the 'Xflow AG' selected in the Company override parameter. Effectively, only the Company of session is customized here.

  • The Mail address company value resolver accesses the Company of session without selecting a Company, which is reliably the 'Xflow AG' in the direct context of the Ausführen als event action. Therefore, the selection of the Company can be omitted. The Context communication info parameter remains unchanged and refers to the key value noreply.

  • If E-mails are created by the E-Mail event action in the context of the Ausführen als event action, 'Xflow AG' is considered the owner of these e-mails. Users who have access to the overview for E-mails on the basis of role permissions, for example, but are logged on in the context of one of the other companies, will only see the e-mails automatically generated with this configuration there if suitable Company authorizations for E-mails exist.

NOTE◄ A change made via Ausführen als for the login context does not necessarily have to be made within the same event handling. The changed context is passed on to event actions triggered by it, for example, by a Eigenes Aktionsevent auslösen (Aktion) event action. This should be considered if there is no explicit Company selection in the Mail address company value resolver.

images/download/attachments/91132240/image2022-1-24_17-36-30-version-1-modificationdate-1643042190464-api-v2.png