EMC Documentum ProcessBuilder ProcessBuilder Version6.5 DevelopmentGuide P/N300-007-248A01 EMCCorporation CorporateHeadquarters: Hopkinton,MA01748-9103 1-508-435-1000

  • View
    213

  • Download
    1

Embed Size (px)

Text of EMC Documentum ProcessBuilder ProcessBuilder Version6.5 DevelopmentGuide P/N300-007-248A01...

  • EMC DocumentumProcess Builder

    Version 6.5

    Development GuideP/N 300-007-248 A01

    EMC CorporationCorporate Headquarters:

    Hopkinton, MA 01748-91031-508-435-1000www.EMC.com

  • Copyright 2004 - 2008 EMC Corporation. All rights reserved.

    Published July 2008

    EMC believes the information in this publication is accurate as of its publication date. The information is subject to changewithout notice.

    THE INFORMATION IN THIS PUBLICATION IS PROVIDED AS IS. EMC CORPORATION MAKES NO REPRESENTATIONSOR WARRANTIES OF ANY KINDWITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLYDISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

    Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

    For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.

    All other trademarks used herein are the property of their respective owners.

  • Table of Contents

    Preface ........................................................................................................................... 7

    Chapter 1 Using Custom Email Templates .............................................................. 9Custom email templates overview ................................................................ 9Creating custom email template objects........................................................ 10Sample template content ......................................................................... 13

    Troubleshooting email template notification ................................................. 14

    Chapter 2 Developing Custom Activities ............................................................... 17Writing the Java class .................................................................................. 18Creating a method object............................................................................. 21Sample code ............................................................................................... 22

    Chapter 3 Activity template denition le schema ................................................ 25

    EMC Documentum Process Builder Version 6.5 Development Guide 3

  • Table of Contents

    List of Figures

    Figure 1. Sample Workflow Java Method ....................................................................... 19Figure 2. XsltTransformationActivity Workflow Class..................................................... 22

    4 EMC Documentum Process Builder Version 6.5 Development Guide

  • Table of Contents

    List of Tables

    Table 1. Tags ......................................................................................... 11Table 2. Element attributes ........................................................................... 26Table 3. Element attributes ............................................................................... 36Table 4. Element attributes.............................................................. 37Table 5. Element attributes.............................................................................. 39Table 6. Element attributes ................................................................... 41Table 7. Element attributes ..................................................................... 42Table 8. Element attributes ................................................................... 43Table 9. Element attributes ...................................................................... 44Table 10. Element attributes ............................................................................... 46Table 11. Element attributes ......................................................... 55Table 12. Element attributes ...................................................... 57Table 13. Element attributes ....................................................................... 59Table 14. Element attributes .......................................................... 61Table 15. Element attributes ...................................................... 63Table 16. Element attributes.................................................................................. 71

    EMC Documentum Process Builder Version 6.5 Development Guide 5

  • Table of Contents

    6 EMC Documentum Process Builder Version 6.5 Development Guide

  • Preface

    Purpose of the manualThis manual explains how to develop workflow methods that can be linked to customautomated activities using EMC Documentum Process Builder. It also describes how tocreate custom email notification messages for workflow events and provides referenceinformation for creating custom activity templates. Refer to the Process Builder User Guidefor information about creating business process templates and linking these customenhancements into a process template.

    Intended audienceThis manual is intended for developers who are customizing business processes createdusing EMC Documentum Process Builder. It assumes some familiarity with basicDocumentum functionality, especially with Documentum Foundation Classes (DFC)programming.

    Revision historyThis section contains a description of this documents revision history.

    Revision history

    Revision Date Description

    July 2008 Initial publication

    Support informationEMC Documentums technical support services and policies are available at the EMCPowerlink website (http://Powerlink.EMC.com).

    Note: You must register online at Powerlink before using it.

    EMC Documentum Process Builder Version 6.5 Development Guide 7

    http://powerlink.emc.com

  • Preface

    Related documentationProcess Builder is a design tool for business process templates. Workflows are createdfrom these templates at runtime; see the user documentation for Documentum Webtopfor information about running and participating in workflows.

    In addition to this manual, the documentation set for Process Builder includes:

    Documentum Process Builder User Guide Documentum Process Builder Installation Guide Documentum Process Builder Release Notes Documentum Process Builder Localization Guide

    8 EMC Documentum Process Builder Version 6.5 Development Guide

  • Chapter 1Using Custom Email Templates

    This chapter describes using custom email templates for releases prior to Documentum ProcessBuilder 6, SP1 and contains the following sections: Custom email templates overview, page 9 Creating custom email template objects, page 10

    Note: Process designers can now use Process Builders Notification Template Wizard to create customemail templates dynamically while defining a process or an individual activity. The NotificationTemplate Wizard is available from the Process Template Properties and from the Notification andTimers tabs of the Activity Inspector. The Notification Wizard includes the ability to use datamapping to define the attributes of the email message. This chapter is included in the documentationfor backward compatibility purposes.

    Custom email templates overviewWorkflows can generate email from Content Server to the workflow supervisor or toan activity performer when a particular event occurs. You can set the formatting andcontent of the notification messages using custom email templates. Email templates aredocuments whose content and attributes define a notification message. The message textcan include a variety of parameters that are resolved at runtime, to tailor the message fora specific context and instance. For example, you can include variables that resolve to thenames of package components, the workflow name, or the performer name.

    Email templates are associated with specific workflow events as part of the definitionof a process template or an activity definition. When an event has an email templateassociated with it, any user who has registered to receive notification of the event willget a message generated from the associated email template. If it is associated withan activity definition, the template is only used when the event occurs in activitiesgenerated from that definition. If different templates are associated with the event in theactivity definition and the process template definition, the one in the activity definitiontakes precedence.

    EMC Documentum Process Builder Version 6.5 Development Guide 9

  • Using Custom Email Templates

    Note: The server generates and sends notification messages only when one or moreusers has registered to receive notification of the event. See Documentum Content ServerFundamentals for information about registering for event notifications.

    To create a custom email template for a workow event:1. Create the email template object.

    Creating custom email template objects, page 10 contains instructions for creatingthe template content.

    2. Import the template in to the repository, in any folder.

    3. Associate the template with a process template or activity definition.See the Process Builder User Guide for instructions.

    Email templates are not recognized by the default method that Content Server uses forsending notifications, dm_event_sender. To use email templates, you must configureContent Server to use the alternative mail method, dm_event_template_sender. Thismethod is installed with Process Builder. For instructions on configuring Content Serverto use this method, refer to the Process Builder Installation Guide.

    Creating custom email template objects

    Caution: This section outlines the basic procedure for creating custom emailtemplates. Documentum provides standard technical support for using thedelivered sample email template as part of the product release. For assistancein creating, implementing, or debugging a

Recommended

View more >