Step 1: Set Up Deltek Vantagepoint for Integration

11 minutes
12 hours ago
Public beta

This integration allows Newforma Konekt to sync projects, employees, and contacts from Deltek Vantagepoint. Records selected for syncing are automatically updated in Newforma Konekt whenever changes are made in Deltek Vantagepoint.

Before you can start connecting the two systems, the following items must first be set up in Deltek Vantagepoint:

  1. Newforma Konekt API authorization (or Integration)
  2. NEWFORMA_KONEKT Security Role
  3. NEWFORMA KONEKT user
  4. Custom fields

1. Create a Newforma Konekt API Authorization (or Integration)

This API authorization (or integration) allows Newforma Konekt to securely connect to Deltek Vantagepoint and access the data needed for the integration.

To set this up, create a new API authorization (or integration) named “Newforma Konekt” by following the steps below:

  1. Go to Utilities → Integrations → API Authorization (or Integrations Manager).
  2. Click + New API Authorization (or + New Integration).
  3. Enter “Newforma Konekt” in the Authorization Name (or Integration Name) field.
  4. Add the following URL in the Callback URL field: https://deltek-replacebyyourdatacenternumber.bimtrackapp.co/oauth/replacebyyourhubname/callback
    • Replace replacebyyourdatacenternumber and replacebyyourhubname in the URL with your data center number and hub name.
    • If your data center is located in:
      • United States: your data center number is “bt03.”
      • Europe: your data center number is “bt02.”
      • Canada: your data center number is “bt00.”
  5. Select Match Role Access in the Scopes dropdown menu.
  6. Allow the remaining fields to auto-populate.
  7. Click Save.

Completing these steps generates the following items:

  • Consumer key
  • Secret
  • Database name

All three items will be required later when enabling the Deltek Vantagepoint connector in Newforma Konekt.

In Deltek Vantagepoint versions earlier than 5.0, the consumer key is the Client ID, and the secret is the Client Secret.

2. Create a NEWFORMA_KONEKT Security Role

This security role defines the permissions Newforma Konekt uses to access and sync data from Deltek Vantagepoint.

Create a new security role in Deltek Vantagepoint called “NEWFORMA_KONEKT” by following the steps below:

  1. Go to Settings → Security → Roles.
  2. Click + New Role.
  3. Enter “NEWFORMA_KONEKT” as the role’s name.
  4. Under Type of Role, select Administrator and clear the CRM checkbox.
  5. In the OVERVIEW tab, enable the following permissions:
    • Hubs → Projects
    • Settings → Workflows → User initiated workflows
    • Hubs →Contacts
    • Hubs →Employees
  6. Click Save.

If your Deltek Vantagepoint database includes multiple companies, specify which companies the NEWFORMA_KONEKT security role can access.

  1. Go to Settings → Security → Roles.
  2. Open the Access Rights tab.
  3. In the Functional Area dropdown, select Companies.
  4. Choose Full Access to All Companies, or specify access by adding companies to the grid.

3. Create a NEWFORMA KONEKT User

This user serves as the service account that Newforma Konekt uses to authenticate and access Deltek Vantagepoint, and will be used later when connecting your Deltek Vantagepoint instance to your Newforma Konekt hub.

Create a new user in Deltek Vantagepoint called “NEWFORMA KONEKT” by following the steps below:

  1. Go to Settings → Security → Users → Roles.
  2. Click + New User.
  3. Enter “NEWFORMA KONEKT” in the User ID field.
  4. Enter a password in the Password field.
  5. Select “NEWFORMA_KONEKT” in the Role dropdown menu.
  6. Click Save.

Leave the Employee field blank and do not enable Windows Authentication. The NEWFORMA KONEKT user must not be linked to an employee.

After creating the NEWFORMA KONEKT user, log out of Deltek Vantagepoint and sign back in using this account. On the first login, you will be prompted to change the password; follow the instructions and save the new password.

4. Create Custom Fields

Custom fields determine which projects, employees, and contacts in Deltek Vantagepoint are synced to Newforma Konekt. For example, selecting the Create in NK <name of hub> custom field for a project ensures it will be synced to that Newforma Konekt hub once the integration is complete.

