EC Management page overview

The Management pages in grid communicate with each grid agent. Use the EC Management page in grid to control, monitor, and manage all instances of EC that may span multiple server machines or nodes.

You can access this page in grid or through the web UI. See, Accessing HTML-based EC Management Page, and Accessing Grid EC Management Page.

Before you can view the EC Management page, you must set the EC Application Role Mappings in Grid. See, the EC Security topic in the M3 Core Installation Guide and M3 Core Administration Guide.

Here are the available tasks in the Management page:

Server

This page monitors the server activities of EC.

Here are the available links:

  • The Overview link shows a complete information of every host's status, usage, and message count.

    Messages are grouped according to status such as, failed, disregarded, in-process, and finished.

    To control the server activity, select pause, reload, or resume options.

    On this page, you can monitor the system connection status to the database (DB), Business Engine (BE), and File System (FS). Under each column a green check-mark for connected or a red x-mark for disconnected indicates the connection status.

  • The Error Reports link shows a message when a server fails to respond. EC Management communicates with EC servers and sends a report through an error mail. For error reporting, you can set the conditions using specific field values. For example, specify the File name or UUID. You can also select to include a complete database in the report. Excluded in the report are log, state, and manifest details.

    Note: 

    Your security software may block the default SMTP port. If this happens, add an exception to allow connection to this port.

  • The Tasks link shows a list of long-running tasks and corresponding progress, for example, the Maintenance and Archive tasks.

  • The Mappings link allows you to Activate mappings to make the mapping ready for use. Dynamic reload of mappings does not require a EC application restart. You can only use the mappings in "Active" state.

    Use these guidelines:

    • When a new mapping is published, it is on an Inactive state. You must explicitly activate the mapping to change the state to "Active".

    • When published mappings are modified and then republished, the state becomes "Republished". You must explicitly reactivate this mapping to change the state to "Active".

      Note: 

      If the mapping used by the XML Transform process in the agreement is published, but is not activated, this error message is displayed "Unable to find source code for mapping id '<id>'". If this happens, you must Activate the mapping and re-run the message to be able to use the mapping.

      See the Business Document Mapper User Guide.

  • The Group Control Properties allows you to search and update the values of agreement control properties on group level.

  • The Agreement Control Properties link allows you to search and update the values of agreement control properties on agreement level.

Communication

On this page you can view and manage incoming and outgoing communication channels, corresponding protocols, and pools.

Here are the available links:

  • The Channel Control link allows you to change the status of a channel. An icon is displayed on each channel indicating the channel state.

    For specific communication channels, you can view or save a copy of the logs. But, log details are limited only from the channel's last startup time. To view the logs per channel from the last restart access the server's channel control page.

    From Channel control link, here are the available tasks:

    • The Load New Channels link allows you to restart newly enabled channels only, that is existing channels will not be changed.

    • The Reload All Channels link allows you to restart/start all enabled channels using latest data from the EC DB.

    • The Pause link allows you to stop a specific channel from receiving incoming messages.

    • The Reload link allows you to restarts a specific channel with the latest available data in the EC DB.

    • The Resume link allows you to start a specific channel from receiving incoming messages.

  • The Import Message link allows you to browse to a file location and import a file to use on EC application. See the Importing Messages topic in this document.

  • The Pools link view shows information on performance-related issues. The Pools and Queues window displays the system status.

Event

On this page you can search for EC application logs.

Here are the available links:

  • The Log link is intended for use as a quick monitoring view. It shows an overview of the latest events registered by the server.

    To filter the logs view, select a log level to display from the Log level drop-down list. The filter options are, All levels, only debug, only info, only warn, only error, and only fatal.

    To view messages, select Show log from the server start-up box to view the messages created at the time when the server was started.

  • The Log Search link allows you to search for detailed server event log. You can use different search criteria and field visibility composing a log event.

  • The Log Download link allows you to download detailed server event logs to a size-specific file. You can use different search criteria and fields just like in the Log Search link. The size field allows you to specify a maximum file size for each downloaded log.
    Note: 

    A log download produces a log file in .csv format, within a zip file, for download. Logs are split into one or more files depending on the file size specified in the Log download page. For example, if the total logs are 10MB and the file size input in the page is 2MB, the logs will be split into five log files with a maximum file size of 2MB each.

  • The Log Configuration link is not commonly used. But if used, this provides a run-time control of log levels and default visibility of log searches. With the proper settings, the view can show a detailed log information to help trace where a problem occurred in a live system.

    You can also access the server event log that contains detailed information about the server operation.

Message

On this page you can view message related activities, filter message views, and messages. See, Message overview.

Archive

On this page you can view archive file system and database tasks.

Here are the available links:

  • The Stored Files link shows the archived files on Central File Folder and its corresponding size and date when it was last modified.

  • The Search Archive link defines a query and builds indices for archived files.

  • The Configure Index link configures indices to generate. For advanced search, define the Name and XPath, and then add to the index to generate.

  • The Backup/Cleaning link cleans or backs up archive files. You can select to remove entries from database for backup documents, remove files from archive after a back up, or to force back up a document in failed state.

    Back up is relative to the Partner, Agreement, and current time details. You specify a date (dd/mm/yy hh:mm:ss) for which documents to back up are included in an archived ZIP file on an archive folder in the server.

  • The Backup/Restore link restores archived backup files.

Maintenance

On this page you can perform manual maintenance tasks on logs, persisted files, and error reports.

Schedules

On this page you can view and manage the scheduled task types. Scheduled jobs can be saved, deleted, and enabled or disabled. Before you can run a scheduled task, you must first select to enable the scheduled task.

For tasks with the same execution time, the Priority field value determines the order of execution. For tasks scheduled to run every hour, the task marked Priority 1 will be executed first. For tasks scheduled to run every <x> minute, the minute interval is reset every hour and does not spill over to the next hour.

See, Schedules overview.

Utilities

On this page you can perform reloading tasks, property checks, and translation data utilities.

Here are the available links:

For a more detailed information, see the corresponding topic sections in this guide.