> > > Cleo Clarify Ruleset Actions F Thru L

Cleo Clarify Ruleset Actions F Thru L

21st 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 from F to L.

Cleo Clarify A thru E actions can be FOUND HERE

Cleo Clarify M thru Z actions can be FOUND HERE

ForceTransformationError

Defintion: Exits the Ruleset with am error.

FormatDateTime

Definition: Used to convert a DateTime to a formatted string.

Input Properties:

  • DateTime: DateTime to be converted
  • Pattern: The pattern syntax. (mostly compatible with java text SimpleDateFormat)
  • Action replaces the older ConvertDateFormat Action

GetApplicationRoutes

Definition: Used in Application Analysis Rulesets to attributes in Application Route objects.  Works in conjunction with the ExecuteRouteBUsinessProcess and RetreiveScriptIDFromRoute actions. These Actions are used for objects created in previous versions of Clarify.

Input Properties:

  • Route Values (1-20): Application routing criteria.

GetCurrentDateTime

Definition: Gets current DateTime. Returns a new Date and Time.  Replaces older GetCurrentDate and GetCurrentTime actions.

GetDaysBetween

Definition: Gets the number of days between two DateTime Values.

Input Properties:

  • Minuend: The number from which another is to be subtracted.
  • Subtrahend: The number that is to be subtracted.

GetDayOfWeek

Definition: Gets the day of the week for the DateTime.  Returns null if the specified DateTime is null. 1 is Monday and 7 is Sunday.

GetDayOfMonth

Definition: Gets the day of the month, from 1 to 31.  Returns null if the specified DateTime is null.

GetHourOfDay

Definition: Gets the hour of the day, from 0-23.  Return null if the specified DateTime is null.

GetMilliseconds

Definition: Gets the number of milliseconds since 1970, 00:00:00 GMT.  Returns null if the specified DateTime is null.

GetMinuteOfHour

Definition: Gets the minute of the hour, from 0 to 59.  returns null if the specified DateTime is null.

GetMonthOfYear

Definition: Gets the moth of the year, returns a numeric value from 1 to 112. Returns null if the input is null.

GetNewUuid

Definition: Creates a new UUID as string.  Typically used in the De-enveloper Ruleset.

GetNextNumberFromServer

Definition; Retrieves the next value of a Next Number using the specified key.

GetSecondOfMinute

Definition: Gets the second of a minute, returns a numeric value from 0 to 59. returns null if the input is null.

GetYear

Definition: Gets the year from DateTime value and returns a numeric value.

GreaterThan

Definition: Checks to see if one number is greater than the other, and returns a Boolean result.

Input Properties:

  • numberA: Returns Boolean of true if numberA is greater than numberB
  • numberB: Returns Boolean of false if numberA or numberB is null.

GreaterThanOrEquals

Definition: Checks to see if one number is greater than or equal to the other, and returns a Boolean result.

Input Properties:

  • numberA: Returns Boolean of true if numberA is greater than or equal to numberB
  • numberB: Returns Boolean of true if NumberA and numberB are null.  Returns Boolean of false if numberA or numberB is null.

IsEmpty

Definition: Used to condition a Rule based on the non-availability of data. Returns a Boolean of true if node is empty.

Input Properties:

  • sourceNode: The reference to a piece of data (storage node)
  • trimValue: Trims the data before checking when this property is true of null.
  • Checks content for data when used with these types: String, DateTime, Element, and Field.

IsFalse

Definition: Determines whether an expression is false and returns a Boolean

  • If Boolean is null, then returns false
  • f Boolean is false, then returns true
  • If Boolean is true, then returns false

IsTrue

Definition: Determines whether an expression is true and returns a Boolean.

  • If Boolean is null, then returns false
  • If Boolean is true, then returns true
  • If Boolean is false. Then returns false

IsNotEmpty

Definition: Used to condition a Rule based on the availability of data.  Returns a Boolean of false if a node is not empty

Input Properties:

  • sourceNode: The reference to a piece of data (storage node).
  • TrimValue: Trims the data before checking when this property is true null.

IsNotNull

Definition: Returns Boolean value of True is sourceNode is not empty.

IsNotNullOrWhiteSpaces

Definition: Contains one property: sourceNode. Returns true for Composite types (Segments, Rows, RecordGroups, Records) if sourceNode is not present in the file. When used with a simple type (String, DateTime, Element, and Field), this Actions check the contents for the sourceNode. Returns true if the property is null or only contains white spaces. While this may be used with any type of node or variable, it is only useful for simple types.

IsNull

Definition:Contains one property: sourceNode. Returns false for Composite types (Segments, Rows, RecordGroups, Records) if sourceNode is present in the file. When used with a simple type (String, DateTime, Element, and Field), this Actions check the contents for the sourceNode. Returns true if the property is null otherwise it returns false. While this may be used with any type of node or variable, it is only useful for simple types.

Length

Definition: returns the length of text as a number, and returns null if the text is null.

LessThan

Definition: Checks to see if one number is less than another, and returns a Boolean result.

Input Properties:

  • numberA: returns Boolean of true if a numberA is less than numberB. Returns Boolean of false if numberA or numberB is null
  • numberB

LessThanOrEquals

Definition: Checks to see if one number is less than or equal to another, and returns a Boolean result.

Input Properties:

  • numberA: Returns true if numberA is less than or equals numberB
  • numberB: Returns true if numberA and numberB are null.  Returns false if numberA or numberB is null.

ListAdd

Definition: Adds an element to the specified list.

Input Properties:

  • List: The list that is being added to.
  • Element: the element tat is being added to the list.

ListGet

Definition: Returns an element from a list at a specified position.

Input Properties:

  • List: The list that s being inspected.
  • Index: The position of the element to be listed.  The position index starts at 1.

ListSize

Definition: Returns the number of elements in a specified list.

Input Properties:

  • List: The list being measured.

LogInfo

Definition: Displays additional transformation/application log data in the Details section when using the Run Transformation feature in your Ruleset editor.


By: on