Skip to main content

Authentication

To authorize access to read and write data between Viewpoint Spectrum and Agave, you will need to complete the following steps:

Step 1: Whitelist Static IP Addresses​

Step 1A: Hosted or Cloud Versions of Viewpoint Spectrum​

Open a case with Viewpoint Customer Support to add Agave's IP address to your Viewpoint Spectrum Endpoint IP whitelist:

  1. Go to https://support.viewpoint.com/s/
  2. Log in to your Customer Support account.
  3. Select My Resources, then Submit a Case.
  1. Select Support, then Systems/IT
  1. Under Which product are you using?, input the following and select Search Knowledge Base:
  • Product: select Spectrum.
  • Version: select the version of your Spectrum instance (e.g. 2022 R3).
  • Module: select "SDX - Data Exchange - Spectrum".
  • Brief Summary: input "Endpoint IP Whitelist".

  1. Scroll to the bottom of the page and press Continue to Case Creation.

  2. Under Case Create, select a Priority. Under Description, add the following:

Hi - we are looking to whitelist our IPs for Spectrum Endpoint connectivity with our Spectrum instance. Here are our static IPs:

  1. 13.58.14.240
  2. 18.219.160.98
  3. 3.143.37.24

Could you also let us know what the database hostname (xyz-data.dexterchaney.com), database name (Spectrum_00xxxxx), and port are for our instance?

  1. Press Submit.

  2. After submitting a case, you should receive a response from Viewpoint Support within 24-48 hours confirming that the IP addresses have been whitelisted.

Step 1B: On-premise Versions of Viewpoint Spectrum​

If you are on an on-premise version of Viewpoint Spectrum, you will need the following three static IP addresses to connect to your SQL server by adding them to your firewall for your network:

  1. 13.58.14.240
  2. 18.219.160.98
  3. 3.143.37.24
note

If you are unable to authenticate with Agave Link even after adding the above static IP addresses, we recommend following our guide on troubleshooting common issues with on-premise connections.

Step 2: Create Authorization ID​

The next step is to configure an Authorization ID and enable required the Web Services in Spectrum. Agave uses the Web Services to write data back to Spectrum.

To enable Web Services:

  1. Login to your Viewpoint Spectrum account.
  2. Press the + at the top of the page.
  3. Select System Administration, then Installation, then Data Exchange.
  1. In Data Exchange screen, select New.

  1. Input a name for the Authorization ID (e.g. "Agave").

  2. Select a Company Code and Operator Code for the Authorization ID, and select Active for Status.

note

You can use an existing Operator Code. It is recommended to select one for a user that has full permissions throughout Spectrum, such as the CFO or Controller. The authorization ID inherits some permissions from the operator, so if you use an operator with limited permissions, then you may encounter Spectrum permission errors when syncing data. 

  1. Add a Memo for the Authorization ID (e.g. "Access for Agave").

  2. Select Build. Then select the relevant Web Services you are looking to support for the integration. For example, the below authorizes access to retrieve details about Jobs from the Job Cost module.

When creating an Authorization ID, you will need to enable the following Web Services for the corresponding Agave endpoint you plan to use:

DataServiceWeb Service(s)
AP InvoicesAccountsPayableAddAPInvoice, APMultiLineInvoice
AR InvoicesAccountsReceivableAddARInvoice, ARMultiLineInvoice
AR PaymentsAccountsReceivableAdd_CashReceipts
Budget Line ItemsJobCostAddPhase, GetPhase, GetPhaseEnhanced, PhaseNotes
Change OrdersAccountsReceivableARChangeRequest, ARChngReqBlankBIUpdate
Cost ProjectionsJobCostJobCostProjections
CustomersAccountsReceivableAddCustomer, CustomerNotes, CustomerBillto, CustomerShipto, GetCustomers
EmployeesPayrollGetEmployee, EmployeeNotes
InventoryInventoryAddInv_Req,UpdateInv_SellPrice
Prime ContractsAccountsReceivableARScheduleOfValues
ProjectsJobCostAddJob, GetJob, GetJobContact, GetJobDates, GetJobMain, UpdateJob
Purchase OrdersPurchaseOrderPOBatch, PODetail, POHeader
Service SitesWorkOrderAddWOSiteAddress
SubcontractsAccountsPayableUpdateSubcontract, UpdateSubcontractPhases, SubcontractNotes
Timecard EntriesPayrollPreTimeCard_Batch
VendorsAccountsPayableAddVendor, GetVendors, UpdateVendor, UpdateVendor_Locations, VendorNotes
Work OrdersWorkOrderWorkOrderHeader
caution

