FTM Plug-In: Technical Reference

Plug-in Configuration

Geneos Universal FTM Plug-in allows for monitoring arrival times of files.

It is typically employed where the Exchange FTPs the previous day's trading reports to the client. These reports are expected to arrive at pre-defined times so that they can be automatically picked up by the back office systems for further processing.

If a report is late, but before the 'drop dead' time, it can be flagged as an amber warning condition. If the report is not available after the 'drop dead' time, this can be flagged as a critical RED condition.

For example: consider a report file that is expected to be FTPd from the Exchange at 05:00 with a back office system programmed to process it at 05:30. If the report arrives before 05:00, the FTM will show GREEN status, if the report arrives between 05:00 and 05:29:59, the status is AMBER, and if the report has not arrived or arrived after the 05:29:59 the status is RED.

FTM works by dividing the time into monitoring periods. By default, a monitoring period starts at 12:00 noon and finishes 11:59:59 the following day. FTM is aware of the current monitoring period and any files that exist, are ignored if their timestamp is outside of the monitoring period. This ensures that FTM monitors for 'fresh' file arrivals and does not confuse them with 'older' files that may be there from the previous monitoring period.

It's possible to switch the monitoring period between "noon to noon" (as described above) and "midnight to midnight".

Note: Monitoring periods for Saturday, Sunday and additional defined holiday dates are ignored only for daily expected period. See expectedPeriod for more details on expected periods.

View

The FTM plug-in can be used to monitor arrival times of any file, for example the log file of a batch process that must be run at a specific time.

Headline Legend

NameDescription
totalFilesExpectedNumber of files configured.
filesDelayedNumber of files that have not arrived yet and are past their due arrival time.
lateArrivalsNumber of files that have arrived, but later than expected, i.e. where the Delay time is greater than zero.
totalReceivedNumber of files received.
  

Table Legend

Name Description
FilenameName of the file or its alias.
expectedTimeTime the file is expected.
arrivalTimeTime the file has arrived.
DelayNumber of seconds the file is delayed by, counted from the expected time. If the file arrives before its expected time, the delay is set to zero.
currentFileSizeCurrent size of the file that was transferred. This can be used to detect files that have not transferred properly.
actualFilenameActual file being monitored that is only visible if showActualFilename is set.
periodStartStart of the current monitoring period.
periodEndEnd of the current monitoring period.
  

Plug-in Configuration

The following parameters can be configured for this plug-in:

files

Allows the configuration of files.

Mandatory: Yes

files > file > path

The full path to the file.

Example:

/usr/data/FileX.dat

If <today> (including the < > brackets) is specified as part of the file name, it will result in the automatic substitution of the date in yyyymmdd format.

Additionally, you can include one or more formatting codes to format the date - <today%d%m%Y>.

Also, in place of the <today> keyword, you can use these keywords when specifying the filename:

Date keywordDescription
<today...>Current date.
<today+x...>Current date + x actual days.

This does not include the monitored days and holidays.
<today-x...>Current date - x actual days.

This does not include the monitored days and holidays.
<yesterday...>Actual date yesterday.

If monitored days is not configured in FTM, Saturdays and Sundays are considered holiday. Therefore, if today is Monday, the <yesterday> tag is the date of the previous Friday.
<tomorrow...>Actual date tomorrow.
<previous_monitored_day...>Previous day with respect to holidays and monitored days.
<previous_monitored_day-x...>Previous monitored day minus the previous x number of monitored days. This includes the holidays and monitored days.
<next_monitored_day...>Next day with respect to holidays and monitored days.
<next_monitored_day+x...>Next monitored day plus the next x number of monitored days. This includes the holidays and monitored days.
  

Sample path configuration details for FTM plug-in:

Date keyword expansions

When using the +x or -x values into the date keywords to offset the date on the filename, note the following behaviours when introducing spaces (depicted as the character) in formatting:

Date keyword expansion formatBehaviour and outcome
<today␣>Ignores the space and uses the default %Y%m%d format.

