Axway Sentinel Configuration Guide...Objects used to control user access privileges 74 Replace...

C O N F I G U R A T I O N G U I D E

SentinelVersion 4.2.0

29 January 2020

Copyright © 2019 Axway. All rights reserved.

This documentation describes the following Axway software:

Axway Sentinel4.2.0

No part of this publication may be reproduced, transmitted, stored in a retrieval system, or translated into any human or computer language, in any form or by any means, electronic, mechanical, magnetic, optical, chemical, manual, or otherwise, without the prior written permission of the copyright owner, Axway.

This document, provided for informational purposes only, may be subject to significant modification. The descriptions and information in this document may not necessarily accurately represent or reflect the current or planned functions of this product. Axway may change this publication, the product described herein, or both. These changes will be incorporated in new versions of this document. Axway does not warrant that this document is error free.

Axway recognizes the rights of the holders of all trademarks used in its publications.

The documentation may provide hyperlinks to third-party web sites or access to third-party content. Links and access to these sites are provided for your convenience only. Axway does not control, endorse or guarantee content found in such sites. Axway is not responsible for any content, associated links, resources or services associated with a third-party site.

Axway shall not be liable for any loss or damage of any sort associated with your use of third-party content.

Contents

Preface 10Related documentation 10Get more help 10Training 10

Sentinel accessibility 11Sentinel accessibility strategy 11Accessibility categories 11Accessibility prerequisites 12Screen reader support 12

Documentation accessibility 12Screen reader support 12Support for high contrast and accessible use of colors 12

1 Sentinel overview 13How does Sentinel work 13User Interfaces 14Administration Interface 14Sentinel Monitoring (Web Monitoring) 14Correlation Interface 15Web Dashboard 15DashboardViewer (deprecated) 16Monitoring Interface (deprecated) 16Composer 17

Tracked objects and attributes 17Tracked-Event messages and records 18Tracked-event message formats 19Tracked-event records 20Define tracked-event messages 20Relationships between tracked-events 20

Tracked-Event links 21Tracked-Event Links Tree structure 21

Processing cycles 22Cycle links 24Tracking database 26Requests 26Indicator Requests 27Requests and user rights 27Request functions 28

AxwaySentinel 4.2.0 | List all user docs Configuration Guide 3

https://docs.axway.com/search?labelkey=prod-sentinel-420&labelkey=ct-category

Define requests 28Access requests 29

Global Variables 29Exceptions and alerts 30Monitor exceptions and alerts 31Respond to exceptions and alerts 31

Event processing rule structure 31Example 32Primary Items 32

Third-party management structures 35DataSources 35Function DataSources 35Request DataSources 36SQL DataSources 36Tracked Object DataSources 36

Probe environments (advanced) 37Probe Server 38Collector Configurations 38Collector 42Complex Attribute Value 42Probe Definition 43Probe 43Subscription 43

Commands 44Command Groups 44Execution criteria 44Command variables 45Execution module 46

Recommendations 46Recommendation Groups 46Execution criteria 47

Sentinel Web Dashboard concepts 47Worlds 47Data dictionaries 47Reports 49Web Dashboards 49

Java Dashboards 50Java Dashboard graphic objects 51Dashboard pages 52Java Dashboard types 54Linked Dashboards 55Example 55Dashboard data sources 56



3 Sentinel architecture 57Data Collection Environments 57Sentinel data collection agents 58Sentinel data collection components 59

Server Environments 61Tracking Database 63

User Interfaces 64Administration Interface 64Sentinel Monitoring (Web Monitoring) 64Correlation Interface 64Web Dashboard 65DashboardViewer (deprecated) 65Monitoring Interface (deprecated) 66Composer 66

4 Set up users 67Manage users with Administration 67About access rights 68Create Profiles 69Create Groups 70Create Users 71Objects used to control user access privileges 74Replace users, profiles, and groups 77

Manage users with PassPort AM 78Log in 82Limitations 82Restrict user access rights to objects 84Use PassPort AM user variables in Sentinel 87

Configure user exits 89Configure authentication user exit 89Configure authentication/authorization user exit 92Example: Authentication/authorization user exit 96Configure user rights 101

Configure Sentinel with SSO 102SAML SSO 103Passport in SSO mode 113Configure SSO with user exit 115

5 Set up Sentinel 124Configure the server environment 124Use trkserver.xml 124 140 140 141



142 143 144 145 146 146 148 149 152 153 153 155 156 156 157 158 158 159 160 161 161 162 164 165 165 167 168 168Alias commands 169Use server.properties 184

Sentinel Tools 202Manage servers 209Understand the syntactic conventions 209Start and stop servers 210Server-specific administration commands 212Work in administrative command sessions 229

Manage the Tracking Database 232Use the TrkCmd function commands 232

Configure objects in Composer 246Topology 246Define Tracked Objects 248Requests 264Toolbar 277Toolbar 279



Toolbar 283Toolbar 286Define commands 300Define recommendations 304Define DataSources 307Manage criteria 326

Manage Sentinel tracked objects 339Define tracked objects without Composer 339Modify the structure of a Tracked Object 359

About the Correlation Module 363About the Correlation Interface 364Event processing rules 366About Correlation Functions 391

Manage master data 506Manage master data using the Monitoring user interface 506Manage master data with the master data exit 515

SNMP and Sentinel 524SNMP Agent and SNMP Manager 525SNMP MIB 525SNMP Traps 526Set up SNMP traps 528Create MIBs 528Configure SNMP Manager 529Send SNMP traps with Correlation Rules 529Generate SNMP IDs 530

Configure monitored apps 531auditTO and auditDeployTO appenders 537TrkSendEvent and TrkSendCycleLink rule commands 538trkapiua 540setUATrace 541setOverflowFile 541setLocalAddr 541getLocalAddr 542setGMT 542getGMT 542setProductName 542getProductName 543sendMessage 543sendMessagesFile 543sendXmlFile 543sendOverflowFile 544getUniqKey 544sendAllBufferFileMessages 545setSleepTime 545



isOvfFileEmpty 545getOvfFileTaux 545getSenderState 546setStopDelay 546stopUA 546enableSSLOnWindows 547enableSSL 547disableSSL 547setSSLProtocolVersion 548waitUntilBufferFileMessagesAreSent 548trkMessageUaEvent 549formatMessage 549setAttribute 549setOption 550trkMessageUaLink 551formatMessage 551setAttribute 551

Monitoring and troubleshooting 552Configure logging in Sentinel 552Error codes used to monitor Sentinel 571Import SSL certificate on client machine 577Configure email alerts for buffer files 579Recover from corrupted overflow files 581Recover events 582Resize buffer files 582Configure Sentinel to Unicode mode 583

Configure probes 583Probe Collector 584Probe Server 584Probe environments (advanced) 584

Configure custom command exit 591Develop the custom command exit 591Install the custom command exit 593Use the custom command exit 593

