Common

This section describes the common business configuration to be performed so that you can integrate the various external authoring systems to SAP Integrated Product Development.

Prerequisites – Product Data Integration SaaS

A subscription to the SAP IPD capability Product Data Integration with Application Technical Name epd-product-data-integration (Product Data Integration SaaS) is a prerequisite for using the SAP IPD Integration to <Authoring System> and should be done before continuing further setup. Please refer in the SAP Help Portal for further information to the SAP Integrated Product Development > Administration Guide > Business Configuration for Product Data Integration > Product Data Integration SaaS.

Prerequisites – Roles

SAP Integrated Product Development interface to Authoring System was introduced as a separate capability connected to Product Data Integration. In order for Product Data Integration to be able to distinguish from which capability the calls come and whether that capability is even allowed to grant access, the users of individual new capabilities must have the appropriate role templates. Please refer to SAP Integrated Product Development > Administration Guide > User Management > Role Templates for SAP Integrated Product Development > Role Templates for Product Data Integration.

Configuration on the Client Site

Settings that control the behavior of the SAP IPD Integration, some of which can be set using the menu function "Configuration" of the respective CAD Interface, are stored in the (normally hidden) directory C:\ProgramData\SAP\IPD interface to XXX (where "XXX" stands for the respective CAD system). The settings are saved in the PDIConnect.config.xml file. As this is a document in XML format, the structure follows the XML rules.

The individual setting parameters (preferences) are stored as an element with their parameter name, whereby the parameter values must be enclosed by tags:

Sample Code

Example of a parameter

<Parameter_name> Parameter value </Parameter_name>

Related parameters are divided into groups whose names refer to the function of the parameters within the group. Subgroups are also possible within a group:

Sample Code

Example of a parameter group

<Group> 

   <Param1>Value of Param 1</Param1> 

   <Param2>Value of Param 2</Param2> 

      <Subgroup> 

         <Param1>Value of Param 1</Param1> 

         <Param2>Value of Param 2</Param2> 

      </Subgroup> 

 </Group>

The configuration file PDIConnect.config.xml can be edited and saved using a normal text editor, such as Notepad.exe.

Parameter description

The configuration parameters are divided into several groups, each of which summarizes speciﬁc aspects of the settings:

General (Anchor to the Part in Table below - General parameters)
PDI (Anchor to the Part in Table below)
CAD (Anchor to the Part in Table below)

The individual parameters are described in detail in the following tables.

General

These are parameters that are not assigned to any speciﬁc group. Some of them are parameters that

represent options that can be set via the "Configuration" menu item in the CAD interfaces.

General parameters
Parameter	Administration Mode
Description	Determines whether the "Configuration" menu item is displayed and whether users are allowed to make changes via the configuration dialog.
Values	"1" = Do not display menu item. "0" = Display menu item.
Default Value	0

Parameter	Language
Description	Sets the language of the SAP IPD Interface. This includes all text in menus, toolbars, and dialog boxes.
Values	EN, DE
Default Value	The respective installation language.

Parameter	SaveLanguageFiles
Description	Specifies whether the language files are written to the language directory when the interface is started. The directory for the language files is located in the "Roaming" directory in a directory that depends on the CAD interface. For the Inventor interface, e.g. under C:\Users\[USERNAME]\AppData\Roaming\SAP\IPD interface to XYZ\Language.
Values	"1" = Write language files to the Language directory. "0" = Do not write language files to the Language directory.
Default Value	0

Parameter

SaveLanguageFiles

Description

Specifies whether the language files are written to the language directory when the interface is started.

The directory for the language files is located in the "Roaming" directory in a directory that depends on the CAD interface.

For the Inventor interface, e.g. under C:\Users\[USERNAME]\AppData\Roaming\SAP\IPD interface to XYZ\Language.

Values

"1" = Write language files to the Language directory.

"0" = Do not write language files to the Language directory.

Default Value

Group	LogSettings
Description	The "LogSettings" group contains settings for generating log files. These can help with troubleshooting.

