Admin Activity Files

Admin Activity Files contain activity performed through the Admin Portal

  1. User File
  2. Login Activity File
  3. Customer Search File
  4. Web Usage File

Admin Activity User File Definition

This is a file of admin portal users that have access to your program's customer data. Multiple files per day can be processed, typically on a 15 minute increment basis. It has the following properties:

  1. Exactly one tab-delimited header line
  2. Zero or more tab-delimited content lines
  3. A tab character (\t, or 0x09) embedded in actual text content will be replaced with a space character (" ", or 0x20) during file generation
  4. Although most other files created and consumed by Helix are fixed-length in nature, this file is tab-delimited to help reduce the size of file as it may grow considerably over time and possibly contain large sections of empty columns
  5. ANSI encoded
  6. Line endings are Windows-style CarriageReturn + LineFeed (\r\n, or 0x0D0A)
  7. File name follows a specific, case-sensitive pattern of: yyyyMMddhhmm_ADMINUSERS.TXT

🚧

Format Disclaimer
Helix reserves the right to append new field(s) to the end of any Header or Content line without notice. This is to allow new data points to be added as needed in a timely fashion.

Implementation Note
Your code should be written such that unexpected characters after the "last" field but prior to the end of each line should be ignored. That is, if the file is documented as having 30 tabs per line, receiving a file with 31 or more per line should not disrupt your processing. This applies to both Header and Content lines.

File Name Disclaimer
The date in file name should be used as a guideline for human eyes only. Any date-related programmatic dependencies should rely on the FileCreatedDate or FileEffectiveDate contained within the header line of each file, as these will be precise to the second and will be in the appropriate timezone.

Header Row

PropertyData Type (Length)Tab OffsetDescription
RecordTypestring (1)0The flag for the header row. Will always be H.
FileNamestring (50)1The name of this file excluding path.
Format: yyyyMMddhhmm_ADMINUSERS.TXT
Example: 201407162348_ADMINUSERS.TXT
RecordCountinteger (10)2The number of records represented within the file.
FileCreatedDatedatetime (34)3The date the file was created. Follows same format as API.
Example: 2014-10-20T10:30:31.456-05:00
See data format guidelines
FileEffectiveDatedatetime (34)4The date to which the data in the file pertains. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines

Content Row

PropertyData Type (Length)Tab OffsetDescription
UserIdinteger (10)0The unique identifier for a Admin Portal User.
Emailstring (255)1Admin Portal User email address.
FirstNamestring (255)2Admin Portal User First Name.
LastNamestring (255)3Admin Portal User Last Name.
Phonestring (255)4Admin Portal User Phone Number.
EffectiveDatedatetime (34)5The date the Admin Portal User record was last modified. Follows same format as API.
Example: 2014-10-20T10:30:31.456-05:00
See data format guidelines
IsActiveinteger (10)60 or 1 value representing if Admin Portal User is active or not. 0 represents not active and 1 represents active.
CreatedDatedatetime (34)7The date the Admin Portal User was created. Follows same format as API.
Example: 2014-10-20T10:30:31.456-05:00
See data format guidelines
TerminatedDatedatetime (34)8The date the Admin Portal User was terminated on. Follows same format as API.
Example: 2014-10-20T10:30:31.456-05:00
See data format guidelines
ProgramIdinteger (10)9The unique ID of the program with which the line item is associated.
ProgramNamestring (50)10The name of the program with which the line item is associated.
CreatorUserIdinteger (10)11The user ID of the user who created this admin user
CreatorEmailstring (255)12The email address of the user who created this admin user

Admin Login Activity File Definition

This is a file of admin portal users login activity that have access to your program's customer data. Multiple files per day can be processed, typically on a 15 minute increment basis. It has the following properties:

  1. Exactly one tab-delimited header line
  2. Zero or more tab-delimited content lines
  3. A tab character (\t, or 0x09) embedded in actual text content will be replaced with a space character (" ", or 0x20) during file generation
  4. Although most other files created and consumed by Helix are fixed-length in nature, this file is tab-delimited to help reduce the size of file as it may grow considerably over time and possibly contain large sections of empty columns
  5. ANSI encoded
  6. Line endings are Windows-style CarriageReturn + LineFeed (\r\n, or 0x0D0A)
  7. File name follows a specific, case-sensitive pattern of: yyyyMMddhhmm_ADMINLOGINACTIVITY.TXT

