API Documentation

Admin Activity Files

Admin Activity Files is representation of activity performed through Admin portal on customer data related to your program.

  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 CorePro 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 contains 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
    • The date in the file name is the creation date of the file. The data it contains will typically be from the last time the file extract ran.
    • For example, if the file name is 201501080315_ADMINUSERS.TXT, the data it contains will usually -- but not necessarily -- be since Jan 8 2015 03:00 am .

Format Disclaimer
Q2 Open 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

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. Should be named following this pattern:
  1. yyyyMMddhhmm_ADMINUSERS.TXT
  2. 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 e.g.: 2014-10-20T10:30:31.456-05:00. See date format details.
FileEffectiveDate datetime (34) 4 The date to which the data in the file pertains.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.

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 e.g.: 2014-10-20T10:30:31.456-05:00. See date format details.
IsActive integer (10) 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 e.g.: 2014-10-20T10:30:31.456-05:00. See date format details.
TerminatedDate datetime (34) 8 The date the Admin Portal User was terminated on.
Follows same format as API e.g.: 2014-10-20T10:30:31.456-05:00. See date format details.

Example Admin Activity User File

Content: See 201909231753_ADMINUSERS.TXT
NOTE: Your browser or text editor may wrap the text to fit the window. Actual source file does not wrap.

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 CorePro 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 contains 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
    • The date in the file name is the creation date of the file. The data it contains will typically be from the last time the file extract ran.
    • For example, if the file name is 201501080315_ADMINLOGINACTIVITY.TXT, the data it contains will usually -- but not necessarily -- be since Jan 8 2015 03:00 am .

Format Disclaimer
Q2 Open 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

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. Should be named following this pattern:
  1. yyyyMMddhhmm_ADMINLOGINACTIVITY.TXT
  2. 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 e.g.: 2014-10-20T10:30:31.456-05:00. See date format details.
FileEffectiveDate datetime (34) 4 The date to which the data in the file pertains.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.

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 e.g.: 2014-10-20T10:30:31.456-05:00. See date format details.
Status string (1) 5 S or F indicating Admin Portal Login success of failure.

Example Admin Login Activity File

Content: See 201909091523_ADMINLOGINACTIVITY.TXT
NOTE: Your browser or text editor may wrap the text to fit the window. Actual source file does not wrap.

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 CorePro 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 contains 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
    • The date in the file name is the creation date of the file. The data it contains will typically be from the last time the file extract ran.
    • For example, if the file name is 201909091523_ADMINCUSTOMERSEARCHACTIVITY.TXT, the data it contains will usually -- but not necessarily -- be since Jan 8 2015 03:00 am .

Format Disclaimer
Q2 Open 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

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. Should be named following this pattern:
  1. yyyyMMddhhmm_ADMINCUSTOMERSEARCHACTIVITY.TXT
  2. 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 e.g.: 2014-10-20T10:30:31.456-05:00. See date format details.
FileEffectiveDate datetime (34) 4 The date to which the data in the file pertains.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.

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 at /transfer/create time. CorePro 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 e.g.: 2014-10-20T10:30:31.456-05:00. See date format details.

Example Admin Activity Customer Search File

Content: See 201909091523_ADMINCUSTOMERSEARCHACTIVITY.TXT
NOTE: Your browser or text editor may wrap the text to fit the window. Actual source file does not wrap.

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 CorePro 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 contains 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
    • The date in the file name is the creation date of the file. The data it contains will typically be from the last time the file extract ran.
    • For example, if the file name is 201909091523_ADMINWEBUSAGEACTIVITY.TXT, the data it contains will usually -- but not necessarily -- be since Jan 8 2015 03:00 am .

Format Disclaimer
Q2 Open 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

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. Should be named following this pattern:
  1. yyyyMMddhhmm_ADMINWEBUSAGEACTIVITY.TXT
  2. 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 e.g.: 2014-10-20T10:30:31.456-05:00. See date format details.
FileEffectiveDate datetime (34) 4 The date to which the data in the file pertains.
Follows same format as API e.g.: 2014-10-20T23:59:59.999-05:00. See date format details.

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 e.g.: 2014-10-20T10:30:31.456-05:00. See date format details.

Example Admin Activity Web Usage File

Content: See 201909091523_ADMINWEBUSAGEACTIVITY.TXT
NOTE: Your browser or text editor may wrap the text to fit the window. Actual source file does not wrap.


Ready to start a conversation?

Email Us