Please make sure to grant the NEWFORMA_KONEKT role access to all of your custom fields (refer to the How to create a custom field in Deltek Vantagepoint section below for more details).”

Create the following custom fields in Deltek Vantagepoint:

  • “Create in NK <name of hub>” in Project (mandatory)
  • “Project template” in Project (optional)
  • “Project access” in Project (optional)
  • “Create in NK <name of hub>” in Employees (mandatory if you want to sync employees)
  • “Create in NK <name of hub>” in Contacts (mandatory if you want to sync contacts)

Once these fields are created, they will appear on the Project, Employees, and Contacts pages in Deltek Vantagepoint.

Follow the steps below to build your custom fields:

  1. Log in to Deltek Vantagepoint using a user with access to the design tool (not the “NEWFORMA KONEKT” user).
  2. Navigate to one of the following:
    • HUBS → Projects → Project
    • HUBS → Employees
    • HUBS → Contacts
  3. On the selected page, click the Other Actions dropdown.
  4. Click Design.
  5. Click Add Field.
  6. Select the appropriate Field type (see section 4.1 for instructions).
  7. Add a Caption (custom field name).
  8. Allow the Database Column Name field to auto-populate. Do not modify this value.
  9. Click Apply.
  10. Add dropdown values, if applicable, by clicking + Add Value (see section 4.1 for options).
  11. Click Apply.
  12. Click on the field under Field security in the right-side menu. The Field Security Rights modal should appear.
    • Select the Displayed option for the NEWFORMA_KONEKT role you previously created.
    • Click on Save in this modal.
  13. Click Save in the upper right corner of the page.
  14. Reload your page and make sure that the new custom field appears on the selected page.

Repeat this process until all five custom fields are built.

4.1 Custom Field Details

See the tables below for how to configure each custom field.

4.1.1 Projects

The table below includes details for all three Project custom fields.

Custom field nameField typeOptions to add in the dropdownIs this field mandatory or optional?Use for this field
Create in NK <name of hub>Checkbox N/A MandatoryProjects with this field checked will be synced to your Newforma Konekt hub. If your hub is named “hub1,” the field should be named “Create in NK hub1.” If you are connecting to multiple hubs, create a separate field for each one.

The Database Column Name field will auto-populate with the following value: “CustCreateinNK<name of hub>.” If not, enter “CustCreateinNK<name of hub>.”
Project template DropdownThe names of your project templates in Newforma KonektOptionalProject templates allow you to save the settings of a past or present project and apply them to a new one.

The values in this dropdown must match the project templates in your Newforma Konekt hub. If this custom field is not created or mapped, the default Newforma Konekt template will be applied to your Deltek Vantagepoint projects.

It will not be possible to edit the project template linked to a Deltek Vantagepoint project once it has been synced in Newforma Konekt.
Project access Dropdown Private and LimitedOptionalThe project access helps admins control the visibility of a project for other users. For more information on project access, please read this documentation.

If you do not create this custom field and choose not to map it in the configuration flow, project access will be Private access by default and only the Hub owner and the user activating the Deltek Vantagepoint connector will have access to the synced projects. However, you will be able to edit the project access directly from Newforma Konekt once the project has been created.
4.1.2 Employees

The table below includes details for the Employees custom field.

Custom field nameField typeOptions to add in the dropdownIs this field mandatory or optional?Use for this field
Create in NK <name of hub>Checkbox N/A Mandatory if you want to sync Deltek Vantagepoint employees to Newforma Konekt. Employees with this field checked will be synced your Newforma Konekt hub. If your hub is named “hub1,” the field should be named “Create in NK hub1.” If you are connecting to multiple hubs, create a separate field for each one.

The Database Column Name field will auto-populate with the following value: “CustCreateinNK<name of hub>.” If not, enter “CustCreateinNK<name of hub>.”

