Admin Activity Files
Admin Activity Files contain activity performed through the Admin Portal
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:
- Exactly one tab-delimited header line
- Zero or more tab-delimited content lines
- A tab character (
\t
, or0x09
) embedded in actual text content will be replaced with a space character (" ", or0x20
) during file generation - 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
- File will be available in the relative directory of
/AdminActivity
- ANSI encoded
- Line endings are Windows-style CarriageReturn + LineFeed (
\r\n
, or0x0D0A
) - 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 theFileCreatedDate
orFileEffectiveDate
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
Property | Data Type (Length) | Tab Offset | Description |
---|---|---|---|
RecordType | string (1) | 0 | The flag for the header row. Will always be H . |
FileName | string (50) | 1 | The name of this file excluding path. Format: yyyyMMddhhmm_ADMINUSERS.TXT Example: 201407162348_ADMINUSERS.TXT |
RecordCount | integer (10) | 2 | The number of records represented within the file. |
FileCreatedDate | datetime (34) | 3 | The date the file was created. Follows same format as API. Example: 2014-10-20T10:30:31.456-05:00 See data format guidelines |
FileEffectiveDate | datetime (34) | 4 | The 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
Property | Data Type (Length) | Tab Offset | Description |
---|---|---|---|
UserId | integer (10) | 0 | The unique identifier for a Admin Portal User. |
Email | string (255) | 1 | Admin Portal User email address. |
FirstName | string (255) | 2 | Admin Portal User First Name. |
LastName | string (255) | 3 | Admin Portal User Last Name. |
Phone | string (255) | 4 | Admin Portal User Phone Number. |
EffectiveDate | datetime (34) | 5 | The 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 |
IsActive | integer (1) | 6 | 0 or 1 value representing if Admin Portal User is active or not. 0 represents not active and 1 represents active. |
CreatedDate | datetime (34) | 7 | The 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 |
TerminatedDate | datetime (34) | 8 | The 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 |
ProgramId | integer (10) | 9 | The unique ID of the program with which the line item is associated. |
ProgramName | string (50) | 10 | The name of the program with which the line item is associated. |
CreatorUserId | integer (10) | 11 | The user ID of the user who created this admin user |
CreatorEmail | string (255) | 12 | The email address of the user who created this admin user |
Take me to the Example Admin Activity User File
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:
- Exactly one tab-delimited header line
- Zero or more tab-delimited content lines
- A tab character (
\t
, or0x09
) embedded in actual text content will be replaced with a space character (" ", or0x20
) during file generation - 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
- File will be available in the relative directory of
/AdminActivity
- ANSI encoded
- Line endings are Windows-style CarriageReturn + LineFeed (
\r\n
, or0x0D0A
) - 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 theFileCreatedDate
orFileEffectiveDate
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
Property | Data Type (Length) | Tab Offset | Description |
---|---|---|---|
RecordType | string (1) | 0 | The flag for the header row. Will always be H . |
FileName | string (50) | 1 | The name of this file excluding path. Format: yyyyMMddhhmm_ADMINLOGINACTIVITY.TXT Example: 201407162348_ADMINLOGINACTIVITY.TXT |
RecordCount | integer (10) | 2 | The number of records represented within the file. |
FileCreatedDate | datetime (34) | 3 | The date the file was created. Follows same format as API. Example: 2014-10-20T10:30:31.456-05:00 See data format guidelines |
FileEffectiveDate | datetime (34) | 4 | The 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
Property | Data Type (Length) | Tab Offset | Description |
---|---|---|---|
UserId | integer (10) | 0 | The unique identifier for a Admin Portal User. |
UserName | string (255) | 1 | Admin Portal User email address/username. |
RemoteAddress | string (200) | 2 | IP address of a client device that was performing a login into Admin Portal |
Headers | string (400) | 3 | HTTP headers of a client application that was performing a logoin into Admin Portal. |
Date | datetime (34) | 4 | Date 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 |
Status | string (1) | 5 | S or F indicating Admin Portal Login success or failure. |
ProgramId | integer (10) | 6 | The unique ID of the program with which the line item is associated. (Will be blank if the user is a bank user). |
ProgramName | string (50) | 7 | The name of the program with which the line item is associated. (Will be blank if the user is a bank user). |
Take me to the Example Admin Login Activity File
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:
- Exactly one tab-delimited header line
- Zero or more tab-delimited content lines
- A tab character (
\t
, or0x09
) embedded in actual text content will be replaced with a space character (" ", or0x20
) during file generation - 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
- File will be available in the relative directory of
/AdminActivity
- ANSI encoded
- Line endings are Windows-style CarriageReturn + LineFeed (
\r\n
, or0x0D0A
) - 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 theFileCreatedDate
orFileEffectiveDate
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
Property | Data Type (Length) | Tab Offset | Description |
---|---|---|---|
RecordType | string (1) | 0 | The flag for the header row. Will always be H . |
FileName | string (50) | 1 | The name of this file excluding path. Format: yyyyMMddhhmm_ADMINCUSTOMERSEARCHACTIVITY.TXT Example: 201909091523_ADMINCUSTOMERSEARCHACTIVITY.TXT |
RecordCount | integer (10) | 2 | The number of records represented within the file. |
FileCreatedDate | datetime (34) | 3 | The date the file was created. Follows same format as API. Example: 2014-10-20T10:30:31.456-05:00 See data format guidelines |
FileEffectiveDate | datetime (34) | 4 | The 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
Property | Data Type (Length) | Tab Offset | Description |
---|---|---|---|
UserId | integer (10) | 0 | The unique identifier for a Admin Portal User. |
FirstName | string (64) | 1 | Customer First Name. |
LastName | string (128) | 2 | Customer Last Name. |
Tag | string (50) | 3 | Customer Tag. |
AccountNumber | string (50) | 4 | Customer Account Number. |
EmailAddress | string (255) | 5 | Customer email address. |
MobilePhone | string (50) | 6 | Customer Mobile Phone Number. |
TaxId | string (30) | 7 | Customer SSN. |
CustomerId | integer (10) | 8 | Customer Id. |
AccountTag | string (50) | 9 | Customer Account Tag. |
ExternalAccountTag | string (50) | 10 | Customer External Account Tag. |
TransactionTag | string (50) | 11 | The program-wide unique identifier provided by the caller during /transfer/create. Helix does not generate this value. |
ReceiptReferenceNumber | integer (19) | 12 | Only applicable for checks. |
Date | datetime (34) | 13 | The 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 |
ProgramId | integer (10) | 14 | The unique ID of the program with which the line item is associated. |
ProgramName | string (50) | 15 | The name of the program with which the line item is associated. |
Take me to the Example Admin Activity Customer Search File
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:
- Exactly one tab-delimited header line
- Zero or more tab-delimited content lines
- A tab character (
\t
, or0x09
) embedded in actual text content will be replaced with a space character (" ", or0x20
) during file generation - 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
- File will be available in the relative directory of
/AdminActivity
- ANSI encoded
- Line endings are Windows-style CarriageReturn + LineFeed (
\r\n
, or0x0D0A
) - 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 theFileCreatedDate
orFileEffectiveDate
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
Property | Data Type (Length) | Tab Offset | Description |
---|---|---|---|
RecordType | string (1) | 0 | The flag for the header row. Will always be H . |
FileName | string (50) | 1 | The name of this file excluding path. Format: yyyyMMddhhmm_ADMINWEBUSAGEACTIVITY.TXT Example: 201909091523_ADMINWEBUSAGEACTIVITY.TXT |
RecordCount | integer (10) | 2 | The number of records represented within the file. |
FileCreatedDate | datetime (34) | 3 | The date the file was created. Follows same format as API. Example: 2014-10-20T10:30:31.456-05:00 See data format guidelines |
FileEffectiveDate | datetime (34) | 4 | The 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
Property | Data Type (Length) | Tab Offset | Description |
---|---|---|---|
UserId | integer (10) | 0 | The unique identifier for a Admin Portal user. |
Url | string (2000) | 1 | Admin Portal Url Admin User accessed. |
Date | datetime (34) | 2 | The 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 |
ProgramId | integer (10) | 3 | The unique ID of the program with which the line item is associated. |
ProgramName | string (50) | 4 | The name of the program with which the line item is associated. |
EmailAddress | string (255) | 5 | The email address of the Admin Portal user |
Take me to the Example Admin Activity Web Usage File
Updated 6 months ago