If the date today is 30 June 2018, then the outcome is:
20180630.dat
<today␣%Y␣%m␣%d␣>Ignores the spaces around the date format, but includes the spaces in-between.

If the date today is 30 June 2018, then the outcome is:
2018 06 30.dat
<today␣+␣10␣>Ignores the spaces and uses the default %Y%m%d format. This format also offsets by the value of the number indicated.

If the date today is 30 June 2018, then the outcome is:
20180710.dat
<today␣+␣1␣0␣>Offsets by the value of the first digit, and interprets the subsequent digit as the format string. As a consequence, this format renders the offset invisible, even though the offset is in effect due to the first digit.

Regardless of the date, the outcome is:
0.dat
<today␣+␣1␣0␣%Y-%m-%d␣>Offsets by the value of the first digit, and interprets the subsequent digit as part of the %Y-%m-%d format.

If the date today is 30 June 2018, then the outcome is:
0 2018-07-01.dat

The limitations for offsets to today, previous_monitored_day-x, and next_monitored_day+x path keywords are set to:

  • Lower bounds: -3650
  • Upper bounds: 3650

The invalid offsets get an expanded value equivalent to the base tag. If you have <previous_monitored_day-3651>, then the date becomes <previous_monitored_day>.

Formatting codeDescription
%aAbbreviated weekday name.
%AFull weekday name.
%bAbbreviated month name.
%^bAbbreviated month name (but capitalised).
%BFull month name.
%dDay of month as decimal number (01 - 31).
%jDay of year as decimal number (001 - 366).
%mMonth as decimal number (01 - 12).
%UWeek of year as decimal number, with Sunday as first day of week (00 - 53).
%wWeekday as decimal number (0 - 6; Sunday is 0).
%WWeek of year as decimal number, with Monday as first day of week (00 - 53).
%xDate representation for current locale.
%yYear without century, as decimal number (00 - 99).
%YYear with century, as decimal number.
%ZTime-zone name or abbreviation; no characters if time zone is unknown.
  

Examples:

ConfiguredEquivalent (if date is 24 September 2003)
filename<today%d%m%Y>.txtfilename24092003.txt
filename<today%d%b%Y>.txtfilename24Sep2003.txt
filename<today%d%^b%Y>.txtfilename24SEP2003.txt
filename<today%d-%b-%Y>.txtfilename24-Sep-2003.txt
  

Mandatory: Yes

files > file > expectedArrival

The expected time in the HH:MM:SS format.

Mandatory: Yes

files > file > expectedPeriod

Specifies how often the file is transferred.

Possible values:

SettingDescription
dailyFile is expected every day.
weeklyFile is expected every week. The day on which the file will arrive should also be specified.
monthlyFile is expected every month. The date on which the file will arrive should also be specified. Last may be chosen if the file will always arrive on the last day of the month.
  
Mandatory: No
Default: daily

The following are the expected periods depending on the day, time and monitoring period set:

Note: The results below assume that the expected arrival time is later than the current Netprobe machine time.

Daily

Monday

Netprobe Machine TimeFTM Expected Arrival in GSEMonitoring PeriodFTM Expected Time in Dataview
Before NoonBefore NoonNoon to NoonBefore Noon, Same Day
Before NoonAfter NoonNoon to NoonAfter Noon, Previous Friday
Before NoonBefore NoonMidnight to MidnightBefore Noon, Same Day
Before NoonAfter NoonMidnight to MidnightAfter Noon, Same Day
After NoonBefore NoonNoon to NoonBefore Noon, Next Day
After NoonAfter NoonNoon to NoonAfter Noon, Same Day
After NoonBefore NoonMidnight to MidnightBefore Noon, Same Day
After NoonAfter NoonMidnight to MidnightAfter Noon, Same Day
    

Tuesday, Wednesday, Thursday