Parameter	Level
Descriptions	Determines the level of detail and thus the scope and frequency of a write access.
Values	This is cumulative from top to bottom and thus becomes increasingly detailed: "Fatal" = Only serious errors that usually cause the application to crash are logged. "Error" = All errors that occur are logged. "Warning" = Any warnings that occur are logged. "Info" = Displayed information is logged. "Debug" = Special debug information is included. This is of interest to developers. "Trace" = Every single step that the CAD interface performs is recorded.
Default Value	Error

Parameter

Level

Descriptions

Determines the level of detail and thus the scope and frequency of a write access.

Values

This is cumulative from top to bottom and thus becomes increasingly detailed:

"Fatal" = Only serious errors that usually cause the application to crash are logged.

"Error" = All errors that occur are logged.

"Warning" = Any warnings that occur are logged.

"Info" = Displayed information is logged.

"Debug" = Special debug information is included. This is of interest to developers.

"Trace" = Every single step that the CAD interface performs is recorded.

Default Value

Error

Parameter	DataTimeFormat
Descriptions	Affects the format of date and time entries on the interface. If this entry is not configured, the default CurrentCulture format "6/15/2008 9:15:07" is used.
Values	Format value.
Default Value	G

Parameter

DataTimeFormat

Descriptions

Affects the format of date and time entries on the interface.

If this entry is not configured, the default CurrentCulture format "6/15/2008 9:15:07" is used.

Values

Format value.

Default Value

Parameter	CadLoadFileRetrievalStrategie
Descriptions	Controls the file retrieval strategy when downloading the files of a design item. Possible values result from the configuration of the Product Data Integration on the endpoint.
Values	Constant
Default Value	CAD_LOAD

Parameter	WebRequestTimeOut
Descriptions	Determines the timeout period in milliseconds for requests to the Product Data Integration. If this value is not set, the timeout period is 10 minutes.
Values	Time in milliseconds
Default Value	600000

Parameter	UseSystemBrowserToLogon
Descriptions	Controls whether the login dialog is the system browser or whether the utility CdnWebView2.exe located in the installation directory should be used.
Values	"1" = Use system browser. "0" = Use utility CdnWebView2.exe.
Default Value	0

Parameter

UseSystemBrowserToLogon

Descriptions

Controls whether the login dialog is the system browser or whether the utility CdnWebView2.exe located in the installation directory should be used.

Values

"1" = Use system browser.

"0" = Use utility CdnWebView2.exe.

Default Value

Product Data Integration

This section summarizes parameters that define and control the connection to the SAP Product Data Integration server. Parameters of the Product Data Integration group

Parameters
Group	Product Data Integration
Parameter	ActiveServerDefinition
Description	Specifies the name of the active BTP server connection. This can be specified and selected in the "Configuration" dialog in the "Server" section. Multiple server connections with different names can be defined. These appear in the list there. Note Only one connection can be active at a time.
Values	Name of a server connection. Example: val_Partner

Subgroup	ServerDefinitions
Description	This subgroup groups the individual BTP server connections under their respective names.

Subgroup	<Name of the server connection>
Description	In this subgroup, the connection parameters of a BTP server connection are stored together under a freely selectable name. This is usually done via the "Configuration" dialog in the "Server" section.
Default Value	val_Partner

Parameter	EndPointUrl
Description	Defines the endpoint URL of the server.
Values	Full URL

Parameter	AuthUrl
Description	Defines the URL of the authentication server.
Values	Full URL

Parameter	AccessTokenURL
Description	Defines the URL of the server for assigning an access token.
Values	Full URL

Parameter	TokenExchangeURL
Description	Defines the URL of the token exchange server.
Values	Full URL

Parameter	Subdomain
Description	Defines the subdomain.
Values	Name of the subdomain.

Parameter	ClientId
Description	Defines the client ID.
Values	The client ID.

CAD

The CAD-specific parameter WORKDIR is described in this table. Another CAD-specific parameters are described in the chapters for the respective interface.

Parameters
Group	CAD
Description	Contains parameters for configuring the interaction between the CAD system and Product Data Integration.

Parameter	WORKDIR
Description	Specifies the working directory where the Product Data Integration Connector stores the documents. This parameter is preassigned by the Product Data Integration connector, but can be overwritten by the respective CAD interface.
Value	Full directory path
Default Value	C:\PdiWorkDir

Subgroup	<CAD system>
Description	Parameters that configure CAD-specific aspects.