Make sure you always add the GetJobMain Web Service under the JobCost Service. We use this endpoint to confirm the customer's Spectrum account has linked successfully.

This section is under construction. Please check back later for updates.

  1. Select OK.

Agave Sync uses Spectrum's Info-Link module to read records from Spectrum to your PM System.

You will need to create an Info-Link user, and provision them access to specific Viewpoint Spectrum tables which are grouped into "Categories".

To enable an Info-Link user:

  1. Login to your Viewpoint Spectrum account.
  2. Press the + at the top of the page.
  3. Select System Administration, then Installation, then Info-Link.
  1. Continue to press "Reset" until the User ID for Info-Link is incremented at least twice. For example, if you started at "INFO0001", it should now be "INFO0003". Then press Save.
note

Spectrum needs to be refreshed to connect with Agave. This will not reset your existing info link connections
  1. Return to the Site Map. Select Info-link, then Table Categories Maintenance.
  1. Select New, and add a Table Category and Description. You can create these Categories however you see fit. If you would like to keep it simple, we recommend creating one Table Category:
caution

Make sure you have followed step 4 above to ensure the User ID for Info-Link has been incremented at least twice before continuing.

  1. Return to the Site Map. Select Info-link, then Table Security Maintenance.

  2. Select New, and add the names of Tables for which you want to support read or write requests. Note, we recommend setting Read and Write Access to "9", unless you have more granular security permissions.

caution

Make sure you add the JC_JOB_MASTER_MC and VN_VENDOR_MASTER_MC tables. You will also need VN_VENDOR_MASTER_MC and VN_VENDOR_CONTACT_DETAIL. These are the default tables we check to confirm your Spectrum account has linked successfully.

If you use Cost Centers, you will also need to add EM_COST_CENTERS_MC.

For reference, here are links to the sections on each Info-Link table you will need:

note

You only need to enable Info-Link tables for records you plan to sync.

For example, adding the below Tables adds support for reading AP Invoice Header and Line Item Tables:

  1. Select Update Database.

  2. Return to the Site Map. Select Info-link, then User Security Maintenance.

  3. Select New, then select a Company. Either add an existing Database user by selecting from the drop-down or type in a new Database user. If it's a new Database user, press the "Enter" (or "Return") key, and input a Password. The select the Table Category. We recommend setting Read and Write Access to "9", unless you have more granular security permissions.

caution

Make sure you have followed step 4 above to ensure the User ID for Info-Link has been incremented at least twice before continuing.

Make sure the Link User you create is uniquely named across Viewpoint Spectrum Companies, otherwise you might run into database validation issues. If you have any concerns, feel free to contact us at support@useagave.com.

danger

Your password must meet the following criteria:

  • Be at least 8 characters long
  • Contain at least one letter, one number, and one special character (e.g. !, @, #, $, etc.)
  • Not be part of an online data leak
    • We use Have I Been Pwned to securely check your password, without sending us your actual password to their servers. See here for more information.
  1. Select Update Database.

Once you have completed the above steps, let your Agave Account Manager know and you will be able to authenticate Agave with Spectrum.

Frequently Asked Questions​

1. How do I troubleshoot Invalid Authorization ID when connecting to Data Exchange?​

  1. Ensure the GetJobMain Web Service is added for the Authorization ID. See Step 2 of the Setup Guide.

  2. Ensure that Data Exchange is enabled for the company:

    Navigate to System Administration > Installation > Company:



Go to the Module tab and ensure Data Exchange is selected: