Class Ecrion::Ultrascale::ServerDocumentTemplate

Top Previous Topic Next Topic  Print this topic

ServerDocumentTemplate represents a XSL or XFD template installed in a remote instance of XF Rendering Server. In this scenario, the client sends the XML and a template unique ID to the server which does all the work and returns the PDF output.

 

See Managing Server Templates for a guide on how to deploy server templates.

 

ServerDocumentTemplateProcessFlow(CPP)

For more information about local vs. server templates see also Choosing between Local and Server Templates.

 

Members/Properties

 

Name

Description

templateID

A string that uniquely identifies a server template.

xsltParameters

Represents the parameters transmitted to xslt engine. Inherited from ecrion.ultrascale.DocumentTemplate.

languageID

Specifies the language used for XFD translations. Inherited from ecrion.ultrascale.DocumentTemplate.

 

Methods

 

Name

Description

ServerDocumentTemplate

Creates a new instance of a server template using the template identifier.

ServerDocumentTemplate

Creates a new instance of a server template using the template identifier and a set of parameters.

ServerDocumentTemplate

Creates a new instance of a server template using the template identifier, a set of parameters and a language identifier.

 

ServerDocumentTemplate

Creates a new instance of a server template using the template identifier.

 

 

ServerDocumentTemplate(Ecrion::String serverTemplateId);

 

                       

Parameters

 

serverTemplateId

       The template ID configured in the XF Management Console on the server.

 

ServerDocumentTemplate

Creates a new instance of a server template using the template identifier and a set of parameters.

 

 

ServerDocumentTemplate(Ecrion::String serverTemplateId, Ecrion::String parameters);

 

                       

Parameters

 

serverTemplateId

       The template ID configured in the XF Management Console on the server.

parameters

       Pairs of key/values that must be used during the transformation.

 

ServerDocumentTemplate

Creates a new instance of a server template using the template identifier, a set of parameters and a language identifier.

 

 

ServerDocumentTemplate(Ecrion::String serverTemplateId, Ecrion::String parameters, Ecrion::String languageId);

 

                       

Parameters

 

serverTemplateId

       The template ID configured in the XF Management Console on the server.

parameters

       Pairs of key/values that must be used during the transformation.

languageId

       When the template is an XFD (XF Designer) layout template, this parameter specifies the language used for translations.

 

 

templateID

A string that uniquely identifies a server template. It must be specified as "applicationname:templatename" where template name includes the file extension (usually xfd, xsl, xslt).

 

 

Ecrion::String templateID

 

 

xsltParameters

The parameters transmitted to XSLT engine. Inherited from Ecrion::Ultrascale::DocumentTemplate.

 

 

Ecrion::String xsltParameters

 

 

languageID

Specifies the language used for XFD translations.  Inherited from Ecrion::Ultrascale::DocumentTemplate.

 

 

Ecrion::String languageID