View source for Standards:IG file.sequence

__NOTOC__ __NOEDITSECTION__
[[Catégorie:Specification Committee|File.sequence]]
{{discussion}}

<svnig source="FilSeq_Intro.txt" repository="General" revision="" date="" last="" conversion="none">
== Introduction ==

The "sequence file" structure is designed to carry various types of contents, in a strictly "intra-IS" environment. It may be considered as a replacement for the missive, when high-level security is unnecessary : no signing and no ciphering are associated with it.

This generic file contains one or several "generic elements", which must all be of the same "type" (all pain.001 for instance) and "version" (001.03 for instance, if we are considering pain.001).

This file holds a sequence number, which must be attributed in strictly ascending order. This allows the other party to check that no file is forgotten in the handling, and that it properly handles everything generated by Sepamail.

The structure also allows for an acknowledgement mechanism, which is currently not used.
</svnig>

<svnig source="FilSeq_Abstract.txt" repository="General" revision="" date="" last="" conversion="none">
== Internal abstraction level ==

To facilitate upgrades, an abstraction level has been inserted at the root of this element.

The actual contents of the SequencedFile element must be any one of the sepamail_sequenced_file_xxx structures.
</svnig>

<svnig source="FilSeq_Abstract.tab" repository="General" revision="" date="" last="" conversion="tab">
{| class="wikitable" style="width:100%"
|- 
! align="center" | Mult
! align="center" | Message Element
! align="center" | Sepamail requirement
|- div class="OrangeClass"
| align="left" style="width:8%" | [1..1]
| align="left" style="width:28%" | sepamail_sequenced_file_001
| align="left" style="width:64 %" | First version of the structure
|}
</svnig>

<svnig source="FilSeq_Body.txt" repository="General" revision="" date="" last="" conversion="none">
== Message Body ==

</svnig>

<svnig source="FilSeq_Body.tab" repository="General" revision="" date="" last="" conversion="tab">
{| class="wikitable" style="width:100%"
|- 
! align="center" | Ref
! align="center" | Mult
! align="center" | Message Element
! align="center" | Sepamail requirement
|- div class="OrangeClass"
| align="left" style="width:5%" | A
| align="center" style="width:8%" | [1..1]
| align="left" style="width:18%" | + SeqFile
| align="left" style="width:69%" | 
|- div class="OrangeClass"
| align="left" style="width:5%" | A1
| align="center" style="width:8%" | [1..1]
| align="left" style="width:18%" | ++ DatTim
| align="left" style="width:69%" | Date and time of creation, in ISO format
|- div class="OrangeClass"
| align="left" style="width:5%" | A2
| align="center" style="width:8%" | [1..1]
| align="left" style="width:18%" | ++ Partner
| align="left" style="width:69%" | Designates the communicating party, either sender or receiver, always by a BIC
|- div class="OrangeClass"
| align="left" style="width:5%" | A2.1
| align="center" style="width:8%" | {Or
| align="left" style="width:18%" | +++ Sender
| align="left" style="width:69%" | If this file is created by Sepamail
|- div class="OrangeClass"
| align="left" style="width:5%" | A2.2
| align="center" style="width:8%" | Or}
| align="left" style="width:18%" | +++ Receiver
| align="left" style="width:69%" | If this file is sent to Sepamail
|- div class="OrangeClass"
| align="left" style="width:5%" | A3
| align="center" style="width:8%" | [1..1]
| align="left" style="width:18%" | ++ EltType
| align="left" style="width:69%" | The exact type of the elements held in this file. Can be a string ("pain.001" for instance) or a URI.
|- div class="OrangeClass"
| align="left" style="width:5%" | A4
| align="center" style="width:8%" | [1..1]
| align="left" style="width:18%" | ++ Version
| align="left" style="width:69%" | The precise version of the elements, allowing schema selection for validation of the body (if needed)
|- div class="OrangeClass"
| align="left" style="width:5%" | A5
| align="center" style="width:8%" | [1..1]
| align="left" style="width:18%" | ++ SeqNbr
| align="left" style="width:69%" | Sequence number of the file. This must be strictly ascending, to allow for detection of any transmission or handling anomaly
|- div class="OrangeClass"
| align="left" style="width:5%" | A6
| align="center" style="width:8%" | [1..1]
| align="left" style="width:18%" | ++ NbElts
| align="left" style="width:69%" | Number of elements in the current file, must be a strictly positive integer.
|- div class="OrangeClass"
| align="left" style="width:5%" | A7
| align="center" style="width:8%" | [1..1]
| align="left" style="width:18%" | ++ Elements
| align="left" style="width:69%" | Holds the Actual payload of the file
|- div class="OrangeClass"
| align="left" style="width:5%" | A7.1
| align="center" style="width:8%" | [1..n]
| align="left" style="width:18%" | +++ Element
| align="left" style="width:69%" | One such item for each content.
|- div class="OrangeClass"
| align="left" style="width:5%" | A7.1.1
| align="center" style="width:8%" | [1..1]
| align="left" style="width:18%" | ++++ EltId
| align="left" style="width:69%" | Element identifier. Can be any string, but must be unique with a given partner.
|- div class="OrangeClass"
| align="left" style="width:5%" | A7.1.2
| align="center" style="width:8%" | {Or
| align="left" style="width:18%" | ++++ EltBody
| align="left" style="width:69%" | The element itself, which can be of any type
|- div class="OrangeClass"
| align="left" style="width:5%" | A7.1.3
| align="center" style="width:8%" | Or}
| align="left" style="width:18%" | ++++ EltAck
| align="left" style="width:69%" | Acknowledgement of the element with the given identifier. This acknowledgement can be positive (true) or negative (false). CURRENTLY, THIS FIELD IS NOT USED.
|}
</svnig>

<svnig source="FilSeq_Use.txt" repository="General" revision="" date="" last="" conversion="none">
== Usage ==

''This belongs anywhere but here ... ''

For every party using this structure, a folder will be created in a suitable place. This folder will hold two subfolders : "In" and "Out", used to held files sent to (resp. generated by) the Sepamail system.

No empty file will ever be generated. The "Out" folder will be empty if no outgoing elements exist.

The frequency of file generation will be freely determined between the communicating parties.

If an acknowledgement is generated by the external party, the files will be created in the "In" folder.

Sepamail will archive the files found in the "In" folder, but it is of the other party's responsibility to archive the files generated by Sepamail in the "Out" folder.

The file name, whether incoming or outgoing, is defined by the following grammar :

 <in_file_name> ::= <date_time> '_' <sender_BIC> '.in.xml'
 <out_file_name> ::= <date_time> '_' <receiver_BIC> '.out.xml'
 <date_time> ::= <long_date> <short_time>
 <long_date> ::= <year> <month> <day>
 <short_time> ::= <hours> <minutes>
 <year> ::= <digit> <digit> <digit> <digit>
 <month> ::= <digit> <digit>
 <day> ::= <digit> <digit>
 <hours> ::= <digit> <digit>
 <minutes> ::= <digit> <digit>
 <digit> ::= '0' .. '9'
 <sender_BIC> ::= <BIC>
 <receiver_BIC> ::= <BIC>

The BIC syntax is precisely described in ISO 9362:1994.


</svnig>