Use the Admin Console perspective to perform various administrative functions and monitor system operations. Most views in the Admin Console remain disabled until connected to your cloud server.
This perspective contains these views:
- Projects
- Business Process
- Resource Monitors
- Auditor
- Settings
- Schedules
Projects View
The Projects view is the primary area for publishing (promoting) resources (objects and Projects).
Business Process View
The Business Process view is an area used for monitoring and launching deployed Business Processes.
Deployed Business Processes may be monitored in real-time, showing the progress and current state of a task, as well as its variable content. Updates are in real-time, so as soon as state changes occur in a Business Process, that change is reflected in this view.
This view has these sections:
Business Processes
This section lists all Business Processes available for deployment. You can also manually launch a Business Process from this section using the Launch Business Process button.
Business Process Manager
- Process ID (PID), Name, Start Date/Time, and State
- Individual Business Process tasks
- Variables and values being processed
Information for active Business Processes only displays as it remains active. Once completed, the Business Process and its related information disappear. Use the Auditor View to view completed Business Processes.
Resource Monitors View
The Resource Monitors view is an area for monitoring and managing Cloud Monitors. This view has these sections.
Resource Monitor Types
This section displays all monitors by type. Currently, the only type is the Cloud Monitor.
Resource Monitors
Auditor View
The Auditor view is a diagnostic tool used to identify and troubleshoot integration runtime errors and exceptions.
It is also used to manage other log-driven activities, such as process- and document-oriented logs, log filtering and customization, reprocessing, and purging. See Using the CIC Studio Auditor for more information.
This view has these sections:
Quick Searches
Quick Searches are a log query, available from the Auditor view, which allows you to use and create custom logs based on different log types. This feature allows you to search based upon either basic log type data or specific groupings of commonly-used types and attributes.
Quick Searches can be created with specific conditions, and these can be saved as a Log Filter and added to a Log Filter Group.
All Quick Search results can be viewed from the Log Entries section of the Auditor.
Quick Searches are based on the type of log selected in the Log Type drop-down. The selected log type determines which log information shows on the Log Entries section. Certain features are not available for all log types.
Modify your Quick Search with conditions
A Quick Search can be customized and refined to include specific conditions. Using different expressions and properties, create new conditions to filter for desired results.
- Under the Quick Search section, select a log type.
- Click the Add Group button
to create either an inclusive or exclusive statement, such as an All (and) or Any (or) statement. This will apply to any child expressions.
- Click the Add Columns Expression button
to create a new row.
- (For Connection log type only) Click the Add Property Expression
button to choose specific Properties for searching.
- For the Name, Condition, and Value columns, click the appropriate field and select the desired attribute, or populate the value by typing into the field. Different options are available according to log type.
The log results change instantly in the Log Entries section based on your modifications.
Save a Quick Search as a Log Filter
In the example above, if you were to select another log type, the modifications would not be saved. You can save a Quick Search as a Log Filter and add it to a Log Filter Group for re-use and more effective log management.
Take these steps to save a modified Quick Search as a Log Filter.- Under the Quick Search section, create a Quick Search based on your requirements .
- Click the Save Quick Search as a Log Filter button.
- Provide a name for your Log Filter.
- If desired, you can add this Log Filter to one, or more, Log Filter Groups.
- Click OK to complete.
Log Filters
A Log Filter is an activity-based log query made available from the Admin Console | Auditor. It allows you to filter log results based on different groupings, including custom groups.
The Studio uses logs to record system activity. While system activities can be specific to individual objects, such as a Business Process, they may also be set to record specific transformation activity, such as inbound EDI document processing.
Filtering by Log Type
The information returned by a Log Filter corresponds to the type of log being queried. Log types are selected from the Quick Search section, shown below. The selection determines what logs display in the Log Entries section. For detailed information on this section and how it can be used, refer to Quick Searches.
Available log types include:
- Connection: a log that records activity at the EDI connection level.
- Interchange: a log that records activity at the EDI interchange level.
- Group: a log that records activity at the EDI group level.
- Message: a log that records activity at the EDI message level.
- Route: a log that records activity for inbound and outbound Routes.
- Process: a log that records Business Process activity.
- Outbound Acknowledgement: a log that records outbound acknowledgment activity.
- Inbound Acknowledgement: a log that records inbound acknowledgment activity.
- Interchange Inbound Acknowledgement: a log that records inbound interchange acknowledgment activity.
- Group Inbound Acknowledgement: a log that records inbound group acknowledgment activity.
- Message Inbound Acknowledgement: a log that records all inbound message acknowledgment activity.
Log Filter Groups
Log Filter Groups are a collection of Log Filters. These can be selected from a drop-down in the Log Filter Group section. The group you select determines which logs display in all other sections of the Auditor view.
Log Filter Groups can be used across all server connections from the Studio in which they were created. User-created Log Filter Groups are not available for all Studio users, as they exist within the local Workspace. Log Filter Groups can be accessed from the Workspace installation in a folder called logFilterGroups. These files can be distributed among other Studio team members, or even placed inside of a Project and shared with an SVN Repository.
While custom Log Filter Groups can be created, the following default groups are provided:
All User Created
This group shows all custom Log Filters.
Application
This group contains these Log Filters:
- Process: Shows the date, process number, and name for Business Process activity.
Inbound EDI
This group contains these Log Filters:
- Connections – Inbound: Shows the date and connection number for inbound activity.
- Interchanges – Inbound: Shows the date and interchange control reference for inbound activity.
- Process – Inbound: Shows the date, process number, and name for inbound Business Process activity.
Outbound EDI
This group contains these Log Filters:
- Connections – Outbound: Shows the date and connection number for outbound activity.
- Interchanges – Outbound: Shows the date and interchange control reference for outbound activity.
Unsuccessful Inbound EDI
This group contains these Log Filters:
- Connections – Inbound - Unsuccessful: Shows the date and connection number for unsuccessful inbound activity.
- Interchanges – Inbound: Unsuccessful: Shows the date and interchange control reference for unsuccessful inbound activity.
- Process - Inbound - Unsuccessful: Shows the date, process number, and name for unsuccessful inbound Business Process activity.
Unsuccessful Outbound EDI
This group contains these Log Filters:
- Connections – Outbound – Unsuccessful: Shows the date and connection number for unsuccessful outbound activity.
- Interchanges – Outbound – Unsuccessful: Shows the date and interchange control reference for unsuccessful outbound activity.
Status Checks
This group contains these Log Filters:
- Inbound Ack Failures: Shows the date, Message ID, and segment reference for inbound acknowledgement that have not been accepted.
- Outbound Group Ack Rejected: Shows the date and Group control reference for rejected outbound acknowledgements.
- Unsuccessful Connections: Shows the date and connection number for unsuccessful connections, including those not delivered to ESX.
- Unsuccessful Processes: Shows date, process number, and name for unsuccessful Business Processes.
Log Entries
The Log Entries section displays log data based on the criteria selected in the other sections of the Auditor view. This section allows for troubleshooting, reprocessing, and log setting configuration.
Each log displays a table of attributes for that selected log type. Date is common to all log types, but the Process log, for example, also shows the Process Number and Business Process name. The Group log shows the Group control reference number.
The toolbar provides functionality to manage the display and behavior of log entries. They are:
- Refresh: reload log entries.
- Log Entries Preferences: opens the Preferences window for general log configuration.
- Reprocess logs: reprocesses an EDI transaction at the connection, interchange or message level.
- Change log status: Changes the log entry status to Completed.
- Change acknowledgment status: Change a log entry acknowledgement status (accepted, rejected, etc.).
- Delete: Removes log entries.
Note: Logs should generally not be deleted; purging is the recommended method for clearing log entries.
Working with individual log entries
Clicking on a log opens a new tab in the Auditor view with log-specific details and processing structure, a key tool in diagnosing errors.
Reprocessing
Reprocessing allows documents to be processed again after they have been initially processed and logged. Transactions can be reprocessed at the connection, interchange or message log level. After a transaction fails and is corrected, reprocess the proper log.
Reprocessing is particularly useful when, for example, an interchange may have had one of its message fail, which other messages successfully processed. In this case, that message can be reprocessed after a fix has been applied, and prevents other messages in the interchange from being reprocessed.
Changing Auditor Preferences and Entries display
Click the Log Entries Preferences button to display the Preferences window. Its Log Entries panel allows for customization of the display area for each log and Log Filter.
Besides column settings, other settings include the ability refresh logs automatically, determine the default number of logs displayed, and adjust log entry font.
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.
- 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.
- Control Number Generators
- Exit Points
- Global Variables
- 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.
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; 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.
Exit Points
- 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 CIC Studio identifies a duplicate interchange.
- Inbound EDI Route Error:
- Inbound EDI Route Not Found: This Exit Point raises a corresponding event when CIC Studio 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 CIC Studio 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.
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 the 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 Workbench | Project Explorer, then the Global Variables in that closed Project will not be shown here.
- Change the Global Variable from the Settings view in the Admin Console.
- Make sure your Global Variable object is synched with whatever change you made.
- Do not undeploy a Project. Redeploy if necessary.
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; 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 provides 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. See Secure Authorization of Web Service Requests using the Server Vault for more details.
Schedules View
The Schedules view is a calendar view showing all deployed Process Schedules on a yearly, monthly, weekly, or daily basis. You may also view a list of scheduled processes.
The Process Schedule object allows you to assign a specific Business Process and determine when and how often it will execute. This object can be created, edited, and deleted.
You cannot edit the actual Business Process from this view; it is simply used for viewing the list of scheduled Business Processes.