File Store UML

Added On: 02/13/12

SQL Table: FILE_STORE

Module: UniCharge

Type: Entity Status: Active

Java Class: FileStore

Registry of interchange files that the system exchanges with roviders.
Request files are generated and placed into file store before they are uploaded. Response files are downloaded and placed into file store before they are parsed.

For efficiency reasons, the actual content of the files is stored in File Store Content.

Available Fields:

Aggregation Code
Aggregation Cycle FK
Aggregation Date
Aggregation File Store FK
Aggregation Prototype
Billing Profile Code
Billing Profile Type
Config Data FK
Decrypt Tokenization File Store FK
Delivery Mode CL
Download Attempt Date
Encoder
Encrypt Tokenization File Store FK
Extractor
File Store CL
File Store Content FK

File Store Resolver
Format Pattern
Id
Is Aggregated
Is Binary
Is Compressed File Content
Is On Download Delete Required
Is Persistent
Is Tokenized
Is Virtual Remote Folder
Is Wait Response
Merchant Account Code
Metadata
Next Attempt Date
Operation CL
Original Merchant Account Code

Provider Account FK
Provider Code
Rename To
Request Date
Request File Name
Request Lock Path
Request PGP Action CL
Response Date
Response Delay
Response File Name
Response Lock Path
Response PGP Action CL
Status
Token Register Profile FK
Tokenization Provider CL
Total Amount

Total Count

Aggregation Code

Added On: 05/18/12

SQL Column: AGGREGATION_CODE

Java Field: aggregationCode

Status: Active

SQL Type: varchar(150)

Java Type: String

Attributes:

Aggregation code.

Aggregation Cycle FK

Added On: 09/30/14

SQL Column: AGGREGATION_CYCLE_FK

Java Field: aggregationCycle

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Aggregation Cycle

Attributes:

Reference to the entity that represents aggregation cycle.

Aggregation Date

Added On: 08/23/19

SQL Column: AGGREGATION_DATE

Java Field: aggregationDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

The date when the file was aggregated.

Aggregation File Store FK

Added On: 05/18/12

SQL Column: AGGREGATION_FILE_STORE_FK

Java Field: aggregationFileStore

Status: Active

SQL Type: bigint(20)

Java Type: Long

References File Store

Attributes:

Reference to the entity that represents aggregation file store.

Aggregation Prototype

Added On: 05/18/12

SQL Column: AGGREGATION_PROTOTYPE

Java Field: aggregationPrototype

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

Aggregation prototype.

Billing Profile Code

Added On: 03/07/16

SQL Column: BILLING_PROFILE_CODE

Java Field: billingProfileCode

Status: Active

SQL Type: bigint(20)

Java Type: Long

Attributes:

Code of the billing profile.

Billing Profile Type

Added On: 06/20/14

SQL Column: BILLING_PROFILE_TYPE

Java Field: billingProfileType

Status: Active

SQL Type: varchar(60)

Java Type: String

Attributes:

Type of the billing profile.

Config Data FK

Added On: 02/13/12

SQL Column: CONFIG_DATA_FK

Java Field: configData

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Config Data

Attributes:

Reference to the entity that represents configuration data.

Decrypt Tokenization File Store FK

Added On: 02/13/12

SQL Column: DECRYPT_TOKENIZATION_FILE_STORE_FK

Java Field: decryptTokenizationFileStore

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Tokenization File Store

Attributes:

Reference to the entity that represents decrypted of tokenization file store.

Delivery Mode CL

Added On: 02/13/12

SQL Column: DELIVERY_MODE_CL

Java Field: deliveryModeCl

Status: Active

SQL Type: varchar(1)

Java Type: String

References Delivery Mode Classifier

Attributes:

Represents the type of delivery mode selected.

Download Attempt Date

Added On: 03/16/14

SQL Column: DOWNLOAD_ATTEMPT_DATE

Java Field: downloadAttemptDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

The date when there was an attempt to download the file.

Encoder

Added On: 02/13/12

SQL Column: ENCODER

Java Field: encoder

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Type of encoder used to encrypt the file.

Encrypt Tokenization File Store FK

Added On: 02/13/12

SQL Column: ENCRYPT_TOKENIZATION_FILE_STORE_FK

Java Field: encryptTokenizationFileStore

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Tokenization File Store

