Register from an authoring tool - HxGN SDx - Update 61 - Help - Hexagon

Before you can begin sharing data with SDx, you must first authenticate and then register your authoring tool plant with a plant in SDx.

The authentication of any tool is completed using one of the authentication servers – SmartAPIManager (SAM) authentication server or any third-party authentication, like Okta authentication server. Every request (share, register, and so on) is authenticated before it is completed.

• Okta authentication server with IWA (Integrated Windows Authentication) is not supported.

• If you are using SAM authentication server with IWA, your role must be SystemAdminPAB or ProjectAdminPAB at ConfigurationTop.

• To register a new authoring tool, your administrator must create a new client in the Authorization Server and enter all the details like Client ID, Client Secret, and so on.

• For more information about Okta authentication server, see Configuring an Okta Authorization Server.

• For more information about why you must register your authoring tool plant with a plant in SDx, see Registering plants.

• For more information about the information that appears in the Registration window, see Learn more about registering.

Create a new registration

A user with client credentials and client name with the appropriate roles for registering a plant must be available in SDx for you to register the plant.

1. From the authoring tool, click Integration > Register with SDx.

2. In the Authentication dialog box, type the SDx Server URL, Client ID, and Client Secret for Proof Key for Code Exchange (PKCE) and Client Credentials.

   Tell me more about the Authentication dialog box

   This functionality was modified in an update. For more information, see Tell me more about the Authentication dialog box (modified in an update)

   You can get the details to enter in the Authentication dialog box from your administrator.

   To know more about registration, see Registering plants.

   The default URI used for PKCE client for any of the authentication servers must be http://localhost:62810/.

   1. In the SDx Server URL, enter the URL of the SDx site you want to register with.

   2. In the Authentication code with Proof Key for Code Exchange and the Client Credentials sections, enter the Client ID and the Client Secret in the respective boxes.

      

      • The Client ID identifies the Smart Client.

      • The Client Secret authenticates the Smart Client and allows access to Smart API.

      • You must enter the values for Client ID and Client Secret in two sections - Authentication code with Proof Key for Code Exchange and Client Credentials.

        • The values in Authentication code with Proof Key for Code Exchange redirects you to the applicable authentication server logon page.

        • The values in Client Credentials authenticates the client and redirects you to the register page.

        • When you are using OKTA with PKCE for authentication, the Client Secret box is optional.

3. In the Authorization Server page, type your user name and password.

   In the Register dialog box, the Tool ID box automatically populates with the tool you are registering.

4. From the Select a Plant list, choose the plant you want to register.

5. Provide information in the Tool description box.

   A new registration relationship and unique tool signature is created for each unique tool description provided, allowing you to register the same authoring tool to one plant multiple times for different organizations or disciplines.

6. If necessary, select a work area definition to work in.

   Users associated with an internal organization can choose one of the defined internal or external filters. Users associated with an external organization must choose an external filter associated with their organization. For more information, see Learn more about Smart 3D work area definitions.

7. Provide the SDx Web Client URL, and validate it.

8. Click OK.

Choose an existing registration to use

1. From the authoring tool, click Integration > Register with SDx.

2. From the Plant list, choose the plant you want to register with.

3. From the Existing Registrations list, choose the registration you want to use.

4. Click Register.

Modify the details of an existing registration

If you want to make any changes to the registration details, you can register a tool to SDx again.

1. In the Authentication dialog box, you can edit the information in the following boxes:

   • If you are using a host workstation, you can edit the SDx Server URL, Client ID, and Client Secret for PKCE and Client Credentials.

   • If you are using a satellite workstation, you can only edit the Client ID and Client Secret for PKCE and Client Credentials.

     If you are using a satellite workstation, the Client ID and Client Secret boxes in Client Credentials are optional.

   You cannot edit the boxes in the Register dialog box.

2. Click Ok in the Register dialog box to modify the registration details.