Jump to main content

Clarify v5 User Guide

Home
Welcome to Cleo Clarify v5
Cleo Clarify supports every phase of business integration – building, integrating, and maintaining – in one simplified, streamlined product. An individual may create, test, and deploy integration processes from beginning to end, or Clarify can be used by teams with multiple participants and roles – including business analysts, developers, and IT operations personnel.
Designing Integration Solutions
This set of comprehensive topics describe the available resources, tools, and processes used to transform data as part of an integration solution.
Transforming the Data
This set of topics describe Rulesets and how to use rules to transform your data.
Rulesets
A Ruleset is a collection of rules that govern the way Clarify transforms one business document into another.
Defining Rules using Actions, Variables, and Methods
While syntaxes vary from Ruleset to Ruleset, the basics behind creating rules and customizing each transformation remain the same, and rely on the use of Actions, Variables, and Methods.
Actions
A Ruleset Action performs some form of operation on data during a transformation run.
Ruleset Actions
Ruleset Actions - F through L
ListAdd
Adds an element to the specified list.

Welcome to Cleo Clarify v5
Cleo Clarify supports every phase of business integration – building, integrating, and maintaining – in one simplified, streamlined product. An individual may create, test, and deploy integration processes from beginning to end, or Clarify can be used by teams with multiple participants and roles – including business analysts, developers, and IT operations personnel.
- What's New in the Current Release
  Cleo Clarify v5 introduces several new features. Many of these are closely interconnected, supporting the functions of other features, editors, and resources. For the latest feature descriptions, please refer to the Clarify v5 Release Notes on the Support Portal of Cleo.com.
- Getting Started
  Clarify is a platform-independent business integration middleware that tackles a wide variety of business integration requirements. It supports Business-to-Business, Application, Data, and Cloud integration, with one investment in middleware, tools, and skills.
- Architecture
  Clarify is divided into two components: a design-time environment (Clarify Studio) and a runtime environment (Clarify Server).
- Navigating the Studio
  Learn how the Studio is structured, and get familiar with its user interface.
- Guidelines and Recommendations
  Cleo recommends specific guidelines for creating, managing, testing, and deploying Projects, Packages, and objects.
- Sharing Resources
  Clarify supports options for sharing the same objects between different Projects, and for sharing the same objects and Projects between different users.
- Versioning & Synchronizing Projects
  Clarify provides an interface to the Subversion® version control system, which allows users to share their projects on repositories, where they are stored afterwards.
