Configure punctuality check on file arrival for a specific account

Introduction

Punctuality is a key concern when it comes to file transfer monitoring. You may ensure that files are arriving from an account before a given deadline because those files are part of a critical process.

The Prebuilt Dashboards for SecureTransport address the following use case:

  • Mary wants to make sure that Y files named b_file.txt have been successfully received from account B by 3pm.

This page provides step-by-step instructions on how to configure a punctuality check for an account and a specific deadline.

Composition of an account file check

An account file check consists of:

  • A unique ID, which will be reused in the next configuration step.
  • The corresponding account.
  • The file transfer state expected.
  • An expected arrival time (for example, 18:00) beyond which all new transfers will be considered late.
  • An expected count of files – when this minimum count is reached, we consider that the punctuality criteria are met as expected for the current day.
  • The day from which a punctuality check must be started.

Configure account file checks

Account file check requires 3 steps to be properly configured:

  1. Register/unregister an account file check by using either a configuration dashboard, an API, or data integration tools such as resources/routes.
  2. Update the decision table that defines the criteria to be used for resolving the account file check when receiving the transfer events.
  3. Stop and restart the absorption route.

Step 1 - Register / unregister an account file check

Configuration dashboard

The bottom area of the screen enables you to:

  • Remove account file checks from the list using the action button, 
  • Create/update file checks by using the link towards the Swagger interface and then using the configuration API from it.

Configuration APIs

Create/update account file check

HTTP Method

URL

POST <base_url>/ws-doc#!/absorb/07_ST_Configuration_03_CreateAccountFileCheck


In-line parameters

Name

Description

id

Account file check identifier.
account Account id
minCountExpected
minimum count of files expected
expectedArrivalTime

Arrival time set with a duration value.

  • integer with the duration in milliseconds
  • ISO 8601 formatted duration string (see sample request below)
state

File transfer state expected

  • RECEIVED
  • SENT
startTime
start time from which the punctuality rule is applied.

Sample request body

{
  "id": "Acc_Test_NEWDOC",
  "account": "Acc_Test",
  "minCountExpected": 6,
  "expectedArrivalTime": "PT54000S",
  "state": "RECEIVED",
  "startTime": "2017-12-01T00:00:00.000+01:00"
}
Remove account file check

HTTP Method

URL

POST <base_url>/ws-doc#!/absorb/07_ST_Configuration_11_RemovePunctualityRule

In-line parameters

Name

Description

id

Account file check identifier.

Sample request body

{
  "id": "Acc_Test_NEWDOC"
}

Create multiple account file checks with resources/routes

You can also create multiple account file checks through the data integration elements available in the 07-ST-Configuration space.

  1. Navigate to Data Integration > Routes
  2. Update the 03_AccountFileChecks internal resource.
    The resource content is in CSV format and should have the first line as a header.

    id,account,state,expectedArrivalTime,minCountExpected,startDay
    Acc_test_ORDER,Acc_Test,RECEIVED,15:00,3,2017-09-29
    Acc_test_INVOICE,Acc_Test,SENT,18:00,2,2017-09-29
  3. Once you've updated your resource, navigate to Data Integration > Routes and run the  03_CreateFileChecks configuration route.

Step 2 - Update the file checks decision table

The decision table is a text file that defines the file transfer criteria that will be used to resolve the corresponding account file check (cf. caption below). 


The decision table is fed to Decision Insight by depositing the text file into the Decision Insight's server. You must also specify the location of the file in the DT_PUNCTUALITY_CHECK property. (cf. table below for details).

property description location default value
DT_PUNCTUALITY_CHECK Location of the decision table file for punctuality check Data Integration > Properties > In space 04-ST-Integration dtPunctualityCheck.txt

If you don't specify an absolute path for the decision table file location, Decision Insight will search for the file in the var folder of Decision Insight's installation's folder.

Very important:

If you need to configure the punctuality check after a Prebuilt Analytics for SecureTransport upgrade, you must follow an additional step before you can proceed. For more information, see Install and configure Axway Decision Insight: Upgrade

You must update the decision table in the following cases:

  • You want to change the resolution criteria for the account file check.
  • You created a new account file check and you need to specify the criteria that will resolve it.
  • You removed an account file check and you need to remove the decision table entries that are still referring to it.


As per the example below, to resolve the account file check ID – which is specified as the final <outcome> –the following criteria are used:

  • The protocol file name
  • The protocol
  • The account
  • The file transfer state
#PROTOCOLFILENAME;PROTOCOL;USERID;STATE;<outcome>
{ORDER.txt};HTTP;Acc_Test;RECEIVED;Acc_test_ORDER
{INVOICE.txt};FTP;Acc_Test;RECEIVED;Acc_test_INVOICE


For instance, the first record of the table is specifying the following rule: if (PROTOCOLFILENAME = "ORDER.txt" and PROTOCOL = "HTTP" and USERID = "Acc_Test" and STATE="RECEIVED"), then the account file checks Acc_test_ORDER punctuality rules applicable.


Decision table rules

  • The column header name of the decision table must match the tracked object attribute name. To get the complete attributes list, search for page "Axway Sentinel tracked objects" in the SecureTransport Administration Guide (example for SecureTransport5.4 go to Axway Sentinel Tracked objects).
  • You can add additional criteria to the decision table based on Tracked Object attributes.
  • To ignore an attribute, use the keyword <any>
  • The operator AND is applied on the condition attributes 
  • The order of the rows in the file is important, namely, the first verified row wins.

For more information about how to configure a decision table on Decision Insight, see the Decision table


Step 3 - Restart the absorption route for the changes to take effect

Any change performed in the decision table will not be effective unless the absorption route is restarted.

From the Routes tab,  stop and restart the 01_AbsorbTrackedObject route in the 04-ST-Integration space. 

  • Be cautious when restarting the absorption route, because a misconfigured decision table might lead to failures during events absorption. Make sure that your changes have not generated any error by checking the integration logs.
  • Changes performed on the decision table do not have any retroactive effect on the events that have already been absorbed.

Related Links