Printing template

From VYRE

Jump to: navigation, search

Printing Templates extend the functionality already present in content templates. Everything that can be done in content templates can also be done in printing templates. However, there are also a number of new features that have been especially designed for Wave 2 integration. These come in the form of 3 new tags specific to this this type of template. To enable or access printing templates you will need a Wave2 license.

Contents

The Unify "VYRE Printing Item" tag library

<%@ taglib uri="http://www.vyre.com/taglibs/vyre-printing-item-1.0" prefix="vyre-printing" %>

vyre-printing:layout-definition

The layout-definition tag is used when the printing template is used within a Configure Document Portlet (e.g. it is used for creating template items). This tag is used to create the interface that is used for creating the interface that end users see when kicking off a Wave 2 job.

  • assetStoreId - This is the ID of the store that assets which will be used to populate Wave 2 templates are allowed to come from.
  • assetStoreFileServiceId - This the ID of the file service which will be used when generating Wave 2 documents.
  • ajaxGatewayId - This is the ID of the Content Gateway that all AJAX requests should use.
  • assetXslId - The ID of the XSL that should be used to render the assets that can be used in the template
  • textXslId - The ID of the XSL that should be used to render the text items that can be used in the template

In addition to these attributes, it is also possible to define which text stores and attributes it is possible to use when allowing people to pick possible attributes to populate a text field on a template with. This is done by placing XML within the layout-definition tag:


<vyre-printing:layout-definition assetStoreId="63" assetStoreFileServiceId="original" ajaxGatewayId="1" assetXslId="931" textXslId="931" >
		<configuration>
		    <text-stores>
		        <store id="156" name="Store 5">
		            <attributes>
		                <attribute id="name" name="Name" xmlMapping="name" isMetadata="true"></attribute>
		                <attribute id="description" name="Description" xmlMapping="description" isMetadata="true"></attribute>
		            </attributes>
		        </store>
                        <store id="94" name="Store 3">
		            <attributes>
		                <attribute id="name" name="Name" xmlMapping="name" isMetadata="true"></attribute>
		                <attribute id="description" name="Description" xmlMapping="description" isMetadata="true"></attribute>
		                <attribute id="218" name="Legal Requirements" xmlMapping="legal" isMetadata="false"></attribute>
 
		            </attributes>
		        </store>
		    </text-stores>
		</configuration>
	</vyre-printing:layout-definition>


vyre-printing:file

This should be present in all printing templates. This tag is used to tell Unify that the binary items for file stores will not be uploaded. When using Wave 2, Unify deals with the binary files and the user does not know anything about them.

  • updateDerivedFiles - (Default is false) whether or not derived files should be created. This will normally be false.


vyre-printing:layout-display

The layout-display tag is used when the printing template is used within a Job Portlet (e.g. it is used to generate output from Wave 2). This tag will display the interface defined in the template item

  • xslId - the Id of the XSL that should be used to render the interface
  • xslName - the name of the XSL that should be used to render the interface

Javascript Framework

Personal tools