Netprobe Machine TimeFTM Expected Arrival in GSEMonitoring PeriodFTM Expected Time in Dataview
Before NoonBefore NoonNoon to NoonBefore Noon, Same Day
Before NoonAfter NoonNoon to NoonAfter Noon, Previous Day
Before NoonBefore NoonMidnight to MidnightBefore Noon, Same Day
Before NoonAfter NoonMidnight to MidnightAfter Noon, Same Day
After NoonBefore NoonNoon to NoonBefore Noon, Next Day
After NoonAfter NoonNoon to NoonAfter Noon, Next Day
After NoonBefore NoonMidnight to MidnightBefore Noon, Same Day
After NoonAfter NoonMidnight to MidnightAfter Noon, Same Day
    

Friday

Netprobe Machine TimeFTM Expected Arrival in GSEMonitoring PeriodFTM Expected Time in Dataview
Before NoonBefore NoonNoon to NoonBefore Noon, Same Day
Before NoonAfter NoonNoon to NoonAfter Noon, Previous Day
Before NoonBefore NoonMidnight to MidnightBefore Noon, Same Day
Before NoonAfter NoonMidnight to MidnightAfter Noon, Same Day
After NoonBefore NoonNoon to NoonBefore Noon, Next Monday
After NoonAfter NoonNoon to NoonAfter Noon, Same Day
After NoonBefore NoonMidnight to MidnightBefore Noon, Same Day
After NoonAfter NoonMidnight to MidnightAfter Noon, Same Day
    

Saturday, Sunday

Netprobe Machine TimeFTM Expected Arrival in GSEMonitoring PeriodFTM Expected Time in Dataview
Before NoonBefore NoonNoon to NoonBefore Noon, Next Monday
Before NoonAfter NoonNoon to NoonAfter Noon, Previous Friday
Before NoonBefore NoonMidnight to MidnightBefore Noon, Previous Friday
Before NoonAfter NoonMidnight to MidnightAfter Noon, Previous Friday
After NoonBefore NoonNoon to NoonBefore Noon, Next Monday
After NoonAfter NoonNoon to NoonAfter Noon, Previous Friday
After NoonBefore NoonMidnight to MidnightBefore Noon, Previous Friday
After NoonAfter NoonMidnight to MidnightAfter Noon, Previous Friday
    

Holidays

Note: The results below disregard weekends. For example, if Monday is the monitoring day, "Previous Day" refers to Friday, not Sunday; and if Friday is the monitoring day, "Next Day" refers to Monday, not Saturday.

Scenario 1: The monitoring day and the holiday is set on the same day.

Netprobe Machine TimeFTM Expected Arrival in GSEMonitoring PeriodFTM Expected Time in Dataview
Before NoonBefore NoonNoon to NoonBefore Noon, Next Day
Before NoonAfter NoonNoon to NoonAfter Noon, Previous Day
Before NoonBefore NoonMidnight to MidnightBefore Noon, Previous Day
Before NoonAfter NoonMidnight to MidnightAfter Noon, Previous Day
After NoonBefore NoonNoon to NoonBefore Noon, Next Day
After NoonAfter NoonNoon to NoonAfter Noon, Previous Day
After NoonBefore NoonMidnight to MidnightBefore Noon, Previous Day
After NoonAfter NoonMidnight to MidnightAfter Noon, Previous Day
    

Scenario 2: The monitoring day is a weekday and the holiday is set the next day.

Note: This also applies to consecutive holidays.

Netprobe Machine TimeFTM Expected Arrival in GSEMonitoring PeriodFTM Expected Time in Dataview
Before NoonBefore NoonNoon to NoonBefore Noon, Same Day
Before NoonAfter NoonNoon to NoonAfter Noon, Previous Day
Before NoonBefore NoonMidnight to MidnightBefore Noon, Same Day
Before NoonAfter NoonMidnight to MidnightAfter Noon, Same Day
After NoonBefore NoonNoon to NoonBefore Noon, Day/s After Holiday/s
After NoonAfter NoonNoon to NoonAfter Noon, Same Day
After NoonBefore NoonMidnight to MidnightBefore Noon, Same Day
After NoonAfter NoonMidnight to MidnightAfter Noon, Same Day
    

