Skip to main content

How to Set Up Your Spectrum Integration

Step-by-step guide for Spectrum administrators to set up the Spectrum integration and share the connection details Workyard needs.

Written by Yesenia Quintana

Before Workyard can connect to Viewpoint Spectrum by Trimble, a few settings need to be turned on in your Spectrum account. This guide walks your Spectrum administrator through each step and shows which details to send to Workyard when you're done.

Note: You need an active Workyard Autopilot subscription to use the Spectrum integration. To learn what the integration syncs, see Spectrum Integration with Workyard.

Before you start

  • These steps must be completed by someone with access to System Administration in Spectrum.

  • Have a secure place ready to save the details you'll collect, such as a password manager.

  • One setting in Step 2 takes effect overnight, after Spectrum restarts its services.

Setup overview

  1. Turn on the Data Exchange module

  2. Enable enhanced authentication

  3. Create the Workyard operator

  4. Create the Authorization ID and add web services

  5. Copy the Client ID and Client Secret

  6. Find the URL and port number

  7. Send your details to Workyard

Step 1: Turn on the Data Exchange module

  1. Go to System Administration > Installation > Company.

  2. Click the Modules tab.

  3. If the Data Exchange? checkbox isn't already checked, check it.

  4. Click Save.

Step 2: Enable enhanced authentication

  1. Go to System Administration > Installation > Data Exchange.

  2. Click Settings to open the Data Exchange Settings window.

  3. If the Enable enhanced authentication for all Spectrum companies? checkbox isn't already checked, check it.

  4. Click OK to close the window.

  5. If a message asks whether this will affect other integrations, click OK.

Tip: You may see a message that this change takes effect overnight, after Spectrum restarts its services. That's expected, and you can keep going with the next steps.

Step 3: Create the Workyard operator

The operator is the Spectrum user that Workyard's connection will run as. You'll link it to the Authorization ID in Step 4.

Create the operator

  1. Go to System Administration > Security > Operator Maintenance.

  2. Click Go next to the Search dropdown to see your existing operators.

  3. Click New to open the New Operator window.

  4. Fill in the required fields:

Field

What to enter

User Type

Office

Operator Code

Press Enter to accept the next default code, or enter your own code of up to 3 letters or numbers

Logon ID

Something easy to recognize, such as workyard-integration

Password

A long, secure password

Name

Workyard Integration

Email

it@workyard.com

  1. Click OK. The New Operator window closes and the Edit Operator window opens.

Give the operator access to your company

  1. In the Edit Operator window, click the Companies tab.

  2. Click New to open the New Company window.

  3. Click the dropdown arrow, then select the company Workyard should connect to from the Search Companies window.

  4. Click OK to return to the New Company window.

  5. For Scheme setting, select Use operator default scheme.

  6. For Copy from, select Default settings for new company.

  7. Click OK to close the New Company window.

  8. Click OK to close the Edit Operator window.

Your new operator now appears in the list.

Step 4: Create the Authorization ID and add web services

The Authorization ID controls which companies Workyard can access and which Spectrum web services it can use.

Create the Authorization ID

  1. Go to System Administration > Installation > Data Exchange.

  2. Click Go next to the Search dropdown to see your existing Authorization IDs.

  3. Click New to open the New Authorization ID window.

  4. Enter a new, unique Authorization ID. Save it somewhere safe, because you'll send it to Workyard later.

  5. Press Tab or click Status: Active. The Build Companies for Authorization ID window usually opens.

  6. In that window, click the company Workyard should connect to on the left, click Select > to move it to Authorized Companies, then click OK.

  7. Make sure Status is set to Active.

  8. In the Spectrum operator code dropdown, click the arrow to open the Search Logon IDs window, search for the operator by name, and double-click the Workyard operator you created in Step 3.

Add the web services

Still in the New Authorization ID window, add each web service below. Repeat these steps for each module:

  1. Click Build to open the Build Web Services for Authorization ID window.

  2. Select the module in the dropdown and click Go.

  3. In the Web Service Library list on the left, click the web service.

  4. Click Select > to move it to Authorized Web Services on the right.

  5. Click OK to return to the New Authorization ID window.

Module

Web services to add

AccountsPayable

GetVendors

JobCost

GetJob, GetPhase

Payroll

GetEmployee, [Pre-Time Card web service: TO BE CONFIRMED]

When you're done, you should see all of these web services listed. Click OK to save and close the New Authorization ID window.

Step 5: Copy the Client ID and Client Secret

Each Authorization ID has its own Client ID and Client Secret. Workyard needs both to connect.

  1. Go to System Administration > Installation > Data Exchange.

  2. Double-click your new Authorization ID to open the Edit Authorization ID window.

  3. Click the Secret Status: ... button. It's between the company selection button and the operator code dropdown.

  4. In the Secret Management window, copy the Client and Secret values and save them somewhere safe.

  5. Check the box next to Allow self-rotation?

  6. Click OK to close the Secret Management window.

  7. Click OK to close the Edit Authorization ID window.

Important: Treat the Client Secret like a password. Don't share it in an email or chat message. Workyard will send you a secure way to share it in Step 7.

Step 6: Find the URL and port number

Workyard also needs to know where to reach your Spectrum system.

  1. Go to System Administration > Utilities > Data Exchange Download.

  2. Click the dropdown arrow to open the Search Authorization ID window.

  3. Select the Authorization ID you created for Workyard.

  4. Click OK.

  5. Copy the Url and the Port Number.

Step 7: Send your details to Workyard

Message us in the app or email help@workyard.com to let us know you're ready. Our team will send you a secure link to share these details:

  • Company Code

  • Authorization ID

  • Client ID

  • Client Secret

  • URL

  • Port Number

Once we have everything, we'll finish connecting Spectrum to your Workyard account and let you know when it's ready.

Questions?

If any step looks different in your Spectrum account, or you get stuck, message us in the app or email help@workyard.com. We're here to help.

Related articles

Did this answer your question?