oData Connector

Workzone's oData Connector allows you to directly query the Workzone database for a wide variety of data, including projects & tasks, time & expense entries, project request submissions, and more. The oData protocol is supported by many different applications, including Tableau, PowerBI, and Microsoft Excel 365, making it possible to create reports and visualizations that suit your team right within your preferred BI platform.

Setting up the oData Connector in Tableau:

• Under Connect, select OData.
• In Server, type one of the following:
  • A service URL to access all feeds inside the service. For Workzone that is https://[subdomain].sharedwork.com/api/odata/
  • A feed URL to access a specific data feed. For Workzone that is https://[subdomain].sharedwork.com/api/odata/[dataTable] See below for a list of available Workzone data tables.
• From the Authentication dropdown, select the Username and Password authentication mode for this connection. Enter the same email address and password you use to log in to Workzone. Click Sign In.

Setting up the oData Connector in PowerBI:

• To load data from an OData Feed in Power Query Desktop select OData or OData Feed in the get data experience.
• Choose the Basic button and enter a URL address in the text box. For Workzone this is https://[subdomain].sharedwork.com/api/odata/[dataTable] Then select OK.
• If this is the first time you're connecting using the OData Feed, select the Basic authentication type and enter the same email address and password you use to log in to Workzone. Then select Connect.

Setting up the oData Connector in Excel 365:

• In the Data ribbon, select Get Data.
  • On PC:
    • Select the From Other Sources option and then select From oData Feed.
    • Select the Basic radio button and, In the URL field, enter the URL for the data table to query using this format: https://[subdomain].sharedwork.com/api/odata/[dataTable] See below for a list of available Workzone data tables. Click Ok.
    • Then, on the left, select Basic. Enter the same email address and password you use to log in to Workzone. Click Connect.
    • The table of data will appear on screen. Click Close and Load in the top left to have the data populate into a sheet in the workbook.
  • On Mac:
    • Select Get Data (Power Query) and then select the oData tile.
    • In the URL field, enter the URL for the data table to query using this format: https://[subdomain].sharedwork.com/api/odata/[dataTable] See below for a list of available Workzone data tables.
    • Under Authentication Kind select Basic. Enter the same email address and password you use to log in to Workzone. Click Next.
    • The table of data will appear on screen. Click Close and Load in the top left to have the data populate into a sheet in the workbook.

Below is a list of Workzone database tables available via the oData connector:

• board — Provides basic information about the Boards in a Workzone site, including board name and board ID.
• board_activity — Provides information on the activity that has been performed in a board, including the creation and movement of cards and updates to the information attached to a card (responsible party, checklist items, etc.).
• board_item — Provides information on the cards in a board, including card names, dates, priorities, etc.
• board_item_assignment — Provides information on the user assigned to a card in a board.
• board_list — Provides information on the lists within boards, including the list names, IDs, and whether or not lists are designated as an Endpoint.
• custom_field — Provides basic information on Documents module custom fields, including the field name, field ID, the data type, etc.
• custom_field_value — Provides specific information on Documents module custom field values, including the field ID, value ID, value, etc.
• project_request — Provides basic information for project requests, including the request name, request ID, requestor ID, requested deadline date, etc.
• project_request_answer — Provides specific information on answers to each question in requests, including the request ID, question ID, answer ID, answer value, etc.
• task2 — Provides a wealth of information on tasks, including task ID, project ID, workspace ID, dates, notes, descriptions, etc.
• task_assignment — Provides information on the user assigned to a task.
• task_custom_field — Provides basic information on Projects module custom fields, including the field name, field ID, the input type, etc.
• task_custom_field_value — Provides specific information on Projects module custom field values, including the project ID, task ID, value ID, value, etc.
• task_expense_entry — Provides specific information on expense entries, including entry ID, task ID, expense amount, expense date, etc.
• task_resource — Provides basic information Resource users, including the resource name, resource ID, etc.
• task_time_entry — Provides specific information on time entries, including entry ID, task ID, time amount, time date, etc.