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.
Routing the Data
This set of topics describe concepts and objects used to identify, process, and route data.

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.
  - Routing the Data
    This set of topics describe concepts and objects used to identify, process, and route data.
    - Trading Partner
      The Trading Partner is a grouping component that improves how you can query EDI activity. The object groups all Clarify objects used for inbound and outbound processing based on individual trading partner identification.
    - Application Interface
      An Application Interface is an object that contains attributes defining Application Routes. Clarify uses values from a Data Analysis Ruleset (DARS) to route data by comparing them to Application Routes and Outbound EDI Routes. It uses information contained in your data to help identify that data's purpose and to which trading partner it should be sent. For example, an attribute might be a customer number.
    - Application-to-Application
    - Inbound EDI
    - Outbound EDI
    - Fields
      A Field is a variable in a Business Process that gets its value from another object.
  - 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.

Routing the Data

This set of topics describe concepts and objects used to identify, process, and route data.

Trading Partner
The Trading Partner is a grouping component that improves how you can query EDI activity. The object groups all Clarify objects used for inbound and outbound processing based on individual trading partner identification.
Application Interface
An Application Interface is an object that contains attributes defining Application Routes. Clarify uses values from a Data Analysis Ruleset (DARS) to route data by comparing them to Application Routes and Outbound EDI Routes. It uses information contained in your data to help identify that data's purpose and to which trading partner it should be sent. For example, an attribute might be a customer number.
Application-to-Application
Inbound EDI
Outbound EDI
Fields
A Field is a variable in a Business Process that gets its value from another object.

© 2018 Cleo. All rights reserved.