Create a consolidated PDF rendition object - HxGN SDx - Update 64 - Administration & Configuration

Administration and Configuration of HxGN SDx

Language
English
Product
HxGN SDx
Search by Category
Administration & Configuration
SmartPlant Foundation / SDx Version
10

Why is a consolidated PDF rendition created?

A consolidated PDF rendition includes PDFs of all the documents and files attached to a workflow. This improves the readability of the complete workflow for a recipient.

Consolidated PDF rendition

The maintenance planning workflow automatically creates a consolidated PDF rendition object in the document review process for all the files attached to each document of the workflow. The consolidated PDF is generated after the document has been consolidated and contractually approved, but before it is sent to the recipient.

Process step class

This process step class can be used on a maintenance planning workflow object to generate the consolidated PDF rendition. The arguments define what the workflow does when a workflow document object is generated as a consolidated PDF rendition.

Process class name: SDACreateDocConsolidatedPDFRendition

Syntax: SDACreateDocConsolidatedPDFRendition,Arg1,Arg2,Arg3,Arg4,Arg5,Arg6,Arg7,Arg8,Arg9,Arg10,Arg11,Arg12.

Example:

SDACreateDocConsolidatedPDFRendition,SDAMaintenancePlanningDocAllFilesGraph,FT_pdf, &Obj->SPFFileComposition_12.Name&,True,True,True,CurrentDate,True,,False,,-SDAWorkPackageMarkupFiles

Where:

Arguments

Definitions

Arg1

The graph definition from documents to all files.

Arg2

The expression to order files (Optional).

Arg3

The expression for bookmark (Optional).

Arg4

Do not include markups (Optional).

Arg5

Do not include references (Optional).

Arg6

Include labels (Optional).

Arg7

Label name (Optional).

Arg8

Include watermark (Optional).

Arg9

Watermark name (Optional).

Arg10

Configure individual PDFs (Optional).

Arg11

DocumentRevisionType (Optional).

Arg12

The relationship definition from the source object to the markups (Optional).

For example, from the work package to the required markups.

The following examples show each type of the SDACreateConsolidatedDocPDFRendition process step:

Step definition class

<SPFStepDefClass>

<IObject UID="WSC_SDAGenerateMergePDFRendition" Name="SDAGenerateMergePDFRendition" Description="Generate merge PDF rendition to the files attached" ContainerID="SDA.ProjComsWPWF" />

<ISPFAdminItem />

<ISPFStepDefClass SPFProcessClassName="SDACreateDocConsolidatedPDFRendition,SDAMaintenancePlanningDocAllFilesGraph,FT_pdf,&amp;Obj-&gt;SPFFileComposition_12.Name&amp;,True,True,True,CurrentDate,True,,False,,-SDAWorkPackageMarkupFiles" />

</SPFStepDefClass>

Relationship between step definition class and type

<Rel>

<IObject UID="WSC_SDAGenerateMergePDFRendition.WST_P" ContainerID="SDA.ProjComsWPWF" />

<IRel UID1="WSC_SDAGenerateMergePDFRendition" DefUID="SPFStepClassStepType" UID2="WST_P" />

</Rel>

Step definition type

<SPFStepDefType>

<IObject UID="WST_P" Name="P" Description="Process" ContainerID="Core.Workflow_Admin" />

<ISPFStepDefType />

<ISPFAdminItem />

</SPFStepDefType>

Relationship between step definition and class

<Rel>

<IObject UID="STP_SDAGenerateMergePDFRendition.WSC_SDAGenerateMergePDFRendition" ContainerID="SDA.ProjComsWPWF" />

<IRel UID1="STP_SDAGenerateMergePDFRendition" DefUID="SPFStepDefStepClass" UID2="WSC_SDAGenerateMergePDFRendition" />

</Rel>

Step definition

<SPFStepDef>

<IObject UID="STP_SDAGenerateMergePDFRendition" Name="SDAGenerateMergePDFRendition" Description="Generate Merge PDF rendition to the files attached" ContainerID="SDA.ProjComsWPWF" />

<ISPFAdminItem />

<ISPFStepDef />

</SPFStepDef>