K2 BLACKPEARL PRODUCT DOCUMENTATION: USER GUIDE
Inline Functions - Word

Inline Functions - Word

The Word feature contains an action called Get Word Content which gets the content data of a Content Control in a Word document residing anywhere on a network or in a SharePoint location.

Content Controls are individual controls that you can add and customize for use in templates, forms, and documents. For example, many online forms are designed with a drop-down list control that provides a restricted set of choices for the user of the form. Content Controls can provide instructional text for users, and you can set controls to disappear when users type in their own text. You can reuse and distribute your customized Content Controls, as well as create your own building blocks to include in a Content Control.

Prerequisite

The following is a prerequisite in order to use the Word Inline Function:

View the Content Controls in a document

You can find the Content Controls for your document on the Developer tab.

Click the Microsoft Office Button and then click Word Options.

Fig. 1. Word Options

Click Popular. Check the Show Developer tab in the Ribbon check box, and then click OK.

Fig. 2. Show Developer tab

If Content Controls are not available, you may have opened a document created in an earlier version of Microsoft Office Word. To use Content Controls, you must convert the document to the Word 2007 file format by clicking the Microsoft Office Button , clicking Convert, and then clicking OK. Content Controls require Microsoft Office Word 2007 or a later version

These are the Content Controls available in Microsoft Office Word 2007.

Fig. 3. Content Controls

 Alternatively use the Quick Parts link to add Content Controls. Quick Parts can be found under the Insert tab in Word, see below.

Fig. 4. Quick Parts

Providing the Content Control tag with a name

In order for the K2 Get Word Content action to function properly, the tag of the Content Control need to be unique. If more than one tag is used with the same name, only the content of the first tag will be returned. Ensure that each Content Control tag is unique.  

To provide the Content Control tag with a name, select the control in Design Mode, and click on Properties. Specify the tag name and click OK.

Fig. 5. Tag Name

Using the Get Word Content Control Inline Function

It is important to note that the K2 Service Account requires Farm Administration rights and Word Services rights. If Run As is utilized instead of the K2 Service Account, then the specified Run As user will require these rights.

The Get Word Content Control can be found by expanding the Word node in the Function Browser of the process designer.

Fig. 6. Get Word Content

The parameter for Content Control Name should be the tag set in the Word document. Only one Content Control name can be set at a time, as the parameter does not allow for multiple items to be retrieved at once
Feature Description How to use it
Location The network or SharePoint location where the Word document resides. Use a Data/XML field to populate the field or alternatively type in the location in the box provided.
Content Control Name Name of the Content Control tag in the Word document. Use a Data/XML field to populate the field or alternatively type in the Content Control tag name.

 

 


K2 blackpearl Help 4.6.10 (4.12060.1690.0)