Integration with Other Applications > Integration with FORAN > Windchill Gateway for FORAN > Preferences
  
Preferences
This chapter describes preferences that control the Windchill Gateway for FORAN.
Optional Preferences
Several optional preferences, located in the shipinteg.properties.xconf file, allow you to modify out-of-the-box settings. Refer to the table below for a description of these preferences.
* 
Do not modify the shipinteg.properties.xconf file after it has been installed. Use the xconfmanager to set, reset, or redefine properties for your installation.
Preference Name
Default
Description
com.ptc.windchill.wvs.shipinteg.isLibraryItemsRepresentationNeeded
False
LibraryParts are the parts below the Design Solution. If the default property value is set to True, library representations are not filtered out from the Product Structure.
com.ptc.windchill.shipinteg.createUsageLink.enabled
False
When set to True, a Library/Catalog part will be associated to a Design Solution. This link creation will be ignored if a library item is already associated with a Design Solution.
com.ptc.windchill.shipinteg.multipleUsageLink.enabled
False
Similar to the preceding property; when set to True, multiple usage links will be created, but only a single usage link will be added per import.
Using the UsageLink Preferences
To enable the functionality related to the UsageLink preferences, add the following property (set to True) to the shipinteg.properties file:
com.ptc.windchill.shipinteg.createUsageLink.enabled=true
* 
Do not modify the shipinteg.properties.xconf file after it has been installed. Use the xconfmanager to set, reset, or redefine properties for your installation.
When the createUsageLink and multipleUsageLink properties are used, a new file called AttributeMapping.xml must be created in <WT.HOME>/DistProc. This file will contain the mapping content for the properties. Sample content of the AttributeMapping.xml follows.
If the classification is for a Design Solution (DS) Component Part “Equipment” (with the datamodel sbt or sbt-ci) to import from FORAN to Windchill, the file AttributeMapping.xml will have the following content:
* 
In the example below, the <type>...</type> code block has been split in two to accommodate PDF publishing restrictions. In actual practice, the contents of the <type>...</type> code block must always appear as a single line in the AttributeMapping.xml file.
<mappings>
<mapping>
<source>
<type>wt.part.WTPart|com.ptc.ptcnet.SBTPart|com.ptc.ptcnet.
SBTDesignSolution|com.ptc.ptcnet.SBTComponentPart</type>
<classification>Shipbuilding/Design Solution/Component Part/Equipment</classification>
</source>
<attribute from="STOCKCODE" to="number"/>
<attribute from="STOCK" to="number"/>
<attribute from="COMPONENT" to="number"/>
</mapping>
</mappings>
The above example shows the DS part “Equipment”. To create a usage link with another DS part (for example, Collar Plate), then a <mapping> block related to the collar plate is added to the AttributeMapping.xml file.
* 
In the example below, the <type>...</type> code block has been split in two to accommodate PDF publishing restrictions. In actual practice, the contents of the <type>...</type> code block must always appear as a single line in the AttributeMapping.xml file.
<mapping>
<source>
<type>wt.part.WTPart|com.ptc.ptcnet.SBTPart|com.ptc.ptcnet.
SBTDesignSolution|com.ptc.ptcnet.SBTPlatePart</type>
<classification>Shipbuilding/Design Solution/Plate Part/Collar Plate</classification>
</source>
<attribute from="STOCKCODE" to="number"/>
<attribute from="STOCK" to="number"/>
<attribute from="COMPONENT" to="number"/>
</mapping>
Without using classification, when using the Advanced Soft Type (with the datamodel classic or classic-ci) to import from FORAN to Windchill, the file AttributeMapping.xml will have the following content:
* 
In the example below, the <type>...</type> code block has been split in two to accommodate PDF publishing restrictions. In actual practice, the contents of the <type>...</type> code block must always appear as a single line in the AttributeMapping.xml file.
<mappings>
<mapping>
<source>
<type>wt.part.WTPart|com.ptc.ptcnet.SBTPart|com.ptc.ptcnet.
SBTDesignSolution|com.ptc.ptcnet.SBTComponentPart|com.ptc.ptcnet.SBTEquipment</type>
</source>
<attribute from="STOCKCODE" to="number"/>
<attribute from="COMPONENT" to="number"/>
</mapping>
</mappings>
The above example shows the DS part “Equipment”. To create a usage link with another DS part (for example, Deck Plate), then a <mapping> block related to the deck plate is added to the AttributeMapping.xml file.
* 
In the example below, the <type>...</type> code block has been split in two to accommodate PDF publishing restrictions. In actual practice, the contents of the <type>...</type> code block must always appear as a single line in the AttributeMapping.xml file.
<mapping>
<source>
<type>wt.part.WTPart|com.ptc.ptcnet.SBTPart|com.ptc.ptcnet.
SBTDesignSolution|com.ptc.ptcnet.SBTPlatePart|com.ptc.ptcnet.SBTDeckPlate
</type>
</source>
<attribute from="STOCKCODE" to="number"/>
<attribute from="COMPONENT" to="number"/>
</mapping>
Similarly, usage links can be created with different DS parts if either Classification or Advanced Soft Types is used. The attributes mentioned above in AttributeMapping.xml are mapped to a number. The attribute must be present in both Windchill and FORAN. The number to which the attribute is mapped is the number of the WTPart SubType created in Windchill, which represents a custom soft type (Library Item).
* 
The WTPart SubType from which Library Item is created must not be a SBT Part nor any Soft Type under a SBT Part.
After an import from FORAN to Windchill, a usage link will be created with the DS part from FORAN and the WTPart SubType present in Windchill.
The behavior for a Single Usage link is as follows:
If a usage link is already created with a DS part, the usage link creation will be ignored.
Only one usage link will be created at a time.
Multiple Usage Links can be created with a single DS part, by adding the following property (set to True) to the shipinteg.properties.xconf file:
com.ptc.windchill.shipinteg.multipleUsageLink.enabled=true
The attribute values with different part numbers can be changed, and a single usage link per import can then be created.
When Multiple Usage Links is used, there will be only one usage link created per import.
Other Import Preferences
The following preferences are also relevant to the import process.
Default Target Context – The import step is executed on Windchill. An IXB jar is imported using the IXB framework The Default Target Context is used when the import jar contains an invalid context reference or if no context is specified in the jar for an object/objects.
The context value is to be specified in the following format:
/<org container class>=<org name>/<container class name>=<container name>”
For example:
“/wt.inf.container.OrgContainer=DemoOrganization/wt.pdmlink.PDMLinkProduct=MY_PRODUCT”
This value is given as input during installation. If you need to change the value after installation, the above property needs to be manually modified.
The following property is available in wt.properties
com.ptc.windchill.gateway.import.defaultContext = “”
Released State – The following properties must be added to the shipinteg.properties file in order to define the RELEASED state:
When an incoming object is trying to iterate the objects which are in the RELEASED state (based on the state defined in the property Windchill_HOME/DistProc/shipinteg.properties), then the FORAN actor on the Windchill side will revise the object to next revision.
com.ptc.windchill.shipinteg.released.state=Basic::RELEASED
The following property must be added to the shipinteg.properties file to define the repository information which will be used to lock objects from FORAN to Windchill:
com.ptc.windchill.shipinteg.repository.1=
<IP Address of FORAN ORACLE DATABASE>-<FORAN ORACLE DATABASE Machine Name in UPPERCASE>-
<FORAN PROJECT NAME>::<FORAN PROJECT NAME>
For example:
com.ptc.windchill.shipinteg.repository.1=130.21.24.125-I4587.ptcnet.ptc.com-TDEV::TDEV
located at Windchill_HOME/DistProc/shipinteg.properties
* 
For the first release of Windchill Gateway for FORAN, there is support only for one FORAN project per Windchill Server.