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 - A through E
CreateList
Returns a new empty list of the defined variable type, and is used with other List-variable type Actions.

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
        
        Absolute
        Returns the absolute value of a number.
        
        Add
        Adds two numbers together and returns a numeric result.
        
        AddDateTime
        Adds two DateTime types and returns a new DateTime value.
        
        AddDateTimeWithFields
        Adds specified values to a DateTime and returns a new DateTime value.
        
        AddDurationToDateTime
        This task adds to or increments Duration from the DateTime value.
        
        And
        Checks whether up to 10 booleans are true and returns a boolean.
        
        AssembleContext
        Used in conjunction with the RestoreContext action. It is also used in Data Analysis Rulesets to create context; this context holds information about the transformation document for outbound EDI.
        
        BooleanEquals
        Compares two strings to see if they are equal, and returns a boolean result.
        
        BooleanNotEquals
        Compares two strings to confirm that they are not equal, and returns a boolean result.
        
        BreakLoop
        Exits a composite rule based on number of loop (iteration) values.
        
        CalculateDuration
        This task calculates the time between two DateTime variables.
        
        Concatenate
        Links string1 with string2 and returns the result as a concatenated string.
        
        ConcatenateMany
        Concatenates all non-null strings using the specified separator and returns a string result.
        
        Contains
        Returns boolean of true if the text contains the specified string (str) value.
        
        CreateDateTime
        Creates a DateTime.
        
        CreateDateTimeFromMilliseconds
        Creates a DateTime from milliseconds since 1970, 00:00:00 GMT.
        
        CreateDateTimeFromString
        Creates a DateTime from a string.
        
        CreateDuration
        This task creates a Duration variable to be used with a DateTime variable.
        
        CreateList
        Returns a new empty list of the defined variable type, and is used with other List-variable type Actions.
        
        CreateNumberFromStringWithLocale
        Converts a Source Number value as the default Java Locale into a String whose format is user-defined by the Locale parameter. For example, passing a number value of "1000.01" to a String defined with the "nl-NL" (Netherlands) locale will result in the value "1.000,01". The format of the Locale needs to be a language tag.
        
        CreateStringFromNumberWithLocale
        Converts a Source String value whose format is user-defined by the Locale parameter into a Number formatted according to the default Java Locale. For example, passing a string value of "1.000,01" defined with the "nl-NL" (Netherlands) locale through this rule will result in a number with the value "1000.01". The format of the Locale needs to be a language tag.
        
        CreateStorageNodeWithID
        Creates a StorageNode object (assignable to StorageNode variable) using a specified UUID String. Typically used in the De-Enveloper Ruleset.
        
        CreateRange
        Returns a read-only list of numbers; starting and stopping at user-defined values. This list can then be used to create a looping construct in conjunction with a Composite Rule.
        
        DateTimeEquals
        Checks to see if two DateTimes are equal and returns a boolean result.
        
        DateTimeNotEquals
        Checks to see if two DateTimes are not equal and returns a boolean result.
        
        DecodeString
        Takes a Base64 encoded string and converts to normal string.
        
        DivideRoundDown
        Divides one number (dividend) by another (divisor) and returns a numeric result.
        
        DivideRoundHalfUp
        Divides one number (dividend) by another (divisor) and returns a numeric result.
        
        DurationEquals
        This task checks to see if two Duration variables are equal and returns a boolean result.
        
        EncodeString
        Takes a normal string as parameter and converts to a Base64 encoded String.
        
        EndsWith
        Returns true if text ends with the suffix; otherwise returns false. If both strings are null then returns true.
        
        ExecuteContentRouter
        This older Action was used in Data Analysis Rulesets to match values in order to find and execute Routes.
        
        ExecuteMessageBusinessProcess
        Used to call the Business Process defined for the found Route.
        
        ExecuteRouteBusinessProcess
        Used in conjunction with the GetApplicationRoutes and RetrieveScriptFromIDRoute Actions to call the Business Process defined for the found Route.
        
        Exponentiate
        Raises the value of an input parameter by the value of another input parameter.
        
        ExtractAfter
        Returns a new string, based on a sub-string of text after the occurrence of another property.
        
        ExtractBefore
        Returns a new string, based on a sub-string of text before the occurrence of another property.
        
        ExtractDigits
        Extracts all digits from a String value.
        
        Ruleset Actions - F through L
        
        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.

CreateList

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

Related concepts

© 2018 Cleo. All rights reserved.