lumis.portal.analytics.automationflow.action

Interface IExperienceAutomationFlowContext

@StableMinor(version="12.4",
             sinceVersion="12.1")
public interface IExperienceAutomationFlowContext

Describes an experience automation flow context.

Since:

12.1.0

Version:

$Revision: 23905 $ $Date: 2020-06-16 15:29:26 +0000 (Tue, 16 Jun 2020) $

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	IExperienceAutomationFlowContext.IExperienceAutomationFlow Describes an experience automation flow.

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	getEventData() Returns an unmodifiable map with the attributes of the event that triggered the experience automation flow. The Java type of the attribute depends on the data type of the attribute as follows: String, Text, Keyword: String Double: Double Boolean: Boolean Long: Long Date time: Date URL: URL Geopoint: ExtendedGeoPoint The attributes may be wrapped within a list. The maps keys are the monitor field's identifier.
IExperienceAutomationFlowContext.IExperienceAutomationFlow	getFlow() Returns information about the experience automation flow being executed.
UserConfig	getFlowUser() Returns the user that generated the event that triggered the flow.

Method Detail

getFlowUser

UserConfig getFlowUser()
                throws PortalException

Returns the user that generated the event that triggered the flow. May be null if the event was not generated by a user.

Returns:

the user that generated the event that triggered the flow.

Throws:

PortalException

Since:

12.1.0

getEventData

Map<String,Object> getEventData()
                         throws PortalException

Returns an unmodifiable map with the attributes of the event that triggered the experience automation flow.
The Java type of the attribute depends on the data type of the attribute as follows:

• String, Text, Keyword: String
• Double: Double
• Boolean: Boolean
• Long: Long
• Date time: Date
• URL: URL
• Geopoint: ExtendedGeoPoint

The attributes may be wrapped within a list.

The maps keys are the monitor field's identifier. For example, the map could have the following key-value pair:

        "lum_event.datetime": 08/13/2019 15:50 (a date object)
 

The key of the key-value pair is the event date time field identifier. The value is the date the event was generated.

Returns:

an unmodifiable map with the attributes of the event that triggered the experience automation flow.

Throws:

PortalException

Since:

12.1.0

getFlow

IExperienceAutomationFlowContext.IExperienceAutomationFlow getFlow()
                                                            throws PortalException

Returns information about the experience automation flow being executed.

Returns:

information about the experience automation flow being executed.

Throws:

PortalException

Since:

12.1.0