Outcome Computations Authoring

The core of the outcome computations view is its data mapping capability. When there are matches in the pattern, the system evaluates the data mappings designed for the outcome to create the output data. Outputs can be monitored and picked up by other tools (such as Cogynt Workstation) to:

• Provide human-in-the-loop interaction.
• Generate automatic notifications.
• Feed into other event patterns for next-level pattern detection (in cases of transitory output).

Adding Computation Elements to Diagrams

At its simplest, data mapping is a value transfer from an element field to an outcome field. However, in situations of greater complexity, it may be necessary to compute an outcome field value based on computations or a chain of computations from values of various element fields. The outcome computations view provides a variety of computation elements for this purpose, including:

• Partition Values
• Constants
• Arithmetic Operators
• Boolean Operators
• Comparison Operators
• Functions

These elements, along with basic elements and favorite functions, can be added using the tool palette or the right-click selection menu. The corresponding topics in this section explain how to add each element.

Adding Partition Values

The Partition Values tool grants access to the values of partitioned event types. When a pattern is partitioned over a split array, this tool makes it possible to capture and manipulate the individual values from the array.

To add partition values:

1. In the tool palette, click the Partition Values tool.
2. From the menu, select the appropriate field/value.
3. Click any open space in the diagramming area to place the partition value.

Adding Constants

The Constants tool grants access to constants of different primitive data types, including:

• Boolean – A true or false value.
• Date/Time – A datatype that represents a date and time together as a single data unit. Sometimes called "datetime" in other contexts. When a date/time datatype is used in calculations or computations, Cogynt outputs a timezone or UTC value consistent with the input.
• Float – A floating point number (decimal value or fractional number).
• Integer – A whole number, such as 25 or -25.
• IP - A unique address that identifies a device on the internet or a local network.
• Null – An empty value. Its datatype conforms to whatever datatype the function is interacting with.
• String – A sequence of (often alphabetical) characters.
• Unique ID – An alphanumeric string for labeling information in a computer system.
• URL – An address for a unique resource on the Internet.

To add a constant:

1. In the tool palette, click the Constants tool.
2. From the context menu, select the intended data type for the constant.
3. Click any open space in the diagramming area to place the constant.
4. In the details panel, set the constant's value.

note

For Date/Time constants, click the calendar icon to bring up date/time control.

Adding Arithmetic Operators

The Arithmetic Operators tool grants access to common arithmetic operators, including:

• Add (+)
• Subtract (-)
• Multiply (x)
• Divide (÷)
• Modulus (%)

To add an arithmetic operator:

1. In the tool palette, click the Arithmetic Operators tool.
2. From the context menu, select the intended operator.
3. Click any open space in the diagramming area to place the arithmetic operator.

Adding Boolean Operators

The Boolean Operators tool gives access to logical conjunctions or disjunctions, including:

• AND
• OR
• NOT

To add a Boolean operator:

1. In the tool palette, click the Boolean Operators tool.
2. From the context menu, select the intended operator.
3. Click any open space in the diagramming area to place the Boolean operator.

Adding Comparison Operators

The Comparison Operators tool grants access to standard comparison operators, including:

• Equal (=)
• Greater Than (>)
• Greater Than or Equal To (≥)
• Less Than (<)
• Less Than or Equal To (≤)
• Not Equal (≠)
• Is Null (∅)

To add a comparison operator:

1. In the tool palette, click the Comparison Operators tool.
2. From the context menu, select the intended operator.
3. Click any open space in the diagramming area to place the comparison operator.

Adding Functions

The Functions tool grants access to a list of built-in functions that can be used in conjunction with other operators.

For a full list of supported functions and their descriptions, see Built-In Computation Functions.

To add a function:

1. In the tool palette, click the Functions tool.
2. From the context menu, select the intended function. Filter the list using the search box as needed.
3. Click any open space in the diagramming area to place the function.

Favoriting Functions