Scenario 3: The monitoring day is on a weekend and the holiday is set on a Monday.

Netprobe Machine TimeFTM Expected Arrival in GSEMonitoring PeriodFTM Expected Time in Dataview
Before NoonBefore NoonNoon to NoonBefore Noon, Next Tuesday
Before NoonAfter NoonNoon to NoonAfter Noon, Previous Friday
Before NoonBefore NoonMidnight to MidnightBefore Noon, Previous Friday
Before NoonAfter NoonMidnight to MidnightAfter Noon, Previous Friday
After NoonBefore NoonNoon to NoonBefore Noon, Next Tuesday
After NoonAfter NoonNoon to NoonAfter Noon, Previous Friday
After NoonBefore NoonMidnight to MidnightBefore Noon, Previous Friday
After NoonAfter NoonMidnight to MidnightAfter Noon, Previous Friday
    

Scenario 4: The monitoring day is on a weekend and the holiday is set on a Friday.

Netprobe Machine TimeFTM Expected Arrival in GSEMonitoring PeriodFTM Expected Time in Dataview
Before NoonBefore NoonNoon to NoonBefore Noon, Next Monday
Before NoonAfter NoonNoon to NoonAfter Noon, Previous Thursday
Before NoonBefore NoonMidnight to MidnightBefore Noon, Previous Thursday
Before NoonAfter NoonMidnight to MidnightAfter Noon, Previous Thursday
After NoonBefore NoonNoon to NoonBefore Noon, Next Monday
After NoonAfter NoonNoon to NoonAfter Noon, Previous Thursday
After NoonBefore NoonMidnight to MidnightBefore Noon, Previous Thursday
After NoonAfter NoonMidnight to MidnightAfter Noon, Previous Thursday
    

Note: If the expected arrival time set is earlier than the current Netprobe machine time and the expected period is set on the same day, the expected time in the dataview will fall on the same day with delay.

Weekly and Monthly

Sunday - Monday

Netprobe Machine TimeFTM Expected Arrival in GSEMonitoring PeriodFTM Expected Time in Dataview
Before NoonBefore NoonNoon to NoonBefore Noon, Expected Period in GSE
Before NoonAfter NoonNoon to NoonAfter Noon, Expected Period in GSE
Before NoonBefore NoonMidnight to MidnightBefore Noon, Expected Period in GSE
Before NoonAfter NoonMidnight to MidnightAfter Noon, Expected Period in GSE
After NoonBefore NoonNoon to NoonBefore Noon, Expected Period in GSE
After NoonAfter NoonNoon to NoonAfter Noon, Expected Period in GSE
After NoonBefore NoonMidnight to MidnightBefore Noon, Expected Period in GSE
After NoonAfter NoonMidnight to MidnightAfter Noon, Expected Period in GSE
    

Note: For monthly expected period, if the expected period set is earlier than the current Netprobe machine day, the expected time in the dataview will fall on the expected period set, next month.

Monitoring DayExpected PeriodExpected Time in Dataview
December 4Monthly, Day 1January 1
   

files > file > tzOffset

The time-zone offset is used when files have date / time formatting in the filename, but the file is produced in a time-zone which may lead to the file having a different date from the expected.

The parameter specifies the number of hours difference between the time-zone the probe is running in and the time-zone in which the file is produced. For example, if the Netprobe is running in London and the file is produced in New York with a with a time difference of -5 hours, then tzOffset should be set to -5. This way, if the file is produced at 10pm in New York (3am in London), FTM will know to expect a filename with what will be the previous days date.

Mandatory: No
Units: Hours
Default: 0

files > file > monitoringPeriod

Specifies the monitoring period, overriding the monitoring period set at the sampler level.

Mandatory: No
Default: Same as the sampler configuration.

files > file > monitoringPeriod > periodAlias

One of the period aliases for the monitoring period, e.g. NOON_TO_NOON or MIDNIGHT_TO_MIDNIGHT.

Mandatory: No
Default: Same as the sampler configuration.

