DataOneFileDescriptor (DOFD) metadata

vfsPath

• Field name: vfsPath

• Data Type: String

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: R

• DataOneVFSWriter Default: --

• Attribute Description: Name of Data One VFS Path in the form: vfsname:/vpath (e.g. "ordersvfs:/receivables/20221H").

fileId

• Field name: fileId

• Data Type: String

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: --

• DataOneVFSWriter Default: --

• Attribute Description: File identifier, it uniquely identifies a file in Data One file registry.

dfiid

• Field name: dfiid

• Data Type: String

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: R

• DataOneVFSWriter Default: --

• Attribute Description: Data Flow Instance Identifier, it is used to perform E2E correlation of file processing as it traverses Data One conctract. In a Data Shaper graph the input dfiid propagated by DataOneVFSReader is typically passed unchanged to DataOneVFSWriter on output.

fileName

• Field name: fileName

• Data Type: String

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: R

• DataOneVFSWriter Default: --

• Attribute Description: Name of the file. For files received via PESIT protocol, this field contains PESIT.label.

description

• Field name: description

• Data Type: String

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: R

• DataOneVFSWriter Default: --

• Attribute Description: File description. For files received via PESIT protocol, this field contains PESIT.userData.

• Internal Notes: MDClass.FSR_FILE_SYS_MD + "." + MDName.DESCRIPTION

topic

• Field name: topic

• Data Type: String

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: R

• DataOneVFSWriter Default: --

• Attribute Description: Additional descriptive field that can be used to better identify the data. For files received via PESIT protocol, this field contains PESIT.fileName.

• Internal Notes: MDClass.FSR_FILE_SYS_MD + "." + MDName.TOPIC

originalFileSize

• Field name: originalFileSize

• Data Type: long

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: --

• DataOneVFSWriter Default: --

• Attribute Description: Original size of the file, the actual size of data streamed into the graph can be different due to the processing applied by File Resource (e.g. decompression, decryption) and/or charset conversion.

arrivalDate

• Field name: arrivalDate

• Data Type: date yyyy-MM-ddTHH:mm:sssZ

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: --

• DataOneVFSWriter Default: --

• Attribute Description: Timestamp of when the file has been initially stored on Data One file registry.

lastUpdateDate

• Field name: lastUpdateDate

• Data Type: date yyyy-MM-ddTHH:mm:sssZ

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: --

• DataOneVFSWriter Default: --

• Attribute Description: File last update timestamp in Data One file registry.

firstReadDate

• Field name: firstReadDate

• Data Type: date yyyy-MM-ddTHH:mm:sssZ

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: --

• DataOneVFSWriter Default: --

• Attribute Description: Timestamp of the first time the file has been opened for reading in Data One file registry.

lastReadDate

• Field name: lastReadDate

• Data Type: date yyyy-MM-ddTHH:mm:sssZ

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: None

• DataOneVFSWriter Default: None

• Attribute Description: Timestamp of the last time the file has been opened for reading in Data One file registry.

dataType

• Field name: dataType

• Data Type: String

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: R

• DataOneVFSWriter Default: application/octet-stream

• Attribute Description: MIME type of file payload, when known.

• Internal Notes: MDClass.FSR_FILE_SYS_MD + "." + MDName.DATA_TYPE

charset

• Field name: charset

• Data Type: String

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: R

• DataOneVFSWriter Default: empty

• Attribute Description: File charset for data files, this attribute is empty for binary files.

• Internal Notes: It must be read after FileRes, and RequestedCharset parm application

  MDClass.FSR_FILE_SYS_MD + "." + MDName.CHARSET.

eol

• Field name: eol

• Data Type: enum

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: R

• DataOneVFSWriter Default: NONE

• Attribute Description: File end-of-line / end-of-record character, for record structured files, possible values: - NONE - No record terminator - CRLF - Carriage Return + Line Feed record terminator - CR - Line Feed record terminator - LF - Line Feed record terminator

• Internal Notes: It must be read after FileRes application

  MDClass.FSR_FILE_SYS_MD + "." + MDName.EOL

recLen

• Field name: recLen

• Data Type: Integer

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: R

• DataOneVFSWriter Default: empty

• Attribute Description: File record length, for fixed length record structured files.

• Internal Notes: It must be read after FileRes application

  MDClass.FSR_FILE_SYS_MD + "." + MDName.REC_LEN

sourceLabel

• Field name: sourceLabel

• Data Type: String

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: R

• DataOneVFSWriter Default: --

• Attribute Description: For files received via PESIT protocol this field contains PESIT.remoteIdentification.

• Internal Notes: PESIT.remoteIdentification. MDClass.FSR_FILE_SYS_MD "." MDName.SOURCE_LABEL

destinationLabel

• Field name: destinationLabel

• Data Type: String

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: R

• DataOneVFSWriter Default: --

• Attribute Description: For files received via PESIT protocol this field contains PESIT.localIdentification.

• Internal Notes: MDClass.FSR_FILE_SYS_MD +"." +MDName.DESTINATION_LABEL

otherAttrs

• Field name: otherAttrs

• Data Type: {(name, value)}

• DataOneVFSReader Access: W

• DataOneVFSWriter Access: R

• DataOneVFSWriter Default: --

• Attribute Description: Name-value pairs data structure rendering optional additional metadata attributes from GENERIC metadata class. The name component of the tuple will have this structure: "generic_" + genericAttributeName Example: A generic attribute modeling a country metadata for a French file would be rendered as: {("generic_country", "France")}. Value field cannot be null nor empty and must have a maximum length of 512 characters.

• Internal Notes: MDClass.SPFB_FILE_GENERIC_MD + "." + <Generic_attr_name>