If certain functions are frequently used, they can be designated as favorites, and can be accessed using the Favorite Functions tool for greater convenience.

To designate a function as a favorite:

1. In the tool palette, click the Functions tool.
2. In the context menu, select the function to designate as a favorite. Filter the list using the search box as needed.
3. Click the heart icon. The icon changes to a highlighted heart to indicate that the function is now a favorite.

Unfavoriting Functions

Favorite functions can have their favorite designations removed as needed, which also removes them from the Favorite Functions tool.

To remove a favorite function's designation:

1. In the tool palette, click the Functions tool.
2. In the context menu, select the function to unfavorite. Filter the list using the search box as needed.
3. Click the heart icon. The icon changes to a non-highlighted heart to indicate that the function is no longer a favorite.

Duplicating Computation Elements

Copies of computation elements can be made as needed.

To duplicate a computation element:

1. In the diagramming area, click the computation element to copy.
2. Click the Clone button and drag the cursor to an open space in the diagramming area.
3. Release the mouse button. The duplicate computation element is created at the cursor’s location.

Deleting Computation Elements

Existing computation elements can be deleted as necessary.

To delete a computation element:

1. In the diagramming area, click a computation element to delete.
2. Click Delete (X).

Hiding and Showing Fields

The field list for elements or outcomes can be hidden from view to reduce onscreen clutter, or returned to view as needed.

To hide or show the fields of an element or outcome:

1. In the diagramming area, click the appropriate element or outcome.
2. Click Collapse to hide the field list.
3. Click Expand to reveal the hidden field list.

Drawing Connections

All computation elements require their input and output parameters to be connected to either:

• Element or outcome fields.
• Other computation elements.

If this condition is not met, Cogynt Authoring draws a red border around it to flag it as a consistency error.

Note

• Elements can only have output connections from their fields.
• Outcomes can only have input connections to their fields.

When drawing a connection, you must always start with a source that is either:

• A field of an element.
• The output parameter of a computation element.

The authoring environment highlights all possible targets in the diagram where you may connect the line.

Drawing from Element Fields

To draw a connection from a field of an element:

1. In the diagramming area, click the appropriate element.
2. Click and hold the mouse button over the cell containing the appropriate field name. (Note: When a field can be clicked and held, the cursor turns into a crosshair (+).)
3. In the diagramming area, look for a highlighted target (either a computation element's input or an outcome field name).
4. Drag the cursor to the desired target.
5. When the target's border is highlighted, release the mouse button.

Note

As a form of data type validation, a target is highlighted if the target field data type is consistent with the data type of the output field of the element or computation element.

Drawing from Computation Element Outputs

To draw a connection from the output of computation elements:

1. In the diagramming area, click the appropriate computation element.
2. Click and hold the cell containing the computation element's output. (Note: It is typically labelled "Result." When the output can be clicked and held, the cursor turns into a crosshair (+).)
3. In the diagramming area, look for a highlighted target (either a computation element's input or an outcome field name).
4. Drag the cursor to the desired target.
5. When the target's border is highlighted, release the mouse button.

Changing Link Types

There are two types of line connections (or links) in an output computations diagram:

• Set-of-values link – A link whose source is treated as a set of input values. Only an element field can be the source for this link type. All built-in aggregation functions expect links of this type connected to them because their input parameters require sets. In the diagram, this type of link is represented by a teal double-arrow.
• Single-value link – A link whose source is treated as a single input value. The source can be either an element field or a computation element’s output. In the diagram, this type of link is represented by a grey arrow.

By default, drawing a connection from an element field to a computation element that is not an aggregated function produces a single-value link. To change it to a set-of-values link:

1. In the diagramming area, hover the cursor over a link originating from an element field. (Note: It should connect to a computation element, not an outcome.)
2. Click the Set icon to toggle the link type. Alternatively, right-click the link and select "As-Set On" or "As-Set Off" as needed.

Note

A link connected to an aggregated function is not editable.

Removing Connections

Right-click an existing connection to delete it.