Configure a method to display the templates - 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

By default, files from template documents are added automatically to a newly-created document in the background. However, you can configure a create method for new documents so that any template documents for a specific classification appear in the Template Documents tab. When a template document is selected, any attached files are then displayed in the Template Files pane.

TemplateDoc_01

You can display the Template Documents tab by relating the selected create method to either the CreateClassObj client API or the CreateWizardClassObj client API, and then adding the template document classification syntax to the selected method argument. The syntax is based on the client API that created the method. The Template documents tab will then appear in the attach files part of the create document form.

What makes up the template document syntax?

The template document syntax to enable the display of the Template Documents tab is constructed using the following string:

TemplateclassificationUID~IsSingleSelection~IsRenameChkBoxEnabled.

Where:

  • TemplateclassificationUID is the UID classification type.

  • IsSingleSelection is for the a single document.

  • IsRenameChkBoxEnabled gives you the option to rename the files using the new document suffix. Selecting true means the option is selected by default. Selecting false means the option is not selected by default.

The syntax string is then added to the following arguments:

  • Argument 18 for methods created using the CreateClassObj client API.

  • Argument 9 for methods created using the CreateWizardClassObj client API.

Example syntax string

The FDWCreateDocument method is configured by default to display the Template Documents tab using the following string:

DC_Template_Documents_1~true~false.

This syntax was added to the method Argument 18, as the method was created using the CreateClassObj client API.

To display the Template Documents tab in the New Document form:

  1. Search for and select a create document type method.

  2. Define the template document syntax for the specific classification type.

  3. Add the syntax string to the applicable method argument:

    • Argument 18 for methods created using the CreateClassObj client API.

    • Argument 9 for methods created using the CreateWizardClassObj client API.

By default, methods created using either the create client APIs have the method argument left blank by design, so they do not show the Template Documents tab in the New Files page.

  • The Template Documents tab can be only be displayed by methods that use client APIs that support the File Attachment configuration (Parameter 6).