Settings View

The Settings view is an administrative area used to configure settings for different objects, logs, email servers, and other cross-functional applications. This view can be found on the Admin Console perspective.

This view has these sections.
  • Setting Types: Each type indicates a specific object or configuration setting that can be selected to inspect.
  • Data: Displays values or attributes for the object or configuration setting selected in the Setting Types section.
    These two sections exist for each of these setting types:
    • Business Process
    • Control Number Generators
    • Email
    • Exit Points
    • Global Variables
    • Logging
    • Next Numbers
    • SSH Keys
    • Keystore Manager
    • Auth Vault

    As with most views in the Admin Console , this view remains disabled until you start a server.

Business Process

This setting type provides a staging area to assign any Business Process you wish to launch upon server start. The Data section contains the Startup Process setting. By default, this is not enabled.

Take these steps to utilize this feature:
  • Change the Enabled value to True.
  • Click under the Business Process column and select an available Business Process.
Note: The Business Process does not launch if the server is either stopped or paused.

A use case may be to have Clarify send an email (using a Business Process) every time your remote server starts.

Note: The Startup Process is only available for Single Server, and not for Server Cluster environments.

Control Number Generators

This setting type allows for viewing and configuring all Control Number Generators (CNG) in deployed Projects. These objects only appear here when referenced by an EDI Enveloper object (that belongs to a deployed Project).

Normally there is very little cause to edit these objects once deployed to a remote Server; however, this view provides a common editing area for all CNG objects (as opposed to opening individual editors).

Clicking in the Value field enables editing.


This setting type provides configuration settings for your email server, and is required in order to use the SendEmail Business Process task. Client-side SMTP authentication (SMTP Server Address, SMTP Port, and fully-qualified username and password) can be defined from this section.

Exit Points

This setting type allows for configuration of Exit Points. These specialized Events are activated whenever certain inbound EDI transactional activities occur. Once assigned to a Business Process, each Exit Point can be configured to alert you via email when certain activities occur, provide relevant data, and help you quickly identify and address errors. The Exit Points include:
  • Inbound Acknowledgement Error: This Exit Point raises a corresponding event when an inbound acknowledgement is received and contains specific EDI acknowledgement error codes. It is important to note that while other Exit Points execute at the interchange level, this ExitPoint is launched at the message or document level. If enabled, this event will raise for each inbound 997 that reports an error.
  • Inbound Duplicate Interchange: This Exit Point raises a corresponding event when Clarify identifies a duplicate interchange.
  • Inbound EDI Route Error:
  • Inbound EDI Route Not Found: This Exit Point raises a corresponding event when Clarify cannot find an Inbound EDI Route.
  • Inbound EDI Route Process Binding Not Found:
  • Inbound Interchange Processed: This Exit Point raises a corresponding event each time Clarify identifies an EDI interchange and analyzes that interchange with the De-Enveloper Ruleset.

You will use this section to assign a related Business Process for each Exit Point. Existing Business Processes can be used, or a Business Process can be created and customized for your own business requirements.

By default, an Exit Point generates an email notification for each of the supported transactional activities.

Note: Once enabled, each Exit Point executes whatever actions are specified by the associated Business Process.

Global Variables

This setting type allows for viewing Cleo-supplied Global Variables and configuring the ones you've created. Global Variables are automatically deployed upon start of the Local Test server; they become visible in the Settings view immediately. The exception is any Global Variables you’ve created that are not contained in an open Project – meaning if your Project is closed in the Clarify Workbench | Project Explorer, then the Global Variables in that closed Project will not be shown here.

Cleo-supplied Global Variables can’t be changed. The Read-Only check box indicates this. However, the Global Variables you’ve created can be changed by clicking in the Value column. As soon as you hit enter, the change is applied on the remote server.
Note: This is the recommended process to update a Global Variable that is deployed to a remote server – without resetting or overwriting deployed objects and their values.
  1. Change the Global Variable from the Settings view in the Admin Console.
  2. Make sure your Global Variable object is synched with whatever change you made.
  3. Do not undeploy a Project. Redeploy if necessary.


This setting type provides configuration settings for log levels that are displayed in the Auditor view. The following values can be selected:
  • Debug: (Most commonly selected) Displays all of the activity; useful for gathering comprehensive information regarding a particular problem.
  • Information: Displays a high-level overview of activity. Although offering less information than Debug, this can be used to gain an understanding of what occurred.
  • Warning: Displays information on potential negative impacts on other processes, configuration, or other events within the application.
  • Error: Displays only failures (when errors cause a process/event to stop abnormally).

Next Numbers

This setting type allows for viewing and configuring Next Numbers in deployed Projects.

Normally there is very little cause to edit these objects once deployed to a remote Server; however, this view provides a common editing area for all Next Number objects (as opposed to opening individual editors).

Clicking in the Value field enables editing.

SSH Keys

This setting type provide connection settings for SSH Keys, which are used with FTP Adapters when SFTP is enabled. When using SSH, a one-time connection must be made in order to retrieve the security/encryption information before sending/receiving files over SFTP.

This connection can be configured from this section of the Settings view.

Keystore Manager

The Keystore Manager provides a storage facility for cryptographic keys and certificates. This utility enables you to view, import, export or delete trusted certificates for use with an SFTP adapter.

Auth Vault

The Auth Vault provides a secure storage location for username and passwords, API keys, tokens, headers, and other info used to authorize calls to external Web Services. The benefit of a Vault is that this information can be maintained in one secure location, but accessed from multiple server environments and from different users. See Secure Authorization of Web Service Requests using a Clarify Server Vault for more details.