To be able to sync project team members, make sure that the TEAM tab in your Deltek Vantagepoint Projects has the “Displayed” field security option for your NEWFORMA_KONEKT role:

  1. In the Deltek Vantagepoint navigation menu, go to HUBS > Projects > Project.
  2. In the upper right-hand corner, select Other Actions > Design
  3. Select the TEAM tab
  4. Select the Team members table
  5. Select the field under Field security in the right-side menu. The Field Security Rights modal should appear.
  6. Select the Displayed option for the NEWFORMA_KONEKT role you previously created
  7. Click Save in this modal.
  8. Click Save in the upper right-hand corner of the page.
4.1.3 Contacts

The table below includes details for the Contacts custom field.

Custom field nameField typeOptions to add in the dropdownIs this field mandatory or optional?Use for this field
Create in NK <name of hub>Checkbox N/A Mandatory if you want to sync Deltek Vantagepoint contacts to Newforma Konekt. Contacts with this field checked will be synced your Newforma Konekt hub. If your hub is named “hub1,” the field should be named “Create in NK hub1.” If you are connecting to multiple hubs, create a separate field for each one.

The Database Column Name field will auto-populate with the following value: “CustCreateinNK<name of hub>.” If not, enter “CustCreateinNK<name of hub>.”

5. Verify Connection Information

You’re almost ready to begin connecting the Deltek Vantagepoint connector to Newforma Konekt. Before you proceed, make sure you have the following information available, as it will be required in the next steps:

  • The consumer key from the Newforma Konekt API authorization (or Integration)
  • The secret from the Newforma Konekt API authorization (or Integration)
  • The database name from the Newforma Konekt API authorization (or Integration)
  • The Deltek Vantagepoint base URL from your Deltek instance
    Example:
    https://<instance>.deltekfirst.com/<instance>
    or
    https://<yourdomain>/Vantagepoint)
  • The user ID and password for the NEWFORMA KONEKT user

6. Prepare to Connect to Multiple Newforma Konekt Hubs (Optional)

If you plan to connect a single Deltek Vantagepoint instance to multiple Newforma Konekt hubs, additional setup is required.

First, create a separate API authorization (integration) in Deltek Vantagepoint for each additional hub. For each authorization, ensure the callback URL includes the correct data center number and hub name.

Then, to control which records are synced to each hub, build the “Create in NK <name of hub>” custom fields (see section 4) for each additional hub.

For example, if you have two additional hubs named “hub2” and “hub3,” create the following custom fields for the Project, Employees, and Contacts pages:

  • Create in NK hub2
  • Create in NK hub3

In step 2 of the integration, you will need to set up a separate Deltek Vantagepoint connector for each additional hub you want to sync to.

7. Select Records to Sync

Finally, select the projects, employees, and contacts you want to sync to your Newforma Konekt hub(s).

Go to each project, employee, and contact you want to sync and select the Create in NK <name of hub> custom field(s)—this ensures the record will be synced to the corresponding hub(s).

If an employee or contact is added to a project to be synced to Newforma Konekt—and both the user and the project have the Create in NK <name of hub> field selected—the user will also be synced to the corresponding project in Newforma Konekt.

FAQ

Can I reuse the same API authorization, security role, and user for other (non–Newforma Konekt) integrations? It is recommended to create separate API authorizations, roles, and users for the Newforma Konekt integration so that integrations do not interfere with one another.

What happens if I log in to Deltek Vantagepoint with my individual credentials? Newforma Konekt will use your individual credentials to connect to Deltek Vantagepoint. You can still set up the integration, including creating the NEWFORMA_KONEKT security role and NEWFORMA KONEKT user, but your account must have the required permissions.

Is the Deltek Vantagepoint integration with Newforma Konekt one-way or two-way? The integration is one-way. Changes in Deltek Vantagepoint are synced to Newforma Konekt, but changes in Newforma Konekt are not synced back to Deltek Vantagepoint.

Can I enable or modify Deltek Vantagepoint’s key conversion after the integration is set up? No. This integration does not support Deltek Vantagepoint’s key conversion feature. Changing key conversion settings may cause previously synced data to be irreversibly duplicated in Newforma Konekt.

Related Items