> > > Cleo Clarify Ruleset Actions A Thru E

Cleo Clarify Ruleset Actions A Thru E

20th February 2017

Cleo Clarify users that interface with rulesets are commonly looking for a definition of the actions. From Cleo Clarify’s on-line help, below are the Clarify 4.6+ actions.

Absolute

Definition: Returns the absolute value of a number

Input Properties:

  • Factor1: First Number
  • RoundingDecimalPositions: Rounds the result “Half Up” if roundingDecimalPositions is not null and >=0  Example: rounding 0.745 to .75

Add

Definition: Adds two numbers together and returns a numeric result

Input Properties:

  • Addend1: First Number
  • Addend2: Second Number
  • RoundingDecimalPositions: Rounds the result “Half Up” if roundingDecimalPositions is not null and >=0  Example: rounding 0.745 to .75

AddDateTime

Definition: Adds two DateTime types and returns a new one

Input Properties:

  • Addend1: FirstDateTime
  • Addend2: SecondDateTime

AddDateTimeWithFields

Definition: Adds specified values to DateTime and returns a new one

Input Properties:

  • DateTime
  • Year
  • MonthofYear
  • DayofMonth
  • HourOfDay
  • MinuteOfHour
  • Seconds

And

Definition: Checks whether all properties are True and returns a boolean

  • Returns False only when all are properties (up to 10) are false.
  • If all values are null then returns null.
  • Returns the boolean result Or for all non null booleans.

AssembleContext

Definition: Used in conjunction with the RestoreContext action.  It is also used in application Analysis Rulesets to create context, this context holds information about the transformation document for outbound EDI.

BooleanEquals

Definition: Compares two strings to see if they are equal and returns a boolean result.

Input Properties:

  • SourceString1: First String
  • SourceString2: Second String
  • If both properties are equal, then returns boolean of true.
  • If both properties are null, then returns boolean of true.
  • If only one property is null, then returns a boolean of False.

BreakLoop

Definition: Exits a composite rule based on number of loop (iteration) values.

Input Properties:

  • numberOfLoops:
  • If numberOfLoops is not specified or it is 1, it will exit the current composite rule.
  • If numberOfLoops is greater than 1 it will exit as many parent composite rules and the specified number.
  • If the numberOfLoops is negative, the ruleset will exit with an error.

Concatenate

Definiton: Links string1 with string2 and returns the result as a concatenated string

Input Properties:

  • SourceString1: First string
  • SourceString2: Second string
  • If one of the strings is null then returns the other
  • If both are null then returns null

ConcatenateMany

Definition: Concatenates all non-null strings using the specified separator and returns a string result.

Input Properties:

  • Seperator: If null, then defaults to empty
  • UseRawValue: All strings are trimmed before the concatenation when this value is false or null.
  • SourceString (1-10): Returns null when all are empty.

Contains

Definition: Returns boolean of true if the text contains the specified string (str) value.

Input Properties:

  • text
  • str: Specified string value

CreateDateTime

Definition: Creates a DateTime

Input Properties:

  • Year
  • MonthOfYear
  • DayOfMonth
  • HourOfDay
  • MinuteOfHour
  • Seconds

CreateDateTimeFromMilliseconds

Definition: Creates a DateTime from milliseconds since 1970, 00:00:00 GMT.

Input Properties:

  • DateTimeMilliseconds: Example- 1457586000000 will create a date representing 03/10/2016.
  • CenturyIncluded: This property is false by default. Example- if property equals true, then 11457586000000 (note the extra 1) will create the same date in above example.

CreateDateTimeFromString

Definition: Creates a DateTime from a string.

Input Properties:

  • DateTimeString
  • FormatPattern: The pattern syntax. (Mostly compatible with java text SimpleDateFormat)

CreateList

Definition: Returns a new empty list of the defined variable type, and is used with other List-variable type Actions.

CreateStorageNodeWithID

Definition: Creates a StorageNode object (assignable to StorgaeNode variable) using a specified UUID String.  Typically used in the De-Enveloper Ruleset.

CreatRange

Definition: Returns a read-only list of numbers; starting and stopping at user-defined values. The list can be used to create a looping construct in conjunction with a Composite Rule.

