Please ensure Javascript is enabled for purposes of website accessibility
Powered by Zoomin Software. For more details please contactZoomin

AVEVA™ Work Tasks

TABLE OF CONTENTS

Create-Open-Office-Document Activity

Save PDF
Save selected topicSave selected topic and subtopicsSave all topics
Share
Share to emailCopy topic URL
  • Last UpdatedJul 01, 2024
  • 3 minute read

Activity Description

You can create Microsoft 2010 Word and Microsoft 2013 Word documents from the workflow using the Create-Office-Document activity. When you include this activity in the workflow, the activity uses the selected template and creates a new document in the specified location with the relevant data.

Creating MS Office Templates

Steps to create an MS Word template

  1. Open a new Word document, and save it with a relevant name.

  2. Enter the required field names for each insert placeholders as shown below.

    1. Drop down the 'Insert' menu and click the 'Fields' option.

    2. In the 'insert fields' window, select 'MergeField' option from the 'Field names' list box.

    3. Enter a name for the new field and click 'OK'.

    Note: Create a merge field name without spaces in between.

  3. The new fields are displayed along with the corresponding placeholders enclosed in double chevrons. The new names will be displayed as placeholders in the window corresponding to the 'SelectTemplate' property. These placeholders will be replaced by the actual values during execution of the workflow.

Workflow Variable for capturing Document Path

Create Office Document stores p hysical path information of the document in a variable of type string with the following syntax:

'^'+CurrentActivity.Name+'DocumentPath'

For example, ^CreateFileDocumentPath.

Activity Properties

The Create-Open-Office-Document activity has to be configured by specifying appropriate values for the different properties in the Activity Properties area. The Activity Properties can be accessed by clicking the Activity Properties tool in the Tool Bar or by selecting the appropriate option from the right click menu for the Create-Open-Office-Document activity. The Activity Properties are organized under the following groups of related properties. The properties under each group are described in this topic.

Name & Description

The properties in the Name & Description group have been described below. You can use these properties to specify the name and description for the activity.

Name - This property can be used to specify a name for the activity.

Property Type: Optional (This property needs to be set only if necessary.)

Description - This property specifies a brief description to be displayed for the activity.

Property Type: Optional (This property needs to be set only if necessary.)

Configuration

The properties in the Configuration group have been described below. You can use these properties to configure the functionality of the activity.

Document Name - This property specifies the name of the new document.

Property Type: Mandatory (This property must be set if the activity is to be executed.)

Destination Details - This property specifies the details of the destination in which the document should be created such as the file path, the user name and password to access the document among others.

Property Type: Mandatory (This property must be set if the activity is to be executed.)

Steps to set the Destination Details property

  1. To specify the details of the destination in which to create the new document, click on the button for the 'Destination Details' property to open the property window.

  2. In this window, specify the protocol for the file transfer, for example, FTP-HTTP in the Protocol field.

  3. Then specify the location; the pattern to use for the transfer, for example, .DOC; the User Name, Password, Domain Name, and Port Number in the respective fields.

  4. After specifying all the details, click Submit to save the settings.

    See Create-Open-Office-Document: Destination Details for a detailed description of the Destination Details property window.

    Select Template - This property specifies the template to be used for creating the document.

    Property Type: Mandatory (This property must be set if the activity is to be executed.)

    Steps to set the Select Template property

    1. To select the template for creating the document, click on the button for the 'Select Template' property to open the property window.

    2. In this window, specify the user name, password, and domain name in the respective fields.

    3. After providing the credentials click Browse and browse to the location of the template.

    4. Select the template file and click Import.

    5. To specify the values to the placeholders, select the placeholder and select the type of value (Value, Variable, XML Variable or Content) from the drop down. Then assign the value by selecting the appropriate option from the second drop down or in case you had selected the "Value" option in the first drop down enter the value in the field that is displayed here.

    6. After choosing the values for the placeholders, click Submit.

      See Create-Open-Office-Document: Select Template for a detailed description of the Select Template property window.

      Activity outputs

      The Create-Open-Office-Document Activity does not return any value.

      Exception Behavior

      Each activity has the Raise Error on Unhandled Linked Output property on click of which, it shows all the default configured mapped error outputs in red with their check boxes selected.

      See Mapped Error Outputs for more details.

      In This Topic
      TitleResults for “How to create a CRG?”Also Available in