Create a Vista SQL User for the Xchange Agent

Creating a SQL Server User in Vista is an essential step in installing the Xchange Agent.

You must be a Vista administrator and a Microsoft SQL Management Studio administrator to complete these steps.

Note: If the integration you are subscribing to includes moving documents such as receipt images to the Viewpoint server, the XChangeServiceUser requires access to the VPAttachments database in addition to the Viewpoint database. Follow these same steps for both databases.

Note: If you are using the Procore Financials < > Vista integration, see How to Setup Your Viewpoint Vista SQL User for Trimble's integrations between Procore Financials and Viewpoint Vista instead.

  1. Create a Trimble Integrations Service User SQL User.
    1. In Microsoft SQL Management Studio, select [Server Name] > Security > Logins in the Object Explorer then right-click Logins and select New Login... to open the Login window.
    2. On the General page, enter XChangeServiceUser in the Login name field.
    3. Select SQL Server authentication.
    4. Establish a secure password. Do not use special characters aside from the exclamation point (!).
    5. Uncheck Enforce password policy.
    6. Ensure the Default database is set to your Viewpoint database.
    7. Navigate to the User Mapping page.
    8. Check the boxes next to db_datareader, public, and VCSUsers to grant this user database role membership.

      Note: Granting db_datareader is recommended, but optional. This permission allows App Xchange Support to troubleshoot more effectively. If you do not grant db_datareader, you may encounter troubleshooting issues. db_datareader is required for Procore and Concur integrations.

      g. Save the new settings.

    9. Select OK.
  2. Optional: Authorize XChangeServiceUser SQL User for the Vista Attachments database.
    Note: This step is only necessary if you have a separate Vista Attachments database. To determine if this applies to your company, open Vista and navigate to Document Management > Programs > DM Attachment Options. If the Database option is selected under Attachment Storage Location and the database name is NOT a standard Vista database (usually Viewpoint), then you must complete step 2.
    Execute the following SQL script in SQL Server Management Studio:
    USE <your Vista Attachments Database name>
    GO
    CREATE USER [XChangeServiceUser] FOR LOGIN [XChangeServiceUser]
    GO
    ALTER ROLE [db_datareader] ADD MEMBER [XChangeServiceUser]
    GO
    ALTER ROLE [db_datawriter] ADD MEMBER [XChangeServiceUser]
    GO
    GRANT EXECUTE TO XChangeServiceUser
    GO
  3. Configure the Vista Application User.
    Note: Vista system access is performed through the Vista views and stored procedures. This aligns Trimble Integrations access patterns with those of the standard Vista software. This also means that our user must be a valid Vista user and a member of the appropriate Data Security Groups to access Vista Data.
    1. Open Vista and navigate to Viewpoint Administration > Programs > VA User Profile.
    2. Select the New Record icon.
    3. Enter XChangeServiceUser in the User Name field.
    4. Set the User Type to User Application.
    5. Enter XChange Service User in the Full Name field.
    6. Enter any email, real or fake, in the Email Address field. The integration does not use it, but the field may be required by your Vista form.
    7. Select the Save icon. You will be prompted that no SQL login matches that username. Select Close.
    8. Enter the password you created for XChangeServiceUser in step 1d when prompted.
      Note: If you see an error message like the one below, disregard it. The SQL user created will still be tied to the Vista user you just created.
      Screen Shot 2021-05-04 at 3.13.13 PM
  4. Optional: Assign the Proper Security Groups to XChangeServiceUser.
    Note: This step is only necessary if you leverage Vista Data Type Security. To determine if this applies to your company, open Vista and navigate to Viewpoint Administration > Programs > VA Data Security Setup. If any Data Types are checked on the Secured column, then you must complete step 2.
    1. Navigate to Viewpoint Administration > Programs > VA User Profile.
    2. Press F4 in the User Name field and select XChangeServiceUser. Select the Security Groups tab.
    3. Grant XChangeServiceUser security group access to the data types used by the integration, otherwise the integration will be unable to access the data. If you are unsure which security groups your integration needs, contact your Vista administrator.
      Note: App Xchange only pulls data from the companies you have specified. It will ignore companies that should not be integrated.
    4. Select OK.

Your new SQL Server User is properly configured. To proceed with installing the Xchange Agent, respond to your Trimble Integrations representative with the following:

  • Server name
  • Database name
  • Password for the XChangeServiceUser