Configuring Publishing for Service Documents
Overview
Windchill Visualization Services (WVS) provides a framework for publishing documents, creating representations for visualization, and producing bundles. This publishing process uses a worker managed by the Worker Agent.
The WVS framework supports publishing from information structures, publication structures, and parts lists. To configure publishing, you must configure the WVS Publisher using WVS properties. You can then define and load publishing rules for publishing to specific outputs.
WVS sends a request to the Arbortext Publishing Engine based on specified publishing rules. These rules specify creating the output or post-published object, pass parameters used for publishing, and specify the type of output, such as PDF or Arbortext Content Delivery bundle.
Configuring the WVS Publisher
You will need to set up authentication for Arbortext Publishing Engine to download input files from Windchill and subsequently handle the output file. There are a couple of ways to handle authentication. You will need to create the auth.properties file in your <Windchill-path> root directory (also known as %WT_HOME%) using a text editor. Then evaluate which method of authentication to use during publishing operations:
• Use Trusted Host Authentication for authentication without passing a password in the publishing request.
• Set up a user name and password for authentication to be passed with the publishing request.
To use Trusted Host Authentication for WVS publishing to Arbortext Publishing Engine:
1. Add an authentication variable to the auth.properties file, like the following example:
auth=$user:
2. Add a Property for the Arbortext Publishing Engine server to the Windchillsite.xconf file:
<Property name="wt.auth.trustedHosts" overridable="true"
targetFile="codebase/wt.properties" value="server-IP-address"/>
3. Run xconfmanager -pF to propagate the property.
4. From the Windchill shell, restart Windchill using:
windchill stop
windchill start
To add user name and password authentication to the auth.properties file:
1. Add an authentication variable that includes a user name and an optional password value. This is the only entry in this file. The syntax would be either of the following:
auth=username
auth=username:password
To use auth=<username>:<password>, set the value com.arbortext.e3.allowAuthenticationWithoutTrustedHost in e3config.xml to true on the Arbortext Publishing Engine server.
|
|
PTC recommends the use of auth=<username>:<password> in demo or test servers only.
|
Replace username and password with valid values.
2. Be sure the user has privileges to read and download all Windchill Service Information Manager structures stored in Windchill that could be published.
In addition, Windchill is configured with the location of the auth.properties file. In particular, wvs.properties contains the auth.properties location.
|
|
The location of the wvs.properties and wvs.properties.xconf files are found in the Windchill-path\codebase\WEB-INF\conf directory.
|
1. In the wvs.properties file, a set of Windchill Service Information Manager publishing properties usually specifies the location of auth.properties as:
$(wt.home)$(wvs.dir.sep)auth.properties
If the location of auth.properties changes, be sure to update the path. You must use the xconfmanager utility to make this change, and you need to specify the entire property statement, for example:
xconfmanager -s
"updated statement within quotes"
-t Windchill-path\wvs.properties -p
The following properties supply the location of auth.properties by default and would need to be updated if its location changes (ignore the line breaks):
publish.cadconvert.com.ptc.arbortext.windchill.partlist.PartList.SIS=
com.ptc.arbortext.windchill.publisher.CadConvertSIS,
useworkerdownload\=$(wt.home)$(wvs.dir.sep)auth.properties,
types\=PDF BUNDLE EPUB,defaulttype\=PDF
publish.cadconvert.wt.part.WTPart|com.ptc.sis.Base
|com.ptc.sis.BaseDiv|com.ptc.sis.IsRoot.SIS=
com.ptc.arbortext.windchill.publisher.CadConvertSIS,
useworkerdownload\=$(wt.home)$(wvs.dir.sep)auth.properties,
types\=BUNDLE ,defaulttype\=BUNDLE
publish.cadconvert.wt.part.WTPart|com.ptc.sis.Base
|com.ptc.sis.BaseDiv|com.ptc.sis.PsSection.SIS=
com.ptc.arbortext.windchill.publisher.CadConvertSIS,
useworkerdownload\=$(wt.home)$(wvs.dir.sep)auth.properties,
types\=PDF HTML BUNDLE EPUB,defaulttype\=PDF
publish.cadconvert.wt.part.WTPart|com.ptc.sis.Base
|com.ptc.sis.BaseDiv|com.ptc.sis.PsSection|com.ptc.sis.PsRoot.SIS=
com.ptc.arbortext.windchill.publisher.CadConvertSIS,
useworkerdownload\=$(wt.home)$(wvs.dir.sep)auth.properties,
types\=PDF HTML BUNDLE EPUB,defaulttype\=PDF
publish.cadconvert.wt.part.WTPart|com.ptc.sis.Base
|com.ptc.sis.Content|com.ptc.sis.ContentRef
|com.ptc.sis.PartsListRef.SIS=
com.ptc.arbortext.windchill.publisher.CadConvertSIS,
useworkerdownload\=$(wt.home)$(wvs.dir.sep)auth.properties,
types\=PDF HTML BUNDLE EPUB,defaulttype\=PDF
publish.cadconvert.wt.part.WTPart|com.ptc.sis.Base
|com.ptc.sis.Content|com.ptc.sis.ContentRef
|com.ptc.sis.TextualContentRef.SIS=
com.ptc.arbortext.windchill.publisher.CadConvertSIS,
useworkerdownload\=$(wt.home)$(wvs.dir.sep)auth.properties,
types\=PDF HTML BUNDLE EPUB,defaulttype\=PDF
2. Restart the Windchill server.
|
|
The wvs.properties file also contains a setting called publish.usesPublishRules=ARBORTEXT SIS. If this property is deleted, or the ARBORTEXT SIS values are removed, WVS will not use Publishing Rules. This is not recommended.
|
Additional Performance Configuration
If your site manages large transactions between WVS and the Arbortext Publishing Engine server, you may need to add a property to configure an extended time-out period to allow publishing jobs to finish.
1. Add a Property to the Windchillsite.xconf file:
<Property name=" publish.cadtimeout.component.SIS " overridable="true"
targetFile="codebase/wvs.properties" value="7200"/>
Set the time-out value in seconds. For example, 7200 means 2 hours.
2. Run xconfmanager -pF to propagate the property.
3. From the Windchill shell, restart Windchill using:
windchill stop
windchill start