DateTimeEquals

Definition: Checks to see if two DateTimes are equal and returns a boolean result.

Input Properties:

  • SourceString1: First Value
  • SourceString2: Second Value
  • If equal, returns true.
  • If both null, returns true.
  • If one is null, returns false.

DateTimeNotEquals

Definition: Checks to see if two DateTimes are not equal and returns a boolean result.

Input Properties:

  • SourceString1: First Value
  • SourceString2: Second Value
  • If both are equal, returns false.
  • If both are null, returns false.
  • If one is null, returns true.

DecodeString

Definition: Takes a Base64 encoded string and converts to normal string.

DivideRoundHalfDown

Definition: Divides one number (dividend) by another (divisor) and returns a numeric result.

Input Properties:

  • Dividend: The number to be divided by another number (divisor)
  • Divisor: The number to divide another number (dividend)
  • RoundingDecimalPositions: Rounds the result “down” if roundingDecimalPositions  is not null and >=0.  Example- rounding 23.5 to 23
  • If dividend is null, then returns null.
  • If divisor is null, then returns dividend.

DivideRoundHalfUp

Definition: Divides one number (dividend) by another (divisor) and returns a numeric result.

Input Properties:

  • Dividend: The number to be divided by another number (divisor).
  • Divisor: The number to divide another number (dividend).
  • RoundingDecimalPositions: Rounds the result “Half Uo” if roundingDecimalPosition is not null and >=0.
  • If dividend is null, then returns null.
  • If divisor is null, then returns dividend.

EncodeString

Definition: Takes a normal string as parameter and converts to a Base64 encoded String.

EndsWith

Definition: Returns true if test ends with suffix, otherwise returns false.  If both strings are null then returns true.

Input Properties:

  • text
  • suffix

ExecuteContentRouter

Definition: this older Action was used in Application Analysis Rulesets to match values in order to find and execute routes.

Input Properties:

  • Route Values (1-20): Application routing criteria
  • Source Context: A container for the internal context values to populate the environment and global levels of the Variables tab in a Ruleset editor. (For Example, the senderID and receiver ID for an inbound EDI document, as they would be included in the environment level in the Variables tab).
  • Source Input Data Fragment: A subset of the file being analyzed.

ExecuteMessageBusinessProcess

Definition: Used to call the Business Process defined for the found Route.

Input Properties:

  • ScriptID: Identifies the Business Process
  • Source Route ID: Identifies the Route
  • Source Context: A container for the internal context values to populate the environment and global levels of the Variables tab in a Ruleset editor.  (For example, the sender ID and receiver ID for an inbound EDI document, as they would be included in the environment level in the Variables tab.)
  • Source Input Data Fragment: A subset of the file being analyzed.

ExecuteRouteBusinessProcess

Definition: Used in conjunction with the GetApplicationRoutes and RetrieveScriptfromIDRoute Actions to call the Business Process defined for the found Route.

Input Properties:

  • ScriptID: Identifies the Business Process Script.
  • Source Route ID: Identifies the Route.
  • Source Context: A container for the internal context values to populate the environment and global levels of the Variables tab in a ruleset editor.
  • Source Input Data Fragment: A subset of the file being analyzed.

Exponentiate

Definition: Raises the value of an input parameter by the value of another input parameter.

Input Properties:

  • Factor1
  • Exponent
  • Returns Factor1 at the power of exponent
  • Returns Factor1 if exponent is null.
  • Returns null if Factor1 is null.

ExtractAfter

Definition: Returns a new string, based on a sub-string of text after the occurrence of another property.

Input Properties:

  • text
  • ContainedText
  • Example- ExtractAfter(“2003/01/15”) returns 03/01/15.

ExtractBefore

Definition: Returns a new string, based on a sub-string of text before the occurrence of another property.

Input Properties:

  • text
  • ContainedText
  • Example- ExtractBefore(“2003/01/15”) returns 2003.

ExtractDigits

Definition: Extracts all digits from a String Value

Input Properties:

  • Input
  • Does not include Comma (,), Decimal (.), or Negative Sign (-).  This Action replaces much of the functionality in the older MoveNumeric.


By: on