Prebuilt Dashboards design overview

Monitored activity

The Prebuilt Dashboards for SecureTransport can be used to monitor transfer activity for two main reasons:

  • Performance – infrastructure availability, responsiveness and reliability
  • Usage – partners'/internal users' behavior and punctuality

Observation model

Entity Description Data type
Global Singleton instance used to consolidate data at a global level Static configuration data
File size category Allows to categorize file transfers by size range Static configuration data
Initiator Determines whether the transfer is server-initiated or client-initiated Static configuration data
State type Determines whether the transfer state is permanent or temporary Static configuration data
Secure connection Determines whether the transfer is initiated through a secure connection Static configuration data
Emitter type Determines whether the account is internal or external (partner) Static configuration data
Evaluation type Preconfigured data that can be used for activity evaluation at a(n) global/account/business unit level Static configuration data
File transfer type Determines whether it is a receiving or a sending file transfer Static configuration data
Protocol Protocol used Reference data
Account The Account that is sending or receiving the transfer Reference data
Business unit Business unit Reference data

SecureTransport server

The SecureTransport server that runs the transfers Reference data
End point End point, corresponding to the transfer site or the account itself Reference data
Watched account Allows enabled account monitoring for high/low volume detection Custom settings data
Account file check Allows enabled punctuality monitoring for specific data Custom settings data
File transfer Receiving or Sending transfers. Transactional data
Flow event Events related to a flow execution. Transactional data

Concepts

Static configuration data  – Data whose static values can be considered as part of the application, regardless of the customer context where the solution is deployed. As such, configuration data are space-related and are automatically retrieved when importing the application.

Reference data  – Corresponds to customer reference data. Most of the time, instances are created on the fly at the integration of tracked object events.

Transactional data  – Events with a specific time dimension (life cycle).

Transactional data life cycle

The Prebuilt dashboards for SecureTransport are designed for tracking and monitoring file transfers.

A file transfer is usually part of a broader processing flow that can consist of one or more file transfers and some additional post processing operations such as archiving or deletion. Because there is no exhaustive rule that can determine exactly when the flow is actually completed, no end-to-end tracking is available for those flows. However, all reported events related to a flow are logged as separate flow events. 

If we consider the example of a processing flow starting when a file is received by the SecureTransport server and sent to 3 different recipients, then deleted once all the send operations are completed, there would be a total of:

  • 1 receiving file transfer
  • 3 sending file transfers


File transfer processing is always a two-steps workflow: the file transfer life cycle starts at Receiving/Sending events and ends at Received/Sent events if successfully completed, or Failed/Canceled otherwise.


Data integration

Data integration – 01_AbsorbTrackedObject routing context – is using the Tracked object events that are reported by SecureTransport. Those events are conveyed by the QLT (Queueless Transport) protocol provided by Axway.

Data parsing and absorption

Tracked objects processing

The Prebuilt dashboards take data from 2 types of Tracked objects:

  • XFBTRANSFER for all flow processing events
  • HEARTBEAT for checking the SecureTransport server availability 

Reference data such as protocols, accounts, business units is created on the fly if it doesn't exist (autodiscovery mechamism).

Data mapping rules

All messages conveyed through Tracked objects are reported in a flat format (no hierarchical structure). 

File transfer data

Entity / Relation / Attrbutes Data source / Data location Instance Id Valid time
File transfer
  • Tracked object (XFB Transfer)
  • decisiontable_filecheck
TrackedObject.CYCLEID
  • start time - TrackedObject.EVENTTIMESTAMP at Receiving /Sending event
  • end time - TrackedObject.EVENTTIMESTAMP at Received/Sent/Failed/Cancelled events

protocol

  • TrackedObject.PROTOCOL
 


intiator

  • TrackedObject.INITIATOR
 

SecureTransport Server

  • TrackedObject.PRODUCTIPADDR
 

state

  • TrackedObject.STATE
  • TrackedObject.FAILURE TYPE
 

account

  • TrackedObject.USERID
 

emitter type

  • TrackedObject.USERPARAMETER1
 
business unit
  • TrackedObject.GROUPNAME


secure connection
  • TrackedObject.ISSSL


file transfer type
  • TrackedObject.DIRECTION


bytes transmitted / file size category
  • TrackedObject.BYTESTRANSMITTED


file check


Reference data

Entity / Relation / Attributes Data source / Data location Instance Id Valid time
Account
  • Tracked object (XFB Transfer)
  • TrackedObject.USERID
  • first file transfer timestamp

type

  • USERPARAMETER1
 


SecureTransport server
  • Tracked object (XFB Transfer)
  • Tracked object (HEARTBEAT)
  • Internal resource 04_STServers
  • TrackedObject.PRODUCTIPADDR
  • application start date property
address

latest heartbeat event
  • Tracked object (HEARTBEAT)
  • TrackedObject.EVENTDATE
  • TrackedObject.EVENTTIME
  • TrackedObject.GMTDIFF

Business unit
  • Tracked object (XFB Transfer)
  • TrackedObject.GROUPNAME
  • first file transfer timestamp
Protocol
  • Tracked object (XFB Transfer)
  • TrackedObject.PROTOCOL
  • application start date property
End point
  • Tracked object (XFB Transfer)
  • TrackedObject.REMOTEPARTY
  • first file transfer timestamp

Metrics and evaluations

Key metrics

Most key metrics are cumulative or average counts that are aggregating values over the current day. 

Metric Description

Transfers completed

∑ file transfers completed
Failure count ∑ file transfers completed with a "Permanent failure" state
Failure rate ∑ file transfers completed with a "Permanent failure" state / ∑ file transfers permanently completed (without temporary failures)
Average transfer rate ∑ bytes transmitted / ∑ transfer duration


Evaluations

Metric Description
Punctuality check Transfers completed >= Min count of transfers expected at deadline
High / Low volume Evaluation against baseline-based thresholds (dispersion multiplier is taken from the evaluation type)
Low transfer rate Average transfer rate evaluation against 5th percentile
Failures ∑ file transfers completed with a "Permanent failure" > 0
SecureTransport server inactivity Evaluation of the latest hearbeat value against a duration threshold.

Manage user rights

User rights management is built around two main concepts:

  • Application perspective – the monitoring solution offers a range of perspectives depending on the profiles of users the monitoring application can handle. An application perspective is a navigation context composed of a home dashboard and a subset of other dashboards, depending on the profile the user will have.
  • User data filtering – the monitoring solution offers an assignation system to enable an Delegated administrator or a Business unit relationship manager to monitor a specific subset of business units.

For more information, see Users management.

Application perspectives

In the context of the Prebuilt Dashboards, the following corresponding application perspectives will be predefined:

User type Domain of concern Filtering rule
Global administrator Global transfer performance None
Delegated administrator Business transfer performance Business unit
Global relationship manager Global service usage None
Business unit relationship manager Business unit service usage Business unit



Noteworthy features

Resubmit action

End-users are enabled to perform a transfer resubmit from the Prebuilt dashboards by calling a service exposed by SecureTransport. This feature is based on an action mashlet. For more information, see How to fetch information on demand using an action mashlet, in the  Axway Decision Insight documentation.

Punctuality check

Punctuality check analytics rely on the decision table connector to identify which transfers to monitor. For more information, see Decision table in the Axway Decision Insight documentation

Prebuilt Alerts

This feature enables alerting end-users on punctuality check updates and file transfer completion.  

Notification rules are based on the punctuality check indicator or the file transfer properties.


Related Links