- Designing Integration Solutions
  This set of comprehensive topics describe the available resources, tools, and processes used to transform data as part of an integration solution.
  - Sending and Receiving the Data
    This set of topics describe how to use objects to input and output data.
  - Defining the Data
    This set of topics describes how to use Schemas to define source and target documents or data.
  - Transforming the Data
    This set of topics describe Rulesets and how to use rules to transform your data.
    - Rulesets
      A Ruleset is a collection of rules that govern the way Clarify transforms one business document into another.
      - Creating Rulesets
        Create a Ruleset object to set up a collection of rules that govern the way Clarify transforms one business document into another.
      - Defining Rules using Actions, Variables, and Methods
        While syntaxes vary from Ruleset to Ruleset, the basics behind creating rules and customizing each transformation remain the same, and rely on the use of Actions, Variables, and Methods.
        
        Actions
        A Ruleset Action performs some form of operation on data during a transformation run.
        
        Ruleset Actions
        
        Ruleset Actions - A through E
        
        Ruleset Actions - F through L
        
        ForceTransformationError
        Exits a Ruleset with an error.
        
        FormatDateTime
        Used to convert a DateTime to a formatted string.
        
        FormatDateTimeWithTimeZone
        Used to convert a DateTime to a formatted string using a specified Time Zone.
        
        GetApplicationRoutes
        Used in Data Analysis Rulesets to call 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.
        
        GetCurrentDateTime
        Gets current Date and Time. Returns a DateTime value.
        
        GetDaysBetween
        Gets the number of days between two DateTime values, and returns a numeric value.
        
        GetDayOfWeek
        Gets the day of the week for the DateTime, and returns a numeric value from 1 to 7.
        
        GetDayOfMonth
        Gets the day of the month from a DateTime, and returns a numeric value from 1 to 31. Returns null if the specified DateTime is null.
        
        GetDayOfYear
        Gets the day of year from a DateTime, and returns null if the specified date time is null.
        
        GetHourOfDay
        Gets the hour of the day from a DateTime and returns a numeric value from 0 to 23. Returns null if the specified DateTime is null.
        
        GetMilliseconds
        Gets the number of milliseconds since 1970, 00:00:00 GMT for the DateTime, and returns numeric value. Returns null if the specified DateTime is null.
        
        GetMinuteOfHour
        Gets the minute of the hour from a DateTime and returns numeric value from 0 to 59. Returns null if the specified DateTime is null;
        
        GetMonthOfYear
        Gets the month of the year from a DateTime and returns a numeric value from 1 to 12. Returns null if the input is null.
        
        GetNewUuid
        Creates a new UUID as String. Typically used in the De-Enveloper Ruleset.
        
        GetNextNumberFromServer
        Retrieves the next value of a Next Number using the specified key. The fully qualified path must be defined as such: <package name>.<object name>.<next number key name>.
        
        GetSecondOfMinute
        Gets the second of the minute from a DateTime and returns a numeric value from 0 to 59. Returns null if the input is null.
        
        GetYear
        Gets the year from a DateTime and returns a numeric value.
        
        GreaterThan
        Checks to see if one number is greater than the other, and returns a Boolean result.
        
        GreaterThanOrEquals
        Checks to see if one number is greater than or equal to the other, and returns a Boolean result.
        
        Length
        Returns the length of text as a number, and returns null if the text is null.
        
        LessThan
        Checks to see if one number is less than another, and returns a Boolean result.
        
        LessThanOrEquals
        Checks to see if one number is less than or equal to another, and returns a Boolean result.
        
        ListAdd
        Adds an element to the specified list.
        
        ListGet
        Returns an element from a list at a specified position.
        
        ListSize
        Returns the number of elements in a specified list.
        
        LogInfo
        Displays additional transformation/application log data in the Details section when using the Run Transformation feature in your Ruleset editor.
        
        InsertReferenceData
        
        IsEmpty
        Used to condition a Rule based on the non-availability of data. Returns a boolean of true if node is empty.
        
        IsFalse
        Determines whether an expression is false and returns a boolean.
        
        IsTrue
        Determines whether an expression is true and returns a boolean.
        
        IsNotEmpty
        Used to condition a Rule based on the availability of data. Returns a boolean of false if node is not empty.
        
        IsNotNull
        Returns boolean value of True if sourceNode is not empty.
        
        IsNotNullOrWhiteSpaces
        Contains one property: sourceNode. Returns true for Composite types (Segments, Rows, RecordGroups, Records) if sourceNode is not present in the file.
        
        IsNull
        Contains one property: sourceNode. Returns false for Composite types (Segments, Rows, RecordGroups, Records) if sourceNode is present in the file.
        
        Ruleset Actions - M through T
        
        Using Custom Actions in the New Engine
        
        Variables
        Variables supply rules (and rule conditions) with values for their Inputs and Outputs parameters. A variable can hold system-generated information that is likely to change at runtime; it can also hold a user-defined initial value (in effect, making it a constant) – but that value too may change, if desired, at runtime.
        
        Methods
        A Ruleset Method, like a Composite Rule, is used to group rules. An important difference however, is that the method includes Type parameters which correspond to data types in the source and target of the Ruleset. Methods can also be re-used within the Ruleset, thereby providing better maintainability.
        
        Using the Properties View
        Configure Rules and general Ruleset behavior using several tabbed views in the Properties view located at the bottom of the Ruleset editor.
      - Run the Transformation directly from the Ruleset
        The new transformation engine gives you the ability to run Rulesets (complete or partial state) within the Studio without having to deploy the Ruleset and other resources first. In fact, you can test a Ruleset before even creating other objects such as Business Processes, Adapters, etc. This allows for regular testing, debugging, and observing specific results or behavior of the rules from directly within your transformation Ruleset.
      - Disabling Rules
        Rules can be temporarily disabled so that they do not execute as part of normal Ruleset operation.
      - An Example of a Working Ruleset
        This example shows how a Ruleset can be configured to use different actions, conditions, and variables. There are many different ways to create rules to achieve a single transformation goal. Because of the many options Clarify provides, you may - and likely will - find other ways to create rules that accomplish your transformation needs.
    - Customizing Your Transformations
      Use these objects to further customize your transformations.
    - Using the new Transformation Engine
      Clarify now includes a next generation transformation engine, and with it new versions of the Ruleset and other supporting resources, as well as new features and improved Ruleset usability.
  - Routing the Data
    This set of topics describe concepts and objects used to identify, process, and route data.
  - Processing the Data
    This set of topics describe how to use Business Processes to sequence and execute the tasks necessary for your integration solution.
  - Wizards and other Tools
    This set of topics describe several Wizards and other tools to assist in the creation and configuration of Project resources.
- Promoting Resources to Servers (deployment)
  Promotion describes the act of moving different resources (mainly objects and Projects) into a server environment that can be used for testing or production-ready integration with external servers. The Studio provides two methods to promote resources – either locally or remotely.
- Integrating Clarify with Other Applications
  This set of topics describe how to configure Clarify to integrate with external applications, programs, and interfaces.
- System Maintenance
  The following topics discuss guidelines, provide recommendations and best practices, and explain available tooling which support good system management and health for your Clarify environments. Topics cover everything from backups and upgrades, to data purging and daily operational maintenance.
- Studio Installation and Configuration
  This set of topics provide installation procedures, system requirements and other configuration details for the Clarify Studio.
- Server Installation and Configuration
  This set of topics provide installation procedures, system requirements and other configuration details for the Clarify Server.

ListAdd

Adds an element to the specified list.

Table 1. Input Properties
Property	Type	Description
List		The list that is being added to.
Element		The element that is being added to the list.

Related concepts

© 2018 Cleo. All rights reserved.