Process Activities / Document tab
Parent topic: Document tab

Microsoft Word activity

An activity that creates or changes Microsoft Word document files (.doc or .docx) or PDF files from Word templates (.dot or .dotx files).



Configure the Microsoft Word activity

To configure the Microsoft Word activity, do the procedure in this topic.

Good to Know

How to Start

  1. On the Organizer, do one of these:
  2. Do one of these:
    • Add an activity:
      1. In the Process Builder, in the Activity Library, open the Document tab.
      2. On the Document tab, drag the Microsoft Word activity onto your process.
    • Change an activity:
      1. In your process, double-click your activity.

Procedure

  1. Complete the fields on the General Configuration screen.

    For more information, refer to Configure General Options for a System Activity.

  2. Click Source Configuration .
  3. On the Source Repository screen, select the source location for your file.

    For more information, refer to Source Repository.

  4. Click Target Configuration .
  5. On the Target Repository screen, select the target location for your file.

    For more information, refer to Target Repository.

  6. Click Microsoft Word Configuration .
  7. Complete the fields on the Microsoft Word Configuration screen.

    For more information, refer to Create a Microsoft Word or PDF File.

  8. (Optional) Click Advanced > E-mail Notification .

    For more information, refer to Configure E-mail Notifications for Any Activity

General Configuration

Specifies the common information for a system activity.



Fields

Field Name Definition

Display Name
Function:
Specifies the activity name that shows in your process.
Accepted Values:
One line of text that can have spaces.
Default Value:
None
Accepts Process Data Variables:
No

Description
Function:
Specifies an optional description for your activity.
Accepted Values:
More than one line of text.
Default Value:
None
Accepts Process Data Variables:
No

Source Repository

Specifies the original, or source, location type for your files.



Fields

Field Name Definition

One Drive

Function:
Specifies that OneDrive is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (One Drive).

Box

Function:
Specifies that Box is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Box).

SharePoint

Function:
Specifies that SharePoint is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (SharePoint).

Dropbox

Function:
Specifies that Dropbox is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Dropbox).

Google Drive

Function:
Specifies that Google Drive is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Google Drive).

Salesforce

Function:
Specifies that Salesforce is your document source location.

To select your file in the source location, complete the fields on Source Repository Configuration (Salesforce).

Local File System

Function:
Specifies that a folder on your local machine is the source location of your file.

To select your file in the source location, complete the fields on Source Repository Configuration (Local File System).

Target Repository

Selects the target storage repository type for your files.



Fields

Field Name Definition

One Drive

Function:
Specifies that OneDrive is your document target location.

To configure the target location for your file, complete the fields in Save To Repository Configuration (One Drive).

Box

Function:
Specifies that Box is your document target location.

To configure the target location for your file, complete the fields in Save To Repository Configuration (Box).

SharePoint

Function:
Specifies that SharePoint is your document target location.

To configure the target location for your file, complete the fields in Save To Repository Configuration (SharePoint).

Dropbox

Function:
Specifies that Dropbox is your document target location.

To configure the target location for your file, complete the fields in Save To Repository Configuration (Dropbox).

Google Drive

Function:
Specifies that Google Drive is your document target location.

To configure the target location for your file, complete the fields in Save To Repository Configuration (Google Drive).

Salesforce

Function:
Specifies that Salesforce is your document target location.

To configure the target location for your file, complete the fields in Save To Repository Configuration (Salesforce).

Local File System

Function:
Specifies that a folder on your local machine is the target location for your file.

To select your file in the source location, complete the fields on Save To Repository Configuration (Local File System).

Microsoft Word Configuration

Specifies your settings for making a Word document or PDF file from a Word template.



Good to Know

  • To create a Word template, see the online help for Word templates, Mail Merge fields, and bookmark fields in Microsoft Word.

Fields

Field Name Definition

Word Template Name
Function:
Specifies the name of the Word template file your process uses when it runs.
Accepted Values:
  • A valid Word template file name
  • A process data variable.

    You can use Process Data screen to specify a process data variable.

Default Value:
None
Accepts Process Data Variables:
Yes

Destination File Name
Function:
Specifies the file name of the output file.
Accepted Values:
  • One line of text that can have spaces.
  • A process data variable.

    You can use Process Data screen to specify a process data variable.

Default Value:
None
Accepts Process Data Variables:
Yes

Save as PDF
Function:
Specifies that the generated file will be saved as a PDF file, and not a Word document.
Accepted Values:
  • Deselected - The output file is saved as a Word document.
  • Selected - The output file is saved as a PDF document.
Default Value:
Deselected

Load Word Fields
Function:
Moves the dynamic fields specified with the Word Template to the Word Fields box.

Display Literal Boolean Value
Function:
Determines whether the generated Word document displays the literal value of a Boolean field — for example, display the words Yes or No for a boolean field.

By default, the Word activity displays the Boolean values as a selection box — X for True, and empty for False.

Accepted Values:
  • Deselected - Displays the Boolean values as a selection box.
  • Selected - Displays the literal value of a Boolean field.
Default Value:
Deselected

Move All
Function:
Moves all the fields in the Word Fields box at one time.

Word Field
Function:
Specifies the word field that is to be mapped to the process value. The mapping is performed to update the fields in the Word document or PDF document, generated as output.
Accepted Values:
Read only - A Word field.

Use the Move All button to move the fields from the Word Field box to the Load Word Fields box.

Default Value:
None

Process Value
Function:
Specifies the process value to be mapped to the Word field to update each field in the Word document.
Accepted Values:
  • A number or a text string that can contain spaces.

    This must be in accordance with the data type of the word field.

  • A process data variable

Note:

  • Once a Word field is in the Word Field column, to map a Word field to a process value, select the row, and use Process Data screen.
Default Value:
None
Parent topic: Document tab

Quick Links:

Send Feedback

Quick Start

Process Activities

eForm Controls

AgilePoint NX Online Help

AgilePoint NX Technical Documentation

Support Portal

AgilePoint

AgilePoint NX

Documentation Updated: December 3, 2015

© 2015 AgilePoint, Inc. All rights reserved.