SPID API in the Data Exchange Manager - Intergraph Smart Completions - Release Bulletin

HxGN Smart Completions Release Notes

Language
English (United States)
Product
Intergraph Smart Completions
Search by Category
Release Bulletin
Smart Completions Version
2020 (5.0)

Smart Completions has an Out-of-Box connector with SPID Operations. The Data Exchange Manager allows you to pull documents directly from SPID Projects into Smart Completions projects. This way you can ensure the latest controlled documents are pulled into Smart Completions when needed.

To set up the connection with SPID, complete the following steps.

Open the Data Exchange Manager:

  1. Click the gear icon.

  2. Search for Data Exchange and open the manager.

Step 1: Set up a new connection:

  1. Click New and enter the Name and Description in the popup window.

  2. In the Data Source dropdown contains our currently supported platforms. In this instance, choose SPID.

  3. In the SC Base Manager, you will choose which Manager the connection will pull from. In this example, we show vDocuments.

  4. In the URL/Connection Path field, you will enter the external API or connection information.

  5. The End Point is the API data source. Smart API customers can configure their own endpoints.

  6. The Access Token and Refresh Token fields are only necessary when the login uses an alternative to the Username/Password of the system. If SPID requires multi-factor authentication, for instance, then these fields will be used. Otherwise they are not required.

  7. The InfoMap Path is optional. If you add the InfoMap path URL here, then users will be able to click a link in the document manager to load the InfoMap for that document. Please see the second image below.

  8. Default User Name and Default Password will come from the user account that was created for the API Authorization.

  9. Client ID, Client Secret, Scope, and Service: SC will use these credentials from the configuration of Smart API. Consult the Smart API documentation for these fields.

  10. In some instances, the authentication server may be different from the application server. The Pre Auth Type (N/A or SiteMinder) and Pre Auth URL can also be added. If no authentication server is used, you may leave these blank.

  11. Save the record at this point and choose to continue editing the form.

  12. Source Project is the project within SPID from which SC will pull data. This field is not editable. To populate this field, click the Get Source Project button and choose the correct project. Note that the URL/Connection Path must be entered before selecting the project. If you have not saved the record, then this list of projects will not be available. If the Projects are not loading, and you have saved the record, then the above steps have not been configured correctly.

  13. The Last Sync Date serves as a filter, so that SC will only pull new information from this date. If you are making configuration changes, then you should clear this date. However, you can leave it blank for now.

  14. The Exchange Type will determine the flow of information between SPID and SC. Currently, it is only possible to Pull from SPID. Pull means that Smart Completions will update with new information that originated in SPID. In the future, Push will allow information that has been entered in Smart Completions to be sent to update SPID, and Push/Pull will allow new information to flow back and forth between the two. If something new is added in Smart Completions, the software will update SPID (Push). And if something new is added in SPID, Smart Completions will automatically update with it (Pull). Push and Push/Pull are not currently available.

  15. The Schedule dropdown allows you to determine whether data exchange will be regularly scheduled (Recurrence) or whether you only want the data exchange to occur when you tell it to by clicking a button (Manual).

  16. Data Propagation: Right now, the only supported type is Automatic. A data staging phase will be coming in a future release. This will mean that if any key fields have been changed, they will be placed into a "staging" area for further analysis and collision rather than automatically updating SC.

  17. If you selected Recurrence as a schedule, then a Recurrence button appears that allows you to determine how frequently the data exchange occurs.

Step 2: Field Mapping

On the second tab, you will determine the fields in the SPID Database that map to the Smart Completions Fields. The fields displayed in SC Fields are determined by the manager you selected on the first tab in SC Base Manager. In this instance, therefore, we will see fields available from vDocuments.

  1. In SPID, each Project can be configured differently. For instance, required fields may be different depending on the project. Click the Get Schema button to pull this data from the SPID Project you selected in Step 1.

  2. There are four default look up fields that are mappable for data restrictions when pulling in data (Discipline, Category, Type and Status).  Checking the lookup check box will also sync the possible lookup values with SC and allows you to select these values for restrictions (discussed later).

  3. Once you’ve started the process, the Clear Schema button will remove your current selections and start a new one.

Step 3: Data Restrictions

This tab allows you to set restrictions on the data you wish to pull. For instance, if you only want documents that are from the Electrical discipline, you can create a filter here. The Get Lookups button will fetch these datapoints from SPID and save them in Smart Completions. However, only lookups that have been configured in Step 2 will be populated. Additionally, there is a default filter on Document Status, so that only the current revision can be pulled.

Remember to Save.

From the Data Exchange Manager, you can now highlight the row and click Fetch Data to run the operation. A sync history is available, and can be seen in the View Panel, that will show the number of records modified. Once you have done this, the Last Sync Date will be populated on the Step 1 tab. Remember that Smart Completions will only pull new data from the time of the last sync. If you need to change the filters, then this means the connection could miss any documents that were edited or changed before this date. Therefore, if you change the filters (Step 3), then you will need to clear the Last Sync Date before fetching new data.