Attributes:

Reference to the entity that represents encryption of tokenization file store.

Extractor

Added On: 02/13/12

SQL Column: EXTRACTOR

Java Field: extractor

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

File Store CL

Added On: 06/05/14

SQL Column: FILE_STORE_CL

Java Field: fileStoreCl

Status: Active

SQL Type: varchar(2)

Java Type: String

References File Store Classifier

Attributes:

Represents the type of file sotre record.

File Store Content FK

Added On: 02/13/12

SQL Column: FILE_STORE_CONTENT_FK

Java Field: fileStoreContent

Status: Active

SQL Type: bigint(20)

Java Type: Long

References File Store Content

Attributes:

Reference to the entity that represents content of the file store.

File Store Resolver

Added On: 02/13/12

SQL Column: FILE_STORE_RESOLVER

Java Field: fileStoreResolver

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Format Pattern

Added On: 02/13/12

SQL Column: FORMAT_PATTERN

Java Field: formatPattern

Status: Active

SQL Type: varchar(255)

Java Type: String

Attributes:

Added On: 02/13/12

SQL Column: ID

Java Field: id

Status: Active

SQL Type: bigint(20)

Java Type: Long

Identifier / Primary Key

Attributes: Unique, Required

Identifier of the object used for references; auto-incremented integer value.

Is Aggregated

Added On: 05/18/12

SQL Column: IS_AGGREGATED

Java Field: isAggregated

Status: Active

SQL Type: tinyint(1)

Java Type: Boolean

Attributes: Default:false

Indicates whether the file is aggregated.

Is Binary

Added On: 02/13/12

SQL Column: IS_BINARY

Java Field: isBinary

Status: Active

SQL Type: tinyint(1)

Java Type: Boolean

Attributes: Default:false

Indicates whether the file is binary.

Is Compressed File Content

Added On: 02/13/12

SQL Column: IS_COMPRESSED_FILE_CONTENT

Java Field: isCompressedFileContent

Status: Active

SQL Type: tinyint(1)

Java Type: Boolean

Attributes: Default:false

Indicates whether the file content is compressed.

Is On Download Delete Required

Added On: 02/13/12

SQL Column: IS_ON_DOWNLOAD_DELETE_REQUIRED

Java Field: isOnDownloadDeleteRequired

Status: Active

SQL Type: tinyint(1)

Java Type: Boolean

Attributes: Default:true

Is Persistent

Added On: 12/28/12

SQL Column: IS_PERSISTENT

Java Field: isPersistent

Status: Active

SQL Type: tinyint(1)

Java Type: Boolean

Attributes: Default:false

Is Tokenized

Added On: 02/13/12

SQL Column: IS_TOKENIZED

Java Field: isTokenized

Status: Active

SQL Type: tinyint(1)

Java Type: Boolean

Attributes: Default:false

Indicates whether the file is tokenized.

Is Virtual Remote Folder

Added On: 02/13/12

SQL Column: IS_VIRTUAL_REMOTE_FOLDER

Java Field: isVirtualRemoteFolder

Status: Active

SQL Type: tinyint(1)

Java Type: Boolean

Attributes: Default:false

Is Wait Response

Added On: 02/13/12

SQL Column: IS_WAIT_RESPONSE

Java Field: isWaitResponse

Status: Active

SQL Type: tinyint(1)

Java Type: Boolean

Attributes:

Indicates whether the file is waiting for the response.

Merchant Account Code

Added On: 02/13/12

SQL Column: MERCHANT_ACCOUNT_CODE

Java Field: merchantAccountCode

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes: Required

Code of Merchant Account to which instance of this object is attributed to. Depending on the context, Merchant Account Code field may contain either Merchant Code or Merchant Account Code.
The field is primarily used for data partitioning and data management, to make it easy to determine the ownership of a record within the database.

Metadata

Added On: 04/21/16

SQL Column: METADATA

Java Field: metadata

Status: Active

SQL Type: varchar(50)

Java Type: String

Attributes:

Next Attempt Date

Added On: 02/13/12

SQL Column: NEXT_ATTEMPT_DATE

Java Field: nextAttemptDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

The date when the next attempt of processing the file is allowed.

Operation CL

Added On: 02/13/12

