7.3 Messaging Auxiliary Information Using SFTP
Should Metadata Providers and Release Distributors agree to use SFTP for this communication, the following two approaches can be used.
If Metadata Provider and Release Distributor agree on a file-by-file delivery (akin to the "Release-by-Release Profile" defined in the ERN Choreography Standard for SFTP), each file containing a PieMessage
shall be named as PIE_Identifier_YYYYMMDDhhmmssnnn.xml
with
Identifier being the identifier used in the
PieMessage
to identify the entity about which the message that provides additional information. Should thePieMessage
contain more than one entity, the identifier shall be the one identifying the main entity as determined by the sender of theMeadMessage
; andYYYYMMDDhhmmssnnn
being the date and time that the Release is placed on the ftp server.
For example PIE_0000000114819103_20190504102412000.xml
is a file containing auxiliary information sent on 4th May 2019 at 10:24:12.000 for the band Marillion (who have been allocated an ISNI of 0000 0001 1481 9103).
Any additional documents referenced from the PieMessage
shall be placed into the same folder as the PieMessage
. It must be uploaded to the FTP server before the PieMessage
is uploaded.
If Metadata Provider and Release Distributor agree on a batched delivery of PieMessage
, the Metadata Provider shall create a separate folder for each Batch.
To ensure sequential processing, a Batch shall be named YYYYMMDDhhmmssnnn/
with YYYYMMDDhhmmssnnn being the date and time that the set of PieMessage
is placed on the SFTP server.
The maximum size of a Batch is not defined in this standard but shall be agreed by the Metadata Provider and the Release Distributor before using this Profile. It is not permitted to include information about the same entity more than once in a single Batch.
If the Metadata Provider wants to have several Batches “open” at the same time, it needs to ensure that no information about the same entity is contained in more than one Batch.
The maximum time a Batch may be kept “open” is a matter for the Metadata Provider and the Release Distributor to define in their commercial agreement.
The Metadata Provider shall make sure that the Batch folder name is unique for each Batch.
The trigger to indicate that a Batch is complete, a zero-byte semaphore file shall be placed into the Batch folder. The semaphore file shall be named BatchComplete_YYYYMMDDhhmmssnnn
.
Each file containing a PieMessage
shall be placed into such a batch folder, following the same file naming convention as defined in Clause 7.3.1 of this standard.
Any additional documents referenced from the PieMessage
shall be placed into the same folder as the PieMessage
. It must be uploaded to the SFTP server before the batch is closed.
The recipient of such a Batch may acknowledge the receipt of each PieMessage
by placing a file containing an FtpAcknowledgementMessage
into a sub-folder acknowledgements/
which is placed into the same folder as the PieMessage
. The FtpAcknowledgementMessage
shall be named following the same file name convention as defined in Clause 7.3.1 of this Standard.
Batches can contain PIE and MEAD messages at the same time as they use the same naming convention and folder structure.