Skip to main content
FirmFlow
Search
Search GoFileRoom Support Help and Support.

This article applies to:

  • Product: GoFileRoom
  • Subject: setup

Set up the FirmFlow API

The FirmFlow API utility retrieves data through the FirmFlow application programming interface (API) and stores it in a local SQL database. This lets you run specific queries and connect the SQL database to different business analytics tools to study your FirmFlow data.
important
Only an administrator can install and set up this utility.
  1. In GoFileRoom, hover over your username, then select
    Preferences
    .
  2. Go to the
    Downloads
     tab, then select
    FirmFlow API Utility
     to download it to your computer.
  3. Double-click the downloaded MSI file to extract its contents.
  4. Navigate to the following location using your file explorer:
    C:\Program Files (x86)\GoFileRoom\FirmFlowAPI_SQL
    .
  5. Right-click the
    FirmFlow_API.exe
     file and choose
    Run as administrator
    .
  6. Complete the following fields:
    • GoFileRoom User Name
      : Enter the sign-in information for a GoFileRoom user who has FirmFlow permissions.
    • GoFileRoom Password
      : Enter the password for the
      GoFileRoom User Name
      .
    • GoFileRoom API KEY
      : Enter the GoFileRoom API KEY provided by Thomson Reuters.
    • SQL Server
      : Enter the name of the SQL server you use to capture FirmFlow data.
    • SQL UserID
      : Enter the SQL User ID for an account that has Read / Write access to databases.
    • SQL Password
      : Enter the password for the
      SQL UserID
      .
    • SQL Database
      : Enter the name of the database you use to capture FirmFlow data. If it already exists, choose it from the list. If not, enter a name for the database and select Create.
    • Table Name
      : Enter the name of the SQL table you use to capture FirmFlow data. The application will replace blank spaces with underscores if needed.
    • JSON
      : Enter your FirmFlow query.
  7. Select one of the following:
    • Add
      : Adds your table name and the JSON string to run the next time the FirmFlow_API_Service.exe is executed.
    • Update
      : Updates the data in the Table Name and JSON fields.
    • Delete
      : Delete the selected list so it doesn't execute.
    • Test
      : Creates the table for the selected list in your SQL database for 200 workflows.
  8. Select
    Save
     to update the FirmFlow_API.ini file.

error-icon

error-close