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 - M through T
ReplaceAll
Replaces occurrences of str in text and returns a new string.

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
        
        Ruleset Actions - M through T
        
        Matches
        Returns true if the text matches the specified regular expression.
        
        Max
        Returns the maximum number of two numbers (Number1 and Number2). For example: Max: [Number1=4, Number2=3] → [Returns] =4.
        
        Min
        Compares two numbers (Number1 and Number2) and returns the lowest (minimum) number.
        
        Move
        Moves data from source to target. (Replaces MoveNumeric, Normalize, Trim, TrimLeading, and TrimTrailing)
        
        Multiply
        Multiplies two values (Factor1 and Factor2) and returns a numeric result.
        
        Negate
        Returns the negated value of a number.
        
        Normalize
        Returns a new String replacing all multiple occurrences of white space with a single occurrence. It also trims the original text.
        
        Not
        Changes a boolean value from False to True, or True to False.
        
        NotContains
        Returns boolean of false if the text contains the specified string (str) value. Returns false if both strings are null.
        
        Not End With
        Returns false if text ends with suffix, otherwise returns true. If both strings are null then returns false.
        
        NotStartsWith
        Returns boolean of false if text starts with prefix, otherwise returns true. If both strings are null returns false.
        
        NumberEquals
        Returns boolean result of true when two numbers are equal (or both are null).
        
        NumberOfMatches
        Returns a number.
        
        NumberNotEquals
        Returns boolean result of false when two numbers are equal (or both are null).
        
        NumberToString
        Takes a number from source and converts it to a sting so that automatic trimming of leading zeros is prevented.
        
        Or
        Checks whether up to 10 booleans are true, and returns a boolean.
        
        RawMove
        RawMove transfers data at face value. Unlike Move, it does not facilitate automatic trimming/padding/spacing behavior.
        
        Remainder
        Returns the remainder of a division.
        
        ReplaceAll
        Replaces occurrences of str in text and returns a new string.
        
        RestoreContext
        Context points can be used to pass RDO and ENV variables between a Business Process and a Ruleset, or to backup and restore the data within the Ruleset. RestoreContext updates the variables and the RDO in the Ruleset with the data that is in the Storage Node.
        
        RetrieveScriptIDFromRoute
        Used in conjunction with the ExecuteMessageBusinessProcess and ExecuteRouteBusinessProcess Actions to return the script ID from a Route.
        
        Split
        Returns a new list of strings after splitting the specified text into sub-strings based on a regular expression.
        
        Starts With
        Returns true if text starts with prefix, otherwise returns false. Returns true if both strings are null.
        
        StringEquals
        Compares two strings for equality and returns a boolean.
        
        StringEqualsNormalized
        Returns true if both strings are equal after normalizing them. If both strings are null returns true. If one is null and the other is not returns false.
        
        StringEqualsNotNormalized
        Returns boolean of true if both strings are equal after normalizing them. If both strings are null then returns true. If one is null then returns false.
        
        StringNotEquals
        Compares two strings for inequality and returns a boolean.
        
        Substring
        Returns a substring of a string. (Used with SubstringReplace). For example, a substring of the word "computer" could be: puter or comp. Another use case would be take a 10-digit phone number and return only certain digits.
        
        Subtract
        Subtracts the first number (subtrahend) from the second number (minuend) and returns a numeric result.
        
        SubtractDateTime
        Subtracts two DateTimes and returns a new DateTime.
        
        SubtractDateTimeWithFields
        Subtracts the specified values from the DateTime and returns a new DateTime.
        
        SubstringReplace
        Replaces a substring within a string.
        
        SubtractDurationFromDateTime
        This task subtracts or decrements Duration from the DateTime value.
        
        ToLowerCase
        Returns a new string after converting all characters to lower case.
        
        ToUpperCase
        Returns a new string after converting all characters to upper case.
        
        Trim
        Returns a new string with leading and trailing spaces removed.
        
        TrimLeft
        Returns a new string with leading spaces removed.
        
        TrimRight
        Returns a new string with trailing spaces removed.
        
        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.

ReplaceAll

Replaces occurrences of str in text and returns a new string.

Table 1. Input Properties
Property	Type	Description
text	String
str	String
replacement	String

© 2018 Cleo. All rights reserved.