7 Set up Sentinel Monitoring 594Tooltips and labels 594Parametrized Search 594Define sub-searches 597Define hidden columns in search results 598Example: monitoring-config.xml 599Define LifeCycle view 600Define images for LifeCycle events 602Configure LifeCycle metadata plug-in 602



Configure internationalization resources for Alerts Web 610Configure internationalization resources for Sentinel Monitoring 611Define possible values for attributes 613Define attributes for modify event option 614Define attributes for add event option 615Define detailed view 615Configure attribute validation plug-in 617Configure LifeCycle attribute order plug-in 622Example: obj-config.xml 627

Manage report templates 630Install the Sentinel plug-in 631Define Sentinel as data source 631Configure Sentinel access 632Create a report template 632Access report templates 633Enable download option 633Disable download option 633Purge report templates 634Customize report templates 634

Custom code with plug-ins 634Web.xml parameters 635Configure Web Monitoring appearance 644Branding 644Define the Business View refresh rate 647Define the number of rows per page 647



PrefaceThis document provides a detailed product over and explains how to configuration Sentinel. Setting up your Sentinel system consists of configuration in several different components, including:

l Sentinel architecture

l Sentinel network topology

l Sentinel Server environment

l Tracked Objects

l Requests and event processing rules

l Sentinel Event Router Users

l User exits

l Monitored applications

l Administrator and PassPort AM)

l Sentinel Monitoring

Related documentationGo to Axway at docs.axway.com to view or download Sentinel documentation. The website requires login credentials and is for customers with active support contracts.

Get more helpGo to Axway at support.axway.com to get technical support, download software, documentation, and knowledge base articles. The website requires login credentials and is for customers with active support contracts.

TrainingAxway offers training across the globe, including on-site instructor-led classes and self-paced online learning.

axway.com/support-services/training


https://docs.axway.com/http://support.axway.com/http://axway.com/support-services/traininghttps://docs.axway.com/search?labelkey=prod-sentinel-420&labelkey=ct-category

Sentinel accessibilityAxway strives to create accessible products and documentation for users. The following describes the accessibility features of Sentinel and its documentation. Accessibility in Sentinel is understood as the design of Sentinel and its services for people with disabilities and is standardized by United States government Section 508 requirements and by the Web Content Accessibility Guidelines (WCAG) Version 2.0.

Sentinel accessibility strategyFor Sentinel, a pragmatic accessibility approach is used, with immediate benefit for users with disabilities. The strategy identifies and focuses on the following:

l Correct personas

l Key use cases

Sentinel personas can fall within three categories:

l Administrators: users who install, operate, configure and maintain Sentinel.

l Developers: users who provide content, for example who create reports and dashboards.

l End Users: users who work with reports and dashboards created by developers.

Users matching the End User persona outnumber other users in Sentinel; therefore, they are the main target of accessibility in Sentinel. The only strategic application destined for End Users is Sentinel Web Dashboard.

Accessibility categoriesSentinel accessibility focuses on the following accessibility categories:

l Visual perception (browser zoom, Windows Magnifier, High Contrast themes)

l Keyboard-only usage

l Screen reader

In our effort to be as accessible as possible, we assure that users with disabilities can successfully perform their day-to-day activities.



Sentinel accessibility

Accessibility prerequisitesFor maximum use of Sentinel accessibility, we recommend using Internet Explorer 11 and JAWS screen reader (version 15).

Screen reader supportSentinel supports JAWS (Job Access With Speech), a computer screen reader program for Microsoft Windows that enables blind and visually impaired users to read the screen with a text-to-speech output or by a refreshable Braille display. However, you must configure your screen reader before using JAWS.

You interact with JAWS using keyboard shortcuts. Typically, you press the JAWS key in combination with other keys. By default, the JAWS key is the Insert key.

To use the arrow keys and keyboard shortcuts with Sentinel, turn off the virtual PC cursor by pressing the JAWS key+Z.

Documentation accessibilityThe product documentation provides the following accessibility features:

l Screen reader support

l Support for high contrast and accessible use of colors

Screen reader support l Alternative text is provided for images whenever necessary.

l The PDF documents are tagged to provide a logical reading order.

Support for high contrast and accessible use of colors l The documentation can be used in high-contrast mode.

l There is sufficient contrast between the text and the background color.



1 Sentinel overview

1 Sentinel overviewAxway Sentinel is an application that enables you to perform end-to-end monitoring of data flow, from start to finish, across the applications in your enterprise that send event information to Sentinel. Monitoring data flow helps you accurately identify when exceptions occur so that you can manage issues and resolve them before they negatively impact your business.

How does Sentinel workSentinel tracks data flow by capturing events from both Axway and third-party applications and systems. You can trigger data processing by applying Event processing rules you define to respond to events or non-events.

At the event level, Sentinel allows you to view captured data on a record-by-record basis. Because Sentinel captures information about your data as it flows from application to application, you can query for all event information related to any piece of data that has been through your system. For example, if you have invoice data flowing through your system, Sentinel will allow you to see when an application has processed a particular invoice, the results of the processing, and which application processed the invoice next.

You can configure Sentinel to trigger Event processing rules when events occur or do not occur. For example, if your system processes invoices, you can use Sentinel rules to send an email when an invoice is passed from your application to your partner's application.

At the aggregate level, Sentinel allows you to display and report on data captured from your system. For example, you can keep track of how many invoices your system processes over time and display that information in a dashboard or as a key performance indicator (KPI) to help you make decisions about your business.

It is important to understand Sentinel's architecture, along with the following key components of Sentinel prior to using the system:

l Sentinel User Interfaces (UI)

l Tracked objects and attributes

l Tracked-event messages and records

l Tracked-event links

l Processing cycles

l Cycle links

l Tracking database

l Requests

l Global variables



1 Sentinel overview

l Event processing rules

l Exceptions and alerts

l Data sources

l Probe environments

l Commands

l Recommendations

l Web Dashboards

User InterfacesSentinel includes interfaces that enable users to access the Sentinel functions that correspond to their type of activity. Sentinel includes:

l Graphical user interfaces (GUIs) to manage and monitor network elements, objects and probes.

l Line command interface to manage individual servers. You can execute commands from the local command console or in a Telnet session.

This section describes the GUIs provided with Sentinel.

Administration InterfaceAdministration Interface, which links directly to the Front-End Server using a TCP/IP connection, enables you to accomplish administration tasks from a web browser, without any specific local installation required:

l Create and manage user accounts.

l Create and manage user groups.

l Create and manage user profiles.

