Creating Integration Users

New integration users are configured to use Basic integration by default.

If your integration user requires OAuth authentication (supported only in cloud environments), you must configure the user through Primavera Administration and submit a Service Request (SR). For more information, see the Primavera Administration Identity Management Configuration Guide.

Note:

If you switch from using Basic authentication to OAuth authentication, as described in Setting Up Integration Users with OAuth Authentication and V1 Get Token REST Service for OAuth Authentication, existing Basic authentication users are set to inactive. New users for OAuth authentication must be created in the User Administration window of Primavera Administration.

To create an integration user:

  1. Go to the Company Workspace tab, and switch to Admin mode.
  2. In the left Navigator, select User Administration, and then select Integration Users.
  3. From the toolbar of the Integration Users log, select Create to open the Create User window.

    Note:

    If you are using OAuth authentication, the Create button is dimmed. As explained earlier, you must use Primavera Administration to create integration users.
  4. Fill out the form.
  5. Select Done.

The following explains each block and field in the Create User window:

General block provides general information about the integration user. The General block has the following fields:

  • First Name
  • Last Name
  • Status
    • Active
    • Inactive
  • E-mail
  • Language (system default language)
  • Description
  • Time Zone (system default time zone)
  • Date Format

Security block provides the ability to add a user name and password for a user. The Security block has the following fields:

  • User Name
  • Password
  • Confirm Password
  • Expiry Duration
  • Expiry Units

Permissions block

It provides the ability to determine the permissions that the user has (for modules in the system). The Permissions block has the following fields:

Administration

  • Company Administration
    • Full Access: Provides full access to the system.
    • Create: Provides access to all the POST services.
    • Update: Provides access to all the PUT services.
    • Get: Provides access to all the PUT services.
  • User Administration
    • Full Access: Provides access to adding and maintaining user-level access.
    • Create: Provides access to all the POST services.
    • Update: Provides access to all the PUT services.
    • Get: Provides access to all the PUT services.

Business Process

  • Business Process Services
    • Full Access: Provides full access to services related to business processes (BPs).
    • Create: Provides access to all the POST services related to BPs.
    • Update: Provides access to all the PUT services related to BPs.
    • Get: Provides access to all the PUT services related to BPs.
  • Non-Workflow Business Process Permissions
    • Update: Provides access for maintaining non-workflow BPs.
    • Get: Provides access to all the PUT services related to non-workflow BPs.
  • Workflow Business Process Permissions
    • Update: Provides access to all the PUT services related to workflow BPs.
    • Get: Provides access to all the PUT services related to workflow BPs.
  • Update terminated Record Permissions
    • Update: Provides access to all the PUT services related to Terminated BPs.
  • Update terminal Record Permissions
    • Update: Provides access to all the PUT services related to Terminal BPs.

Document Manager

  • Document Services
    • Full Access: Provides full access to services related to Documents.
    • Create: Provides access to all the POST services for Documents, which includes:
      • Create Documents by Path
      • Create Documents by Parent Folder ID
    • Update: Provides access to all the PUT services for Documents, which includes:
      • Update Documents Metadata by Path
      • Update Document Metadata by Document ID
    • Get: Provides access to all the PUT services for Documents, which includes:
      • Get Documents by Path
      • Get Documents by Parent Folder ID
      • Get Document by File ID
    • Delete: Provides access to all POST services for documents which includes:
      • Delete Documents by Node ID
  • Folder Services
    • Full Access: Provides full access to services related to Folders.
    • Create: Provides access to all the POST services for Folders, which includes:
      • Create Folder by Path
      • Create Folder by Parent Folder ID
    • Update: Provides access to all the PUT services for Folders, which includes:
      • Update Folders Metadata by Path
      • Update Folder Metadata by Folder ID
    • Get: Provides access to all the PUT services for Folders, which includes:
      • Get Folders, or Documents, Metadata by Path.
      • Get Folders, or Documents, Metadata by Parent Folder ID.
    • Delete: Provides access to all POST services for documents which includes:
      • Delete Documents by Node ID

Reporting

  • User Defined Reports
    • Get: Provides access to all the PUT services for user-defined reports (UDRs).

Legacy block

SOAP Services

  • The Full Access permission will be supported for all the Legacy SOAP services.
  • The checkboxes will be selected by default when Full Access is selected.

Cost

  • CBS Services
    • Full Access: Provides full access to services related to Work/Cost Breakdown Structure (WBS/CBS).
    • Create: Provides access to all the POST services related to CBS Services.
    • Update: Provides access to all the PUT services related to CBS Services.
    • Get: Provides access to all the PUT services related to CBS Services.
  • CashFlow Services
    • Full Access: Provides full access to services related to CashFlow Services.
    • Create: Provides access to all the POST services related to CashFlow Services.
    • Update: Provides access to all the PUT services related to CashFlow Services.
    • Get: Provides access to all the PUT services related to CashFlow Services.
  • CashFlow Permissions
    • Update: Provides access for maintaining permission levels for CashFlow Services.
    • Get: Provides access to all the PUT services related to CashFlow Services.

Fund

  • Fund Services
    • Full Access: Provides full access to services related to Fund Services.
    • Create: Provides access to all the POST services related to Fund Services.
    • Update: Provides access to all the PUT services related to Fund Services.
    • Get: Provides access to all the PUT services related to Fund Services.

ScheduleSheet

  • Schedule Sheet Services
    • Full Access: Provides full access to services related to Schedule Sheet Services.
    • Update: Provides access to all the PUT services related to Schedule Sheet Services.
    • Get: Provides access to all the PUT services related to Schedule Sheet Services.

Activity Manager

  • WBS Services
    • Full Access: Provides full access to services related to Work/Cost Breakdown Structure (WBS/CBS).
    • Create: Provides access to all the POST services related to WBS Services.
    • Update: Provides access to all the PUT services related to WBS Services.
    • Get: Provides access to all the PUT services related to WBS Services.
  • Activity Sheet Services
    • Full Access: Provides full access to services related to Activity Sheet Services.
    • Create: Provides access to all the POST services related to Activity Sheet Services.
    • Update: Provides access to all the PUT services related to Activity Sheet Services.
    • Get: Provides access to all the PUT services related to Activity Sheet Services.

Master Rate Sheet

  • Rate Sheet Services
    • Full Access: Provides full access to services related to Rate Sheet Services.
    • Create: Provides access to all the POST services related to Rate Sheet Services.
    • Update: Provides access to all the PUT services related to Rate Sheet Services.
    • Get: Provides access to all the PUT services related to Rate Sheet Services.

ExchangeRates

  • Exchange Rates Services
    • Update: Provides access to all the PUT services related to Exchange Rates Services.
    • Get: Provides access to all the PUT services related to Exchange Rates Services.

Space Manager

  • Space Manager Services
    • Full Access: Provides full access to services related to Space Manager Services.
    • Create: Provides access to all the POST services related to Space Manager.
    • Update: Provides access to all the PUT services related to Space Manager.
    • Get: Provides access to all the PUT services related to Space Manager.