Client Installation
The S1000D client application integrates into Arbortext Editor and Arbortext Publishing Engine installations. The application introduces S1000D features to Arbortext Editor and enables the S1000D publishing standard for Arbortext Publishing Engine.
The installation process comprises multiple steps:
1. Install the Windchill Service Information Manager — S1000D Module Application Files
2. Edit the connections configuration file to configure the connection to Windchill via the PTC Server connection.
3. Configure the environment for publishing with Arbortext Publishing Engine
4. Restart the Tomcat service (if working with Arbortext Publishing Engine)
This release of Windchill Service Information Manager — S1000D Module supports Arbortext Editor and Arbortext Publishing Engine 7.1 F000+. For more information, see Windchill Service Information Manager - S1000D Module Software Matrices.
For new and existing installations, carry out these three steps before commencing the client installation:
1. Ensure that the application directory, in the Arbortext Editor and Arbortext Publishing Engine installations, does not contain an existing com.ptc.arbortext.slmaad folder
For example:
C:\Program Files\PTC\Arbortext Editor\application\
C:\Program Files\PE\Arbortext PE\application
2. Ensure that all Arbortext Editor sessions are closed.
3. Stop the Tomcat service (only required if installing into Arbortext Publishing Engine):
a. From the Windows Start menu, select > >
The PTC Arbortext Publishing Engine Configuration dialog box is displayed.
b. Select the Tomcat/IIS tab
c. Click Stop
This has stopped the Tomcat service used by Arbortext Publishing Engine.
|
|
You may need to evaluate and re-integrate any customizations to application files in existing installations.
|
Install the client application
To install the Windchill Service Information Manager — S1000D Module Application Files into previously installed Arbortext Editor or Arbortext Publishing Engine client:
1. Locate PTC Windchill <Windchill Version> Service Information Module for S1000D Application Files.zip on the delivery media, and open the file.
|
|
• PTC recommends using the latest version of the Windchill Service Information Manager — S1000D Module Application Files, corresponding to the Windchill Service Information Manager — S1000D Module version installed. The files are available from the Software Download Center on the PTC Support site.
• For more information about configuring Arbortext Editor or Arbortext Publishing Engine or the PTC server connection, see the Arbortext Help Center: > > > .
|
2. Extract the application\com.ptc.arbortext.slmaad application to the application folder in the Arbortext Editor and Arbortext Publishing Engine installations
For example:
C:\Program Files\PTC\Arbortext Editor\application\com.ptc.arbortext.slmaad
C:\Program Files\PTC\Arbortext PE\application\com.ptc.arbortext.slmaad
3. Extract the doctypes\dita\ditabase\ditabase.bcf file to the doctypes folder in the Arbortext Editor installation
For example:
C:\Program Files\PTC\Arbortext Editor\doctypes\dita\ditabase\ditabase.bcf
Edit the client configuration files
New installations of Arbortext Editor or Arbortext Publishing Engine require configuration changes when installing the application files. To edit the configuration files:
1. Close Arbortext Editor (and any Editor processes that are running)
2. Open siteprefs.xml in a text editor.
3. Locate the parameter <ParameterName>HostList</ParameterName> section.
4. Add the server connection definition lines. For example:
|
|
Ensure that there are no trailing / characters at the end of the ParameterValue definitions.
|
5. Locate the parameter <ParameterName>RefreshContentOnCheckin</ParameterName>
6. Change its <ParameterValue> to true
7. Save and close the siteprefs.xml file.
8. Open userprefs.xml in a text editor.
9. Locate the parameter <ParameterName>RemoveObjectsFromWorkspaceAfterCheckIn</ParameterName>
10. Change its <ParameterValue> to Yes
11. Locate the parameter <ParameterName>WorkspaceCleanupThreshold</ParameterName>
12. Change its <ParameterValue> to 0
13. Save and close the userprefs.xml file.
|
|
Templates for the preferences files are located in the directory \adapters\com.ptc.prowt.arbortext. Copy the template files and rename the copies sitreprefs.xml and userprefs.xml.
|
Configure environment for publishing with Arbortext Publishing Engine
Sufficient memory must be allocated to Arbortext Editor/Arbortext Publishing Engine’s Java Virtual Machine (JVM) to publish with Arbortext Publishing Engine.
These steps are required for new Arbortext Publishing Engine installations:
1. Ensure that all instances of Arbortext Editor and Arbortext Publishing Engine are closed, and that the Tomcat service attached to Arbortext Publishing Engine has been stopped.
2. Add the system environment variable APTJAVAVMMEMORY.
3. Set the value of the environment variable to the required amount of memory (in MB).
Restart the Tomcat service
This step is only required if installing Arbortext Publishing Engine.
To integrate the S1000D client application into the Tomcat environment:
1. From the Windows Start menu, select > >
The PTC Arbortext Publishing Engine Configuration dialog box is displayed.
2. Select the Tomcat/IIS tab
3. Click Restart (or Start if the service is currently stopped)
