Trimble Viewpoint Spectrum

The Viewpoint Spectrum connector enables App Xchange users to synchronize data, streamline workflows, and improve reporting efficiency for their construction businesses.

The Viewpoint Spectrum connector bridges the gap between your Viewpoint Spectrum ERP and a wide ecosystem of applications, empowering users to synchronize critical data and optimize workflows. This connector leverages comprehensive API endpoints spanning Accounts Payable, Job Cost, Payroll, and more. It facilitates seamless data exchange and drives improved reporting efficiency.

User Access

To access the developer environment for Viewpoint Spectrum, please view the Data Exchange Module Authorization Setup document.

Engagement and Training

If you would like additional training or to ask for enhancements to this connector, please view the following resources: 

Trimble Professional Services

Technical Documentation

Technical documentation for this product may be viewed on the Spectrum Help page.

Connector Endpoints

The documentation below is an OpenAPI description (OAD) of each module in this connector. Note: This is provided as a quick view of coverage and capabilities. The API and endpoints documented are used internally by the platform and not directly by end users.

• Accounts Payable

• Accounts Receivable

• Cash Management

• Enterprise Management

• Equipment Control

• General Ledger

• Hilti

• Human Resources

• Inventory Control

• Job Cost

• Order Processing

• PA

• Payroll

• Purchase Order

• System Admin

• Work Order

Connecting in App Xchange

Before you can use this connector, you must complete these steps.

1. Connect a Spectrum environment.
   If you are integrating a cloud environment, see Connect a Spectrum Cloud Environment. If you are integrating an on-prem environment, see Connect a Spectrum On-Prem Environment.

2. Create a Spectrum Data Exchange.
   For instructions, see Create a Spectrum Data Exchange.

3. Enter the connector details in App Xchange. If you are using the general configuration method, check Configuration for additional connector details.
   Note: Depending on the workspace type, this connector uses either a connection or fields built into the general configuration to manage credentials. Either method works. Eventually, connections will be used in all workspaces to allow for more data protection enhancements.

   • Api Root Url: Enter the root URL for the Spectrum Site with the port included. For example, https://trimble.dexterchaney.com:8482.

   • OAuth Client: If you are using an Enhanced Auth connection, create a new OAuth Client using the OAuth 2.0 Client Credentials connection definition. To find the values for your OAuth Client in Spectrum, navigate to System Administration > Installation > Data Exchange and open the appropriate Authorization ID. For instructions on creating a new OAuth Client, see Create an OAuth Client.

   • Data Exchange Authorization Id: If your workspace contains a flow that brings data into Spectrum, enter the appropriate Authorization ID. This is found in Spectrum by navigating to System Administration > Installation > Data Exchange.

   • Company Code: Enter the three-digit code for the Spectrum company. It is found in Spectrum by navigating to System Administration > Installation > Enterprise > Company then selecting the Company tab. This code can be alphabetical, numeric, or both. For example, ABC, 101, or TS2.

   • Database Connection String: Create the Database Connection String using info from your initial ERP setup. Insert the appropriate values into each field below, then enter these fields separated by semicolons:

     • Data Source=[the Spectrum server URL]

     • Initial Catalog=[the database name provided by Spectrum]

     • User ID=XChangeServiceUser (this must match the Info-Link username created during step 1)

     • Password=[the password created for the Info-Link user you created during step 1]

     • MultipleActiveResultSets=true

For example, Data Source=trimble.dexterchaney.com; Initial Catalog=Spectrum; User ID=XChangeServiceUser; Password=Password2; MultipleActiveResultSets=true;.

Configuration

The properties below influence the behavior of this connector. Which ones are necessary depends on the integrations or automations for which they are used.

• Real-time Action Processing: This feature should always be enabled for optimal performance. Only disable it if you are advised to do so by support.

• Run Services on Connector App: This feature should be enabled if you installed the XChangeAgent as part of your ERP connection setup, such as for an on-prem environment. Otherwise, it should be disabled.

• Starting Cache Write Job Id: Leave this blank unless advised by a Spectrum administrator. If your Spectrum database is too large to be cached normally, toggle this feature.

System Interface Configuration

• Base Url of the Ryvit AppNetwork Environment: https://api.xchange.trimble.com/connect/v1 (default)

• Partner Api Key: This field is pre-populated with a unique API key issued to you by App Xchange.

Connector Details

Only complete the following fields if you have not yet entered them as part of the connection.

• Api Root Url: Enter the root URL for the Spectrum Site with the port included. For example, https://trimble.dexterchaney.com:8482.

• Company Code: Enter the three-digit code for the Spectrum company. It is found in Spectrum by navigating to System Administration > Installation > Enterprise > Company, then selecting the Company tab. This code can be alphabetical, numeric, or both. For example, ABC, 101, or TS2.

• Database Connection String: Create the Database Connection String using info from your initial ERP setup. Insert the appropriate values into each field below, then enter these fields separated by semicolons:

  • Data Source=[the Spectrum server URL]

  • Initial Catalog=[the database name provided by Spectrum]

  • User ID=XChangeServiceUser [this must match the Info-Link username created during the first step of Connecting in App Xchange

  • Password=[the password created for the Info-Link user you created during the first step of Connecting in App Xchange]

  • MultipleActiveResultSets=true

For example, Data Source=trimble.dexterchaney.com; Initial Catalog=Spectrum; User ID=XChangeServiceUser; Password=Password2; MultipleActiveResultSets=true;.

• Data Exchange Authorization Id: If your workspace contains a flow that brings data into Spectrum, enter the appropriate Authorization ID. This is found in Spectrum by navigating to System Administration > Installation > Data Exchange.

• Data Exchange Client Id: If Enhanced Authentication is enabled in Spectrum, enter the appropriate Data Exchange Client ID. This is found in Spectrum by navigating to System Administration > Installation > Data Exchange, opening the appropriate Authorization ID, then selecting Secret Status.

• Data Exchange Client Secret: If Enhanced Authentication is enabled in Spectrum, enter the appropriate Data Exchange Client ID. This is found in Spectrum by navigating to System Administration > Installation > Data Exchange, opening the appropriate Authorization ID, then selecting Secret Status.

• Use Spectrum Enhanced Security: If Enhanced Authentication is enabled in Spectrum, toggle this feature.

• Data Exchange Client Secret Expiration Date: If Enhanced Authentication is enabled in Spectrum, enter the expiration date of the Data Exchange Client Secret. This is found in Spectrum by navigating to System Administration > Installation > Data Exchange, opening the appropriate Authorization ID, then selecting Secret Status.

• Number of days to rotate the secret before expires: If Enhanced Authentication is enabled in Spectrum, enter the number of days required to rotate the secret. This is found in Spectrum by navigating to System Administration > Installation > Data Exchange, then selecting the Settings tab.

User Support

If you encounter a problem or need support for this connector, please create a ticket at App Xchange Support or email xchange_support@trimble.com.

Was this helpful? Give us feedback.