Service Worker Parameters

Additional Capabilities > Service Information Management > Configuration Guide > Service Publishing Setup > Service Worker Parameters

The Service (or SIS) Worker parameters control the publishing process. Worker parameters are specified in the publishing rule using the following form:

<worker name="namespace/parameter">value</worker>

A worker parameter specification is part of a param-set which is passed to WVS when publishing processing begins. For Windchill Service Information Manager publishing, you can target a parameter to a specific system or subsystem used by the publishing process.

Constructing a publishing rule is explained in Service Publishing Rules for WVS.

Specifying a Parameter System

The name attribute specifies the system using one of the following prefixes:

• com.ptc.arbortext.wvs controls behavior of WVS on the Windchill server.

• com.ptc.arbortext.pe controls behavior of publishing on the Arbortext Publishing Engine server using the service application (which must already be installed on the Arbortext Publishing Engine server).

• com.ptc.arbortext.all applies to both WVS on Windchill and publishing on Arbortext Publishing Engine server.

Specifying WVS Worker Parameters

The com.ptc.arbortext.wvs/ parameters control the behavior of the WVS system. Append a parameter name to the system to specify the parameter. Note that a forward slash / precedes the parameter name. For example:

Parameter Name

Output Type

Description

ApplyTranslationFilter

PDF

XML bundle

Using XSL

Specify whether the baseline filter criteria should be applied while publishing translated objects. When set to true, the default value, the object version included in the baseline will be considered during publishing. If set to false, publishing will use the latest version of the translated documents.

attachmentFilter

XML bundle

Using XSL

Specify the categories for dynamic document and WTDocument attachments (secondary content) to include in the payload. Attachments that match the specification are published in the payload.

The default value is derived from the ContentFilter parameter prepended with *: (which specifies all categories).

Each attachment is assigned to a category in Windchill. The syntax for specifying a category and related file extensions:

([-]*|category)[:
[-]ext,
ext,...
[|...]

category is the name of a category in Windchill. Separate multiple category filters using a vertical bar |

ext is an optional file extension for the specified category. Multiple file extensions are separated by commas.

For example:

GRAPHICS:png,gif|
ILLUSTRATIONS:png,gif

If a category is specified by itself, all its secondary content files are allowed. For example:

GRAPHICS

If the ext specification is empty, nothing for that category is passed to the payload. For example:

GRAPHICS:

You can specify the * wildcard character to include all categories. It can be used by itself, or it can be used with one or more ext values. For example, the following allows the specified extensions for all categories:

*:png,tif,jpg

The following allows all secondary content except files with no file extension.

Categories or extensions that are not specified are considered to be included.

The - exclusion character can begin the entire filter specification for either category or ext to exclude everything that follows it. For example, the following excludes all secondary content for the GRAPHICS category:

-GRAPHICS

Both jpg and tif files are excluded in each of the following examples:

-GRAPHICS:jpg,tif

GRAPHICS:-jpg,tif

The following filter excludes the specified extensions for both of the specified categories.

-ILLUSTRATIONS:png,jpg,
tif|GRAPHICS:cgm,tif

The - can be combined in a specification with the wildcard *.

For example, the following excludes all secondary content:

Both png and jpg files are excluded for all categories in each of the following examples:

-*:png,jpg

*:-png,jpg

Wildcard * specifications must be placed after more specific values (For example, *|GRAPHICS:jpg allows all files and ignores the GRAPHICS specification after it).

A sample list of categories follows this table.

Audit.Enabled

HTML

PDF

XML bundle

Using XSL

Specify whether the publishing process logs diagnostic information about the collection of dynamic document objects linked to content holders.

Specify yes or no (the default).

Dynamic document links to other dynamic documents are not audited.

Audit.IncludeChild

HTML

PDF

XML bundle

Using XSL

Specify whether to collect child content objects of dynamic documents, called child dynamic documents. Auditing child dynamic documents are not enabled by default.

Specify yes or no (the default).

If you specify yes, Audit.Enabled must also be set to yes.

checkDuplicatePINodes

XML bundle

Specify whether to check for duplicate product instance nodes.

Specify true, the default, to check for duplicate product instance nodes.

Specify false to improve performance when there are no duplicate product instance nodes.

collectChildDocMetadata

XML bundle

Specify whether to include the metadata from a reference to a graphic or dynamic document.

Specify yes to include reference metadata, or specify no (the default) to ignore it.

completeTranslationCheck

HTML

PDF

XML bundle

Using XSL

Specify whether to proceed with publishing if a translation for an attribute value can’t be found.

Specify yes to fail publishing if the translated attribute value can’t be found, or specify no (the default) to continue publishing using the source text for the attribute value..

configurableLinkFilter

XML bundle

Specify the name of the configurable document filter to set it as the filter for configurable documents.

contentFilter

HTML

PDF

XML bundle

Using XSL

Specify the file extensions to be used as the fallback default filter specification for AttachmentFilter and PrimaryFilter.

You can specify a list of file extensions separated by commas. The default value is the * wildcard character, which allows all graphic dynamic documents and their attachments.

To override this value specifically for graphic dynamic documents, see the AttachmentFilter and PrimaryFilter parameters.

describeLinkFilter

XML bundle

Specify the name of the describing document filter to set it as the filter for describing documents.

disableMetadataReplacer

PDF

HTML

When the com.ptc.arbortext.wvs/disableMetadataReplacer worker parameter is added to the SamplePublishingRules.xml file for the Arbortext authoring application with a value of false, it ensures that if the two-way metadata is configured in Arbortext Editor, any changes made to the applicable Windchill metadata will reflect into the document after publishing.

This is applicable when using Arbortext Publishing Engine 8.2.0.0 or higher. Else, do not add this parameter.

emitAttachments

HTML

PDF

XML bundle

Using XSL

Specify whether to include attachments for graphic dynamic documents or WTDocuments (secondary content) in the payload.

Specify yes to include attachments, or specify no (the default) to ignore them.

This parameter is ignored for textual information elements.

This parameter is also ignored for Parts Lists. Parts List illustration attachments are included in the payload by default.

emitRepresentations

HTML

PDF

XML bundle

Using XSL

Specify whether to include representations in the payload according to the value specified by RepresentationFilter.

Specify yes to include representations. The default is no.

This parameter supports documents and dynamic documents of Part List illustrations only.

enableNoServiceEffectivity Delegate

HTML

PDF

XML bundle

Using XSL

Specify whether to filter out parts lists with no service effectivity from the payload.

Specify yes to filter parts lists with no service effectivity. Specify no, the default, to include parts lists with no service effectivity.

includeContentHolderReps

XML bundle

Specify whether to publish the default representation of an information element content holder for a textual dynamic document, graphical dynamic document, document, or parts list. This default representation will be used as a thumbnail in Arbortext Content Delivery.

Specify true to publish the default representation of a content holder. The default is false.

includeContentMetadata

HTML

PDF

XML bundle

Using XSL

Specify whether to include dynamic document and parts list metadata in a publication structure published to a payload.

Specify yes to include the metadata in the publication structure. Specify no, the default, to discard the metadata.

The metadata are still always included in the manifest.

includeEmptyBranches

HTML

PDF

XML bundle

Using XSL

Specify whether to include all sections containing no content (dynamic documents or parts lists) in the service structure payload.

Specify yes to include sections containing no content. Specify no, the default, to discard empty sections.

includeMilestoneTimes InWorkerLog

HTML

PDF

XML bundle

Using XSL

Specify whether to include event performance information for publishing milestones in the SIS Worker log file. Specify true to include the milestone performance. Specify false, the default, to exclude them.

Each milestone entry contains the time for completion of the associated activity. The trace includes the time and duration for the publishing request to be zipped, the time and duration to send it, and the time and duration when a response was returned.

language

HTML

PDF

XML bundle

Using XSL

Specify the language for the publishing job. Define the locale of the target translation, for example fr_FR. The locale needs to match the translation links from the authored content and the locale attribute of a localizable object.

This parameter can be overridden by the Language selection in the Publish Representation dialog box.

language is used to:

• follow translation links to translated content.

• translate localizable attributes using the translation dictionary.

• generate a translation.xml file in the payload.

• perform language-specific actions (such as generated text translations) in the publishing process.

• define the language of the XML bundle

If not specified (the default), and if the service structure contains a mix of authoring languages, no translation links are followed and the payload could still contain a mixture of languages.

maxErrorCount

HTML

PDF

XML bundle

Using XSL

Specify the number of missing translations errors shown in a failure notification. Specify an integer value for the maximum number of translation errors in a failure notification. The default is 100.

maxPartReferenceDepth

HTML

PDF

XML bundle

Using XSL

Specify the depth for a related part to be included for a parts list in the payload. Specify an integer value for the depth of related parts to include. Related parts that have a depth equal or less than the value will be included in the payload.

Parts lists can reference parts indirectly through relationships such as supersessions, alternates, substitutes, or supplementary parts. These indirectly referenced parts are called related parts. Each related part has one more depths than the part that references it.

Parts that are directly referenced by a parts list have a depth of 0. When this value is set to 0, no related parts will be included in the payload.

When the value of this parameter is -1, the default, all related parts will be included in the payload.

onBundleWithoutContexts

XML bundle

Specify the publishing behavior when the service structure is not associated with a product hierarchy or product hierarchy nodes. The default value warning reports a warning message in the WVS log, and proceeds with the publishing job.

Specify ignore to publish with no messages.

Specify error to report an error message in the WVS log, and fail the publishing job after the process completes.

Specify fatal to report a fatal error message in the WVS log, and fail the publishing job immediately.

onContentHolderLinkFailed

HTML

PDF

XML bundle

Using XSL

Specify how to handle a content holder when its content is not available or has multiple associated content objects. The default value Latest applies the latest configuration specification to locate the associated content.

Specify ignore to skip missing content and proceed.

Specify warning to report missing content in the WVS log, skip missing content, and proceed with the publishing job.

Specify error to report missing content in the WVS log skip missing content, but fail the publishing job after the process completes.

Specify fatal to report the first missing data object and fail the publishing job immediately.

onContentWithNoPrimary

HTML

PDF

XML bundle

Using XSL

Specify whether to continue publishing job if a content object is missing primary content.

Specify ignore to skip the content object and proceed with the publishing job.

Specify fail, the default, to fail the publishing job immediately.

onlyForeignContent

XML bundle (created from a publication structure)

Specify whether to include all referenced dynamic documents, images, and parts lists in an XML bundle.

Specify no to include all dynamic documents, images, and parts lists. Specify yes, the default, to include only content that is not referenced from the primary information structure associated with the same product.

A publication structure being published to a bundle accesses content using a reference to its information structure bundle, which is published separately.

This parameter is for publishing a publication structure to an XML bundle only.

onPvzMissingTranslation

HTML

PDF

XML bundle

Using XSL

When publishing an information or publishing structure that references a PVZ file which is linked to a .c3di file containing translated content, this parameter specifies the action to take if the PVZ file is missing content required for a language-specific representation.

Specify warning to report the missing content in the WVS monitor, but continue with publishing. (The default value.)

Specify fail to report the missing content in the WVS monitor, and fail the publishing job.

Specify error to continue with publishing but generate errors in the WVS log.

Specify fatal to fail the publishing request and stop publishing, generating a fatal error in the WVS log.

onPartListItemMissing

HTML

PDF

XML bundle

Using XSL

Specify whether to include a parts list with one or more missing parts. For example, a parts list may have ten items but one of them may be filtered out.

Specify fail to report the missing part in the WVS monitor, and fail the publishing job.

Specify message to report the missing part in the WVS monitor, but continue with publishing.

Specify ignore to ignore the missing part with no message in the WVS monitor.

onPartListWithoutParts

HTML

PDF

XML bundle

Using XSL

Specify whether to publish a parts list with no parts, such as when a filter is applied.

Specify Ignore to continue with publishing empty parts lists and generate no messages.

Specify Warning (the default) to continue with publishing but generate a warning for each empty parts list.

Specify Error to continue with publishing but generate errors in the WVS log.

Specify Fatal to fail the publishing request and stop publishing, generating a fatal error in the WVS log.

partListImageSource

XML bundle

Specify how to handle a graphic dynamic document that has attachments in a parts list.

Specify postPublishOnly to include only post-published content linked to the graphic. If no post-published content exists, this parameter will not include any graphics.

Specify originalOnly to include the original graphic only.

Specify preferPostPublish, the default, to use post-published content if it is available. Otherwise, the original graphic will be included.

The metadata will always come from the original graphic, even if only post published content is included.

The graphic dynamic document content can still be filtered using the primaryFilter, attachmentFilter, and representationFilter parameters.

partListIncludeAllPostPublish

XML bundle

Specify whether to include all post-published content in the bundle.

Set to true to include post-published content of the part list illustration in the bundle.

Set to false (the default), to exclude post-published content from the bundle.

To use this parameter, the partListImageSource must have the value specified as preferPostPublish or postPublishOnly.

partListVersion1.5

HTML

PDF

XML bundle

Using XSL

Specify whether to publish a parts list in the 1.5 version format or the version 2.0 or later format. Specify yes to use version 1.5. Specify false, the default, to use version 2.0 or later.

In version 1.5, there is no related parts information in the payload and the referenced parts information is embedded in each parts list item.

In later versions, related parts information (supersessions, alternates, substitutes, or supplementary replacements) will be included in the payload.

PartResources

XML bundle

Using XSL

Specify the types of part representations that will be included in the partThumbnails.zip in the payload. You can specify a role for the graphic thumbnail as well as the special value PVZ. Multiple parameter values are separated by commas.

The default value is THUMBNAIL,THUMBNAIL_SMALL,PVZ.

Specify THUMBNAIL to choose the thumbnail.

Specify THUMBNAIL_SMALL to choose the small thumbnail.

Specify THUMBNAIL3D to choose a 3D thumbnail.

Specify PVZ to choose a PVZ containing the default representation.

Specify NONE to exclude all thumbnails and PVZ files.

For example:

THUMBNAIL,THUMBNAIL3D,PVZ

Although PVZ is not a role, it is a special value allowed in the list. When PVZ is specified, the contents of the PVZ file are specified by the PvzFilter parameter.

Files to be included in partThumbnails.zip can also be specified by the thumbnailRole parameter.

For more information on partThumbnails.zip and how thumbnail parameters are processed, see Payload and Manifest

For more information on partThumbnails.zip and how thumbnail parameters are processed, see Payload and Manifest in Customizing Windchill Service Information Manager and Windchill Service Parts.

payloadCache

XML bundle

Specifies whether the payload is cached in the SISPayloadCache subfolder of the Windchill temporary folder. Set the value to yes or true to store the payload in the temporary folder. The default value is false.

PTC recommends using this parameter for troubleshooting, not for regular publishing.

includePIReps

XML bundle

PIReps are not used by Arbortext Content Delivery. Specifies whether product instances representations are included in the bundle.

Specify false, the default, to exclude representations of a product instance in the published bundle.

Specify true to include representations of a product instance in the published bundle.

preferAdapter

XML bundle

Specify whether to retrieve the content for a structure using the PTC Server connection adapter on the Arbortext Publishing Engine server.

Specify yes to use the adapter on the Arbortext Publishing Engine server. Specify no, the default, to send the content for a structure in a payload from Windchill to the Arbortext Publishing Engine server. The default is no.

In either case, it’s possible that some content is sent in the payload and some retrieved using the adapter.

primaryFilter

XML bundle

Specify the filter for the primary content of a graphic dynamic document to determine whether to include it in the payload. Graphics that match the specification are published to the payload.

You can specify a list of file extensions separated by commas. The default value is derived from the ContentFilter parameter.

The * wildcard character allows all primary content.

It’s possible to suppress primary graphic content and still allow associated representations and attachments in the payload.

PvzFilter

XML bundle

Using XSL

Specify the file types that will be included in a PVZ file for a part. The PVZ is included in the payload in the partThumbnails.zip file. This parameter is applied when the PartResources parameter value includes PVZ. You can specify graphic file types supported for a PVZ or roles specified on the content in the PVZ. Multiple parameter values are separated by commas.

+|- extension or role,
extension or role,...

The + is optional as values are presumed to be inclusions by default. Use the - to specify only exclusions.

For example:

png,jpg includes all PNG and JPG files in the PVZ.

pvs,ol includes all PVS and OL files in the PVZ.

-png,THUMBNAIL3D excludes all PNG files and all 3D thumbnails.

For more information on partThumbnails.zip and how thumbnail parameters are processed, see Payload and Manifest

For more information on partThumbnails.zip and how thumbnail parameters are processed, see Payload and Manifest in Customizing Windchill Service Information Manager and Windchill Service Parts.

referenceLinkFilter

XML bundle

Specify the name of the reference document filter to set it as the filter for reference documents.

representationFilter

HTML

PDF

XML bundle

Using XSL

Specify the types of representations to include in the payload. Specify the primary type and its related attachment file extensions. Representations that match the specification are included in the payload.

Specify using the following format:

[-][*|primary,
primary,...]:
[-]extension,
extension,...[|...]

Multiple primary types are separated by commas. The colon is followed by the list of associated representation extensions. Separate multiple specifications using a vertical bar.

For example, the specification c3di:jpg,gif matches primary c3di representations with the attachment types of jpg or gif. An empty list of extensions does not match any representations.

In another example, the filter specifies the primary representation types c3di and tiff. The representation attachment types must be specified after the colon to be included.

c3di:png,jpg,gif|
tiff:imap

You can use the wildcard character *, which needs to follow other more specific specifications. The following example includes the specified attachment types for all primary types:

*:png,tiff,jpg

The - can exclude all representations for a primary type. For example:

-pvz

The - exclusion character can begin the filter specification to exclude specified types. In the following example, only pvz representations are excluded for png or jpg primary representation types. Everything else would be allowed.

-png,jpg:pvz

The - can also exclude specified file extensions for primary types. For example, the following excludes only pvz attachments or png or jpg:

png,jpg: -pvz

You can filter objects with no primary type by specifying the empty string for the primary type. For example, , you could specify png representations using :png.

savedFilter

HTML

PDF

XML bundle

Using XSL

Specify the name of the options and variants filter to apply while serializing the structure to the payload. Specify the name of a previously saved filter.

structuresUseAuthored Language

HTML

PDF

XML bundle

Using XSL

Specify whether to use the authored language or target language in structure artifacts.

Specify false to use target language translations for object attributes where available.

Specify true to use the authoring language values for object attributes.

The default is

• true for bundle output and using XSL.

• false for PDF.

thumbnailRole

HTML

PDF

XML bundle

Using XSL

Specify the types of part representations that will be included in the partThumbnails.zip in the payload. Specify the role for which graphic thumbnail to include when publishing. The default value is an empty string.

Specify THUMBNAIL to choose the thumbnail role.

Specify THUMBNAIL_SMALL to choose the small thumbnail role.

Specify PVZ to choose a PVZ containing the default representation.

Files to be included in partThumbnails.zip can also be specified by the PartResources parameter.

For more information on partThumbnails.zip and how thumbnail parameters are processed, see Payload and Manifest

For more information on partThumbnails.zip and how thumbnail parameters are processed, see Payload and Manifest in Customizing Windchill Service Information Manager and Windchill Service Parts.

useApexExpression

HTML

PDF

XML bundle

Using XSL

Specifies whether the expressions in the payload will be in APEX format.

Setting to yes specifies expressions use the APEX format, Setting to no (the default value) specifies expressions use the ATO format.

usePseudoTranslation

HTML

PDF

XML bundle

Using XSL

Specify whether to publish the source content of a localizable attribute in a special format for a translation.

Specify yes to use the source content. Specify no, the default, to use translations.

When set to yes, the following apply:

• If the attribute is localizable but no translated value exists, the translated result of an attribute value will be represented by [source-value].

• If the attribute is localizable and a translated value exists, the translated attribute value will be represented by [[source-value]].

Examples of Windchill Categories

The following lists some Windchill categories that you can use to filter secondary content attachments using com.ptc.arbortext.wvs.AttachmentFilter:

• ANALYSIS_INPUT

• ANALYSIS_RESULTS

• DRAWING

• EXPORT

• FAMILY_TABLE

• GENERAL

• GRAPHICS

• ILLUSTRATION

• IMAGE_MAP

• IMPORT

• INFORMATION

• IMAGE

• MANUFACTURING

• PACKAGE

• PRINT

• REPRESENTATION

• TEXT

• VIEWABLE

• XCF (XML Companion File)

Specifying an Arbortext Publishing Engine Server Parameter Subsystem

For publishing on the Arbortext Publishing Engine, the name attribute can also specify several Arbortext Publishing Engine subsystems that target specific aspects of publishing:

• com.ptc.arbortext.pe.service transforms a publication structure, information structure, or parts list from the generic format serialized and transmitted by WVS to the Arbortext Publishing Engine server.

The result can be a DITA map or other document type that can be processed for publishing to the desired output.

When publishing a bundle for Arbortext Content Delivery, this subsystem produces output that provides the input to the bundle subsystem.

This subsystem also handles graphic format conversion.

For information on graphic formats, refer to Graphic File Formats.

• com.ptc.arbortext.pe.publish transforms a DITA map or other document processed by the service subsystem into the requested output format, such as PDF .

• com.ptc.arbortext.pe.bundle transforms the XML document processed by the service or publish subsystems into a bundle, which is placed on the Arbortext Publishing Engine server. Arbortext Content Delivery picks it up from there.

The bundle parameters control bundle file-creation and handling on the Arbortext Publishing Engine server. The bundle base file subdirectory location can be specified. The bundles can also be preserved for troubleshooting.

• com.ptc.arbortext.inservice.all parameters control the Arbortext Publishing Engine server publishing to Arbortext Content Delivery.

• com.ptc.arbortext.pe.all affects the service and publish subsystems. Parameters for all are set before the service subsystem starts to run and stay in effect until after the bundle subsystem finishes.

If a subsystem is not specified (service or publish), the default is all.

Specifying an Arbortext Publishing Engine Parameter Type

In addition to specifying a subsystem, the type of parameter can be optionally specified using a /type:name form. The type can be any of the following:

• composer specifies a parameter used by the Service application, the publishing framework, and the content pipeline on the Arbortext Publishing Engine server.

If type is omitted, the default is composer.

• environment specifies a parameter that sets an environment variable for the Arbortext Publishing Engine sub-process running the Service application.

• option specifies a parameter that sets an Arbortext Command Language (ACL) set option for the Arbortext Publishing Engine sub-process running the service application, for example, option:appsnapshot. Refer to the Arbortext Command Language Reference, a manual delivered with Arbortext Editor and Publishing Engine, for information on the set command option.

• variable specifies a parameter that sets an ACL global variable for the Arbortext Publishing Engine sub-process running the service application.

Refer to the Arbortext Command Language Reference.

Specifying Arbortext Publishing Engine Parameters

The following com.ptc.arbortext.pe parameters control the behavior of the Arbortext Publishing Engine server system. You can append an optional subsystem. Then specify an optional type and a parameter name to the system to specify the parameter after the forward slash /. For example:

<worker name="com.ptc.arbortext.pe.service/stylesheet">techinfomap.xsl
</worker>

The table also provides information about which parameters or publishing rule are overridden or take in account the change in their value during Incremental Publish.

Parameter Name

Output

Description

Overriddable(supports change of value during Incremental Publish)

applicabilitySyntax

PDF

XML bundle

Using XSL

Specify the name of applicability syntax used for applicability expressions in the payload. Specify the name registered on the Arbortext Publishing Engine server. There is no default.

for more information on applicability, see Inline Applicability in Publishing.

artifactDirectory

HTML

PDF

XML bundle

Using XSL

Specify the directory where zipped copies of the payload artifacts created during publishing are saved for troubleshooting.

The directory must be a valid, writable directory on the Arbortext Publishing Engine server.

Yes

disableInlineApplic Filtering

PDF

Using XSL

Specify whether to enable filtering based on inline applicability expressions for PDF and Using XSL outputs. Specify true (the default) to disable inline applicability, or specify false to enable it.

disableStructure ApplicabilityConverter

HTML

PDF

XML bundle

Using XSL

Specify whether applicability expressions found in structures and auxiliary collection files are converted.

The default is false for bundle output. In that case, the conversion is controlled by the structureSourceApplicSyntaxstructureTargetApplicSyntax

For PDF publishing, this parameter defaults to true.

enableChecksumOnMetadata

XML Bundle

Specify a checksum value to track any change in attribute or service effectivity of a referenced part. The default, true, adds a checksum value when an attribute or service effectivity is altered for a part.

htmlLogVerbosityLevel

HTML

PDF

XML bundle

Using XSL

Specify the level of messages included in the HTML version of the event log returned to WVS. Messages. The messages at the specified level and higher are included in the log. Values are info, warning, error, or fatal. If this parameter is not specified or has an invalid value, the default is warning.

All messages are always included in the XML version of the log also returned to WVS.

Yes

includeMilestoneTimes InHtmlLog

HTML

PDF

XML bundle

Using XSL

Specify whether to include event timing information for publishing milestone activities in the HTML version of the event log returned to WVS. Each milestone entry contains the time for completion of the activity.

This log is also available from the Transaction Archive on the Arbortext Publishing Engine server. A list of the milestone activities follows this table.

Yes

reportMore Applicability ParseErrors

PDF

Using XSL

Specify whether to report additional applicability expression problems for inline applicability before failing. The default, false, causes publishing to fail immediately after finding the first problematic expression. Set to true to collect as many applicability expression problems as possible before failing the publishing job.

resultBaseName

HTML

PDF

XML bundle

Using XSL

Specify the string that defines the base file name for a representation. The string can contain one or more string substitution patterns called a key, which is evaluated during publishing and replaced with the substituted value. The keys can represent WVS substitution keys, Service Worker parameters, and attributes for the root of the service structure being published.

The default is to use the root object ID as the base name for PDF and XSL outputs or the root object ID and the pubstructXsl stylesheet name for bundles.

Specify a key using the form {key}, where key is a WVS substitution key, a Service Worker parameter (that starts with com.ptc.arbortext), or the name of an attribute on the root of a service structure attribute (such as name, number, or state). A parameter value example:

{name}_myrep_
{EPM_NUMBER}_{state}

WVS substitution keys that you can supply for {key} are:

• EPM_NAME – Name of the document being published.

• EPM_NUMBER – Number of the document being published.

• EPM_TYPE – The document's subtype.

• AUTHORING_APP – The document's Authoring Application.

• OUTPUT_TYPE – The type of output to be produced.

• PARAM_SET_NAME – Name of the param-set in the publishing rule being published.

If the {key} is a worker parameter name that is not defined in the publishing rules (or in pubspec.xml), the default value for that parameter is used.

This parameter does not define the file extension (for pubspec.xml), the default value for that parameter is used.

This parameter does not define the file extension for the output file. Also, if a representation contains a PDF, the PDF inside the representation is not affected.

If the {key} is an attribute of a root part being published, then the attribute must be configured in manifest_attset.xml to appear in the manifest.xml file of the payload.

For more information, see Defining Attribute Sets.

Yes

rootApplicability Expression

PDF

Using XSL

Specify an applicability expression to apply to the service structure and content during publishing. The expression syntax must match the syntax found in the structure and XML textual content.

Publishing applies filters to the publication structure and to its dynamic documents. You can create a filter using the Filter action set on the toolbar for the service structure, and save it to make it available for future publishing jobs. However, the rootApplicabilityExpression publishing rule parameter overwrites the filter.

When this value is not specified, the value is derived from the filter the user set using the Filter action set.

The XSL transformation stylesheet needs to include the applicability expression so it gets copied to the DITA map.

for more information on applicability, see Applicability in Publishing.

Service application information is in Customizing Windchill Service Information Manager and Windchill Service Parts.

structureSource ApplicSyntax

HTML

PDF

XML bundle

Using XSL

Specify the name of the source applicability syntax used for applicability expressions in the service structure, parts lists, and other collected files. Specify the name registered on the Arbortext Publishing Engine server. If not specified, the value of applicabilitySyntax is used. If applicabilitySyntax is not specified, the default is ATO.

for more information on applicability, see Applicability in Publishing.

structureTarget ApplicSyntax

HTML

PDF

XML bundle

Using XSL

Specify the name of the target applicability syntax to be applied during publishing for applicability expressions in the service structure, parts lists, and other collected files. Specify the name registered on the Arbortext Publishing Engine server. If not specified, the value of applicabilitySyntax is used. If applicabilitySyntax is not specified, the default is APEX for bundle output and ATO for the other output types.

for more information on applicability, see Inline Applicability in Publishing.

stylesheet

HTML

PDF

XML bundle

Using XSL

Specify the stylesheet for bundle or publication used to style the output. You can specify a stylesheet using an absolute path or a name.

The XSL stylesheet must be stored in either the Arbortext Editor install folder, APTCUSTOM folder, or the APTAPPLICATION folder.

A name is resolved using the catalog path for the document type on the Arbortext Publishing Engine server matching the document type of the topics being published.

See Arbortext Editor and Publishing Engine documentation for information about document types and stylesheets.

If the topic has a stylesheet association processing instruction, it is ignored.

useRestricted TransactionArchive

PDF

XML bundle

Using XSL

Specify whether to use the alternate location of the transaction archive. Specify 1 to use the alternate transaction archive.

The alternate transaction archive allows transactions containing sensitive information to be stored in a location accessible only by permission. Transaction archives are configured on the Arbortext Publishing Engine server. Refer to documentation for Arbortext Publishing Engine in Configuring Arbortext Publishing Engine.

Yes

usingxsl.destination

Using XSL

Specify the location where the output of XSL publishing is placed. Specify an absolute path to a writable folder accessible from Arbortext Publishing Engine. If the folder conflicts with an existing directory, it is overwritten.

Yes

usingxsl.stylesheet

Using XSL

Specify the .xsl stylesheet to use during publishing XSL. This stylesheet expects a source document with a document type that matches the output of the pubstructXsl transformation or a Resolved Document for Styling (RDS).

The XSL stylesheet must be stored in either the Arbortext Editor install folder, APTCUSTOM folder, or the APTAPPLICATION folder.

The output is placed at the location specified by usingxsl.destination. Only the composer log and a manifest with information about the publishing job are returned to Windchill.

To customize XSL output, use a publishing rule for the publishing subsystem. For example, to prevent href attributes from being changed to local paths (from WC URI paths), add the following publishing rule:

com.ptc.arbortext.
pe.publish
/dontModifyHref=yes

XSL output is a feature supported by Arbortext Editor and Publishing Engine.

variable:compose:: debug

HTML

PDF

XML bundle

Using XSL

Specify either 1, true, or on to increase the amount of information logged to the composer log during a publishing request.

By default, error and warning information messages are placed in the composer event log.

In addition, atitrace.exe can be launched on Arbortext Publishing Engine and debugging output sent to that window, capturing low-level trace information. This action would be performed by an Arbortext Publishing Engine administrator.

Yes

variable:_sis:: archiveTransaction

HTML

PDF

XML bundle

Using XSL

Specify whether to use the transaction archive to store publishing artifacts on the Arbortext Publishing Engine server. Specify 1 to archive the transaction. The default 0 does not archive the transaction, but the configuration on the Arbortext Publishing Engine server may archive it anyway.

Yes

For more information on applicability expressions, please see Applicability in Publishing.

The milestone activities reported by includeMilestoneTimesInHtmlLog include:

Milestone	Activity
Payload extraction complete	The time to unzip the payload into a temporary directory on the Arbortext Publishing Engine server.
Pre-service subsystem processing complete	Processing the values in the configuration file pubspec.xml, determining the adapter setup, and other pre-processing activities.
Service subsystem complete	The pipeline configuration file Service.ccf has executed and the publication structure and its content are transformed.
Publish subsystem complete	Publishing subsystem has executed. The activities are determined by what type of publishing is being performed.
Bundle subsystem complete	Included if a bundle is being published. Covers the time to generate the remaining bundle content, package it, and place it in its destination location.

The following com.ptc.arbortext.pe.bundle subsystem parameters control the behavior of the Arbortext Publishing Engine server bundle output processing. You can specify an optional type and a parameter name to specify the parameter after the forward slash /.

Parameter Name

Output

Description

Overridable(supports change of value during Incremental Publish)

altDestination

XML bundle

Specify the alternate directory where Arbortext Publishing Engine places the bundle. This location is compatible with the Windchill server OS, and is specified as a mount point, UNC path, or by a mounted drive letter. For example:

/local/mnt/bundles

Yes

boilerplate

XML bundle

Specify the name of a boilerplate zip file for a bundle that is extracted to the destination directory.

The path to the boilerplate file is determined by searching the set libpath specification on the Arbortext Publishing Engine server. The file needs to have read permission and be named the same name as the value of this parameter. The default is boilerplate.zip.

bundleName

XML bundle

Specify a name for the bundle subdirectory where generated bundles will be placed. The name is appended with _timestamp. The default value is bundle.

The bundle subdirectories are placed in the directory specified by the destination parameter.

Bundle name characters can be numerals, letters, and some special characters such as . (period), - (dash), and _ (underscore). Characters that are not supported, such as \ / : * ? " < > |, are escaped with the appropriate %xx HEX value.

Left and right single and double quotation marks are not supported and will be escaped using a %xx HEX value.

Yes

destination

XML bundle

Specify the directory where Arbortext Publishing Engine places bundle output. This location is on the Arbortext Publishing Engine server, specified as a physical or mapped drive. The directory must be created beforehand. There is no default.

Specify bundleName to create subdirectories of this directory for bundles.

Yes

DMPmapSchema

XML bundle

Specify the path (either relative or absolute) to the schema you want to use for validation. The default value presumes a path relative to DMPmap\DMPmap.xsd.

Specifying a relative path will use the first location in the Arbortext Publishing Engine doctypes search path which includes the specified schema file.

If the schema is not found, the Arbortext Publishing Engine composer event log captures the error message, The DMPmapSchema parameter value that was specified appears in the message.

saveCopy

XML bundle

Specify whether to save bundle files in a zip file for troubleshooting. Specify true to enable. The default is false.

Specify a directory using the artifactDirectory parameter. The bundle file name is constructed from the value of saveCopyName.

Yes

saveCopyName

XML bundle

Specify a base file name for bundle files. The base name is appended with _timestamp.zip.

The default value is bundle_saveCopy.

The files are placed in the directory specified by the artifactDirectory parameter.

Base name characters can be numerals, letters, and some special characters such as . (period), - (dash), and _ (underscore). Other characters, such as those not supported in Windows file names (\ / : * ? " < > |), are replaced with the appropriate % hex value.

Left and right single and double quotation marks are not supported.

Yes

validate

XML bundle

Specify whether to validate the DMPmap.xml against a schema specified by the DMPmapSchema parameter. DMPmap.xml is the file produced by a bundle publishing request.

Specify yes to validate. The default is no.

If set to yes, publishing fails if the output can’t be validated.

The default DMPmap.xsl stylesheet produces a DMPmap.xml that does not validate against the default DMPmap\DMPmap.xsd.

The Arbortext Publishing Engine composer event log captures the error message, and it contains the absolute path to the schema that was used for validation

If validation passes, an INFO message appears in the event log confirming validation passed and containing the absolute path to the schema.

The following com.ptc.arbortext.pe.service subsystem parameters control the behavior of the Arbortext Publishing Engine server service application processing. You can specify an optional type and a parameter name to specify the parameter after the forward slash /.

Parameter Name

Output

Description

Overridable(supports change of value during Incremental Publish)

contentMetadaTokens

HTML

PDF

XML bundle

Using XSL

Specify which metadata token values are copied from the manifest into the publication structure markup. Specify a list of metadata token values separated by commas. The wildcard character *, the default, means include all. An empty value or - means to supply none. This parameter only supports publication structures with a version of 2.0 or greater.

disableStructureTitleAndDescriptionCreator

PDF

Specify whether the service application restores Title and Description elements to the publication structure. When set to false, the service application will insert Title and Description elements in the publication structure if they are not already present. When set to true (the default), no changes are made.

graphicTransform

XML bundle

Specify the graphic conversions that are applied to graphics referenced from dynamic documents and parts lists. Each conversion rule takes the form:

graphic-type,
graphic-type,...
:target-type,
target-type,...
[|...]

Where graphic-type and target-type are graphic file extensions.

Separate multiple specifications with a vertical bar |.

The default value is:

tif,drw,eps,svg:png,-

Each graphic-type is converted to each target-type.

For graphic-type, the * wildcard matches all file formats, and the + symbol matches web-friendly formats.

For target-type, specify the - exclusion character if you don’t want to convert the graphic file.

In the following example, all web-friendly formats are simply copied to the payload, and then all remaining graphic formats are converted to the JPG format.

+:-|*:jpg

If there is no conversion rule for a graphic type, it is not converted. Conversions are processed in order, so wildcard characters must be used after other specifications. For example, in *:-|tif:jpg, the wildcard overrides the graphic type in the second conversion rule and makes the entire specification equivalent to *:-. In this case, all graphics are copied and no conversions would be performed.

The default value is applied in the Service application pubspec.xml file.

For information on graphic formats, refer to Graphic File Formats and Media Objects and Graphic Conversion Support.

You can specify how to handle parts list graphic conversions in bundles using the set of transformImage parameters.

Yes

Outputclass

HTML

PDF

XML bundle

Using XSL

Specify the value of the outputclass attribute to the root node in the output DITA map. It is used by the XSL transformation stylesheet.

partlistBundleCcfParam. convertAttachments

XML bundle

Specify whether parts list graphic attachments must be converted. Set to true, the default, to convert parts list graphic attachments. Set to false to keep parts list image attachments in their native format.

Graphic conversions use the graphicTransform parameter for default values.

Yes

partlistBundleCcfParam. partMetadataTokens

XML bundle

Specify which part metadata token values are copied from the referenced parts file into the parts list markup. Specify a list of metadata token values separated by commas. The default value is number,orgName,servicekit,name.

The wildcard character * means include all. An empty value or - means supply none. This parameter only supports parts lists with a version of 2.0 or greater.

The list of all the available part metadata token values: name,number,orgName,ServiceEffectivity,LogicalExpression,beginSerialNumberRange,endSerialNumberRange,beginDateRange,endDateRange,effTarget,effContextReference,serviceable.

Yes

partlistBundleCcfParam. sbomMetadataTokens

XML bundle

Specify which SBOM metadata token values are copied from the referenced parts file into the parts list markup. Specify a list of metadata token values separated by commas. The default value is number,orgName,servicekit,name.

The wildcard character * means include all. An empty value or -means supply none. This parameter only supports parts lists with a version of 2.0 or greater.

The list of all the available SBOM metadata token values:name,number,orgName,servicekit,ServiceEffectivity,LogicalExpression,beginSerialNumberRange,endSerialNumberRange,beginDateRange,endDateRange,effTarget,effContextReference,serviceable.

Yes

partlistBundleCcfParam. transformImage

XML bundle

Specify whether parts list images must be transformed. If set to true, parts list graphics can be transformed according to the value of transformImageTypes. Set to false, the default, to use the values specified by graphicTransform instead.

This parameter does not affect graphic references in dynamic documents, which use the graphicTransform parameter.

Yes

partlistBundleCcfParam. transformImageTypes

XML bundle

Specify the types of primary images in a parts list to transform from the original source, along with associated attachment types for each primary. The default value is *, which means every IMAGE element is processed and could possibly be transformed into one or more additional IMAGE elements.

Specify primary file extensions or *, followed by an optional colon : and a comma separated list of attachment file extensions. Multiple specifications are separated by the vertical bar |.

The syntax follows:

primary_ext:
attach_ext
[|primary_ext:
attach_ext]

primary_ext can be * or one or more file extensions separated by commas.

attach_ext is one or more file extensions separated by commas.

For example:

png,tif:imap|cgm|ldf

If the specified primary types match multiple source types, the first one found is used as the primary type and the remaining ones are ignored.For example, if you only want one raster format, you prefer png to tif, and you also want to include an imap attachment if possible, then you would specify png,tif:imap.

Other examples:

png:imap|*

jpg:tif|png|gif|eps|
svg|tif|bmp

This parameter does not affect graphics referenced from dynamic documents, which use the graphicTransform parameter.

You must specify supported graphic conversion formats. For information on graphic formats, refer to Graphic File Formats and Media Objects and Graphic Conversion Support.

Yes

partlistBundleCcfParam. transformImage AllowedConversions

XML bundle

Specify a list of allowed output graphic formats and their associated source formats for parts list images. Specify as follows:

output1:
source1,source2

Multiple specifications are separated with a vertical bar |.

For example:

png:tif,cgm|
jpg:tif,pvz

The graphic conversions are performed in the order the source formats are specified. The specified output formats are converted from the source in the order in which the output formats are listed.

For example, if png:tif,cgm is specified, PNG graphics are generated from TIFF source graphics first, then CGM graphics. If no TIFF or CGM source graphics exist, then no PNG graphics are generated.

If this parameter is not set, the default behavior is to convert graphic to all supported outputs.

For information on graphic formats, refer to Graphic File Formats and Media Objects and Graphic Conversion Support.

Yes

partlistBundleCcfParam. transformImage DisableConversions

XML bundle

Specify whether to disable parts list image conversions. If set to true, parts list graphic conversions are disabled. Graphics will be included only if they are primary or secondary content.

If set to false, the default, the default, graphic conversions are permitted. The conversions use the specification of the transformImageAllowedConversions parameter.

Yes

partlistStylesheet

HTML

PDF

XML bundle

Using XSL

Specify the XSL stylesheet that Arbortext Publishing Engine will use to transform the generic XML form of a parts list into a document type compatible with the document type for com.ptc.arbortext.pe/stylesheet.

The XSL stylesheet must be stored in either the Arbortext Editor install folder, APTCUSTOM folder, or the APTAPPLICATION folder.

You can specify the name or absolute path on Arbortext Publishing Engine server to the stylesheet. A name is resolved using the catalog path for document type directories on the Arbortext Publishing Engine server. By default, it looks for the Service application partlist document type.

pubstructXsl

HTML

PDF

XML bundle

Using XSL

Specify the XSL stylesheet that Arbortext Publishing Engine will use to transform the generic XML form of a service structure into a document type compatible with the document type for com.ptc.arbortext.pe/stylesheet.

The XSL stylesheet must be stored in either the Arbortext Editor install folder, APTCUSTOM folder, or the APTAPPLICATION folder.

You can specify the name or absolute path on the Arbortext Publishing Engine server to the stylesheet. A name is resolved using the catalog path for document type directories on the Arbortext Publishing Engine server. By default, it looks for the Service application pubstruct document type.

For PDF or using XSL, this stylesheet should transform a publication structure into a document type that can be published. For bundle output, the stylesheet should transform the service structure into the format expected by Arbortext Content Delivery (DMPmap).

suppressPipeline InfoMessages

HTML

PDF

XML bundle

Using XSL

Specify whether to log messages from the service pipeline that are INFO level and below (such as TRACE or DEBUG). Fatal, error, and warning messages are still included.

Specify true, the default, to suppress logging verbose pipeline messages. Specify false to permit logging verbose pipeline messages.

Specifying false can have significant impact on performance. Use it only for troubleshooting, and create a smaller test case if necessary.

When compose::verbose variable is set to any value, this parameter is ignored.

Yes

topicCCfParam. disableApplicability Converter

XML bundle

Specify whether to find and convert applicability expressions in a topic. Specify false, the default, to enable applicability conversion. Specify true to disable applicability conversion.

Use topicCcfParam.SourceApplicabilitySyntax and topicCcfParam.TargetApplicabilitySyntax to define the expressions.

topicCCfParam. sourceApplicability Syntax

XML bundle

Specify the name of the applicability syntax used for applicability expressions inside topics in the bundle. Specify the name registered on the Arbortext Publishing Engine server. If not specified, the value of applicabilitySyntax is used. If applicabilitySyntax is not specified, the default is ATO.

topicCCfParam. targetApplicability Syntax

XML bundle

Specify the name of the applicability syntax used for applicability expressions inside topics after the service subsystem has finished processing. Specify the name registered on the Arbortext Publishing Engine server. If not specified, the value of applicabilitySyntax is used. If applicabilitySyntax is not specified, the default is APEX.

topicCCfParam. disableMetadata Replacer

XML Bundle

Specify whether information element metadata replacement is disabled for XML topics. The parameter controls whether information element content is replaced with values from the metadata found in the XML topic during bundle publishing. Specify false to enable metadata replacement. Specify true, the default, to disable metadata replacement.

topicCCfParam. disableProfiling Converter

XML Bundle

Specify whether profiling conversion is disabled for XML topics. The parameter controls whether profiling markup in XML topics is converted during bundle publishing. Specify false to enable profiling conversion. Specify true, the default, to disable profiling conversion.

The profiling attribute is specified by topicCCfParam.profilingAttribute.

topicCCfParam. profilingAttribute

XML Bundle

Specify the attribute to use for profiling filtering. Specify either the local localName for the attribute or the URI specifying the namespace and the local name ({uriNamespace}localName).

The default creates the applic attribute from the following:

{http://arbortext.ptc.com/namespace
/applicability/profiling}applic

topicCCfParam. removeProfilingMarkup

XML Bundle

Specify whether profiling markup is removed from XML topics. The parameter controls whether profiling markup in XML topics is removed during publishing. Specify trueto remove profiling markup in XML topics. Specify false, the default, to keep profiling markup.

The profiling attribute is specified by topicCCfParam.profilingAttribute.

The following com.ptc.arbortext.pe.publish subsystem parameters control the behavior of theArbortext Publishing Engine server publishing subsystem processing. You can specify an optional type and a parameter name to specify the parameter after the forward slash /.

Parameter Name	Output	Description
APPConfigFile	PDF	Specify an APP configuration file (.3sppdf) if you want to produce PDF using APP. Specify the absolute path to the file on the Arbortext Publishing Engine server.

The following com.ptc.arbortext.inservice.all subsystem parameters control the behavior of Arbortext Content Delivery when handling bundles.

Parameter Name	Output	Description
Language	XML Bundle	Specify the language code or locale of the content being published. By default, the value is derived from the com.ptc.arbortext.wvs/language parameter.
Bundle-Source	XML Bundle	Specify the property value for mapping a subtype of the service structure for Arbortext Content Delivery. The default is the orgName root property value of the service structure. Only a single value is valid; multiple values are not supported.

Examples

In a publishing rule, you can specify something like the following for a bundle:

<param-set name="ServiceBundleRule">
<worker name="com.ptc.arbortext.pe/stylesheet">techinfo.style</worker>
<worker name="com.ptc.arbortext.pe.service/pubstructXsl">DMPmap.xsl</worker>
<worker name="com.ptc.arbortext.wvs/PreferAdapter">no</worker>
<worker name="com.ptc.arbortext.wvs/IncludeContentMetadata">yes</worker>
<worker name="com.ptc.arbortext.pe.bundle/destination">
D:\ptc\bundlepath</worker>
</param-set>

In a publishing rule, you can specify something like the following for a PDF:

<param-set name="PDFPublishingRule">
<worker name="com.ptc.arbortext.pe/stylesheet">techinfo.style</worker>
<worker name="com.ptc.arbortext.pe.service/stylesheet">techinfomap.xsl
</worker>
<worker name="com.ptc.arbortext.wvs/PreferAdapter">yes</worker>
<worker name="com.ptc.arbortext.wvs/IncludeContentMetadata">yes</worker>
<post-publish name="delegate">com.ptc.wvs.server.publish.
DDPostPublishDelegate</post-publish>
<post-publish name="name">{EPM_NAME}.{OUTPUT_TYPE}</post-publish>
<post-publish name="folder">Published</post-publish>
<post-publish name="published-content-link">create</post-publish>
</param-set>

In a publishing rule, you can specify something like the following for HTML:

<param-set name="html">
<worker name="com.ptc.arbortext.pe/stylesheet">techinfo.style</worker>
<worker name="com.ptc.arbortext.pe.service/pubstructXsl">techinfomap.xsl
</worker>
<worker name="com.ptc.arbortext.pe/includeMilestoneTimesInHtmlLog">yes
</worker>
<worker name="com.ptc.arbortext.wvs/PreferAdapter">no</worker>
<worker name="com.ptc.arbortext.wvs/IncludeContentMetadata">yes</worker>
</param-set>

For troubleshooting purposes, you could add something like the following to a publishing rule param-set:

<worker name="com.ptc.arbortext.pe/artifactDirectory">
D:\ptc\bundle_debug</worker>
<worker name="com.ptc.arbortext.pe.bundle/saveCopy">
true</worker>
<worker name="com.ptc.arbortext.pe.bundle/saveCopyName">
bundle_debug</worker>

The sample publishing rule file contains examples for Windchill Service Information Manager and Windchill Service Parts.

SamplePublishingRules.xml file is located in:

Windchill-path\codebase\com\ptc\arbortext\windchill\worker

Look for the SIS Publishing Rules section with the heading:

Some rules specify the EPUB output type, which is not yet supported and is noted as such in the comments. These rules are included as a technology preview for non-production use.

Was this helpful?