files > file > monitoringPeriod > periodStartTime

A specific time in HH:MM format for the start of the monitoring period, e.g. 12:00 is the same as specifying NOON_TO_NOON.

Mandatory: No
Default: Same as the sampler configuration.

files > file > alias

A more readable name for the file, to be displayed in the first column of the view.

Mandatory: No
Default: The filename

files > file > activePeriod

An amount in seconds that gets added before and after the expected time of a file to provide a period during which file arrivals should be recognized and responded to and ignored otherwise. This is useful when you are monitoring the arrival of a file with the same name two or more times during the day. If a file arrives after (expectedTime + activePeriod), then none of the displayed metrics should be affected.

Mandatory: No
Default: Nothing

monitoringPeriod

Sets the monitoring period for the plug-in.

monitoringPeriod > periodAlias

An alias for the start of the monitoring period.

Possible values:

SettingDescription
NOON_TO_NOONMonitoring period starts at 12:00pm and ends at 11:59am the following day.
MIDNIGHT_TO_MIDNIGHTMonitoring period starts at 12:00am and ends at 11:59pm on the same day.
  

Mandatory: No
Default: NOON_TO_NOON

monitoringPeriod > periodStartTime

A start time for the monitoring period in HH:MM format. A start time of 12:00 is the same as specifying a periodAlias of NOON_TO_NOON.

holidays

A list of holiday dates in DD-Month[-YYYY] format (month is truncated to first three characters). When the year is not specified, it is assumed that the date applies to every year.

Mandatory: No
Default: No holidays

monitoredDays

This setting allows FTM to monitor only on certain days of the week. For example to Monitor only on weekdays.

Note: This option is not compatible with the expectedPeriod option for files. The behaviour is undefined if these options are used in conjunction.

Holidays are ignored if this option is used.

Mandatory: No
Default: Weekdays (Monday to Friday)

consistentDateStamps

By default, the plug-in uses the Netprobe host's date and timestamp as reference for its date and time resolution. For example, the filename function <previous_monitored_day...> uses the Netprobe host's date and timestamp and the value of the monitoredDays setting to determine the correct value.

If consistentDateStamps is set to true, the expected date and time are based on the date and time at the start of the monitoring period. For example, the filename function <previous_monitored_day...> uses the date and time of the start of the monitoring period and the value of the monitoredDays setting to determine the correct value.

Mandatory: No
Default: false

showPreviousDay

Plug-in shows a separate view of the data relating to the previous day. (Previous day data is stored in a file by the plug-in when the current day ends - at noon or midnight based on the monitoringPeriod setting).

This implements the monitoring period snapshot at the file level, instead of using the sampler level monitoring period.

The periodStart and periodEnd columns are added to the main and previous day dataview. It shows the start and end of the current monitoring period respectively.

Mandatory: No
Default: false

previousDayFile

The full path (including filename) of the file that the plug-in should use for writing and reading data. The plug-in should have write permissions to this file/location.

Mandatory: No
Default: FTMpredaydata.dat

showActualFilename

Adds an additional column "actualFilename" which shows the actual filename of each file (this is useful when files have aliases specified)

Mandatory: No
Default: false

delayUnit

The unit of time that the "delay" column should be displayed in.

Possible values:

SettingDescription
SECONDSDisplays the delay time in seconds.
MINUTESDisplays the delay time in minutes.
HOURSDisplays the delay time in hours.
  

Mandatory: No
Default: SECONDS

sizeUnit

The unit of size that the "currentFileSize" column should be displayed in.

Possible values:

SettingDescription
BYTESDisplays the current file size in bytes.
KILOBYTESDisplays the current file size in kilobytes.
MEGABYTESDisplays the current file size in megabytes.
GIGABYTESDisplays the current file size in gigabytes.
  

Mandatory: No
Default: KILOBYTES

useChangedTime

Determines whether ctime or mtime should be used when a monitored file has been determined to have arrived. If false or not defined, then mtime is used. Else if true, then ctime is used.

Mandatory: No
Default: false