🚧

Format Disclaimer
Helix reserves the right to append new field(s) to the end of any Header or Content line without notice. This is to allow new data points to be added as needed in a timely fashion.

Implementation Note
Your code should be written such that unexpected characters after the "last" field but prior to the end of each line should be ignored. That is, if the file is documented as having 30 tabs per line, receiving a file with 31 or more per line should not disrupt your processing. This applies to both Header and Content lines.

File Name Disclaimer
The date in file name should be used as a guideline for human eyes only. Any date-related programmatic dependencies should rely on the FileCreatedDate or FileEffectiveDate contained within the header line of each file, as these will be precise to the second and will be in the appropriate timezone.

Header Row

PropertyData Type (Length)Tab OffsetDescription
RecordTypestring (1)0The flag for the header row. Will always be H.
FileNamestring (50)1The name of this file excluding path.
Format: yyyyMMddhhmm_ADMINLOGINACTIVITY.TXT
Example: 201407162348_ADMINLOGINACTIVITY.TXT
RecordCountinteger (10)2The number of records represented within the file.
FileCreatedDatedatetime (34)3The date the file was created. Follows same format as API.
Example: 2014-10-20T10:30:31.456-05:00
See data format guidelines
FileEffectiveDatedatetime (34)4The date to which the data in the file pertains. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines

Content Row

PropertyData Type (Length)Tab OffsetDescription
UserIdinteger (10)0The unique identifier for a Admin Portal User.
UserNamestring (255)1Admin Portal User email address/username.
RemoteAddressstring (200)2IP address of a client device that was performing a login into Admin Portal
Headersstring (400)3HTTP headers of a client application that was performing a logoin into Admin Portal.
Datedatetime (34)4Date a login was performed into Admin Portal. Follows same format as API.
Example: 2014-10-20T10:30:31.456-05:00
See data format guidelines
Statusstring (1)5S or F indicating Admin Portal Login success or failure.
ProgramIdinteger (10)6The unique ID of the program with which the line item is associated. (Will be blank if the user is a bank user).
ProgramNamestring (50)7The name of the program with which the line item is associated. (Will be blank if the user is a bank user).

Admin Activity Customer Search File Definition

This is a file of admin portal users customer search activity that may have accessed your program's customer data. Multiple files per day can be processed, typically on a 15 minute increment basis. It has the following properties:

  1. Exactly one tab-delimited header line
  2. Zero or more tab-delimited content lines
  3. A tab character (\t, or 0x09) embedded in actual text content will be replaced with a space character (" ", or 0x20) during file generation
  4. Although most other files created and consumed by Helix are fixed-length in nature, this file is tab-delimited to help reduce the size of file as it may grow considerably over time and possibly contain large sections of empty columns
  5. ANSI encoded
  6. Line endings are Windows-style CarriageReturn + LineFeed (\r\n, or 0x0D0A)
  7. File name follows a specific, case-sensitive pattern of: yyyyMMddhhmm_ADMINCUSTOMERSEARCHACTIVITY.TXT

🚧

Format Disclaimer
Helix reserves the right to append new field(s) to the end of any Header or Content line without notice. This is to allow new data points to be added as needed in a timely fashion.

Implementation Note
Your code should be written such that unexpected characters after the "last" field but prior to the end of each line should be ignored. That is, if the file is documented as having 30 tabs per line, receiving a file with 31 or more per line should not disrupt your processing. This applies to both Header and Content lines.

File Name Disclaimer
The date in file name should be used as a guideline for human eyes only. Any date-related programmatic dependencies should rely on the FileCreatedDate or FileEffectiveDate contained within the header line of each file, as these will be precise to the second and will be in the appropriate timezone.

Header Row

PropertyData Type (Length)Tab OffsetDescription
RecordTypestring (1)0The flag for the header row. Will always be H.
FileNamestring (50)1The name of this file excluding path.
Format: yyyyMMddhhmm_ADMINCUSTOMERSEARCHACTIVITY.TXT
Example: 201909091523_ADMINCUSTOMERSEARCHACTIVITY.TXT
RecordCountinteger (10)2The number of records represented within the file.
FileCreatedDatedatetime (34)3The date the file was created. Follows same format as API.
Example: 2014-10-20T10:30:31.456-05:00
See data format guidelines
FileEffectiveDatedatetime (34)4The date to which the data in the file pertains. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines

Content Row

PropertyData Type (Length)Tab OffsetDescription
UserIdinteger (10)0The unique identifier for a Admin Portal User.
FirstNamestring (64)1Customer First Name.
LastNamestring (128)2Customer Last Name.
Tagstring (50)3Customer Tag.
AccountNumberstring (50)4Customer Account Number.
EmailAddressstring (255)5Customer email address.
MobilePhonestring (50)6Customer Mobile Phone Number.
TaxIdstring (30)7Customer SSN.
CustomerIdinteger (10)8Customer Id.
AccountTagstring (50)9Customer Account Tag.
ExternalAccountTagstring (50)10Customer External Account Tag.
TransactionTagstring (50)11The program-wide unique identifier provided by the caller during /transfer/create. Helix does not generate this value.
ReceiptReferenceNumberinteger (19)12Only applicable for checks.
Datedatetime (34)13The date the Admin Portal Customer Search query was performed. Follows same format as API.
Example: 2014-10-20T10:30:31.456-05:00
See data format guidelines
ProgramIdinteger (10)14The unique ID of the program with which the line item is associated.
ProgramNamestring (50)15The name of the program with which the line item is associated.

Admin Activity Web Usage File Definition

This is a file of admin portal users url access history for users that have access to your program's customer data. Multiple files per day can be processed, typically on a 15 minute increment basis. It has the following properties:

  1. Exactly one tab-delimited header line
  2. Zero or more tab-delimited content lines
  3. A tab character (\t, or 0x09) embedded in actual text content will be replaced with a space character (" ", or 0x20) during file generation
  4. Although most other files created and consumed by Helix are fixed-length in nature, this file is tab-delimited to help reduce the size of file as it may grow considerably over time and possibly contain large sections of empty columns
  5. ANSI encoded
  6. Line endings are Windows-style CarriageReturn + LineFeed (\r\n, or 0x0D0A)
  7. File name follows a specific, case-sensitive pattern of: yyyyMMddhhmm_ADMINWEBUSAGEACTIVITY.TXT

🚧

Format Disclaimer
Helix reserves the right to append new field(s) to the end of any Header or Content line without notice. This is to allow new data points to be added as needed in a timely fashion.

Implementation Note
Your code should be written such that unexpected characters after the "last" field but prior to the end of each line should be ignored. That is, if the file is documented as having 30 tabs per line, receiving a file with 31 or more per line should not disrupt your processing. This applies to both Header and Content lines.

File Name Disclaimer
The date in file name should be used as a guideline for human eyes only. Any date-related programmatic dependencies should rely on the FileCreatedDate or FileEffectiveDate contained within the header line of each file, as these will be precise to the second and will be in the appropriate timezone.

Header Row

PropertyData Type (Length)Tab OffsetDescription
RecordTypestring (1)0The flag for the header row. Will always be H.
FileNamestring (50)1The name of this file excluding path.
Format: yyyyMMddhhmm_ADMINWEBUSAGEACTIVITY.TXT
Example: 201909091523_ADMINWEBUSAGEACTIVITY.TXT
RecordCountinteger (10)2The number of records represented within the file.
FileCreatedDatedatetime (34)3The date the file was created. Follows same format as API.
Example: 2014-10-20T10:30:31.456-05:00
See data format guidelines
FileEffectiveDatedatetime (34)4The date to which the data in the file pertains. Follows same format as API.
Example: 2014-10-20T23:59:59.999-05:00
See data format guidelines

Content Row

PropertyData Type (Length)Tab OffsetDescription
UserIdinteger (10)0The unique identifier for a Admin Portal user.
Urlstring (2000)1Admin Portal Url Admin User accessed.
Datedatetime (34)2The date the Admin Portal Customer Search query was performed. Follows same format as API.
Example: 2014-10-20T10:30:31.456-05:00
See data format guidelines
ProgramIdinteger (10)3The unique ID of the program with which the line item is associated.
ProgramNamestring (50)4The name of the program with which the line item is associated.
EmailAddressstring (255)5The email address of the Admin Portal user

{ "file_type": "tab_delimited" }