Skip to content

Desktop Administrator ​

Starting the client and logging in are covered in Accessing the Administrator. The client connects over HTTPS on port 8443 by default. A status bar along the bottom of the window shows the server URL, the logged-in user, and the server time with its timezone.

The Web Administrator does the same job in a browser.

The left menu ​

The left side of the window is a context-sensitive menu.

The desktop Administrator showing the Dashboard, with the Engine, Dashboard Tasks and Other sections of the left menu

ViewWhat it is
DashboardThe first screen after logging in. Deployed channels with their state, message counts, and connection activity. Start, stop, pause, and undeploy from here, and open the Message Browser for a channel with View Messages. See Dashboard and Monitoring
ChannelsEvery channel configured on the server. Create, delete, import, export, clone, enable, disable, and deploy. Channels can be grouped, and filtered by name or tag
UsersAccounts that can reach the server through either administrator, the CLI, or the REST API. See User Management
SettingsServer-wide configuration, covered below
AlertsConfigured alerts with their status and how often each has fired. See Alerts and Notifications
EventsA searchable log of user actions and system events, filterable by date, severity, user, and outcome, exportable to a comma-separated text file in the server's exports directory. See the Event Browser
ExtensionsInstalled plugins and connectors with their status, author, and version, and where you enable or disable them. See the Plugin Guide

Channel Editor ​

Opening a channel from the Channels view gives you a tabbed workspace:

TabPurpose
SummaryName, description, data types, initial state, storage and pruning settings, tags, dependencies, and custom metadata columns
SourceThe source connector and its settings
DestinationsOne or more destination connectors, each with its own filter and transformer
ScriptsChannel-level Deploy, Undeploy, Preprocessor, and Postprocessor scripts

Within Source and Destinations you can open two editors:

  • Filter Editor, for rules (Rule Builder, JavaScript, External Script, Iterator) joined by AND/OR. A message that matches is accepted, and one that does not is filtered.
  • Transformer Editor, for a sequence of steps (Mapper, Message Builder, JavaScript, External Script, XSLT Step, Iterator, Destination Set Filter). Dragging a field between the inbound and outbound message trees generates a mapping step.

A connector's filter and transformer are compiled into one script. A variable a filter rule assigns without var is still there in the transformer; one declared with var stays inside the rule. See Filters and Transformers.

Settings ​

The tabs cover server-wide options:

TabPurpose
ServerEnvironment name and server name, both of which appear in the title bar, plus default background color, auto logout, clear global map on redeploy, default queue buffer size, default metadata columns, SMTP configuration, and login notification and consent
AdministratorUI preferences such as dashboard refresh interval and confirmation dialog behavior
TagsCreate and manage channel tags
Configuration MapKey-value pairs readable from channel scripts at runtime
Database TasksDatabase cleanup and index tasks. See Database tasks
ResourcesCustom class-path library resources available to channels
Data PrunerGlobal settings for automatic message pruning

The Server tab of Settings, with the General, Channel, Email and Notification sections

A plugin that ships a settings panel adds its own tab here, named for the plugin.

Other ​

Below the view buttons, a fixed section of the left menu is available from every view:

TaskDescription
NotificationsOIE release announcements from the project's GitHub repository. When there are unread items the link reads Notifications (n)
View User APIOpens the User API (Javadoc) in your browser
View Client APIOpens the REST API documentation in your browser
Visit homepageOpens the OIE project repository
Report IssueOpens the project's issue tracker
HelpOpens the OIE GitHub discussions
AboutVersion, build date, server ID, Java version, and third-party acknowledgements
LogoutEnds the session and returns to the login screen

Working with tables ​

Most screens present data in tables that behave the same way:

  • Drag a column header to move it; adjacent columns shift.
  • Right-click the header row to show or hide columns, or use the table control icon at its top right.
  • Click a header to sort ascending, again for descending. Not every table sorts.
  • Click the plus or minus beside a row to expand or collapse it, or right-click the header for Expand All and Collapse All.
  • Shift-click for a contiguous range of rows, Ctrl-click (Cmd on macOS) for individual ones.
  • Press Delete to remove a selected row, where the table allows it.