Note In order to access the Administration Interface when your Sentinel installation is configured to use SSL encrypted communication with a self-signed certificate (it's the case of the default certificate shipped with Sentinel), that certificate needs to be manually installed on the client machine. Normally you should need to do this action the first time you access the Sentinel installation from that particular client machine or whenever the SSL certificate is updated. For detailed instructions on importing the SSL certificate, please see Import SSL certificate on client machine on page 577

Sentinel Monitoring (Web Monitoring)Sentinel Monitoring is an end-user, web-based GUI that enables you to:



1 Sentinel overview

l Manage and monitor items based on monitored data that is associated with the items.

The monitored data is captured from multiple sources in various formats and stored in the Sentinel data repository with which Sentinel Monitoring communicates.

l Manage Event processing rules, including activating and deactivating rules, copying and deleting rules, and editing parameters and notification data (Alert Rules only) for individual rules.

Correlation InterfaceThe Correlation Interface helps you manage your Event processing rules, which define the actions to execute in response to interpreting data stored in the Tracking Database.

It links directly to the Correlation Server and Acquisition Server using TCP/IP. You perform tasks in this GUI from a Web browser. No specific local installation is required.

Use the Correlation Interface to create, modify, delete and monitor Event processing rules.

For detailed information, see About the Correlation Interface on page 364.

Note In order to access the Correlation Interface when your Sentinel installation is configured to use SSL encrypted communication with a self-signed certificate (it's the case of the default certificate shipped with Sentinel), that certificate needs to be manually installed on the client machine. Normally you should need to do this action the first time you access the Sentinel installation from that particular client machine or whenever the SSL certificate is updated. For detailed instructions on importing the SSL certificate, please see Import SSL certificate on client machine on page 577

Web DashboardSentinel Web Dashboards are HTML5-based dashboards you configure based on the data you collect using Sentinel. As HTML5, Web Dashboards can be displayed on tablets and mobile devices.

Web Dashboards do not require Axway Composer or any other desktop-based tool for configuration. Instead, you configure Web Dashboards using an HTML-based UI you run in a browser.

Using web dashboard you can:

l Use an in-memory database to aggregate data and improve response time for transactional database hits and operations that are processing intensive and time-consuming. :

l Automate dashboards to run on a periodic basis (hourly, for example) to provide the most up-to-date dashboards possible. In addition, this helps improve server performance by reducing loads due to high concurrent user count.

l Automate offline reports that can be sent via email and schedule them using the same web-based UI you use to create the dashboards.



1 Sentinel overview

DashboardViewer (deprecated)The DashboardViewer is a dedicated GUI for monitoring the objects you create and configure on the Dashboard Server. It links directly to the Dashboard Server using a TCP/IP connection. You monitor Dashboard objects in this GUI using a web browser.

Note In order to access the DashboardViewer on HTTP when your Sentinel installation is configured to use SSL encrypted communication (protocol becomes HTTPS) with a self-signed certificate (it's the case of the default certificate shipped with Sentinel), that certificate needs to be manually installed on the client machine. Normally you should need to do this action the first time you access the Sentinel installation from that particular client machine or whenever the SSL certificate is updated. For detailed instructions on importing the SSL certificate, please see Import SSL certificate on client machine on page 577

The DashboardViewer does not enable you to create and configure functions intended for administrative and management users. You use Composer to perform creation and configuration tasks.

The DashboardViewer enables business end users to accomplish their business tasks without the encumbrance of non-essential menus and options.

Monitoring Interface (deprecated)The Monitoring Interface links directly to the Correlation Server and Acquisition Server using TCP/IP. You perform tasks in this GUI from a browser. No specific local installation is required.

The Monitoring Interface does not include the sophisticated functions intended for administrative and management users. It enables business end-users to accomplish their tasks without the encumbrance of non-essential menus and options.

Use the Monitoring Interface to:

l Execute requests

l View request results

l View graphic representations of the relationships between monitored events

l View details of the individual request results

l Execute custom commands that enable users to easily react to returned request results

l Execute recommendations linked to request results to guide end-users in executing tasks

Note Before you can execute requests, commands or recommendations using Sentinel Monitoring, you must create them on the Monitoring tab of the Integration-Services workbench in Composer.



1 Sentinel overview

ComposerAdministration Interface and Monitoring Interface users manage server connections and monitoring objects using the Integration-Services workbench in Composer. When you install the Sentinel Enabler plug-in, Composer displays the Monitoring tab that enables you to navigate the Sentinel monitoring objects. You use Sentinel-specific menu bars, context menus and toolbars to define and use monitoring and data collection objects and functions.

Use the Monitoring tab of the Integration-Services workbench in Composer to:

l Create and manage server connections.

l Create and manage Sentinel objects (tracked objects, requests, probes, dashboards and so on).

l View your entire network configuration and manage the relationships between Axway products.

For details, check Configure objects in Composer on page 246 chapter.

Tracked objects and attributesIn the Sentinel Server environment, the Acquisition Server contains tracked objects. A tracked object is a model that describes an application event. Each incoming tracked-event message contains a name field that corresponds to the name of the tracked object to be used with that message. Using that tracked object, the Acquisition Server extracts the data from the fields of the tracked-event message, and writes the data to a specific table in the Tracking Database.

Every tracked object contains the following:

l Unique name

l Version number

l List of attributes describing the properties of events. Each attribute has a:

o name (unique for that object)

o data type

o default value

The attributes contained in a tracked object fall into one of two categories:

l System attributes that are common to most tracked objects. System attributes identify application and platform events and errors. You can view the system attributes of a tracked object on the Definition tab of the Tracked Object window.

l User attributes that are not common to all tracked objects. User attributes describe the application- or platform-specific properties of monitored events. You can create, modify, and delete user attributes on the Definition tab of the Tracked Object window.

For example, XFBTransfer is a tracked object that you can download and import to monitor the Axway Gateway application. XFBTransfer describes the events that occur when a Gateway application sends or receives a file transfer. This tracked object includes the following attributes:



1 Sentinel overview

o System attribute IsException. This attribute identifies whether or not an application event produced a processing exception. This attribute applies to all tracked applications, whatever tasks they perform.

o User attribute SenderId. This attribute identifies the monitor that sends a file transfer. This attribute does not apply to a tracked object that describes a file translation, for example.

Additionally, tracked objects contain the following secondary properties:

l Storing mode

l Version management mode

l Correlation mode

To enable you to monitor Sentinel, Axway provides the HeartBeat tracked object with all Sentinel configurations. The HeartBeat tracked object enables you to confirm the functional presence of Sentinel-monitored applications. Use this tracked object to link the non-presence of an application to an alert via an Event processing rule.

Together, tracked-event messages and tracked objects enable Sentinel to record information about tracked events in the form of tracked-event records. Tracked objects also indirectly describe the tracked-event messages that tracked applications create.

Tracked-Event messages and recordsSentinel monitoring agents are located on tracked applications and tracked platforms. These agents generate tracked-event messages that contain data about application and platform events. The agents then send the tracked-event messages to the Sentinel Server.

The Acquisition Server receives tracked-event messages and analyzes the message content. If the message corresponds to a known model, the Acquisition Server records the data contained in the message to the Tracking Database. The data recorded in the database for a single tracked event is referred to as a tracked-event record.

The following figure illustrates the transformation of an event on a tracked application or platform into a tracked-event record:

1. A Sentinel agent residing on a tracked application or tracked platform collects data about a specific occurrence of an event.



1 Sentinel overview

2. The Sentinel agent generates a tracked-event record composed of fields and values, containing information about the event occurrence. Each generated message contains a unique identification number. The Sentinel agent sends the tracked-event record to the Acquisition Server via the Front-End Server.

3. The Acquisition Server interrogates the tracked object indicated in the tracked-event message and writes an entry in the appropriate table of the Tracking Database, using the values contained in the fields of the tracked-event message. Each row of values entered in the table describes a single tracked event, identifiable by its unique identification number. A single row of values is a tracked-event record.

Tracked-event message formatsThe format of a tracked-event message depends on the tracked application or tracked platform on which the message is generated:

l The Sentinel-related processes inherent in XFB applications format tracked-event messages in XNTF, a proprietary format of Axway Software.

l Many other applications contain processes or host agents that format tracked-event messages in XML.

For example, each time a file transfer application transfers a file to a partner application, the file transfer application acknowledges the relevant transfer request and updates the transfer catalog. Together, these two preliminary steps in the transfer process constitute an application event. The file transfer application notifies Sentinel about the event using a tracked-event message that is in the following XML format:



1 Sentinel overview

Tracked-event recordsEach tracked-event message includes a set of attribute names and corresponding attribute values. The Sentinel Acquisition Server uses these attribute names and the appropriate tracked object (identified in the tracked-event message) to store the attribute values in the Tracking Database. Sentinel stores the values contained in tracked-event messages in the form of a tracked-event record. In most cases, attribute names contained in a tracked-event message match the attribute names of a single tracked object.

In the database tables of a tracked object:

l Each attribute name represents a single column.

l The values contained in each tracked-event message are written to a single row, which constitutes a tracked-event record.

This database structure enables Sentinel to use SQL requests to locate and retrieve any attribute of any stored tracked-event message.

Using a counter, the Sentinel agent assigns a unique EventId to each tracked-event message that it generates. When the agent sends the message to the Sentinel Serverenvironment, the Acquisition Server includes the EventId in each stored tracked-event record.

Define tracked-event messagesAdministrators have the option of importing predefined tracked objects when configuring Sentinelfor use with other Axway applications. These predefined tracked objects enable the Acquisition Server to process the data sent in tracked-event messages. To send additional tracked-event messages to Sentinel, administrators use the functions of the Tracking API, TrkUtil. They can then create the corresponding tracked object using the tools of the Composer Integration-Services workbench.

Relationships between tracked-eventsIn addition to recording the data extracted from tracked-event messages, Sentinel can record the relationships between the events these messages describe using tracked-event links and processing cycles.



1 Sentinel overview

Tracked-Event linksA Tracked-Event Message describes the occurrence of a single event on an application or platform. For some tracked applications and platforms, Tracked Events are hierarchically related. In the Monitoring Interface, you can monitor the hierarchical relationship between Tracked Events.

For example, a tracked accounting application that receives a group of data. Suppose the processing of this group of data includes two input events. Each input event in turn includes two segments. To identify these data structures as application events, the Sentinelagent that monitors the accounting application generates:

l One Tracked-Event Message that describes the group.

l Two Tracked-Event Messages that describe the input events of the group.

l Four Tracked-Event Messages that describe the segments of the two input events.

To identify the hierarchical relationship between these Tracked Events, the Sentinel agent that monitors the accounting application creates links between them. These links are referred to as Tracked-Event Links. The attributes that an agent uses to create Tracked-Event Links depend on the tracked application or tracked platform.

You can send requests that return Tracked-Event Links for a specific Tracked Event. This Tracked Event is referred to as the Reference Event. The Tracked Events that:

l Hierarchically precede the Reference Event are referred to as the Parent Events.

l Hierarchically follow the Reference Event are referred to as the Child Events.

Tracked-Event Links Tree structureFor an example tree structure, if you request to see Parent Events and Segment_Four is the Reference Event, Sentinel displays the following tree structure:

Group

Input_Event_One

Segment_One

Segment_Two

Input_Event_Two

Segment_Three

Segment_Four

If you request to see Child Events and Input_Event_One is the Reference Event, Sentinel displays the following tree structure:

Input_Event_One

Segment_One

Segment_Two



1 Sentinel overview

Axway applications contain procedures that automatically create Event Links. To create additional Event Links, use the functions of the Tracking API, TrkUtil.

In addition to identifying the hierarchical relationship between Tracked Events, Sentinel can also identify groups of Tracked Events that describe application tasks in Processing Cycles.

Processing cyclesJust as Sentinel uses Event Links to identify Tracked Events that are hierarchically related, Sentinel uses Processing Cycles to identify groups of Tracked Events that are related to specific application or platform tasks.

Fore example, consider a file transfer application that transfers a file to a partner application. The Sentinel agent that monitors the file transfer application generates one Tracked-Event Message for each of the following events:

l Created: The Requester prepared a transfer and updated the transfer catalog or, alternatively the transfer mailbox.

l To Execute: The Requester sent the transfer request to the Server.

l Sending: The Sender is sending data.

l Sent: The Sender sent all of the transfer data.

l Receiving: The Receiver is receiving data.

l Received: The Receiver received all of the transfer data.

l Terminated: The Sender sent all of the transfer data, and the Receiver received all of the transfer data.

Taken together, the set of Tracked Events that concern a single file transfer are referred to as a Processing Cycle. A Processing Cycle is a group of related Tracked Events. Together, these related Tracked Events describe an application task.

The exact meaning of a Processing Cycle depends on the tracked application or tracked platform. In the case of the file transfer application, a Processing Cycle describes a linked sequence of file transfer events and identifies the linear relationship between the associated Tracked-Event Messages.

In Sentinel, the system attribute CycleId identifies Processing Cycles. For each Tracked-Event Message in a given Processing Cycle, the value of the CycleId attribute is the same. The Sentinel agent that monitors the tracked application or platform generates this value.

When this tracked application transfers two files to a partner application, Sentinel receives and records a series of Tracked-Event Messages. Taken together, these Tracked-Event Messages describe two Processing Cycles:



1 Sentinel overview

Processing Cycle

EventId State CycleId

First 9525 Created C2ABC23001121317522512150

9526 To Execute C2ABC23001121317522512150

9530 Sending C2ABC23001121317522512150

9531 Receiving C2ABC23001121317522512150

9536 Sent C2ABC23001121317522512150

9537 Received C2ABC23001121317522512150

Second 9920 Created C3ABC23001121317522512150

9923 To Execute C3ABC23001121317522512150

9924 Sending C3ABC23001121317522512150

9928 Receiving C3ABC23001121317522512150

9929 Sent C3ABC23001121317522512150

9932 Received C3ABC23001121317522512150

Note

l EventId: Each occurrence of the EventId attribute is unique.

l CycleId: For each Tracked-Event Message that belongs to the same Processing Cycle, the value of the CycleId is the same.

To illustrate the linear relationship between these Tracked-Event Messages, this example includes the system attribute State. The value of this attribute describes the status of an application event. This attribute is not available for all Tracked-Event Messages.



1 Sentinel overview

Some of the Sentinel data collection agents that are associated with Axway applications contain procedures that automatically generate CycleIds. To generate additional CycleIds, Sentinel administrators can use the functions of the Tracking API/TrkUtil.

In addition to identifying individual Processing Cycles, Sentinel can identify Processing Cycles that sequentially precede and follow one another called Cycle Links.

Cycle linksSentinel uses the CycleId attribute to identify every Tracked Event that belongs to a given Processing Cycle. Sentinel can also use the CycleId attribute to identify Processing Cycles that sequentially precede and follow one another. In the Sentinel Monitoring Interface, you can monitor Processing Cycles that sequentially precede and follow one another. These sequential relationships are known as Cycle Links. Sentinel stores Cycle Links in the Tracking Database.

For example, a file transfer application generates the following three processing cycles:

l Processing Cycle 1: File transfer application transfers a group of general ledger entries to an accounting application.

l Processing Cycle 2: The accounting application updates the general ledger.

l Processing Cycle 3: The accounting application transfers the updated general ledger to the file transfer application.

Each time this series of tasks occurs, the file transfer and accounting applications use the CycleId attribute of the relevant Tracked-Event Message to create links between them. These links are messages that are referred to as Cycle Links. They identify the sequential relationships between Processing Cycles, as follows:

l The accounting application creates a message that links the Cycle Id of Processing Cycle 2 with the Cycle Id of Processing Cycle 1.

l The file transfer application creates a message that links the Cycle Id of Processing Cycle 3 with the Cycle Id of Processing Cycle 2.

When you monitor the links between Processing Cycles, you view links for the Tracked Event of a specific Processing Cycle. This Processing Cycle is referred to as the Reference Cycle. Processing Cycles that precede the Reference Cycle are called Parent Cycles and those that follow the Reference Cycle are called Child Cycles.

For example, if you consider the example of the file transfer application. When you request to see Cycle Links for a Tracked Event that belongs to Processing Cycle 2:

l Processing Cycle 1 is the Parent Cycle

l Processing Cycle 3 is the Child Cycle

In the Sentinel Monitoring Interface, you can view graphic representations of Cycle Links:



1 Sentinel overview

Some of the Sentinel data collection agents that are associated with Axway applications contain processes that automatically create Cycle Links. Sentinel administrators can use functions of the Tracking API/TrkUtil to create additional Cycle Links.

Like Tracked-Event Messages and Tracked-Event Records, each Cycle Link is a set of attributes. The following table describes the values of these attributes. To monitor Cycle Links in the Sentinel Monitoring Interface, you do not need to be familiar with this table. Where appropriate, this table is referenced in other topics of this documentation.

Attribute Value

CycleLinkId Unique string that identifies a Reference Cycle.

ParentObjectId Unique string that identifies a Processing Cycle as the Parent Cycle of the relevant Reference Cycle.

ParentCycleId CycleId of the Parent Cycle.

ChildObjectId Unique string that identifies a Processing Cycle as a Child Cycle of the relevant Reference Cycle.

ChildCycleId CycleId of the Child Cycle.

LinkType One of the following:

l empty: To create the Cycle Link, the tracked application did not reuse an existing Cycle Link.

l Update: To create the Cycle Link, the tracked application reused an existing Cycle Link.

EventDate Date on which the Sentinel Server received the relevant Cycle Link. The format of this date is defined in the server configuration file, trkserver.xml.

IsArchived One of the following:

l 0: The relevant Cycle Link is not archived in the Tracking Database.

l 1: The relevant Cycle Link is archived in the Tracking Database.



1 Sentinel overview

Tracking databaseThe Sentinel Server environment receives details about network events in the form of Tracked-Event Messages, Tracked-Event Links, Processing Cycles, and Cycle Links. In the Sentinel Server environment, the Front-End Server records these details in the Tracking Database. The Tracking Database includes the following types of tables:

l Cycle Link Table: The Tracking Database includes a single Cycle Link Table. This table stores all Cycle Links.

l History Table: The Tracking Database includes one History Table for each Tracked Object. Each History Table stores all of the currently processed Tracked-Event Messages in each Processing Cycle. This means that when a Processing Cycle is complete, the relevant History Table stores all of the Tracked-Event Records in the Processing Cycle.

l Current Table: For some Tracked Objects, the Tracking Database includes one Current Table. Each Current Table stores only the most recent Tracked-Event Record in each Processing Cycle. Each time Sentinel receives a new Tracked-Event Message for a Processing Cycle, Sentinel overwrites the previous Tracked-Event Record.

This means that when a Processing Cycle is in process, a Current Table contains the current Tracked-Event Record. When a Processing Cycle is complete, a Current Table contains the final Tracked-Event Record.

To retrieve details about Tracked Events, Event Links, Processing Cycles, and Cycle Links from the Tracking Database, you execute Requests.

RequestsA Request is a set of operator-defined SQL that enables you to retrieve data from the tracking database, including details of your tracked applications including Tracked-Event Messages, Tracked-Event Links, Processing Cycles, and Cycle Links.

A Request definition is based on:

l The associated Tracked Object(s).

l The attributes of the Tracked Object(s).

l An optional PreRequest executed before the Request.

l Request criteria that defines the conditions under which the Request is executed.

You can define three different types of Requests:

l PreRequest: PL/SQL (Oracle proprietary Procedural Language) instructions that Sentinel executes before it executes a standard Request, or an Indicator Request, or both.

l Request: The principal set of operator-defined executable SQL instructions for retrieving data.

l Indicator Request: Procedure that retrieves the statistics used to monitor the performance quality of a tracked application from the Tracking Database.



1 Sentinel overview

Indicator RequestsAn Indicator Request enables you to refine the results of an existing standard Request. To refine the existing Request results, apply function-based Performance Indicators to them.

A Performance Indicator is a statistical function you can use to monitor the performance quality of a tracked application. Sentinel provides five different functions that you can choose from when defining a Performance Indicator:

l Minimum: The minimum function returns the minimum value of the selected attribute.

l Maximum: The maximum function returns the maximum value of the selected attribute.

l Count: The count function returns the number of occurrences of the selected attribute.

l Sum: The sum function returns the sum of the values of the selected attribute.

l Average: The average function returns the average value of the selected attribute.

Note To use the Minimum, Maximum, Sum or Average functions, the data type of the selected attribute must be either integer or floating point number.

Each Request is based on the attributes of an associated Tracked Object. You select, from these Tracked Object attributes, the attribute(s) to which you want to apply a Performance Indicator.

Requests and user rightsNote This is disabled if the Sentinel Server installation uses PassPort AM.

Each Request has associated user rights. For example, a user can have the right to:

l View Request - The right to view the Request.

l Clear Alerts - The right to clear alerts displayed in Request results of the Sentinel Monitoring Interface.

l Execute Commands - The right to execute operations via Command available on specified Request results of the Sentinel Monitoring Interface.

You can restrict access to a Request by assigning a scope to the user rights associated with the Request. For example:

l Public: (default) Sentinel allows access to the Request to all users.

l Private /User: Sentinel allows access to the Request to a specified User who has the Administration right to perform the specified user right.

l Private/Group: Sentinel allows access to the Request to a specified Group who has the Administration right to perform the specified user right.

l Private /Profile: Sentinel allows access to the Request to a specified Profile who has the Administration right to perform the specified user right.

You manage user rights for Requests on the General tab of the Request window in the Integration-Services workbench.



1 Sentinel overview

Request functionsTo help you create Requests, Sentinelincludes:

l PreRequest functions: When you define the PL/SQL instructions for a PreRequest, use these functions to:

o Specify a message for the screen of the Sentinel Server.

o Identify a PL/SQL procedure or function.

l Request functions: When you define the SQL instructions for a standard Request or an Indicator Request, use these functions to specify a:

o Table in the Tracking Database

o WHERE clause

o Date or time

Define requestsYou can define a Request using the:

l Assisted method

l Unassisted method

Assisted methodUsing the assisted method, you use the tabs of the Request Assistant to create or modify a Request. The tabs guide you through the process of defining what application properties you want to monitor using the Request. You define:

l The Tracked Object(s) on which your Request is based using the drag-and-drop operation.

l The attributes on which your Request is based by selecting them from a list.

l The PreRequest associated with your Request.

l The layout and content of the Request results window.

l The Request criteria.

l Linked Requests - Parent/Child relationship with another Request.

Note Creating Requests using the assisted method requires a knowledge of SQL only if you want to define a PreRequest.

Unassisted methodUsing the unassisted method, you define or modify directly the SQL instructions that create a Request. You require a knowledge of SQL to create a Request using this method.

You define:



1 Sentinel overview

l The SQL instructions that select Tracked-Event Records from the Tracking Database and display them in the Request results window.

l Indicator Request - SQL instructions that select Tracked-Event Records from the Tracking Database, and then execute a Performance Indicator.

Note The Indicator Request from Unassisted Request is used only in Sentinel Monitoring. It is not used in Web Dashboard.

l The PreRequest associated with your Request

l The layout and content of the Request results window

l The Request criteria

Note You cannot define Linked Requests using this method.

Access requestsYou can access existing Requests using the:

l Administration Interface

l Monitoring tab of the Composer Integration-Services workbench

How you gain access to a Request depends on how you want to work with the Request. If you want to display, execute, and monitor a Request, you must gain access from the user who created the Request.

Access to standard Requests and Indicator Requests is managed on two levels:

l In the Administration Interface, a Sentinel user who is authorized to manage users assigns the appropriate user rights to you. You can be authorized to manage and execute both standard Requests and Indicator Requests.

l On the Monitoring tab of the Composer interface, you can gain access from another user. If the Request is:

o A standard Request and you want all access rights to the Request, gain access from the Admin user. The Admin user can assign the Request to you. You become the author of the Request.

o A standard Request and you only want the right to display, execute, or monitor the Request, gain access from the author of the Request or, alternatively from the Admin user. These users can grant access to all users or, alternatively to your user group.

o An Indicator Request, gain access from the author of the Request. This user can grant access to all users or, alternatively to your user group.

Global VariablesYou create global variables outside of any of the correlation rules in which you use them. This means you can use global variables in multiple correlation rules at the same time and you can update them without having to deactivate any rules.



1 Sentinel overview

To define global variables, you use the contextual menu on the Global Variables node in the Sentinel Correlation applet's tree pane. See About the Correlation Interface on page 364. All global variables are of type String. You can use global variable values in different rules using the TrkGetGlobalVar() function.

You can see the rules in which a global variable is used by expanding the tree node corresponding to the global variable. You can edit or delete a variable by accessing the contextual menu on the corresponding tree node. You cannot change the name of a global variable or delete a global variable if it is used in at least one correlation rule.

If you try to use a non-existent global variable in a rule definition, you will not be able to activate the rule. This can happen, for example, when you copy XML rule definitions from one Sentinel environment to another, where the global variables do not correspond exactly.

Exceptions and alertsThe tools that you use to monitor and respond to application events use the attributes of Tracked-Event Records. For example:

l Requests retrieve attribute values

l Event processing rules respond to attribute values

Among the attribute values that you can use in Requests and Event processing rules there is a set of system attributes that identify exceptions and alerts.

l An exception is a processing error that is defined in a tracked application and stored in the application log.

l An alert is an important exception.

The system attributes that identify and describe exceptions and alerts include the following:

Attribute Description

IsException When a tracked application encounters an exception in an application event, the tracked application sets the value of the IsException attribute to one (1) in the associated Tracked-Event Message.

ReturnCode ReturnMessage

The Tracked Application can also use the ReturnCode and ReturnMessage attributes to describe the relevant exception.

IsAlert If the encountered exception is important, the tracked application also sets the value of the attribute to one (1) in the associated Tracked-Event Message.

Severity The tracked application can also use the Severity attribute to identify the severity of the alert (1: important, 2: urgent).



1 Sentinel overview

The Axway applications that can send Tracked-Event Messages to Sentinel can also generate exceptions and alerts. To generate exceptions and alerts in other tracked applications, Sentinel Administrators use the functions of the Tracking API/TrkUtil.

Monitor exceptions and alertsYou can monitor exceptions and alerts in the Sentinel Monitoring Interface by executing Requests that query the Tracking Database for the appropriate values of the IsException and IsAlert attributes (IsException=1, IsAlert=1). In addition, use the following tools for alerts:

l Color codes: When a Request retrieves a Tracked-Event Record that identifies an alert (IsAlert=1), by default, Sentinel displays the Tracked-Event Record in red. When you no longer need the color coding, you can clear the alert. When you clear an alert, by default, Sentinel modifies the color of the Tracked-Event Record from red to green and the value of IsAlert from one (1) to two (2).

l Alert notifications: From the Login screen for the user interfaces, set Sentinel to send alert notifications to each user who logs in to the Monitoring Interface. Each alert notification is a pop-up message that displays only the number of alerts that Sentinel generated since Sentinel last notified the relevant user.

Respond to exceptions and alertsSentinel users with administrator rights can configure Sentinel to respond to the alerts that tracked applications generate. For example, administrators can configure Sentinel to:

l Clear alerts

l Send email messages to users

l Execute scripts and system commands

l Consolidate alerts on a Sentinel Server

Administrators can configure Sentinel to respond to alerts, using the following interfaces and tools:

l Correlation Interface—Create Event processing rules that configure the Correlation Server to respond to alerts.

l TrkAlert.xml—Use the elements of an XML file to configure the Sentinel Server to respond to alerts. TrkAlert.xml is delivered with the Sentinel Server. TrkAlert.xml is not retained in V3.

Event processing rule structureEvent processing rules define actions the Correlation Server should perform when Sentinel Monitoring encounters Tracked Events with certain attributes. You specify the actions and the Tracked Event attributes that act as a trigger for the actions.

When the Correlation Server applies an Event processing rule in response to a Tracked Event, that Tracked Event is referred to as the current Tracked Event for that Event processing rule.



1 Sentinel overview

To identify Tracked Events for an Event processing rule, you use the names of Tracked Objects and their attributes. In addition, you can create custom parameters to help define conditions when an Event processing rule is carried out. When Sentinel encounters a Tracked Event with attributes that match the conditions defined by custom parameters, the action defined in the Event processing rule is carried out. When you create an Event processing rule with field parameters, those parameters are displayed in Sentinel Monitoring on the Edit and View pages of the Event processing rule page and provide the Sentinel Monitoring user with an opportunity to select the parameter value. See Work with event processing rules on page 368 and Create a custom parameter on page 369.

To specify actions to be carried out, you use:

l Items - graphic objects associated with specific types of commands.

l Correlation Functions - a set of pre-defined functions you can use to return some result based on some attribute of the current Tracked Object.

A Event processing rule can include different types of Items. In the Correlation Interface, each type of Item is represented by a graphic object associated with a specific type of command.

To create chains of commands, link Items together. Some Items can conditionalize the execution of the Items that follow them. To customize Items, enter instructions in them. For most of these instructions, you need the Correlation Functions.

ExampleThe illustration below shows the Event processing rule, Sample_Delay, delivered with Sentinel.

Notice that Sample_Delay includes three lines of graphic objects, each line representing a set of linked Items. In the Correlation Interface, the order in which sets of linked Items appear is not important. When the Correlation Server encounters Tracked-Event Messages about a file transfer event, the Correlation Server analyzes each set of linked Items in the correct order.

Primary ItemsThe primary Items are the starting point of Event processing rule. The following table introduces the primary Items and describes their roles:



1 Sentinel overview

Primary Item

Role

Init

Environment initializerWhen you reinitialize the Correlation Server, you start a new Correlation Session. The secondary Items that you link to an Init Item provide instructions that the Correlation Server uses to prepare the session environment for an Event processing rule. These instructions are not related to Tracked-EventMessages.Unlike the other Items, Init Items contain only a name. They do not contain any instructions. These instructions initialize the session environment. They do not respond to Tracked-Event Messages.Each time you start a new Correlation Session, the Correlation Server executes the Init Items in all activated Event processing rules . During a single Correlation Session, the Correlation Server typically executes the Init Items in activated Event processing rules only once.However, each time you modify the status of an Event processing rule from deactivated to activated, the Correlation Server also executes any Init Items in the Event processing rule.Init Items are optional. There is no limit on the number of Init Items that a Event processing rule can include.

Catcher

Event catcherIn a Catcher Item, identify one or more Tracked-Event Messages that the Event processing rule selects. The secondary Items that you link to a Catcher Item provide instructions that the Correlation Server uses to respond to the selected Tracked-Event Messages.Catcher Items are optional. There is no limit on the number of Catcher Items that an Event processing rule can include.

Secondary ItemsThe secondary Items that you link to Catcher Items and Init Items are the central part of an Event processing rule. You can adapt the secondary Items to respond to a wide range of Tracked Events, as follows:

l To design the process flow in an Event processing rule, use and reuse the secondary Items in any order.

l To specify the instructions in a secondary Item, choose from over one hundred Correlation Functions.

The following table introduces the secondary Items and describes their roles:



1 Sentinel overview

Secondary Item

Role

Decision

Control structureIn a Decision Item, define a conditional clause. In a set of linked Items, this clause typically instructs theCorrelation Server to execute the next Item when the condition is true or, alternatively false.

Timer

TimerIn a Timer Item, set a clock. In a set of linked Items, your setting typically triggers the Correlation Server to execute the next Item at a future time or date.When a Timer Item follows:

l An Init Item, the Correlation Server does not record the Timer setting in the Tracking Database. If the Correlation Server fails, the Timer Item is reset the next time you reinitialize the Correlation Server.

l A Catcher Item, the Correlation Server records the Timer setting in the Tracking Database. If the Correlation Server fails, the Timer setting is not lost. When you reinitialize the Correlation Server, the Correlation Serverapplies only the most recent setting.

For example, a Timer Item is set to trigger a Decision Item every hour. The Correlation Server fails at 7:30 in the morning. If you reinitialize the Correlation Server at 10:00, the Timer Item triggers the Decision Item only once, for 10:00. The Correlation Server ignores the settings for 8:00 and 9:00.

CommandSet

Command seriesIn a CommandSet Item, specify a series of commands. In a set of linked Items, these commands can instruct the Correlation Server to execute the next Item.

CommandErrorSet

Item error catcherIn a CommandErrorSet Item, specify a command or a series of commands. In a set of linked Items, this Item monitors the activity of either:

l All other Items (global monitoring), or

l The single Item to which it is linked (specific monitoring)When the CommandErrorSet Item detects an error, the commands you specify in the Item instruct the Correlation Server on the action to execute.

You can use Event processing rules to respond to processing exceptions.



Third-party management structuresSentinel creates application logs that store the exceptions and alerts defined in tracked applications. If you use Sentinel and also operate a third-party management framework, you may want to use your external framework to collect Sentinel-generated alerts.

The Sentinel Server can use a function of the Correlation Server to transform the information in stored objects into standardized SNMP Trap notifications. Sentinel can then send these notifications to any third-party manager that is compatible with SNMP V1.

To generate SNMP Traps and send them to third-party management frameworks, activate one of the following Correlation functions in an Event processing rule:

l TrkSendSNMPTrap

l TrkSendSNMPTrapAllParams

In order to provide events with a specific identity for use in SNMP management frameworks, Tracked Objects and their associated attributes contain an SNMPId field. When you update, import, or create new Tracked Objects, it is possible to accidentally create redundant SNMP IDs. To avoid this, the Sentinel TrkProd function provides you with an update command that forces regeneration of these SNMP identifiers in the Tracking Database. Use this function to generate a complete set of non-redundant SNMPIDs.

For a detailed description of the use of these functions, see SNMP and Sentinel.

DataSourcesA DataSource is an interface between the raw data returned from Requests, Tracked Objects or external databases and the graphical representation of this data in a user-friendly format on an associated Dashboard. You use DataSource objects as the source of data for the graphics objects of a Dashboard. DataSource sources of data include Tracked Objects and databases.

Use can Sentinel to manage four different DataSource types:

l Function DataSources on page 35: A DataSource based on existing Function(s)

l Request DataSources on page 36: A DataSource based on an existing standard Request or Indicator Request

l SQL DataSources on page 36: A DataSource based on a Request to an external JDBC-compliant database

l Tracked Object DataSources on page 36: A DataSource based on an existing Tracked Object

Function DataSourcesA Function DataSource is based on a Sentinel Function. In order to create a Function DataSource, you must first create the Function.



A Function is a mathematical expression composed of operands and operators. The possible operators include:

l The arithmetic operators: addition, subtraction, multiplication, division

l Predefined functions: MAXIMUM, MINIMUM, AVERAGE

Possible operands include:

l Constants

l Attributes of existing Tracked Object DataSources

l Attributes of existing SQL DataSources

l Attributes of existing Request DataSources

Sentinel enables you to define Functions that perform calculations on the attributes of existing DataSources and then to synthesize this information in a Function DataSource.

Request DataSourcesA Request DataSource is based on a Sentinel Request. In order to create a Request DataSource, you must first create the Request on which the Request DataSource is based.

A Request DataSource is active and you can specify that the values of a Request DataSource are updated either depending on the reception of a user request, the periodic execution of a Request or the arrival of a Tracked-Event Message.

SQL DataSourcesAn SQL DataSource is based on a Request that interrogates an external database. For an SQL DataSource you specify:

l Connection details of the external database

l The information to retrieve from the external database

l How to display the information retrieved

An SQL DataSource is active and you can specify that the values of an SQL DataSource are updated either depending on a preset time interval or on the reception of a user request or a particular Tracked-Event Message.

Tracked Object DataSourcesA Tracked Object DataSource is based on a Sentinel Tracked Object. In order to create a Tracked Object DataSource, you must first create the Tracked Object. The Tracked Object DataSource inherits the system attributes and user attributes of the Tracked Object on which it is based.

For a Tracked Object DataSource, Sentinel retrieves information concerning the associated Tracked Object attributes from the Tracking Database. You can filter the information that Sentinel retrieves based on:



l A certain time interval

l A Tracked Object attribute

l The value of a Tracked Object attribute

You can also define details about the Tracked Object attributes inherited by your Tracked Object DataSource including:

l The attribute names

l The visibility of the attributes by Dashboards or Functions that use your Tracked Object DataSource

l Filtering options, based on attribute values, that determine which Tracked-Event Records are displayed on the Dashboard

Probe environments (advanced)The Probe environment enables you to collect performance-related data from external applications and databases. You create Probes, sets of agent processes that you can install on a variety of applications, to collect data about a wide range of operational processes including:

l Business-related data (related to business-user tasks)

l Functional data (related to the performance of applications)

l Technical data (related to the performance of the platform elements)

l Statistical data (related to the metrics of application activities)

Probes can scan files, query database information in JDBC or analyze screen terminals (VT emulation).

The Probe environment is based on the following objects defined in Composer:

l Probe Server on page 38

l Collector Configurations on page 38

l Collector on page 42

l Complex Attribute Value on page 42

l Probe Definition on page 43

l Probe on page 43

l Subscription on page 43

Out of the above objects, the Probe Definition and the Collector Configuration do not need to be explicitly sent to server.

We advise creating the objects in the order in which they are described below, as it is respecting the dependency hierarchy.



Probe ServerA Probe Server maintains the relationship between the physical collection of information on the monitored platforms and the user management interface in Composer. The Probe Server listens to Probe Collectors in order to recuperate data or configure the Collector behavior. A Probe Server is a type of Axway Server object.

Axway Server objectA Axway Server object is an Axway software product whose internal structure is visible and configurable from inside Composer. You define Axway Server objects in the Composer Topography workbench.

Axway Server object types in Sentinel include:

l Sentinel Server

l Probe Server

l Event Router

For more information on Axway Server objects, refer to the Composer documentation.

Collector ConfigurationsA Collector Configuration is an object that defines the basic parameters of a Collector. It describes the type of data your Collector collects and the results it retrieves. For example, Sentinel enables you to define Collector types to:

l Verify the presence of a file or a directory

l Interrogate a JDBC-compliant database

l Execute a terminal script during a terminal emulation session

l Scan a file for particular data

You can:

l Define your own Collector Configuration

l Use one of the four types of Collector Configurations provided by Sentinel

Sentinel provides the following four types of Collector Configurations:

l ExistenceFileCollectorConfiguration

l TerminalCollectorConfiguration

l JDBCCollectorConfiguration

l ScanFileCollectorConfiguration

They are delivered in the file Collectors.xml and must be imported in Composer. This file is available in the folder extras\probes of your Sentinel installation folder.



The four prebuilt Collector Configurations are stored in a hidden folder called Folder_Collectors. Use the Entity Browser to access them. To display the Entity Browser, select Tools > Entity Browser from the menu bar.

The following sections describe the four types of Collector Configurations and their associated attributes. For each Collector Configuration type, there are two types of attributes:

l Input attributes: The input attributes define the data collection attributes of the Collector

l Output attributes: The output attributes define the results of the data collection of the Collector

ExistenceFileCollectorConfigurationUse the ExistenceFileCollectorConfiguration type if you want to monitor the presence of a file or a directory. The following table describes the attributes associated with this Collector Configuration type.

Attribute Function

Input attributes

parent Directory where file is located.

childIn Name of file or in the case where parent is not specified, name of directory, the presence of which you want to monitor.

Output attributes

childOut Name of results file.

childExists Indicates if file or directory exists.

childLength Length of file.

lastModified When file was last modified.

isHidden Indicates if file is hidden.

isDirectory Indicates if file is a directory.

canRead Indicates if application can read file.

canWrite Indicates if application can modify file.

TerminalCollectorConfigurationUse the TerminalCollectorConfiguration type when you want to create a Collector Configuration based on a terminal script.



Attribute Function

Input attributes

script Terminal script to execute.

emulation type

Type of emulation.

Output attributes

result Result obtained from script.Note Sentinel adds an attribute for each result parameter defined in

the script. For example, if the script returns five different results then Sentinel adds five new attributes to this section. The name of an attribute is inherited from the script definition.

JDBCCollectorConfigurationUse the JDBCCollectorConfiguration type when you want to create a Collector Configuration based on a JDBC request.

Attribute Function

Input attributes

jdbcquery Complex Attribute Value name that contains JDBC query.

url URL of JDBC-compliant database.

driver JDBC driver.

user User name that enables you to connect to JDBC-compliant database.

password Password that enables you to connect to the JDBC-compliant database.

sessionMode Indicates the database connection mode:

l True - You are in session mode and remain connected to the database.

l False - You are in normal mode and connect to the database for each execution of the request and disconnect after each execution.

url URL of JDBC-co

Date post:	13-Feb-2020
Category:	Documents
Upload:	others
View:	19 times
Download:	0 times

Axway Sentinel Configuration Guide...Objects used to control user access privileges 74 Replace...

Documents