SQL Column: OPERATION_CL

Java Field: operationCl

Status: Active

SQL Type: varchar(255)

Java Type: String

References Operation Type

Attributes:

Represents the type of an operation.

Original Merchant Account Code

Added On: 02/13/12

SQL Column: ORIGINAL_MERCHANT_ACCOUNT_CODE

Java Field: originalMerchantAccountCode

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Original account code of the merchant.

Provider Account FK

Added On: 02/13/12

SQL Column: PROVIDER_ACCOUNT_FK

Java Field: providerAccount

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Provider Account

Attributes:

Reference to the entity that represents provider account.

Provider Code

Added On: 02/13/12

SQL Column: PROVIDER_CODE

Java Field: providerCode

Status: Active

SQL Type: bigint(20)

Java Type: Long

Attributes:

Code of the provider that is processing the file.

Rename To

Added On: 02/13/12

SQL Column: RENAME_TO

Java Field: renameTo

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

Name which the file should be renamed to.

Request Date

Added On: 02/13/12

SQL Column: REQUEST_DATE

Java Field: requestDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

The date when the file was requested.

Request File Name

Added On: 02/13/12

SQL Column: REQUEST_FILE_NAME

Java Field: requestFileName

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

The name of the request file.

Request Lock Path

Added On: 04/16/14

SQL Column: REQUEST_LOCK_PATH

Java Field: requestLockPath

Status: Active

SQL Type: varchar(70)

Java Type: String

Attributes:

Value used for concurrency synchronization within curator system (ZooKeeper).

Request PGP Action CL

Added On: 02/13/12

SQL Column: REQUEST_PGP_ACTION_CL

Java Field: requestPgpActionCl

Status: Active

SQL Type: varchar(2)

Java Type: String

References PGP Action Classifier

Attributes:

Represents the type of PGP action selected.

Response Date

Added On: 02/13/12

SQL Column: RESPONSE_DATE

Java Field: responseDate

Status: Active

SQL Type: datetime

Java Type: Date

Attributes:

The date when the response file was created.

Response Delay

Added On: 02/26/16

SQL Column: RESPONSE_DELAY

Java Field: responseDelay

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Time delay before the response file would be sent.

Response File Name

Added On: 02/13/12

SQL Column: RESPONSE_FILE_NAME

Java Field: responseFileName

Status: Active

SQL Type: varchar(100)

Java Type: String

Attributes:

The name of the response file.

Response Lock Path

Added On: 04/16/14

SQL Column: RESPONSE_LOCK_PATH

Java Field: responseLockPath

Status: Active

SQL Type: varchar(70)

Java Type: String

Attributes:

Value used for concurrency synchronization within curator system (ZooKeeper).

Response PGP Action CL

Added On: 02/13/12

SQL Column: RESPONSE_PGP_ACTION_CL

Java Field: responsePgpActionCl

Status: Active

SQL Type: varchar(2)

Java Type: String

References PGP Action Classifier

Attributes:

Represents the type of PGP action send as the response.

Status

Added On: 02/13/12

SQL Column: STATUS

Java Field: status

Status: Active

SQL Type: varchar(255)

Java Type: String

References Status Classifier

Attributes:

Status of the file processing.

Token Register Profile FK

Added On: 02/13/12

SQL Column: TOKEN_REGISTER_PROFILE_FK

Java Field: tokenRegisterProfile

Status: Active

SQL Type: bigint(20)

Java Type: Long

References Token Register Profile

Attributes:

Reference to the entity that represents token register profile.

Tokenization Provider CL

Added On: 07/10/14

SQL Column: TOKENIZATION_PROVIDER_CL

Java Field: tokenizationProviderCl

Status: Active

SQL Type: varchar(1)

Java Type: String

References Tokenization Provider Classifier

Attributes:

Represents the selected tokenization provider.

Total Amount

Added On: 02/13/12

SQL Column: TOTAL_AMOUNT

Java Field: totalAmount

Status: Active

SQL Type: bigint(20)

Java Type: Long

Attributes:

Total amount paid for the item (including tax and discount).

Total Count

Added On: 02/13/12

SQL Column: TOTAL_COUNT

Java Field: totalCount

Status: Active

SQL Type: int(11)

Java Type: Integer

Attributes:

Total number of transaction records in the file.