Payload and Manifest
The Payload Zip File
The payload file is a zip file sent from WVS to the Arbortext Publishing Engine server. The payload contains content and metadata that will be used to produce the desired output. The payload contents are determined by the type of published output requested, and whether the request is for a full publish job or an incremental publish job. Publishing can be launched from an information structure, a publication structure, or a product hierarchy.
A payload may have any of the following files in its file set, depending on the publishing request and the type of structure:
• manifest.xml
itemizes all the objects found in the payload. The entries represent an inventory of the contents of the payload file. The manifest also includes other information such as Windchill path to the publishing specification, server host name, creation date, output type, and the URI of the root structure.
• PublishInfo.xml
itemizes information related to the environment and system used to create the payload.
◦ payload version
◦ System output of Windchill version
◦ Release toggle
◦ Publish job specifications, including WVS publish job ID.
◦ Basic service structure information and attributes
In bundles, PublishInfo.xml also includes the bundle version, the Arbortext Publishing Engine version and the transaction ID.
The service structure attributes that are included in PublishInfo.xml can be configured in publishinfo_attset.xml.
• windchill.type.name directories
one or more directories that contain content, such as dynamic documents, from the structure. The name is formed from the Windchill type. There can be one or more of these directories.
• windchill.partlist.PartList directory
A directory that contains parts lists serialized in the partslist.xml generalized markup format.
• custom directory
A directory that contains custom artifacts from Windchill. Custom artifacts could be non-Windchill objects or objects that are not linked to a publication structure, an information structure, or a product hierarchy. The creation of this directory, adding custom artifacts to it, and adding the directory to the payload are controlled by the CustomArtifactProvider extension. For more information, see Advanced Customization of Publishing.
• Identfier.xml
is the root service structure serialized to an XML file in the generalized markup format sent by WVS. The Identfier is generated. This file is an XML document that represents the root structure to be processed.
In bundle publishing, the structure is identified by a URI, which is a fixed value regardless of language.
• ProductInstances.xml
contains the product instance information associated with the product hierarchy, if it exists, in serialized XML format.
ProductInstances.xml metadata attributes can be configured in the publishable_attset.xml.
The content elements in the ResourceMap information for an object in the payload contains a role attribute that indicates the role of the file. For instance, role = “THUMBNAIL_SMALL” for a file indicates that the file is the thumbnail for the object.
• reps
contains representations referenced by ResourceMap elements specified in various XML artifacts. The representations are not itemized in the payload manifest.
• pubspec.xml
contains the specifications for publishing from the selected WVS publishing rule, transformed to an XML format for use by the Arbortext Publishing Engine server. When a publishing rule is selected, its specifications are placed in the pubspec.xml and sent by WVS to Arbortext Publishing Engine.
Another pubspec.xml file exists on the Arbortext Publishing Engine server, usually within the Service application, which contains a set of default values for publishing parameters. A parameter value that is specified in the pubspec.xml sent from WVS overrides a default value, if one is set, in the file on the Arbortext Publishing Engine server. By default, the Service Application has a pubspec.xml file containing default values in the following location:
Arbortext-path\application\com.ptc.arbortext.service\lib\pubspec.xml
Should you wish to make changes to the default values in pubspec.xml on the server, save a backup copy of the file first before making changes.
• OptionsDefinition.xml
specifies the structure that is passed to the bundle.
If options sets are configured for profiling, the options definitions are included. For more information, see Applicability in Publishing.
• referencedObjects.xml
contains the metadata for referenced objects not included in the payload.
You can set custom set of attributes to include in referencedObjects_attset.xml.
• referencedParts.xml
contains the metadata of all parts referenced in the payload.
The content elements in the ResourceMap information for an object in the payload contains a role attribute that indicates the role of the file. For instance, role = “THUMBNAIL_SMALL” for a file indicates that the file is the thumbnail for the object.
• relatedParts.xml
contains the relationship between parts in a part list that are superseded by other parts or have alternative parts.
You can specify attributes to include by entering them in the publishable_attset.xml file. The entry needs to specify the list of attributes to publish for related parts.
For more information, see Defining Attribute Sets.
• classifications.xml
contains the names of Part classification categories used in the payload, their attributes, and their default values.
Classification child attributes are not controlled by publishable_attset.xml. You can exclude the primary classification attribute itself to exclude all the attributes associated with the classification (including child attributes). For more information, see Classifying Parts in Windchill.
• partThumbnails.zip
contains thumbnail graphic images of parts. The thumbnails are the default representation of each part that is referenced in the bundle with a role.
A part can have many thumbnails, and each thumbnail is identified by its role. The thumbnailRole publishing parameter can specify which role is included in the bundle.
You can also choose to specify which thumbnails to include using the parameter PartResources. The PartResources allow you more flexibility in specifying multiple thumbnail roles, as well as specify the components of a PVZ to be included.
Both parameters handle the special PVZ value. For thumbnailRole, the default representation is zipped into a PVZ file which is used as the thumbnail of the part. When the value is a role, the thumbnail matching the specified role is put in the partThumbnails.zip. For PartResources, you can specify multiple roles and PVZ components when used in combination with the PvzFilter parameter.
When both the thumbnail parameters are set, the contents of partThumbnails.zip are the product of processing both parameters.
• translation.xml
contains localizable metadata strings that are found during the publishing process. This file is copied to the bundle. The file contains a Targetelement for each target language of the payload (as specified in xml:lang). The Target element contains a Value element for each localizable attribute for each specified xml:lang. Localizable attributes are specified in localizable_attset.xml.
For more information, see Defining Attribute Sets.
• ContentMap.xml
contains the mapping of URIs to local content in the bundle. Each mapping includes the path to the .meta file, the path to the content, and the URI of the content. Paths are relative to the root of the bundle.
• relatedContexts.xml
contains product hierarchy information that is associated with a service structure in Windchill. The file contains information about the relationship between a service structure and one or more product hierarchy structures.
 |
A product hierarchy file is an individual file. This file is published from a product hierarchy bundle. The content elements in the ResourceMap information for an object in the payload contains a role attribute that indicates the role of the file. For instance, role = “THUMBNAIL_SMALL” for a file indicates that the file is the thumbnail for the object.
|
• SymptomTree.xml
contains the symptom values in a tree structure, that are authored using the Symptom Set document type. During a publishing process, only one SymptomTree.xml file is generated per Site per language.
A Symptom Set is published only if it is in a RELEASED state. If there are more than one Symptom Set in RELEASED state in Windchill server, then publishing of the bundle will fail. The ready state of Symptom Set can be configured by the com.ptc.arbortext.windchill.siscore.SKDSymptomsTreeReadyState property in the wt.properties file. The default value of this property is set to RELEASED.
You can configure some of the attributes that are to be included in the manifest, in the XLIFF sent for translation, for referenced objects, and for publishing. For more information, see Defining Attribute Sets.