null  null
Altiris™ Workflow from
Symantec
Version 7.0
Workflow 7.0 User's Guide
The software described in this book is furnished under a license agreement and may be used
only in accordance with the terms of the agreement.
Documentation version: 7.0
Legal Notice
Copyright © 2009 Symantec Corporation. All rights reserved.
Symantec, the Symantec Logo are trademarks or registered trademarks of Symantec
Corporation or its affiliates in the U.S. and other countries. Other names may be trademarks
of their respective owners.
This Symantec product may contain third party software for which Symantec is required
to provide attribution to the third party (“Third Party Programs”). Some of the Third Party
Programs are available under open source or free software licenses. The License Agreement
accompanying the Software does not alter any rights or obligations you may have under
those open source or free software licenses. Please see the Third Party Legal Notice Appendix
to this Documentation or TPIP ReadMe File accompanying this Symantec product for more
information on the Third Party Programs.
The product described in this document is distributed under licenses restricting its use,
copying, distribution, and decompilation/reverse engineering. No part of this document
may be reproduced in any form by any means without prior written authorization of
Symantec Corporation and its licensors, if any.
THE DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS,
REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT,
ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO
BE LEGALLY INVALID. SYMANTEC CORPORATION SHALL NOT BE LIABLE FOR INCIDENTAL
OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH THE FURNISHING,
PERFORMANCE, OR USE OF THIS DOCUMENTATION. THE INFORMATION CONTAINED
IN THIS DOCUMENTATION IS SUBJECT TO CHANGE WITHOUT NOTICE.
The Licensed Software and Documentation are deemed to be commercial computer software
as defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19
"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, "Rights in
Commercial Computer Software or Commercial Computer Software Documentation", as
applicable, and any successor regulations. Any use, modification, reproduction release,
performance, display or disclosure of the Licensed Software and Documentation by the U.S.
Government shall be solely in accordance with the terms of this Agreement.
Symantec Corporation
350 Ellis Street
Mountain View, CA 94043
http://www.symantec.com
Technical Support
Symantec Technical Support maintains support centers globally. Technical
Support’s primary role is to respond to specific queries about product features
and functionality. The Technical Support group also creates content for our online
Knowledge Base. The Technical Support group works collaboratively with the
other functional areas within Symantec to answer your questions in a timely
fashion. For example, the Technical Support group works with Product Engineering
and Symantec Security Response to provide alerting services and virus definition
updates.
Symantec’s maintenance offerings include the following:
■
A range of support options that give you the flexibility to select the right
amount of service for any size organization
■
Telephone and Web-based support that provides rapid response and
up-to-the-minute information
■
Upgrade assurance that delivers automatic software upgrade protection
■
Global support that is available 24 hours a day, 7 days a week
■
Advanced features, including Account Management Services
For information about Symantec’s Maintenance Programs, you can visit our Web
site at the following URL:
www.symantec.com/techsupp/
Contacting Technical Support
Customers with a current maintenance agreement may access Technical Support
information at the following URL:
www.symantec.com/techsupp/
Before contacting Technical Support, make sure you have satisfied the system
requirements that are listed in your product documentation. Also, you should be
at the computer on which the problem occurred, in case it is necessary to replicate
the problem.
When you contact Technical Support, please have the following information
available:
■
Product release level
■
Hardware information
■
Available memory, disk space, and NIC information
■
Operating system
■
Version and patch level
■
Network topology
■
Router, gateway, and IP address information
■
Problem description:
■
Error messages and log files
■
Troubleshooting that was performed before contacting Symantec
■
Recent software configuration changes and network changes
Licensing and registration
If your Symantec product requires registration or a license key, access our technical
support Web page at the following URL:
www.symantec.com/techsupp/
Customer service
Customer service information is available at the following URL:
www.symantec.com/techsupp/
Customer Service is available to assist with the following types of issues:
■
Questions regarding product licensing or serialization
■
Product registration updates, such as address or name changes
■
General product information (features, language availability, local dealers)
■
Latest information about product updates and upgrades
■
Information about upgrade assurance and maintenance contracts
■
Information about the Symantec Buying Programs
■
Advice about Symantec's technical support options
■
Nontechnical presales questions
■
Issues that are related to CD-ROMs or manuals
Maintenance agreement resources
If you want to contact Symantec regarding an existing maintenance agreement,
please contact the maintenance agreement administration team for your region
as follows:
Asia-Pacific and Japan
[email protected]
Europe, Middle-East, and Africa
[email protected]
North America and Latin America
[email protected]
Additional enterprise services
Symantec offers a comprehensive set of services that allow you to maximize your
investment in Symantec products and to develop your knowledge, expertise, and
global insight, which enable you to manage your business risks proactively.
Enterprise services that are available include the following:
Symantec Early Warning Solutions These solutions provide early warning of cyber attacks, comprehensive threat
analysis, and countermeasures to prevent attacks before they occur.
Managed Security Services
These services remove the burden of managing and monitoring security devices
and events, ensuring rapid response to real threats.
Consulting Services
Symantec Consulting Services provide on-site technical expertise from
Symantec and its trusted partners. Symantec Consulting Services offer a variety
of prepackaged and customizable options that include assessment, design,
implementation, monitoring, and management capabilities. Each is focused on
establishing and maintaining the integrity and availability of your IT resources.
Educational Services
Educational Services provide a full array of technical training, security
education, security certification, and awareness communication programs.
To access more information about Enterprise services, please visit our Web site
at the following URL:
www.symantec.com
Select your country or language from the site index.
Contents
Technical Support ............................................................................................... 4
Section 1
About Workflow 7.0 ................................................... 21
Chapter 1
Introducing Workflow 7.0 .................................................. 23
About Symantec Workflow 7.0 ........................................................
Basic elements of Symantec Workflow 7.0 ........................................
How Symantec Workflow 7.0 works .................................................
What you can do with Symantec Workflow 7.0 ..................................
Where to get more information about Symantec Workflow 7.0 .............
Chapter 2
23
24
26
26
27
Getting started with Workflow 7.0 .................................. 29
About Workflow Designer, Workflow Server, and Process
Manager ...............................................................................
Installing and configuring Workflow 7.0 ..........................................
Workflow 7.0 and LogicBase Terminology ........................................
About Workflow 7.0 and the Symantec Management Console ...............
29
32
33
34
Section 2
Using Workflow Server 7.0 .................................... 37
Chapter 3
Workflow Server 7.0 ........................................................... 39
About Workflow Server 7.0 ............................................................
Viewing a project on Workflow Server .............................................
Server Extensions Configurator ......................................................
Setting up the Symantec Management Console URL in Workflow
Server ............................................................................
Server Extensions Configurator page .........................................
39
42
43
43
44
8
Contents
Section 3
Using Workflow Designer 7.0 ............................... 49
Chapter 4
Introducing Workflow Designer 7.0 ................................ 51
About Workflow Designer 7.0 .........................................................
Workflow Designer loading window .................................................
Opening the Designer loading window .......................................
Creating a new project ............................................................
Editing Workflow Designer preferences .....................................
Workflow Designer project types ..............................................
Workflow Designer tool .................................................................
About workflow components ....................................................
Workflow Designer project tree ................................................
Project Workspace .................................................................
Component Toolbox ...............................................................
About project models ..............................................................
About data ............................................................................
Generating project reports .......................................................
Chapter 5
51
53
54
54
55
55
60
62
69
75
76
76
78
80
Using tasks created in a workflow project ..................... 83
About using tasks ......................................................................... 83
About the Dialog Workflow component and tasks ........................ 84
Setting task source in a Dialog Workflow component .................... 85
Setting a task assignment in a Dialog Workflow component ........... 86
DefaultTaskSource task configuration example ................................. 87
ProcessManagerTaskSource task configuration example ..................... 90
ProcessManagerTaskSource task configuration example with added
features ................................................................................ 93
SharePointTaskSource task configuration example ............................ 97
ActiveDirectoryTaskSource task configuration example ...................... 99
Delivering a task in Process Manager and email ............................... 102
Delivering a task in an email ......................................................... 102
Chapter 6
Working with projects ....................................................... 105
About publishing a project ...........................................................
Adding a server in the task tray application ...............................
Project start types ................................................................
Publishing formats ...............................................................
Publishing a project ..............................................................
Publishing a process to Process Manager ..................................
Setting up Workflow Designer to publish to multiple Workflow
Servers .........................................................................
105
106
107
109
111
112
113
Contents
Tracking the status of a published workflow ....................................
Packaging a project .....................................................................
Testing a project ........................................................................
Reloading a project .....................................................................
Chapter 7
114
115
116
117
Using the component generators ................................... 119
Introducing the component generators ...........................................
About the component generators ..................................................
Database .............................................................................
XML ...................................................................................
Microsoft ............................................................................
Flat Files .............................................................................
Enterprise Resources ............................................................
Authoring ...........................................................................
Symantec Workflow ..............................................................
More ..................................................................................
Symantec workflow component generators ...............................
Generating components ...............................................................
Generating the Symantec components with the generators ................
119
120
120
121
121
122
123
123
123
124
125
126
127
Section 4
Integrating Workflow 7.0 ...................................... 129
Chapter 8
Workflow 7.0 and Active Directory ................................ 131
Integrating Active Directory with a workflow process ....................... 131
Chapter 9
Workflow 7.0 and SharePoint ......................................... 133
Integrating SharePoint with a workflow process .............................. 133
Using a Process Manager task list in SharePoint .............................. 134
Chapter 10
Workflow 7.0 and the Symantec Management
Platform ......................................................................... 135
How to prepare for your first use of Workflow Designer on the
Symantec platform ...............................................................
Generating libraries with the Symantec Management Platform
generators ....................................................................
Importing Symantec components ............................................
Creating a new integration project ...........................................
Managing connections to the Symantec Management
Console ........................................................................
135
136
138
138
139
9
10
Contents
Design time and run time Symantec Management Console
credentials ....................................................................
Creating Symantec Management Console credentials ..................
Creating design time Symantec Management Console
credentials ....................................................................
Setting run time Symantec Management Console
credentials ....................................................................
Setting up how a project runs .................................................
Deployment Server connection settings ..........................................
Design time and run time Deployment Server connection
settings ........................................................................
Setting design time Deployment Server connection settings .........
Setting run time Deployment Server connection settings .............
Publishing projects to Symantec Management Console 7.0 .................
Publishing a workflow as a right-click action in the Symantec
Management Console ......................................................
Publishing a workflow to the Symantec Management
Console ........................................................................
Publishing a workflow as a task to the Symantec Management
Console ........................................................................
Granting a user permission to publish workflows to the Symantec
Management Console ......................................................
Distributing workflow components with the Symantec
Management Console ......................................................
Scheduling a task in the Symantec Management Console .............
Defining automation policies for workflows in the Symantec
Management Console ......................................................
140
142
142
143
145
146
146
148
149
149
152
170
170
172
173
174
174
Section 5
Using Workflow Process Manager 7.0 .......... 177
Chapter 11
Introducing Workflow Process Manager 7.0 ................ 179
About Process Manager ...............................................................
Logging on to Process Manager .....................................................
Setting your opening portal page ...................................................
Symbols in Process Manager ........................................................
Chapter 12
179
181
181
182
Managing the Process Manager portal ......................... 183
About the Process Manager portal .................................................
Changing Process Manager master settings .....................................
Process Manager settings .............................................................
About Process Manager pages .......................................................
183
184
185
196
Contents
Managing pages ...................................................................
Uploading plug-ins .....................................................................
Adding Web part catalogs ............................................................
Working with Web part catalogs ...................................................
Chapter 13
Managing Workflow processes in Process
Manager ......................................................................... 221
About managing Workflow processes in Process Manager ..................
Delegating a task ........................................................................
Adding a task .............................................................................
Working with tasks .....................................................................
Viewing a process .......................................................................
Setting up users to view the Process View page ................................
Setting up workflow task integration with Workflow Designer ............
Chapter 14
196
219
219
219
221
222
223
224
225
226
226
Managing documents in Process Manager .................. 229
About document management ......................................................
About the Documents page ...........................................................
Searching for documents .............................................................
Adding a document category ........................................................
Editing a document category ........................................................
Adding a document sub category ...................................................
Category and Sub Category dialog boxes .........................................
Deleting a document category .......................................................
Displaying the document category history ......................................
Displaying the document viewer ...................................................
Setting document category permissions .........................................
Creating expected document messages ...........................................
Adding simple documents to the Documents page ............................
Add Documents dialog box ...........................................................
Adding advanced documents to the Documents page ........................
Add Advanced Document dialog box ..............................................
Downloading documents ..............................................................
Downloading ZIP files of documents ..............................................
Viewing documents ....................................................................
Viewing document versions ..........................................................
Viewing the document history ......................................................
Editing document data ................................................................
Adding a new document version ....................................................
Promoting a document version .....................................................
Setting document permissions ......................................................
Adding documents to additional categories .....................................
230
231
232
233
233
234
234
236
237
238
238
239
240
240
241
241
243
243
244
244
245
245
246
246
247
247
11
12
Contents
Emailing documents ................................................................... 248
Deleting documents .................................................................... 249
Adding a document in Process Manager using Workflow
components ........................................................................ 249
Chapter 15
Managing the Knowledge Base and discussions in
Process Manager ......................................................... 253
About Knowledge Base and discussions ..........................................
Managing categories ...................................................................
Adding a Knowledge Base article ...................................................
Adding a Bulletin board ...............................................................
Adding a Wiki ............................................................................
Adding a FAQ ............................................................................
Working with articles ..................................................................
Adding a new entry to an article ....................................................
Setting permissions for a Knowledge Base entry ...............................
Adding a discussion ....................................................................
Working with discussions ............................................................
Adding a new thread to a discussion ...............................................
Chapter 16
Managing schedules in Process Manager .................... 263
About scheduling in Process Manager ............................................
Adding a schedule ......................................................................
Add Schedule dialog box ..............................................................
Working with schedules ..............................................................
Chapter 17
263
264
265
266
Managing data in Process Manager .............................. 269
About data management ..............................................................
Working with document types ......................................................
Working with document category types ..........................................
Adding a user relationship type .....................................................
Chapter 18
254
255
256
257
258
258
259
260
260
261
261
262
269
270
271
271
Managing the service catalog in Process
Manager ......................................................................... 273
About the service catalog .............................................................
Working with categories ..............................................................
Adding a Web form .....................................................................
Adding a Webservice ...................................................................
Web form settings ......................................................................
Webservice settings ....................................................................
273
274
275
276
276
278
Contents
Chapter 19
Managing accounts in Process Manager ...................... 279
About Process Manager security ...................................................
About groups and permissions ......................................................
About using Active Directory with Process Manager .........................
How Active Directory groups are added to Process Manager ...............
About the default user groups and permissions ................................
Setting up groups, permissions, and users .......................................
Creating groups .........................................................................
Add Group dialog box ..................................................................
Modifying groups .......................................................................
Deleting groups ..........................................................................
Adding users to groups ................................................................
Adding or removing permissions for groups ....................................
Viewing the list of permissions .....................................................
Viewing the permissions for a group ..............................................
Creating organizational units .......................................................
Creating a new user ....................................................................
Clone User tab ...........................................................................
Manually adding new Process Manager users from Active
Directory ............................................................................
Modifying data for existing users ..................................................
Deleting users ............................................................................
Viewing your Process Manager group memberships ..........................
Editing your user account ............................................................
Changing your password ..............................................................
Sending an email to a user ...........................................................
Managing users ..........................................................................
Managing a user’s groups ............................................................
Managing a user’s permissions .....................................................
Managing a user’s organizations ...................................................
Working with users .....................................................................
Managing Permissions ................................................................
Managing Organizations ..............................................................
Chapter 20
280
281
282
284
284
285
286
287
287
288
288
289
289
290
290
290
292
292
293
293
294
294
294
295
295
296
296
297
297
300
301
Performing administrative tasks in Process
Manager ......................................................................... 305
Commands on the Admin menu ....................................................
About the Process Manager portal master settings ...........................
Master Settings page ...................................................................
Editing the Process Manager portal master settings ..........................
About Actions in Process Manager .................................................
305
309
310
311
312
13
14
Contents
Chapter 21
Reports in Process Manager ............................................ 313
About Process Manager reporting ..................................................
About the Reports page ...............................................................
Viewing a report .........................................................................
Creating a standard report ...........................................................
Setting up or modifying the data in standard reports ........................
Customizing the layout of grid standard reports ...............................
Setting up or modifying Web Service access for standard
reports ...............................................................................
Customizing filtering and sorting for standard reports ......................
Modifying standard reports ..........................................................
Creating a cube report .................................................................
Specifying filtering for cube reports ...............................................
Customizing cube reports ............................................................
Modifying cube reports ................................................................
Setting permissions for reports .....................................................
Exporting a report definition ........................................................
Copying a report ........................................................................
Adding reports to a portal page .....................................................
Creating a scheduled report ..........................................................
Adding report categories .............................................................
Adding report sub categories ........................................................
Deleting report categories ............................................................
Setting report category permissions ..............................................
Adding reports to additional categories ..........................................
Deleting reports .........................................................................
Add/Edit Cube Report dialog box ...................................................
Add/Edit Standard Report dialog box .............................................
Displaying reports in print view ....................................................
Importing report categories .........................................................
Importing reports .......................................................................
Chapter 22
314
315
316
316
317
318
319
320
321
322
323
323
324
325
326
327
327
328
329
329
330
331
332
333
333
334
337
337
337
Integrating Process Manager .......................................... 339
About Process Manager integration ...............................................
Integrating Process Manager with Workflow Designer ......................
Integrating Process Manager with Active Directory
authentication .....................................................................
Integrating Process Manager with Active Directory information .........
339
339
340
342
Contents
Section 6
Example Scenarios .................................................... 345
Chapter 23
New Employee Set Up Scenario ...................................... 347
About new employee set up ..........................................................
Step 1: Create a new project ....................................................
Step 2: Edit the Create Notification Server Credentials
component ....................................................................
Step 3: Add and Configure a Workflow Component .....................
Step 4: Test the Project ..........................................................
Chapter 24
347
348
348
349
357
Scheduling conference room scenario .......................... 361
About conference room scheduling ................................................
Step 1: Setting up .................................................................
Step 2: Create a Workflow project of type Form Start ..................
Step 3: Publish the Form Start project to Process Manager ...........
Step 4: View the project (as a service) in Process Manager ............
Step 5: Request to book the conference room .............................
Step 6: View the status of a workflow process ............................
Step 7: Approve the request for the conference room ..................
Step 8: Check the schedule for the conference room ....................
361
362
364
375
376
376
377
378
379
Section 7
Reference Material .................................................... 381
Chapter 25
Component properties
..................................................... 383
Common tabs throughout components ...........................................
Settings tab in all components ................................................
Context tab in Active Directory components ..............................
Deployment Server tab in deployment components ....................
Notification Server tab in Symantec components .......................
Message Listeners tab in some components ...............................
Components ..............................................................................
Active Directory components ..................................................
Add Computer To Organization Unit ........................................
Add Group To Group .............................................................
Add Group To Organization Unit .............................................
Add Group To Share ..............................................................
Add Items To Collection .........................................................
Add New Data Element ..........................................................
Add Organization Unit To Organization Unit .............................
Add Ticket Comment .............................................................
383
383
385
385
386
387
387
392
394
395
396
396
398
398
400
400
15
16
Contents
Add User To Group ...............................................................
Add User To Organization Unit ...............................................
Add User To Share ................................................................
Add Values ..........................................................................
Approval Workflow ..............................................................
AsciiMergeLabelComponent ...................................................
Assign Manager To Computer .................................................
Assign Manager To Group ......................................................
Assign Manager To Shared Folder ...........................................
Assign Manager To User ........................................................
Compare Numbers Rule .........................................................
Configurable Auto Start .........................................................
Create Anonymous Access Token ............................................
Create Basic Authentication Token ..........................................
Create Collection ..................................................................
Create Computer ..................................................................
Create Default Access Token ...................................................
Create DS Connection Profile ..................................................
Create Group .......................................................................
Create Kerberos Authentication Token .....................................
Create Notification Server Credentials ......................................
Create Organization Unit .......................................................
Create Resource ...................................................................
Create Shared Folder .............................................................
Create Ticket .......................................................................
Create User .........................................................................
Date Greater Than ................................................................
DatePickerComponent ...........................................................
Date Range Rule ...................................................................
Decision Path Component ......................................................
Delete Computer ..................................................................
Delete Group .......................................................................
Delete Organization Unit .......................................................
Delete Shared Folder .............................................................
Delete User .........................................................................
Dialog Workflow ..................................................................
Display Content ...................................................................
Embedded Merge ..................................................................
End component ....................................................................
Exception Component ...........................................................
Exception Trigger .................................................................
Exception Trigger By Component ............................................
Exception Trigger By Components ...........................................
401
402
402
404
404
411
412
413
414
415
416
416
417
418
419
420
421
421
423
424
424
427
429
430
431
436
437
438
440
441
443
444
445
445
446
447
454
455
457
458
459
460
461
Contents
Exception Trigger By Exception Type .......................................
Find Help Desk Contact .........................................................
Folder Watch Start ...............................................................
For Each Element in Collection ...............................................
Form Builder .......................................................................
Gain Approval .....................................................................
Get All Children For Parent Ticket ...........................................
Get All Users And Groups ......................................................
Get Computer ......................................................................
Get Computer List ................................................................
Get Current Date ..................................................................
Get Folder Permission List .....................................................
Get Group List .....................................................................
Get Groups For User .............................................................
Get Job ...............................................................................
Get Number From String ........................................................
Get Organization Units List ....................................................
Get Scheduled Job .................................................................
Get Help Desk Assets For Contact ............................................
Get Help Desk Contact Manager ..............................................
Get Share Permission List ......................................................
Get Shared Folders List ..........................................................
Get Task Definition from Task ................................................
Get Ticket Status ..................................................................
Get User List .......................................................................
Get Users in Group ...............................................................
Global Logging Capture .........................................................
Hanging Path Trigger ............................................................
Hanging Path Trigger By Components ......................................
Hanging Path Trigger By Path ................................................
HTMLMergeComponent ........................................................
Initialize Data ......................................................................
LabelComponent ..................................................................
List Computers .....................................................................
List Jobs In Folder .................................................................
List Schedules For Job ...........................................................
Matches Rule .......................................................................
Move Object To Container ......................................................
New File Auto Start ...............................................................
Number Range Rule ..............................................................
Password String Generator ....................................................
Quick Link Dialog Workflow ...................................................
Remove Computer from Organization Units ..............................
462
463
464
465
467
469
474
474
475
476
477
477
479
479
480
481
482
483
484
485
486
487
487
488
489
490
490
491
491
492
493
494
495
497
498
499
499
500
501
502
503
504
511
17
18
Contents
Remove Group from Group ....................................................
Remove Group from Organization Units ...................................
Remove Group from Share .....................................................
Remove Manager from Computer ............................................
Remove Manager from Group .................................................
Remove Manager from Shared Folder .......................................
Remove Manager from User ...................................................
Remove Organization Unit out of Organization Unit ...................
Remove User from Group .......................................................
Remove User from Organization Units .....................................
Remove User from Share .......................................................
Reset User Password .............................................................
Run Job On Computer ............................................................
Schedule Job On Computer .....................................................
Send Complete Workflow Message ...........................................
Send Email ..........................................................................
Setup Process ......................................................................
Set Ticket Status ..................................................................
Single Value Mapping ...........................................................
Start component ..................................................................
Subtract Days ......................................................................
Terminate Window and Close Dialog ........................................
TextBoxComponent ..............................................................
True False Rule ....................................................................
Update Computer .................................................................
Update Group ......................................................................
Update Organization Unit ......................................................
Update Shared Folder ............................................................
Update User ........................................................................
Wait For All Workflow Components (Merge) ..............................
Wait For Job Completion ........................................................
Wait For Ticket Change .........................................................
Wait On External Event .........................................................
Appendix A
512
513
513
515
515
516
517
517
518
519
520
521
522
523
524
527
529
530
530
532
532
532
533
537
537
538
539
541
541
543
543
544
545
Project Global Properties ................................................. 549
Resources tab ............................................................................
Libraries tab ..............................................................................
Models tab ................................................................................
Publishing tab ............................................................................
Properties tab ............................................................................
Storage Preferences tab ...............................................................
Reporting tab ............................................................................
549
551
551
552
557
558
558
Contents
Global Data tab .......................................................................... 558
Application Properties ................................................................. 558
Appendix B
Edit Tool Preferences ........................................................ 559
Studio Configuration page ............................................................
Designer page ............................................................................
Debugging page .........................................................................
Deployment page .......................................................................
Process Manager page .................................................................
Repository page .........................................................................
Appendix C
559
563
567
568
570
570
Symantec Component Datatypes ................................... 573
Symantec component datatypes .................................................... 573
Index ................................................................................................................... 577
19
20
Contents
Section
About Workflow 7.0
■
Chapter 1. Introducing Workflow 7.0
■
Chapter 2. Getting started with Workflow 7.0
1
22
Chapter
1
Introducing Workflow 7.0
This chapter includes the following topics:
■
About Symantec Workflow 7.0
■
Basic elements of Symantec Workflow 7.0
■
How Symantec Workflow 7.0 works
■
What you can do with Symantec Workflow 7.0
■
Where to get more information about Symantec Workflow 7.0
About Symantec Workflow 7.0
Symantec Workflow 7.0 is a graphical .NET application development tool that
provides advanced logic and workflow to the Symantec Management Platform
and the Altiris solutions. You can use it to edit and implement pre-built workflow
and workflow packs, and you can also build your own workflows.
Workflow refers to the automation of a business process that requires input from
multiple parties to accomplish a business goal. The process may also include
communicating with disparate technologies. This business process can render
segments of its work to its consumers through different user interfaces depending
on the available and appropriate access points for all contributing parties.
Examples of interaction include email, Web forms, handheld devices, or a queue
of workflow tasks requiring action.
In addition to basic Workflow 7.0 capability, Workflow 7.0 includes Process
Manager. Process Manager is a web portal for managing the various parts of a
workflow process—tasks, documents, data, and so on. Process Manager can be
integrated with Active Directory for user authentication, proper access control,
and user management. Process Manager has a graphical interface that is intuitive
and easy to use, making it simple for everyone from management to developers
24
Introducing Workflow 7.0
Basic elements of Symantec Workflow 7.0
to work with the system and get what they need, quickly. Process Manager is also
thoroughly customizable. You can change almost everything about Process
Manager—pages, symbols, webparts, and so on—to create an interface that works
for you. You can also add new pages to Process Manager that embed either Process
Manager contents, or content from the Web or other servers. By letting you design
a hierarchy of pages that suit your specific needs, Process Manager lets you work
the way you want to work, yet still work within a larger process framework.
Basic elements of Symantec Workflow 7.0
Workflow 7.0 is not a single piece of software. It has five main pieces—Workflow
Solution, Workflow Designer, Workflow Server, Process Manager, and client tools.
Table 1-1
Pieces of Workflow 7.0
Software piece
Description
Workflow Solution
Workflow Solution is the solution piece that lives in the
Symantec Management Console. It handles licensing and
reports. It also integrates Workflow Designer and Workflow
Server with the Symantec Management Platform. This
integration lets Workflow have interactions with other
solutions, such as creating tasks other solutions can utilize.
The solution piece also lets you distribute components
through Symantec Management Portal.
See “ About Workflow 7.0 and the Symantec Management
Console” on page 34.
Workflow Designer
Workflow Designer is the tool used to design processes. It
contains components you can arrange into processes and
then publish to a Workflow Server. It gets installed on
computers other than the SMP host.
See “About Workflow Designer 7.0” on page 51.
Workflow Server
Workflow Server runs and manages published workflow
projects. It is the execution engine (or runtime engine) for
all published processes. It gets installed on any computer
to which you want to publish: a designated server or your
local computer. Workflow Server must be installed on any
computer with Workflow Designer.
See “About Workflow Server 7.0” on page 39.
Introducing Workflow 7.0
Basic elements of Symantec Workflow 7.0
Table 1-1
Pieces of Workflow 7.0 (continued)
Software piece
Description
Process Manager
Process Manager is a Web portal used to manage published
processes that include human interaction.
Process Manager provides the following:
■
It lets users view and manage tasks.
It lets administrators get reporting on the running
processes and their states.
■ It contains a storage area for documents, articles, and
schedules so users can communicate with each other
and store that communication.
■
Process Manager should be installed on a central Process
Manager server.
See “About Process Manager” on page 179.
Client tools
Workflow client tools are a number of tools that support
Workflow 7.0. The tools are as follows: Business TimeSpan
Editor, Composer Theme Editor, Configuration and Logging
Tool, Local Machine Info Editor, Messaging Console,
Notification Server Credentials Tool, Profiler Tool, Scheduler
tool, Server Extensions Configurator, Task Tray Tool, Tool
Preferences Editor, and Translation Editor.
You do not need to install all the pieces of Workflow 7.0 on the same computer.
Symantec recommends that you do not install them all on the same computer.
For example, if you install Workflow Designer on computers other than the
Symantec Management Platform computer, the design computers can connect
with the Symantec Management Platform computer so multiple users can make
changes to workflow projects and create new ones. Workflow Server is necessary
to run Designer, so it is automatically installed with Designer. Workflows created
in Workflow Designer can run on one or more Symantec Management Platform
servers.
See “About Workflow Server 7.0” on page 39.
For more information on installation and configuration, see the Workflow 7.0
Installation and Configuration Guide:
www.aliris.com/support/documentation.aspx
25
26
Introducing Workflow 7.0
How Symantec Workflow 7.0 works
How Symantec Workflow 7.0 works
The Symantec platform architecture consists of several key parts: CMDB, Item
Object Model, Resource Model, Solution Layer, UI Framework, and the ASDK
(Altiris Software Development Kit). Symantec Workflow 7.0 interacts with the
Symantec platform and its parts through a Webservices layer and custom
Webservices installed directly onto the Symantec Management Console. However,
not all workflow processes directly integrate with the Symantec Management
Platform. A workflow may have no other interaction or dependence on the platform
except licensing for the copy of Workflow Designer being used to create it. For a
workflow process that integrates with the platform or another solution, the
workflow makes method calls to different parts of the Symantec platform
depending on the interaction. For example, a component that can escalate a
ServiceDesk incident would make a method call to ServiceDesk to change the
priority, impact, or urgency.
Process Manager is an integrated application containing Webservices that let you
encapsulate, track, manage, and control all aspects of a workflow process. Built
on these Webservices is a fully ASP.NET 2.0 compliant portal. This gives Process
Manager the capability of Web parts, customizable pages, and themes so you can
work the way you want to work. Process Manager is built on a Microsoft SQL
Server database.
What you can do with Symantec Workflow 7.0
Workflow 7.0 has an immense number of uses. You can create almost any kind of
business application with Workflow 7.0. You can create applications that monitor
systems (hardware or software), manage communication, manage data analysis
and delivery from databases or other sources, execute complex logic, and use the
functions of other tools (including any Webservice). The application possibilities
are endless.
One of the most useful functions of Workflow 7.0 is its ability to manage human
interactions in a business process. The current Altiris solutions are linear, making
interaction with people while executing the process a challenge. With Workflow
7.0, you can insert human interaction points in key places, while leveraging data
and existing solutions that are available through the Symantec platform. Each
interaction point, with either a person or a technology, is controlled by a
component in the workflow process. This interaction can include communicating
with a database, creating a task in Process Manager or SharePoint, and any
supporting or third-party technology necessary to accomplish the goal.
Process Manager is an integrated application that has many capabilities, including
knowledge base, document management, scheduling, reporting, workflow tracking,
Introducing Workflow 7.0
Where to get more information about Symantec Workflow 7.0
and user management. Process Manager can also host workflow projects. You can
create a workflow project and publish it to Process Manager so you can invoke it
and manage it in Process Manager. Workflow projects can be set up to create tasks
in Process Manager for users to see in their task lists.
Where to get more information about Symantec
Workflow 7.0
For more information, refer to the information sources in the following table.
Table 1-2
Where to get more information
Information source
Location
Workflow SWAT
www.workflowswat.com
Symantec Management Platform https://.kb.altiris.com
7.0 Release Notes
Altiris 7.0 Planning and
Implementation Guide
https://.kb.altiris.com
Installing the Symantec
Management Platform 7.0
products
https://.kb.altiris.com
Knowledge Base
https://.kb.altiris.com
Symantec Connect
http://www.symantec.com/connect/
27
28
Introducing Workflow 7.0
Where to get more information about Symantec Workflow 7.0
Chapter
2
Getting started with
Workflow 7.0
This chapter includes the following topics:
■
About Workflow Designer, Workflow Server, and Process Manager
■
Installing and configuring Workflow 7.0
■
Workflow 7.0 and LogicBase Terminology
■
About Workflow 7.0 and the Symantec Management Console
About Workflow Designer, Workflow Server, and
Process Manager
The following graphic is a basic illustration of how Workflow Designer 7.0,
Workflow Server 7.0, and the Symantec Management Platform relate to each
other:
30
Getting started with Workflow 7.0
About Workflow Designer, Workflow Server, and Process Manager
In a basic configuration, a Workflow Designer computer publishes completed
workflow projects to a central Workflow Server computer. The Workflow Server
computer connects to the Symantec Management Platform computer for licensing
and possibly to publish functionality into the Symantec Management Console.
However, this graphic can be misleading because Workflow Server is installed on
every computer running Workflow Designer. In the graphic above, the Workflow
Server computer represents a central computer to which other Workflow Designer
computers can also publish. Also, the above graphic does not show Process
Manager, which can be installed on the Workflow Server computer or another
computer.
Workflow Designer provides a graphical view of the workflow components so you
can build a process. You use it to build, test, and publish your processes. When
you finish a workflow project, you publish the process to one or more Workflow
Servers. During publishing you can also choose to publish to the Symantec
Management Console.
See “Installing and configuring Workflow 7.0” on page 32.
Getting started with Workflow 7.0
About Workflow Designer, Workflow Server, and Process Manager
The following graphic is another representation of the relationship between
Workflow Designer 7.0, Workflow Server 7.0, and the Symantec Management
Platform:
Workflow Server is a Microsoft Web Server, so every process runs as a Webservice
on the Workflow Server. All communication is linked by inbound and outbound
HTTP communication.
Publishing workflow items to the Symantec Management Console is a separate
option when publishing. If you choose to publish to the Symantec Management
Platform, the platform server receives link information to the project on the
Workflow Server computer. Simply publishing to Workflow Server does not send
link information to the Symantec Management Console.
31
32
Getting started with Workflow 7.0
Installing and configuring Workflow 7.0
While Workflow Server runs on every computer running Workflow Designer,
Symantec recommends establishing at least one central, designated computer to
run Workflow Server. Designer computers can publish to this server. If the only
instances of Workflow Designer and Server you have running are on the same
computer, Designer can only publish processes to the local computer.
The graphic above does not show Process Manager, which can be installed on the
Workflow Server computer or another computer. You can also publish a project
to Process Manager. In that case, like the Symantec Management Console, Process
Manager receives link information to the project on the Workflow Server computer.
See “About Process Manager” on page 179.
See “About publishing a project” on page 105.
Installing and configuring Workflow 7.0
Use the following process for basic guidelines on getting started with Workflow.
For more complete instructions, consult the Workflow 7.0 Installation and
Configuration Guide.
See “Where to get more information about Symantec Workflow 7.0” on page 27.
See “About Workflow Designer, Workflow Server, and Process Manager”
on page 29.
Table 2-1
Process for getting started with Workflow 7.0
Step
Action
Description
Step 1
Install Workflow 7.0 in the
Symantec Installation
Manager.
Installing Workflow through the Symantec
Installation Manager makes Workflow
available in Symantec Management Console.
After you have installed Workflow to the
Symantec Management Platform, you can
download the installer for your local
computer through the Symantec
Management Console.
Step 2
Download the Workflow 7.0 A link to the Workflow installer is available
installer in the Symantec
in Symantec Management Console. Clicking
Management Console.
this link downloads the Workflow installer
to your local computer.
Step 3
Install Workflow
Run the Workflow installer. Because there
are many options during installation, decide
how you want to install before running the
installer.
Getting started with Workflow 7.0
Workflow 7.0 and LogicBase Terminology
Table 2-1
Process for getting started with Workflow 7.0 (continued)
Step
Action
Description
Step 4
Set up licensing.
Licensing is set up through the Symantec
Installation Manager.
See “ About Workflow 7.0 and the Symantec
Management Console” on page 34.
Step 5
Start working with Workflow You can start working with Workflow
Designer.
immediately after installation. A good place
to get ideas is the Workflow 7.0 Component
Examples Reference Guide.
See “Where to get more information about
Symantec Workflow 7.0” on page 27.
Workflow 7.0 and LogicBase Terminology
While using Workflow 7.0, you may come across unfamiliar names and terms
such as "Ensemble" and "Logicbase." These are legacy terms that still appear in
some Workflow 7.0 files. If you are a legacy user, you know these terms and the
new terms to which they correlate. If you are not a legacy user, these terms can
be confusing. Use the table below to reference the meaning of these terms.
See “Workflow Designer project types” on page 55.
Table 2-2
Workflow 7.0 and LogicBase naming of project types
LogicBase project types
Workflow 7.0 equivalent
Composer Web Forms
Forms (Web)
Composer Windows Forms
Forms (Windows)
Maestro
Decision Only
Harmony
Workflow
Metronome
Monitoring
Virtuoso
Integration
Table 2-3
Other LogicBase terms
Legacy term
New term
LogicBase
Workflow 7.0
33
34
Getting started with Workflow 7.0
About Workflow 7.0 and the Symantec Management Console
Other LogicBase terms (continued)
Table 2-3
Legacy term
New term
Ensemble
Process Manager
Deploy
Publish
About Workflow 7.0 and the Symantec Management
Console
After you have installed Workflow 7.0, you can view it in the Symantec
Management Console. You can also view workflows published to the console and
Workflow licenses.
Table 2-4
Key interactions in Symantec Management Console for Workflow
7.0
Interaction
Description
Workflow licenses in Symantec
Management Console
Workflow 7.0 has only one license; only the Workflow Solution piece (the piece
of Workflow 7.0 that lives in the Symantec Management Console) is licensed.
When you download the product, Workflow comes with a 10-day evaluation
license. You can view and manage licenses in the Notification Server Management
Home page (Home > My Portal > Portal Pages > Notification Server
Management Home).
You can add licenses by clicking Add licenses. This link opens the Symantec
Installation Manager, which handles the installation of all licenses.
Workflow servers in Symantec
Management Console
All Workflow Servers should be registered in the Symantec Management Console.
You can view registered servers in the console. Registered servers are listed
under Settings > All Settings, then in the left pane Service and Asset
Management > Workflow > Manage Workflow Servers > Manage Workflow
Servers.
You can only view registered servers; no management functions are available
at this time.
Getting started with Workflow 7.0
About Workflow 7.0 and the Symantec Management Console
Table 2-4
Interaction
Key interactions in Symantec Management Console for Workflow
7.0 (continued)
Description
Published workflows in Symantec When you publish a workflow, you can optionally publish it to the Symantec
Management Console
Management Console. When published to the console, the workflow still gets
published to Workflow Server, but it also appears in the console as one of three
items: right-click action, task, or item.
All workflows published to the Symantec Management Console appear under
Settings > All Settings, then in the left pane Notification Server, then in the
right pane Published Workflows.
All published workflows fall into one of two categories: Dialog Workflows and
Service Workflows.
See “Publishing projects to Symantec Management Console 7.0” on page 149.
You can invoke a published workflow by right-clicking the workflow and clicking
Open. Dialog Workflows display a form in the right pane, while Service
Workflows display only workflow settings.
Workflow right-click actions in
Symantec Management Console
Right-click actions appear in the right-click menus of target class items. Target
class refers to the class of items that get the right-click action (such as
Computers).
See “Publishing a workflow as a right-click action in the Symantec Management
Console” on page 152.
Workflow tasks in Symantec
Management Console
Tasks appear under Manage > Jobs and Tasks, then in the tree structure on the
left under System Jobs and Tasks > Notification Server.
35
36
Getting started with Workflow 7.0
About Workflow 7.0 and the Symantec Management Console
Section
2
Using Workflow Server 7.0
■
Chapter 3. Workflow Server 7.0
38
Chapter
3
Workflow Server 7.0
This chapter includes the following topics:
■
About Workflow Server 7.0
■
Viewing a project on Workflow Server
■
Server Extensions Configurator
About Workflow Server 7.0
When you publish a project, the project goes to Workflow Server. Workflow Server
is a Microsoft Web Server and handles all processing of projects. Workflow Server
stores published projects as Webservices.
See “About publishing a project” on page 105.
For users to be able to publish a project from a Workflow Designer computer to
a Workflow Server computer, the two computers must have two-way
communication established. All communication is linked by inbound and outbound
Webservices using HTTP communication.
When projects are published, they get added to the service catalog on the Workflow
Server. Published projects can then be called by the Symantec Management Console
or any other caller that has communication set up with the Workflow Server.
One Workflow Server can receive workflow processes from one or more Workflow
Designers.
The following graphic illustrates multiple Workflow Designer computers
publishing to a single Workflow Server computer:
40
Workflow Server 7.0
About Workflow Server 7.0
The following graphic illustrates how multiple Workflow Server computers can
be used to process workflow requests from one Symantec Management Platform
server:
Workflow Server 7.0
About Workflow Server 7.0
The following graphic illustrates how one Workflow Server computer can run
projects that interact with more than one Symantec Management Platform server.
41
42
Workflow Server 7.0
Viewing a project on Workflow Server
See “Viewing a project on Workflow Server” on page 42.
See “Server Extensions Configurator” on page 43.
See “Setting up the Symantec Management Console URL in Workflow Server”
on page 43.
See “Server Extensions Configurator page” on page 44.
Viewing a project on Workflow Server
When you publish a workflow to a Workflow Server computer, the workflow runs
on that computer in a Web site in IIS.
See “About Workflow Server 7.0” on page 39.
Workflow Server 7.0
Server Extensions Configurator
To view a project on Workflow Server
1
On the Workflow Server computer, click Start Menu > All Programs >
Administrative Tools > Internet Information Services (IIS) Manager.
2
In IIS, in the left pane, click Web Sites > Default Web Site.
3
Click on the virtual directory that has the same name as the project you want
to view.
Server Extensions Configurator
The Server Extensions Configurator is a tool that lets you define all the properties
for the Workflow Server. It is located in the Tools section of Workflow 7.0 (Start
> Programs > Altiris > Workflow Designer > Tools > Workflow Designer Server
Extensions Configurator).
See “About Workflow Server 7.0” on page 39.
See “Setting up the Symantec Management Console URL in Workflow Server”
on page 43.
See “Setting up Workflow Designer to publish to multiple Workflow Servers”
on page 113.
See “Server Extensions Configurator page” on page 44.
Setting up the Symantec Management Console URL in Workflow Server
You need to set up the URL of the Symantec Management Console that the
Workflow Server needs to work with. The Workflow Server uses the Symantec
Management Console URL in the Server Extensions Configurator to send the
projects to the intended Symantec Management Console server.
See “About Workflow Server 7.0” on page 39.
To set up the Symantec Management Console URL in Workflow Server
1
On the Workflow Server computer, click Start Menu > All Programs > Altiris
> Workflow Designer > Tools > Workflow Designer Server Extensions
Configurator.
2
In the Deployment section, in the Deployment Info box, click [...].
3
In the Root URL box, enter the URL of the Symantec Management Console
that this Workflow Server should send project information to.
4
Click OK.
43
44
Workflow Server 7.0
Server Extensions Configurator
5
Click OK.
6
Click Yes to save changes.
Server Extensions Configurator page
The Server Extensions Configurator is a tool that lets you define all the properties
for the Workflow Server. It is located in the Tools section of Workflow 7.0 (Start
> Programs > Altiris > Workflow Designer > Tools > Server Extensions
Configurator).
See “About Workflow Server 7.0” on page 39.
This page lets you define all the properties for the Workflow Server.
Table 3-1
Options in the Server Extensions Configurator page
Option
Description
Server Extensions Port Number
Enter the default remoting port that Workflow Server uses to communicate with
Server Extensions in order to publish new projects. Default: 11434
Run Message Server
Select to run the default exchange server included with Workflow 7.0. This is
the default way of storing and moving data.
Run Deployment Server
Set this to let this Workflow Server accept projects. If this setting is cleared,
this Workflow Server does not accept any projects from any Workflow Designers.
Workflow Server 7.0
Server Extensions Configurator
Options in the Server Extensions Configurator page (continued)
Table 3-1
Option
Description
Deployment Info
Click [...] to configure how this Workflow Server manages projects.
■
■
■
■
■
■
■
Physical Root Directory
Enter the physical directory on this Workflow Server to which you want
projects to reside. Workflow Server creates Debug and Release sub-directories
to store different workflow versions.
Root URL
Enter the default base URL that Server Extensions uses to configure projects
being deployed to this Workflow Server. Changing this lets projects leveraging
workflow have a different BASE URL that might be externally accessible.
This property should almost always be changed on a production server.
IIS Root Path
Enter the IIS root path. This lets Workflow Server create Virtual Directories
under a specific Web Site within IIS. Default IIS installations have a Web
Site called Default Web Site. If you have another Web Site that you want to
be the Web Site to which you publish your projects, then you need to change
this property.
The easiest way to find your Web Site's ID is to open the IIS control panel,
choose Properties on the Web Site, and look at the path to your log files.
Create App Name
Enter the executable that is used to create new virtual directories under your
Web server for your projects. CreateVirDirectory is the utility provided by
Workflow Server to use with IIS.
Temp App Prefix
Enter the prefix used to indicate projects that are being published to the
server on a temporary basis. This is mostly used for testing.
Ds File Name
Enter the file used to store information about temporary publishing so that
they can be cleaned up later. This is not often used in production computers.
Authentication Required
Set this to turn on an authentication system so that only authorized users
can publish applications from Workflow Designer to the server. The
authentication system used is by Process Manager.
Remove Deploy Directory Itself
Select to delete the publishing directory as well as its contents when you redeploy.
Republishing deletes the contents of a folder and puts the new files in its place.
Run Licensing Server
Set this to control whether or not this instance of Server Extensions will run a
licensing server. Projects that are not signed with a special signing license require
some form of on-server license to be available. You cannot run unlicensed
projects on an unlicensed server by simply disabling the Licensing Server. Doing
so produces unexpected results.
45
46
Workflow Server 7.0
Server Extensions Configurator
Options in the Server Extensions Configurator page (continued)
Table 3-1
Option
Description
Run Proxy Server
Proxy server is not currently available.
Click [...] to configure the proxy server.
■
■
■
■
■
■
AutoTrigger Info
Default URL
Enter the proxy server URL.
Host
Enter the IP Address of the proxy server.
Persistent Applications
Click Add to add applications that you want to persist on the proxy server.
Phone Number To Call
Enter the phone number to the proxy server that is handed back to developers
using the proxy so that they know how to contact their application.
Port Lower Bound
Enter the lower boundary of a range of ports that the proxy server can use
to dynamically allocate services to a speech application. Make sure that there
are no ports in use on your server between the upper and lower bound.
Port Upper Bound
Enter the upper boundary of a range of ports that the proxy server can use
to dynamically allocate services to a speech application. Make sure that there
are no ports in use on your server between the upper and lower bound.
Click [...] to configure the automatic invoke of local webservices.
■
■
■
■
■
Auto Invoke Local Web Services
Select to automatically invoke local webservices.
Polling Service List Interval Minutes
Enter the minutes between polling of the Webservice list.
Polling Interval
Enter the minutes between polling of the Webservice.
Delay Seconds
Enter the number of seconds to delay the automatic invoke of local
Webservices.
Number of Retries
Enter the number of retries for the automatic invoke of local Webservices.
Workflow Server 7.0
Server Extensions Configurator
Options in the Server Extensions Configurator page (continued)
Table 3-1
Option
Description
Manual Setup Info
The manual setup info property controls the Workflow Job Server. The Job Server
is one of the most basic elements of Workflow because it checks published
processes for pending actions (such as task creation, escalations, or timeouts).
It discovers Webservices of published workflows, and can also make calls to
configured Webservices outside of workflow.
Run Web Services
Turns the Job Server on or off
■ Defined URLs To Invoke
URLs for Webservices you want to invoke. The method name is the name of
a method you want to run on your Webservice. For a workflow project, the
method name refers to an invocable secondary model in your project. Select
Auto Scheduled for only Auto Start projects. A Webservice set to Auto
Schedule always runs the auto invoke method.
■ Second Between Service Invokes
Number of second between each Job Service check.
■ Use Credentials
If necessary, specify the credentials needed to invoke a Webservice.
■
HTTP Authentication
Click to enter the Username and Password for the HTTP authentication of this
Workflow Server.
Reun Debugger
Select to run the internal designer debugger.
Run Web Server
Select to use the virtual directories for the internal Web server instead of IIS.
Click [...] to configure the Web server information.
Port
Enter the port of the Web server.
■ Applications
Click Add to enter applications accepted by the Web server.
■ Reload Pages
Click to Reload the Web server pages.
■
Run FTP Server
Select to allow FTP access to Process Manager folders.
Run SMTP Server
Configure this property if you want to use Workflow's SMTP Server.
47
48
Workflow Server 7.0
Server Extensions Configurator
Section
3
Using Workflow Designer 7.0
■
Chapter 4. Introducing Workflow Designer 7.0
■
Chapter 5. Using tasks created in a workflow project
■
Chapter 6. Working with projects
■
Chapter 7. Using the component generators
50
Chapter
4
Introducing Workflow
Designer 7.0
This chapter includes the following topics:
■
About Workflow Designer 7.0
■
Workflow Designer loading window
■
Workflow Designer tool
About Workflow Designer 7.0
Workflow Designer is the tool used to design processes. It contains components
you can arrange into processes and then publish to a Workflow Server. After you
use Workflow Designer to build and test your projects, you can publish the project
to the Workflow Server.
After you publish a project, you can always open it again, edit it, and republish.
When you open Workflow Designer, you see the Workflow loading window first.
The Workflow loading window lists your projects, displays a preview of the selected
project, and opens a project when you double-click it.
See “Workflow Designer loading window” on page 53.
From the Designer loading window, you can create or open projects. Projects open
into the Workflow Designer tool.
See “Workflow Designer tool” on page 60.
52
Introducing Workflow Designer 7.0
About Workflow Designer 7.0
Figure 4-1
Workflow loading window
Introducing Workflow Designer 7.0
Workflow Designer loading window
Figure 4-2
Workflow Designer
Workflow Designer loading window
The Workflow Designer loading window has multiple functions. You open projects
with the Workflow Designer loading window and also manage tool preferences
(for example, look and feel of Workflow Designer) and global settings (for example,
the server locations and publishing parameters for projects). However, the majority
of time, you use the Designer loading window to launch the Workflow Designer
tool so you can create and edit projects.
The Local Projects tab lists any projects that are available for viewing or
modification through Workflow Designer.
To launch the Workflow Designer tool, either add a new project or open an existing
project listed in the Local Projects window, or double-click a project file from a
local directory.
See “Opening the Designer loading window” on page 54.
See “Editing Workflow Designer preferences” on page 55.
See “Workflow Designer tool” on page 60.
53
54
Introducing Workflow Designer 7.0
Workflow Designer loading window
Opening the Designer loading window
To open the Designer loading window
◆
Open Workflow Designer by clicking Start Menu > All Programs > Altiris >
Workflow Designer > Workflow Designer.
The designer loader screen appears and toolbars, tabs, a preview window, and
view controls are present. You can open the Workflow Designer tool by creating
a new project.
See “Workflow Designer loading window” on page 53.
See “Workflow Designer tool” on page 60.
Creating a new project
You can create a new project from the Workflow loading window.
See “Workflow Designer loading window” on page 53.
When you create a new project, you must choose a project type.
Choosing the correct project type is very important for the success of your project.
Every project type is different; each project type has its own set of available
components and settings. If you choose the wrong project type, you may not be
Introducing Workflow Designer 7.0
Workflow Designer loading window
able to create the functionality you want your project to have. Also, after you
create a project of a certain type, your cannot convert the project to another
project type. If you decide to change project types while you are building a project,
you must start over in a new project. (You may be able to copy and paste some of
your components into the new project.)
If you do not know what project type to choose, read the descriptions in the
following section:
See “Workflow Designer project types” on page 55.
To create a new project
1
Open Workflow Designer.
2
In the Workflow loading window, click New.
3
Click a project type, and then name your project.
Use a name for your project that represents the basic function of your project
(for example: SendVacationScheduleToManager).
4
Click OK.
Editing Workflow Designer preferences
You can change the preferences for Workflow Designer from the Designer loading
window. These preferences are global to all projects on this Workflow Designer.
See “Workflow Designer loading window” on page 53.
To edit Workflow Designer preferences
1
Start the Workflow Designer by clicking Start Menu > All Programs > Altiris
> Workflow Designer > Workflow Designer.
2
Click File > Edit Tool Preferences.
3
Make the changes you want.
See “Symantec component datatypes” on page 573.
4
Click OK.
Workflow Designer project types
Projects are categorized into several project types. When you create a new project,
the first thing you do is choose the type of project you want it to be. You choose
the project type based on your business-related needs and how end-users will
interact with the finished product. After you pick a project type, you cannot change
the project to another type.
55
56
Introducing Workflow Designer 7.0
Workflow Designer loading window
Projects can be tied together using features within Workflow Designer, but each
project should be selected based on the end results. For example, while a Forms
project type produces Web forms for user interaction, if multiple parties need to
interact with forms in a coordinated way to accomplish the business goal, then a
Workflow-type project would be the best choice.
Note: After you pick a project type, you cannot change it. If you begin a project of
a certain type and later decide to change it, you will have to start over with a new
project.
You can export most components from any project and import them into any
project. However, there are components that are specific to project types that
cannot be used in other project types. For example, workflow components are
only accessible within a Workflow-type project and Forms components are only
available in Form project types.
The following are available project types:
■
Decision-Only-type project
■
Workflow-type project
■
Forms-type project
■
Integration-type project
■
Monitoring-type project
Decision-Only-type project
Use a Decision-Only-type project when you need all the logic capabilities of
Workflow 7.0, but you do not need any user interaction. A Decision-Only-type
project is ideal for a project that interacts primarily with back-end systems, or
that consists mostly of business decisions. It can be used for business rules and
making automated decisions. It can be used whenever you need to process
information without user involvement. For example, a Decision-Only-type project
is ideal for a process that screens loan applications or for a process that
pre-populates documents that require signatures. The Decision Only project can
handle thousands of transactions per second and runs as a Webservice or as a
.DLL. It can use the Integration generators for connecting to databases,
Webservices, and so forth.
Decision Only-type projects can be published as .DLLs and consumed by developers
writing other software applications.
See “Workflow Designer project types” on page 55.
See “Workflow-type project” on page 57.
Introducing Workflow Designer 7.0
Workflow Designer loading window
See “Forms-type project” on page 57.
See “Integration-type project” on page 59.
See “Monitoring-type project” on page 59.
Workflow-type project
Use a Workflow-type project when you need user interaction based on a task. A
Workflow-type project is ideal for a project that creates tasks for users and takes
steps based on user decisions. Workflow-type projects are the only type of projects
that can create a task and pause execution until the user completes the task.
Special components called Workflow components (such as Dialog Workflow) pause
execution and wait for user interaction. Workflow components have properties
to control the behavior of delivering a task, set conditions on how to deliver and
how long to wait, and control how to deal with a task that has been waiting for a
response for too long. These components are available only in Workflow-type
projects.
Workflow and Forms are the two project types that use forms. In a Workflow-type
project, the user is invited to the form by a task; in a Forms-type project the user
actively opens the form (through a link or otherwise).
In a Workflow-type project, human interaction occurs primarily through a user
interface (such as Process Manager) or email. Workflow-type projects are ideal
for document routing, document approval, human resources requests, and IT
department approvals.
The Workflow project type is the most commonly used project type in Workflow
7.0. Workflow-type projects have more available functionality than any other
project type. In addition to being able to create tasks, Workflow-type projects
include all the logic capabilities of Workflow 7.0, and they can interact with
disparate systems using generated components.
See “Workflow Designer project types” on page 55.
See “Decision-Only-type project” on page 56.
See “Forms-type project” on page 57.
See “Integration-type project” on page 59.
See “Monitoring-type project” on page 59.
Forms-type project
Use a Forms-type project when you need user interaction immediately in a Web
form or Windows form. A Forms-type project is ideal for a project that interacts
57
58
Introducing Workflow Designer 7.0
Workflow Designer loading window
with a single user in a Web or Windows form. Forms-type projects are linear,
user-interface-based processes.
Workflow and Forms are the two project types that use forms. In a Workflow-type
project, the user is invited to the form by a task; in a Forms-type project the user
actively opens the form (through a link or otherwise).
Forms-type projects can produce the following forms: Web forms, Win32 forms,
Cisco Phone forms, and Blackberry forms. You can quickly create forms that have
graphics and themes that let a user enter information or make a decision about
information. A Forms-type project using Web Forms creates ASPX applications
that run on Microsoft IIS. A Forms-type project using Windows Forms creates
desktop applications that can run in any Windows .NET environment and run on
the desktop like any other application.
Forms-type projects are ideal for Web surveys, statistical display (such as a
dashboard), and non-task-based management applications (such as a conference
room reservation application).
See “Workflow Designer project types” on page 55.
See “Decision-Only-type project” on page 56.
See “Workflow-type project” on page 57.
See “Integration-type project” on page 59.
See “Monitoring-type project” on page 59.
You can use a Web forms-type project to create applications for mobile devices.
Created mobile-enabled forms is identical to creating regular Web forms except
for some limitations on form controls and display. Workflow-type projects can
also be set to use mobile forms.
You can set your Web forms-type project to use mobile forms in your project's
Publishing tab.
You can set the project to one of the following settings:
Default
Uses the Web setting.
Web
Use this setting if your project displays forms for only full
Web displays.
Mobile
Use this setting if your project displays forms for only
mobile Web displays.
Introducing Workflow Designer 7.0
Workflow Designer loading window
MobileAndWeb
Use this setting if your project could be displayed in either
full or mobile Web displays. The MobileAndWeb setting
displays your Web forms normally unless they are accessed
from a mobile device. The reduction of a mobile display may
make some form controls unuseable. Symantec recommends
thoroughly testing Web forms projects that use the
MobileAndWeb setting.
Integration-type project
Use an Integration-type project when you need to create new components or
datatypes to be used in projects of other types. Integration-type projects are
different from the other project types. They do not use component configurations
to create processes; they actually create components and datatypes to be used in
projects of other types. Integration-type projects generate code (which can be
compiled or used as raw source code) using the integration engine and custom
parameters. For the Symantec Management Platform, Integration-type projects
are used to build Task, Resource, ASDK, and Report components.
See “Workflow Designer project types” on page 55.
See “Decision-Only-type project” on page 56.
See “Workflow-type project” on page 57.
See “Forms-type project” on page 57.
See “Monitoring-type project” on page 59.
Monitoring-type project
Use Monitoring-type projects when you need all the logic capabilities of Workflow
7.0 without any user interaction, and you want the project to run on a schedule.
A Monitoring-type project type is ideal for an analytical, logic-based application
that runs on a schedule in the background of other processes. Monitoring-type
projects are normally invoked by a triggering event or on a schedule. The
Monitoring project can be published as a task tray application, a Windows desktop
service, or a Webservice.
You can use the Monitoring project to monitor the pulse of your business. Some
examples include: running a scheduled troubleshooting script that monitors
another application, monitoring data for certain conditions and taking some action
as a result, monitor hardware, check databases, monitor incoming faxes, and start
a new workflow.
See “Workflow Designer project types” on page 55.
See “Decision-Only-type project” on page 56.
59
60
Introducing Workflow Designer 7.0
Workflow Designer tool
See “Workflow-type project” on page 57.
See “Forms-type project” on page 57.
See “Integration-type project” on page 59.
Workflow Designer tool
The Workflow Designer tool lets you create and edit projects. The Workflow
Designer tool contains toolbars, a project tree, a component tool box, and a
workspace.
See “Workflow Designer project tree” on page 69.
See “Project Workspace” on page 75.
See “Component Toolbox” on page 76.
See “Validating a project model” on page 77.
See “Packaging a project” on page 115.
See “Reloading a project” on page 117.
See “Generating project reports” on page 80.
See “Creating a project model” on page 77.
See “Importing a workflow model” on page 78.
See “About publishing a project” on page 105.
Introducing Workflow Designer 7.0
Workflow Designer tool
Table 4-1
Navigational Tips
Navigation type
Description
Context Menus
As you begin using Workflow Designer, you can right-click at any time
to see the context specific options. The options change based on what
you select within the development environment.
Tool Tips
To assist with learning and navigation, each symbol displays a tool
tip when you hover over a selection.
Windows
Thumbnails
The thumbnail appears throughout Workflow Designer windows,
typically on toolbars. If you click on the thumbtack symbol (located
to the far-right of the toolbox window), the toolbox automatically
hides when it is not needed, and only appears when you hover with
your cursor.
Embedded UIs
The ellipsis ([...])appears throughout Workflow Designer. When you
see this in a window, there is an embedded UI for selecting a piece of
information relevant to the task at hand. For example, double-click
the Start component. Next to the Description and Override
Background Color fields, you see the ellipsis.
61
62
Introducing Workflow Designer 7.0
Workflow Designer tool
Table 4-1
Navigational Tips (continued)
Navigation type
Description
Views
Throughout Workflow Designer, there are two ways of viewing your
project: Diagram and Browser. The Diagram view is the most efficient
way to view your project, by showing the picture or presenting a
simpler, more visual representation of your view. The Browser view
shows a lower level of detail and organization.
About workflow components
Workflow components are the building blocks of workflow projects. They are
graphical representations of singular functions in a workflow. Out of the box,
Workflow Designer contains components that you use to create a workflow. You
use these components to create a process in the workspace of Workflow Designer.
Workflow Designer includes many hand-coded Symantec components. Most are
available immediately, but some are available only by running component
generators.
See “Generating libraries with the Symantec Management Platform generators”
on page 136.
Different Symantec components work with different parts of the Symantec
platform. Each component has a unique function: working with resources, tasks,
and activities in the Symantec Management Console, working with Symantec
Solutions (such as Deployment Solution), and so on. All Symantec components
have a live connection to the Symantec Management Platform server. This
connection lets components view available resources and tasks and perform
actions against them as part of a workflow.
To be able to use Symantec components in your project, your project must have
a Create Notification Server Credentials component with valid credentials.
See “Design time and run time Symantec Management Console credentials”
on page 140.
See “Generating libraries with the Symantec Management Platform generators”
on page 136.
See “About the component generators” on page 120.
Introducing Workflow Designer 7.0
Workflow Designer tool
Components that are available for use in your project are listed in the component
toolbox of Workflow Designer. A search box is provided so you can quickly find
components by name.
63
64
Introducing Workflow Designer 7.0
Workflow Designer tool
Some components are provided in component libraries that are not listed in the
component tool box. To import component libraries, you need to click the Import
Components in Workflow Designer.
Introducing Workflow Designer 7.0
Workflow Designer tool
See “Importing Components” on page 68.
Adding components to a project
When you open a project in Workflow Designer, there are some components
already in the workspace (a Start component, an End component, and possibly a
Create Notification Server Credentials component). All other components are in
the component toolbox.
See “Component Toolbox” on page 76.
To add components to a project
1
In an open project in Workflow Designer, in the component toolbox find the
component you want to add to your project.
To find a component, search for it in the search bar, or look for it in the
component folders.
2
When you find the component you want to add, click on it and drag it onto
the workspace.
If you drag-and-drop a component from the component toolbox directly onto
an existing component connection, the component will be connected
automatically.
65
66
Introducing Workflow Designer 7.0
Workflow Designer tool
Connecting components
In an open project in Workflow Designer, when you drag-and-drop a component
onto the workspace it is not connected to any other components. Components
must be connected to work. A component must have a connection for its input
path and all of its outcome paths for it to work.
If you drag-and-drop a component from the component toolbox directly onto an
existing component connection, the component will be connected automatically.
You cannot connect to some components, such as a Start component or an Auto
Start component (such as Configurable Auto Start).
To connect components
1
In an open project in Workflow Designer, drag-and-drop a component from
the component toolbox onto the workspace.
See “Adding components to a project” on page 65.
2
Click on the component you just added to the workspace.
Gray nodes appear around the component. The nodes are the connection
points.
3
Click on one of the gray nodes that appears around the component, and drag
it toward another component.
A blue line and arrow appears. This is the component connection.
4
Release your mouse click when the blue line and arrow connects with another
component.
Copying components to another model
A single project can have many models. These models could be entire processes
or simply sub-processes. Each model can be copied wholly or in part to other
models.
Copying components to another model reproduces everything about the model,
including symbols, properties, and links.
Components can be copied into an existing model or to a new model. If you forget
to select your Start and End Components, this feature automatically inserts the
components into the model.
This feature is very helpful on large projects, as it lets you design and test
sub-projects in isolation from a larger project and transfer tested configuration
back into the Primary Model. Also, when you have already created a complete
sub-project, you can separate the sub-project from the main project.
See “About workflow components” on page 62.
Introducing Workflow Designer 7.0
Workflow Designer tool
To copy components to another model
1
From the Workflow Designer tool, in the workspace, click the components to
copy by Ctrl-clicking each component or by clicking and dragging a window
around the designated components.
2
Click the Copy components to model symbol.
3
Select your copy preferences.
4
■
Replace with embedded model component
Click to replace the selected components with an embedded model
component.
■
Copy to new model
Click to copy the selected components to a new model. Selecting Replace
components with a link to the new model places the selected components
in an embedded model component.
■
Copy to existing model
Click to copy the selected components into an existing model.
Click OK.
Copying properties to other components
Properties that components have in common can be copied from one component
to another. This is useful when you have set up one component and want to copy
one or more of its properties to multiple components (for example, when disabling
multiple components).
See “About workflow components” on page 62.
To copy properties to other components
1
From the Workflow Designer tool, in the workspace, click the components to
copy by Ctrl-clicking each component or by clicking and dragging a window
around the designated components.
The first component selected will be the component to copy properties from.
2
Click the Copy properties symbol.
3
Select the properties you want to copy.
The selected properties will be copied from the first selected component to
all other selected components.
4
Click OK.
67
68
Introducing Workflow Designer 7.0
Workflow Designer tool
Adding components to your personal library
After you have added and set properties on a component within a project, you can
add the component to a personal library for quick access on any project.
See “Component Toolbox” on page 76.
To add components to your personal library
1
From the Workflow Designer tool, in the workspace, right-click on a
component and select Save Component To Library.
2
Enter the name you want and click OK.
To view components in personal library
◆
From the Workflow Designer tool, in the toolbox, click the Library tab.
Components are sorted by name, type, and date. Components in the library
can be added to your project the same way you do in the Components tab.
Start and End components
The Start and End components begin and end your projects. End components
sometimes have the added function of mapping data out of a model. This is true
only in secondary models in the project tree structure or in embedded models.
Importing Components
In an open project in Workflow Designer, you can add to your project only
components that are available in the component toolbox.
See “Component Toolbox” on page 76.
If you want to have more components available in the component toolbox, you
need to import them.
The default component library for a project does not contain all available
components. For example, some projects do not automatically contain workflow
components or web components.
Workflow Designer provides libraries of components that you can import into
your projects as needed. These component libraries are organized according to
the types of work that they are meant to perform. To illustrate what kinds of
things you might find in a component library, a few of them are listed below:
■
Microsoft Office Components
A group of components used to interact with Word and Excel from the Microsoft
Office Suite.
■
Instant Messaging Components
Introducing Workflow Designer 7.0
Workflow Designer tool
A group of components used to send and receive instant messages from popular
messaging protocols.
■
Decision Table Components
A group of advanced components that let you create decision trees and decision
tables for making complex decisions.
In addition to these component libraries, you may also want to import customized
components that were created using one of the component generators.
See “Importing Symantec components” on page 138.
See “Introducing the component generators” on page 119.
To import components
1
From the Workflow Designer loading tool, open a project.
2
Click Import Components.
3
Click the Custom Libraries tab.
4
In the Add Library to Project dialog box, select the libraries you want to import
and click Add.
5
Click OK.
The added components show up under branches with an orange star appearing
in the Component Toolbox.
Component help
Each component comes with instructions on how to set up component parameters.
Right-clicking any component shows a list of available options. One of those
options is Help. By selecting Help from the right-click menu, an HTML file is
shown with a description of the component functionality and information on how
to set component parameters in order for the component to validate and run.
See “About workflow components” on page 62.
Workflow Designer project tree
A Workflow Designer project tree appears on the left side of an open project in
Workflow Designer. The project tree is an organizational representation of your
project.
The following screen shot shows a project tree:
69
70
Introducing Workflow Designer 7.0
Workflow Designer tool
The project tree displays the following items:
■
Project name
The project name is the top item in the project tree structure.
See “Project metadata” on page 70.
■
Model names
Models are sections of a process.
See “About project models” on page 76.
■
Model input and output data
See “About data” on page 78.
■
Model documentation
Designers use model documentation to explain a model for future reference.
See “Project documentation” on page 75.
Project metadata
Project metadata refers to the highest level of data that describes a project. When
a project is open in Workflow Designer, you can view its metadata by clicking on
the project name in the project tree structure.
See “Workflow Designer project tree” on page 69.
A project has only one set of project metadata.
When you click the project name in the project tree structure, you can view the
metadata above the project data tabs (resources, libraries, models, and so on).
Project metadata includes the following properties:
■
Project name
This is the name of the project as it was set when the project was first created.
■
Project type
This is the type of project as it was set when the project was first created. The
types are as follows: Workflow, Decision-Only, Integration, Webforms, and
Windows forms. This data is not editable.
Introducing Workflow Designer 7.0
Workflow Designer tool
■
Description
This is a general description of the project.
■
Author mail
This is the email address of the person who created the project. Including an
email address gives users and later designers a contact for any questions they
may have.
■
Creation date
This is the date when the project was created. This data is not editable.
■
Service ID
By default, this is a global unique identification (GUID) for the project. You
can change this data to anything you want.
The following screen shot shows a project's metadata:
The metadata is everything in the right pane above the data tabs. You can modify
some metadata.
See “Symantec component datatypes” on page 573.
Project data tabs
Project data tabs organize a project's data that is one level lower than metadata.
See “Project metadata” on page 70.
71
72
Introducing Workflow Designer 7.0
Workflow Designer tool
The following table describes each other project data tabs:
Table 4-2
Data tabs
Tab
Description
Resources
Lets you add any file to your project. When you add a
resource to a project, you add a file that will be
compiled with the project data so the project always
has immediate access to the file. For example, if you
use a number of images in your project, you can add
those images as resources so your project has reliable
access to them, and you know they will not be changed.
Resources are similar to project properties and global
data. Symantec recommends using resources and
project properties instead of global data wherever
possible.
When you publish your project all project resources
are compiled with the project code. If you package your
project all project resources are compiled with the
package, so the resources go wherever the package
goes.
See “Resources tab” on page 549.
Introducing Workflow Designer 7.0
Workflow Designer tool
Table 4-2
Data tabs (continued)
Tab
Description
Libraries
Lets you manage the libraries (component .DLL files)
that are available in the component toolbox. You can
add or remove libraries.
See “Libraries tab” on page 551.
See “Component Toolbox” on page 76.
See “Importing Components” on page 68.
Models
Displays models contained within the project.
See “Models tab” on page 551.
See “About project models” on page 76.
Publishing
Displays information and settings used to govern
project publishing to Workflow Server.
See “Publishing tab” on page 552.
Properties
Lets you manage project properties. Project properties
are values that you can use in your project.
Project properties are similar to resources and global
data. Symantec recommends using resources and
project properties instead of global data wherever
possible.
See “Properties tab” on page 557.
Storage Preferences
Lets you set specific parameters (serialization,
datatype, and so on) for data used within the project.
See “Storage Preferences tab” on page 558.
73
74
Introducing Workflow Designer 7.0
Workflow Designer tool
Table 4-2
Data tabs (continued)
Tab
Description
Reporting
Let you configure some settings for how your project
relates to Process Manager. If you are not publishing
your project to Process Manager, disregard this tab.
See “Reporting tab” on page 558.
The following list explains the items in the reporting
tab:
■
■
■
■
■
Add Process Component
Clicking this option adds a Global Logging Capture
component to your process. Without this
component your project cannot communicate with
Process Manager.
Process Prefix
This property is the term that is prefixed to the
instance number of your project in Process
Manager. For example, the first instance of a project
with a prefix of IM will appear as IM-00001 in
Process Manager.
Pad Char
This property is the character that pads the
instance number of your project in Process
Manager. For example, the first instance of a project
with a prefix of IM and a pad character of 0 will
appear as IM-00001 in Process Manager.
Pad Length
This property is the number of pad characters used
in the instance number of your project in Process
Manager. For example, the first instance of a project
with a prefix of IM, a pad character of 0, and a pad
length of 4 will appear as IM-00001 in Process
Manager.
Data Saving Mode
This property refers to the manner in which your
project communicates with Process Manager.
Symantec recommends leaving it set to Messaging
unless you have a specific reason for changing it.
Introducing Workflow Designer 7.0
Workflow Designer tool
Table 4-2
Data tabs (continued)
Tab
Description
Global Data
Lets you manage global data. Global data refers to data
that is universally accessible in your project. You can
access global data in any model without configuring
input values.
Project properties are similar to resources and global
data. Symantec recommends using resources and
project properties instead of global data wherever
possible.
Application Properties
Lets you manage Application Properties. Application
Properties refer to data elements you make available
to a multiple-project application that connects to
Process Manager. If you are not publishing your project
to Process Manager, disregard this tab.
If no Application Properties appear under the tab after
you have clicked Use Application Properties, make
sure a Process Manager server that has application
properties is added in the Workflow 7.0 task tray
application.
Project documentation
A project can be documented using the Documentation tab. For a project, the
documentation should provide the high-level description of the workflow process,
plus any additional details relevant to the workflow configuration. However, it is
there for you to use as wanted.
Annotation components are provided that let you place documentation in your
project. You can also edit component names by double-clicking on the name. We
recommend that you change component names whenever possible to reflect their
functionality in the project.
See “Workflow Designer project tree” on page 69.
Project Workspace
The main portion of any Workflow Designer window is the workspace. This is
where you will spend the majority of your time configuring components or setting
properties. Regardless of the project type selected, the workspace layout appears
and functions similarly.
75
76
Introducing Workflow Designer 7.0
Workflow Designer tool
The primary function of the workspace is to display your project, its components
and its connections graphically, and let you edit the project. You use the workspace
to layout a logical path for your project to take from component to component.
Components can be dragged from the component toolbox to the workspace. Drag
the component directly on a line linking two components to snap the component
into place.
See “Workflow Designer tool” on page 60.
Component Toolbox
The component toolbox contains all the components that are available to use in
your project. The component toolbox consists of three tabs—components, library,
and images—which give you better flexibility in finding your components.
See “About workflow components” on page 62.
Tabs
Description
Components
Contains a listing of all the components currently visible to your
project. The components are divided and organized into categories,
depending on their functionality. The components tab contains two
ways to locate components: a search box and a component tree.
Library
Displays the components you have added to your personal library.
Your personal library usually contains components that you have
made changes to and want to re-use.
See “Adding components to your personal library” on page 68.
Images
This lets you search for components based on the image associated
with the component. Find a component by expanding and collapsing
the image tree.
About project models
Models are sections of a process that are listed in a project’s tree structure. A
model can be either a primary or a secondary model. Every project has one primary
model by default and can have an unlimited number of secondary models. You
can set project models to work together or to work independently.
See “Workflow Designer project tree” on page 69.
Introducing Workflow Designer 7.0
Workflow Designer tool
Creating a project model
You can create models in an open project in Workflow Designer. A project's models
are displayed in the tree structure in the left pane of an open project. Created
models are referred to as secondary models.
See “About project models” on page 76.
Your Primary Model may become congested, or it may have multiple components
that perform similar functions. By creating new models, you can reduce the
complexity of the primary model, and you can assign specific tasks that can be
accessed repeatedly from your Primary Model.
For more information on models, see the Workflow Solution Models Guide. The
Models Guide is located under the Learn tab under Modularizing Workflow
Projects.
www.workflowswat.com
To create a project model
1
Open the workflow project in which you want to create a model.
See “About Workflow Designer 7.0” on page 51.
2
In the left pane of the open project, in the tree structure, right-click on the
project name.
The project name is the top item in the tree structure.
3
Click New Model.
4
Name the model and select a parent model.
Use a name that indicates the basic function and purpose of the model.
5
Click OK.
After you click OK the model appears in the project tree structure.
Validating a project model
A valid workflow has no errors in individual component configuration, component
connections, or project configuration. For example, if you do not have links out
of your Start component or into your End component, you will see validation
errors.
See “About project models” on page 76.
When you validate a project you examine the reliability of the project. During
design time, Workflow Designer shows you validation errors with red exclamation
mark circles. You can also validate your project manually.
77
78
Introducing Workflow Designer 7.0
Workflow Designer tool
The project model needs to be valid before you can test or publish it to your
Workflow Server.
To validate a project model
1
In an open project in Workflow Designer, in the tool bar, click the Validate
symbol.
A detailed message appears identifying problem areas.
2
Alternately, hover over or double-click a component to initiate text explaining
invalid parts.
Importing a workflow model
You can share models between projects, from any Workflow Designer.
See “About project models” on page 76.
Importing external models has the following benefits:
■
Helps promote reuse among projects
■
Isolates complex or distinct process configuration to simplify the model
To import workflow models
1
In an open project in Workflow Designer, right-click the project name in the
tree structure on the left.
The project name is the top item in the tree structure.
2
Click Import Model.
3
Search for and select the model you want to import.
4
Click Open.
About data
Every Workflow project needs data to operate. Components and models operate
on data. Many components require input variables to do their jobs, and many
components create output variables.
Data for a project can be introduced while the project is running, or it can be
introduced before the project runs. Data can be introduced while the project is
running in a number of ways. It can come from a component that queries a
database and retrieves data; it can come from user input in a form; it can be
generated by certain components; it can come from a Webservice call, and so on.
Data can be introduced before the project runs by adding values to a project's
input data. In an open project in Workflow Designer, under a model in the project
tree structure, the input and output data branches establish what data comes in
Introducing Workflow Designer 7.0
Workflow Designer tool
and goes out of the model. Use input data to declare what values must be available
to the project before the project runs. Use output data to declare what values must
come out of the project. You can set input and output data for all models of a
project.
See “Workflow Designer project tree” on page 69.
Workflow Designer handles data based on its datatype. A datatype is a data
classification that describes the nature of the data. For example, a variable with
a value of 15 is probably of datatype integer.
Workflow components handle data according to datatype. For example, a Get
Current Date component produces an outcome variable of type Date (Date Time).
Datatypes are categorized in two major divisions: simple datatypes and complex
datatypes.
Table 4-3
Datatypes
Datatype
Description
Simple datatype
The most basic set of datatypes. Simple datatypes
classify only one piece of data (although that data can
be in an array); they do not have multiple properties
like complex datatypes.
Examples of simple datatypes include: number (integer
or decimal), text, boolean, and date time.
Complex datatype
A data object with multiple properties. Complex
datatypes combine data (potentially of different simple
datatypes) into a data object with a single, meaningful
name. For example, a complex datatype called
Employee could include the following properties: Name
(text), EmployeeID (number), IsRetired (true/false),
and CellPhoneNumber (number).
Custom datatype
Complex datatypes that are unique to Workflow 7.0.
Custom datatypes are used in projects to pull together
related data from the Symantec database into relevant
groupings.
These custom datatypes are dependent upon the
components available and being used in a project, and
they are dynamic to the component added to a project.
Some example datatypes are listed in the Component
Data Types section.
See “Symantec component datatypes” on page 573.
79
80
Introducing Workflow Designer 7.0
Workflow Designer tool
Table 4-3
Datatypes (continued)
Datatype
Description
User-defined datatype
A complex datatypes that a user creates. You can create
a use-defined datatype for any pieces of data you want
to group together into a single object. For example, you
may wish to create a datatype called user which holds
user data (such as First Name, Address, and Telephone
Number).
Creating a user-defined type can speed project
functions by simplifying how you work with datatypes.
Without the user-defined type, you may be required
to have several individual variables to organize and
work with user data. With the user-defined type, you
would only need one variable.
See “Authoring” on page 123.
See “Generating components” on page 126.
You set up custom datatypes and create user-defined datatypes by creating an
Integration-type project and selecting user-defined type (or by clicking the Create
Integration Library button in Workflow Designer).
After you import the custom library that was created after running the
user-defined type Integration-type project, the datatype is available for selection
on the drop-down list of datatypes.
Generating project reports
You can generate reports for a project. These reports include images of your
project workspace, data on project performance, and data on project locations,
connections, and options.
Reports are saved in the Install Path\Altiris\Workflow
Designer\WorkflowProjects\[project name]\reports directory.
While most reports you are familiar with provide specific information to the
project designer or user, in this case, these reports eventually provide information
directly to the Workflow Server.
Introducing Workflow Designer 7.0
Workflow Designer tool
To generate project reports
1
In an open project in Workflow Designer, right-click the project name in the
tree structure on the left.
The project name is the top item in the tree structure.
2
Click Generate Reports.
After the reports are generated, you can open an index page or view the
directory that the reports are in.
81
82
Introducing Workflow Designer 7.0
Workflow Designer tool
Chapter
5
Using tasks created in a
workflow project
This chapter includes the following topics:
■
About using tasks
■
DefaultTaskSource task configuration example
■
ProcessManagerTaskSource task configuration example
■
ProcessManagerTaskSource task configuration example with added features
■
SharePointTaskSource task configuration example
■
ActiveDirectoryTaskSource task configuration example
■
Delivering a task in Process Manager and email
■
Delivering a task in an email
About using tasks
Task integration refers to setting up a workflow process to communicate with a
task handling system, such as Process Manager or SharePoint. Task integration
refers not only to delivering a task to a task list but also to tracking task progress.
Your workflow process can handle the entire task process: task creation, progress
tracking and reporting, and task completion. Workflow 7.0 can integrate with
four different task systems:
84
Using tasks created in a workflow project
About using tasks
Table 5-1
Description of task sources
Task Source
Description
AltirisTaskSource
Creates tasks in Altiris Help Desk 6.5.
DefaultTaskSource
Creates a task in the internal task manager of Workflow
7.0. Tasks created in this task manager do not appear
in any portal or interface but exist invisibly in data.
Most commonly, the assigned user gets a link to the
task in an email.
See “DefaultTaskSource task configuration
example”on page 87 on page 87.
See “Delivering a task in an email”on page
102 on page 102.
ProcessManagerTaskSource
This task source creates a task in the Process Manager
portal. Tasks created here can be assigned to Process
Manager users.
See “ProcessManagerTaskSource task configuration
example with added features” on page 93.
ActiveDirectoryTaskSource
This task source gives you access to Active Directory
users. It does not create a task in Active Directory.
SharePointTaskSource
This task source creates a task in SharePoint. Tasks
created here can be assigned to SharePoint users.
See “SharePointTaskSource task configuration
example” on page 97.
See “About the Dialog Workflow component and tasks” on page 84.
See “Setting task source in a Dialog Workflow component” on page 85.
About the Dialog Workflow component and tasks
Tasks are one of the most central concepts in Workflow 7.0. A task is a piece of
work that can be assigned to a specific person. Tasks can be any step in a business
flow that requires human interaction from approve/reject, review and close, to
installing and configuring a piece of hardware. The Dialog Workflow component
is the main source of tasks in Workflow 7.0. Part of the function of the Dialog
Workflow component is to create tasks. A Dialog Workflow component can create
a task in any of the following places: Process Manager, SharePoint, Altiris Help
Desk 6.5, and the default task manager (an internal task manager for workflow
processes). These options are available in the Assignments tab of the Dialog
Using tasks created in a workflow project
About using tasks
Workflow editor. The two most common places the Dialog Workflow component
creates tasks is DefaultTaskSource and ProcessManagerTaskSource.
In addition to creating tasks, the Dialog Workflow component can also assign
tasks to individuals. This means that the task will appear in the specific task list
of the assigned person.
See “About using tasks” on page 83.
See “Setting task source in a Dialog Workflow component” on page 85.
Setting task source in a Dialog Workflow component
The Dialog Workflow component creates and assigns tasks. It can create and
assign tasks using one of four task sources:
Table 5-2
Description of task sources
Task Source
Description
AltirisTaskSource
This task source creates tasks in Altiris Help Desk 6.5.
DefaultTaskSource
This task source creates a task in Workflow 7.0’s
internal task manager. Tasks created in this task
manager do not appear in any portal or interface but
exist invisibly in data. Most commonly, the assigned
user gets a link to the task in an email.
See “DefaultTaskSource task configuration example”
on page 87.
See “Delivering a task in an email” on page 102.
ProcessManagerTaskSource
This task source creates a task in the Process Manager
portal. Tasks created here can be assigned to Process
Manager users.
See “ProcessManagerTaskSource task configuration
example” on page 90.
ActiveDirectoryTaskSource
This task source gives you access to Active Directory
users. It does not create a task in Active Directory.
SharePointTaskSource
This task source creates a task in SharePoint. Tasks
created here can be assigned to SharePoint users.
See “SharePointTaskSource task configuration
example” on page 97.
By default, AltirisTaskSource, DefaultTaskSource, and ProcessManagerTaskSource
are available in a Dialog Workflow component. For the ActiveDirectoryTaskSource
85
86
Using tasks created in a workflow project
About using tasks
and SharePointTaskSource to be available, the Active Directory and SharePoint
libraries must be imported into the project.
See “Importing Components” on page 68.
To set task source in the Dialog Workflow component
1
In an open Workflow-type project, add a Dialog Workflow component to the
workspace.
2
Open the component editor.
Double-click the Dialog Workflow icon in the workspace to open its editor.
3
Under the Assignments tab, click the Task Source Type drop-down list.
4
Select a task source, and then click OK.
Setting a task assignment in a Dialog Workflow component
Any tasks created with the ProcessManagerTaskSource need to be assigned. This
is not true of tasks created with the DefaultTaskSource, because those tasks are
available only through an email, and the email is sent only to the person who
needs to work the task. With ProcessManagerTaskSource, however, the task is
created generically in the Process Manager portal without any specific assignment.
You have four options while configuring an assignment:
Table 5-3
Description assignment options
Assignment option
Description
Provide Value
Lets you provide a constant value for the assignment.
If you use a constant value, make sure that it is an
accurate value that will authenticate. For example, if
you are using the ProcessManagerTaskSource, your
constant value must match a registered user in Process
Manager. If you use the constant value
"[email protected]" then that value must also
identify a user in Process Manager.
From List
Lets you choose from a list of users in your task source
target. For example, if your task source target is
Process Manager, the From List option lets you pick
from a list of Process Manager users. This list is
dynamically populated from the registered users in
Process Manager.
If you use another task source target such as
SharePoint, the user list is populated from that source.
Using tasks created in a workflow project
DefaultTaskSource task configuration example
Table 5-3
Description assignment options (continued)
Assignment option
Description
Search List
Lets you search from a list of users from your task
source target. This is helpful if your task source target
has a lot of users.
From Process
Lets you use a process variable for the assignment.
To set a task assignments in a Dialog Workflow component
1
In an open process, open the Dialog Workflow component editor.
Double-click the component to open its editor.
2
In the Assignments tab, scroll down and click the first assignment […] button.
3
Click Add.
4
Add an assignment from one of the available sources, then click OK.
5
Optionally add more assignments.
DefaultTaskSource task configuration example
In this example, a vacation request workflow lets employees submit vacation
requests for approval. After the employee has submitted a request, the process
generates a task for a manager to approve or reject it. The approval task is
delivered to the manager in an email. After the manager makes the decision, the
employee gets an email notification of the decision.
This example highlights two features:
■
A Dialog Workflow component set to use DefaultTaskSource
■
A task sent in an email
Here is what the process looks like:
87
88
Using tasks created in a workflow project
DefaultTaskSource task configuration example
This process has two Dialog Workflow components – “Time Off Request Form”
and “Time Off Request Approval.” The first contains the vacation request form;
the second creates a task for the manager to approve or reject the request. This
project is set to Form Start, so the first Dialog Workflow component displays a
form immediately upon process execution. The second Dialog Workflow component
creates a task for a manager to review the request and approve or reject. This
component is set to use the DefaultTaskSource. This means that a task is created
invisibly in process data, and the only way the manager can view and work the
task is through an email link.
Let’s go into the editor of “Time Off Request Approval”:
Using tasks created in a workflow project
DefaultTaskSource task configuration example
Here we see that this Dialog Workflow component is set to the DefaultTaskSource
source type. This means that it creates a task in Workflow 7.0’s internal task
manager. This task does not appear in any portal or interface. The manager gets
this task in an email that is configured in the Dialog Workflow component’s start
process.
See “To deliver a task in an email” on page ?.
In summary, this example showed a Dialog Workflow component set to
DefaultTaskSource. The component created the task, and delivered it to a manager
in an email.
This configuration has some advantages and some disadvantages. Here are some
advantages:
■
This configuration is effective for users who do not work regularly in Process
Manager. Users who do not work regularly in Process Manager will not know
they have a task assigned to them unless they get an email.
■
This configuration requires no special configuration to connect with Process
Manager because it does not connect with Process Manager.
Here are some disadvantages:
■
The task comes to the manager in an email, which can be easily overlooked.
■
The requester cannot check the status of the process.
89
90
Using tasks created in a workflow project
ProcessManagerTaskSource task configuration example
■
This configuration has no central location to record all the events and data of
the process.
See “ProcessManagerTaskSource task configuration example” on page 90.
See “ProcessManagerTaskSource task configuration example with added features”
on page 93.
See “SharePointTaskSource task configuration example” on page 97.
See “ActiveDirectoryTaskSource task configuration example” on page 99.
ProcessManagerTaskSource task configuration
example
In this example, a vacation request workflow lets employees submit vacation
requests for approval. After the employee has submitted a request, the process
generates a task for a manager to approve or reject it. The approval task is
delivered to the manager in the Process Manager portal. After the manager makes
the decision, the employee gets an email notification of the decision.
This example highlights three features:
■
A Dialog Workflow component set to use ProcessManagerTaskSource
■
Task assignment
■
Task sent to manager's task list
Here is what the process looks like:
Using tasks created in a workflow project
ProcessManagerTaskSource task configuration example
This process has two Dialog Workflow components –"Time Off Request Form”
and “Time Off Request Approval.” The first contains the vacation request form;
the second creates a task for the manager to approve or reject the request. This
project is set to Form Start, so the first Dialog Workflow component displays a
form immediately upon process execution. The second Dialog Workflow component
creates a task for a manager to review the request and approve or reject. This
component is set to use the ProcessManagerTaskSource. This means that a task
is created in the manager’s task list in the Process Manager portal, and the only
way the manager can view and work the task is through the portal.
Let’s go into the editor of “Time Off Request Approval”:
91
92
Using tasks created in a workflow project
ProcessManagerTaskSource task configuration example
Here we see that this Dialog Workflow component is set to the
ProcessManagerTaskSource source type. This means that it creates a task in
Process Manager. This task must be assigned to the manager before it will show
up in the manager’s task list. Back in the editor, assignments are set in the
Assignments tab under “Task Assignments”:
Using tasks created in a workflow project
ProcessManagerTaskSource task configuration example with added features
Here we see that one person assignment has been added to the task. Because
Process Manager uses email addresses to assign tasks, the manager’s email address
is used here. This assignment uses the From list option (options appear after you
click Add).The email address is a process variable; the employee entered this data
on the first request form. During runtime, the process uses this data to create a
task in the portal and assign it to the manager. This task appears in the manager’s
task list in the portal.
See “Setting a task assignment in a Dialog Workflow component” on page 86.
In summary, this example showed a Dialog Workflow component set to
ProcessManagerTaskSource. The component created the task and delivered it to
a manager in the task list in Process Manager.
This configuration has some advantages and some disadvantages. Here are some
advantages:
■
The tasks appear in the Process Manager task list and so will not be lost in an
inbox.
■
Data from the process (such as date of request) is stored in Process Manager
and can be easily retrieved (for reporting, auditing, and so on).
Here are some disadvantages:
■
It requires configuring Workflow 7.0 to integrate with Process Manager.
See “Integrating Process Manager with Workflow Designer” on page 339.
■
The requester cannot check the status of the process.
■
Tasks appear only in Process Manager, so if users do not visit the portal, they
will not see their assigned tasks.
See “DefaultTaskSource task configuration example” on page 87.
See “ProcessManagerTaskSource task configuration example with added features”
on page 93.
See “SharePointTaskSource task configuration example” on page 97.
See “ActiveDirectoryTaskSource task configuration example” on page 99.
ProcessManagerTaskSource task configuration
example with added features
In this example, a vacation request workflow lets employees submit vacation
requests for approval. After the employee has submitted a request, the process
generates a task for a manager to approve or reject it. The approval task is
delivered to the manager in the Process Manager portal and in an email. After the
93
94
Using tasks created in a workflow project
ProcessManagerTaskSource task configuration example with added features
manager makes the decision, the employee gets an email notification of the
decision.
This example highlights three features:
■
A Dialog Workflow component set to use ProcessManagerTaskSource
■
Task assignment
■
Task sent to manager's task list in Process Manager
■
Task sent to manager in an email
■
Process View page features
Here is what the process looks like:
This process is exactly like the basic ProcessManagerTaskSource configuration
example, except for a few new components.
See “ProcessManagerTaskSource task configuration example” on page 90.
Notice three components in this process: Setup Process, Set Process State/Status,
and Global Logging Capture.
Here is the Setup Process component's editor:
Using tasks created in a workflow project
ProcessManagerTaskSource task configuration example with added features
Here we see two variables that will show up on the Process View page: Process
Name and Process Description. The variable TimeOffComment comes from user
input on the initial request form.
Let’s go into the editor of the Set Process State/Status component:
Here we see the status set to “Waiting for approval” and the percent complete set
to “33%.” These values will appear in the Process View page. During runtime,
here’s what the Process View page looks like:
95
96
Using tasks created in a workflow project
ProcessManagerTaskSource task configuration example with added features
This is the page the manager sees upon clicking the task. Notice some of the values
that are displayed: task name (“Vacation Request”), Status, Percent Complete,
and Description. These four values are generated by the Setup Process and Set
Process State/Status components. These two components – Set Process
State/Status and Setup Process – do not require any configuration to communicate
their variables to the Process View page. Process Manager recognizes these
variables and automatically inserts them into the Process View page.
Note: For the process to be able to communicate with Process Manager, Workflow
7.0 must be properly configured.
See “Integrating Process Manager with Workflow Designer” on page 339.
This configuration has some advantages and some disadvantages. Here are some
advantages:
■
The task appears in the Process Manager task list and an email.
■
Data from the process (such as date of request) is stored in Process Manager
and can be easily retrieved (for reporting, auditing, and so on).
■
Users can see process status and percent complete in the Process View page.
■
Users can see the process name and description in the Process View page.
Here is one disadvantage:
■
Requires configuring some additional components, and configuring Workflow
7.0 to integrate with Process Manager.
Using tasks created in a workflow project
SharePointTaskSource task configuration example
See “Integrating Process Manager with Workflow Designer” on page 339.
See “DefaultTaskSource task configuration example” on page 87.
See “ProcessManagerTaskSource task configuration example” on page 90.
See “SharePointTaskSource task configuration example” on page 97.
See “ActiveDirectoryTaskSource task configuration example” on page 99.
SharePointTaskSource task configuration example
In this example, a vacation request workflow lets employees submit vacation
requests for approval. After the employee has submitted a request, the process
generates a task for a manager to approve or reject it. The approval task is
delivered to the manager in SharePoint. After the manager makes the decision,
the employee gets an email notification of the decision.
See “Integrating SharePoint with a workflow process” on page 133.
This example highlights three features:
■
A Dialog Workflow component set to use SharePointTaskSource
■
Task assignment
■
Task sent to manager's task list
Here is what the process looks like:
This process has two Dialog Workflow – “Time Off Request Form” and “Time Off
Request Approval.” The first contains the vacation request form; the second
97
98
Using tasks created in a workflow project
SharePointTaskSource task configuration example
creates a task for the manager to approve or reject the request. This project is set
to Form Start, so the first Dialog Workflow component displays a form immediately
upon process execution. The second Dialog Workflow component creates a task
for a manager to review the request and approve or reject. This component is set
to use the SharePointTaskSource. This means that a task is created in the
manager’s task list in the SharePoint portal, and the only way the manager can
view and work the task is through the portal.
Let’s go into the editor of “Time Off Request Approval”:
Here we see that this Dialog Workflow component is set to the
SharePointTaskSource source type. This means that it creates a task in SharePoint.
This task must be assigned to the manager before it will show up in the manager’s
task list. Back in the editor, assignments are set in the Assignments tab under
“Task Assignments”:
Using tasks created in a workflow project
ActiveDirectoryTaskSource task configuration example
Here we see that one assignment has been added to the task. This example
represents a SharePoint setup that authenticates users by email address, so an
email address is used here to make the assignment. This task appears in the
manager’s task list in SharePoint.
See “Setting a task assignment in a Dialog Workflow component” on page 86.
See “DefaultTaskSource task configuration example” on page 87.
See “ProcessManagerTaskSource task configuration example” on page 90.
See “ProcessManagerTaskSource task configuration example with added features”
on page 93.
See “ActiveDirectoryTaskSource task configuration example” on page 99.
ActiveDirectoryTaskSource task configuration
example
In this example, a vacation request workflow lets employees submit vacation
requests for approval. After the employee has submitted a request, the process
generates a task for a manager to approve or reject it. The approval task is
delivered to the manager in an email. After the manager makes the decision, the
employee gets an email notification of the decision.
See “Integrating SharePoint with a workflow process” on page 133.
This example highlights three features:
99
100
Using tasks created in a workflow project
ActiveDirectoryTaskSource task configuration example
■
A Dialog Workflow component set to use ActiveDirectoryTaskSource
■
Task assignment
■
Task sent to manager in an email
Here is what the process looks like:
This process has two Dialog Workflow components – “Time Off Request Form”
and “Time Off Request Approval.” The first contains the vacation request form;
the second creates a task for the manager to approve or reject the request. This
project is set to Form Start, so the first Dialog Workflow component displays a
form immediately upon process execution.
The second Dialog Workflow component creates a task for a manager to review
the request and approve or reject. This component is set to use the
ActiveDirectoryTaskSource. This does not mean that a task is created in Active
Directory. Rather, the ActiveDirectoryTaskSource connects with Active Directory
to enable assignments to Active Directory users. The task is created invisibly in
data (like the DefaultTaskSource), but can be assigned to a user in Active Directory.
The Start Process in the Time Off Request Approval Dialog Workflow component
is set to send an email with a link to the task. The only way the manager can view
and work the task is through this email link.
See “Delivering a task in an email” on page 102.
Let’s go into the editor of “Time Off Request Approval”:
Using tasks created in a workflow project
ActiveDirectoryTaskSource task configuration example
Here we see that this Dialog Workflow component is set to the
ActiveDirectoryTaskSource source type. This means that Active Directory users
are exposed to the component for setting assignments. A task is created invisibly
in data, and you can assign it to any Active Directory user.
Back in the editor, assignments are set in the Assignments tab under “Task
Assignments”:
101
102
Using tasks created in a workflow project
Delivering a task in Process Manager and email
Here we see that one assignment has been added to the task. This example shows
that one Active Directory user object is used for the task assignment. In the Start
Process (under the Interaction Setup tab), the Send Email component uses the
object's email address property to send the task to the manager. The biggest
advantage of this configuration is that it simplifies the process; instead of having
to retrieve Active Directory user data with one or more extra components, you
can retrieve the data directly in the Dialog Workflow component.
See “DefaultTaskSource task configuration example” on page 87.
See “ProcessManagerTaskSource task configuration example” on page 90.
See “ProcessManagerTaskSource task configuration example with added features”
on page 93.
See “SharePointTaskSource task configuration example” on page 97.
Delivering a task in Process Manager and email
Using the ProcessManagerTaskSource configuration, with a little extra
configuration you can deliver a task in Process Manager and in an email. Delivering
a task in the portal and in an email helps ensure two things: 1) that the user sees
the task (in an email), and 2) that the user cannot misplace it (because it stays in
the portal task list). If the user works the task through email, Process Manager
removes it from the user’s task list. If the user works the task through Process
Manager, the email link becomes inoperable.
To deliver a task in Process Manager and email
1
In an open workflow project, open a Dialog Workflow component's editor.
Double-click the component to open its editor.
2
Under the Assignments tab, set the Task Source Type to
ProcessManagerTaskSource.
3
Under the Assignments tab, assign the task to the appropriate user.
See “Setting a task assignment in a Dialog Workflow component” on page 86.
4
Under the Interaction Setup tab, set the Start Process to send an email.
See “Delivering a task in an email” on page 102.
Delivering a task in an email
You can deliver a task to a user in an email using the Dialog Workflow component.
Delivering a task in an email is a good way to make sure that the user sees the
task. However, tasks sent in emails can be easily lost among a user's other emails.
Using tasks created in a workflow project
Delivering a task in an email
You can deliver tasks to users in multiple ways. You can choose one of these other
methods instead of sending an email, or combine the methods to deliver a task in
multiple ways.
See “Delivering a task in Process Manager and email” on page 102.
See “Setting task source in a Dialog Workflow component” on page 85.
To deliver a task in an email
1
In an open workflow project, open the Dialog Workflow component's editor.
Double-click the component to open its editor.
2
Under the Event Configuration tab, click the Start Process [...] button.
This opens the Start Process editor, which by default contains only a start
and end component.
3
Add a Send Email component to the workspace, and connect all three
components.
4
Open the Send Email component's editor.
Double-click the component to open its editor.
5
Configure the Send Email component.
Set the From Address, To Address, and Subject.
6
Configure the actual email.
Click on the HTML content [...] button. From the left panel, drag
ResponsePageLink onto the email pallet. This adds a link in the email to the
dialog contained in the Dialog Workflow component.
7
Click OK to exit the content editor.
8
Click OK to exit the email editor.
9
Click OK to exit the start process editor.
103
104
Using tasks created in a workflow project
Delivering a task in an email
Chapter
6
Working with projects
This chapter includes the following topics:
■
About publishing a project
■
Tracking the status of a published workflow
■
Packaging a project
■
Testing a project
■
Reloading a project
About publishing a project
When a project is finished, you publish it from the Workflow Designer to Workflow
Server using the publishing wizard. Publishing is the act of moving the project
from your test environment to your production environment so that it is ready
to be run. The publishing wizard lets you publish to one or more Workflow Servers.
See “Setting up Workflow Designer to publish to multiple Workflow Servers”
on page 113.
Every published project resides on Workflow Server. However, while you are
publishing a project to Workflow Server, the publishing wizard gives you the
option of publishing to the Symantec Management Console and Process Manager.
(If you want to publish to ServiceDesk, use the Process Manager publishing format.)
If you publish to either the Symantec Management Console or Process Manager,
your process is still published to Workflow Server, but it is accessible through the
Symantec Management Console or Process Manager. Publishing to the Symantec
Management Console or to Process Manager means only that you can invoke your
process from these locations; the project still resides on Workflow Server.
You have many options when you publish a project, including project start type,
server destination, publishing format (zip file, installer and so on), and Symantec
106
Working with projects
About publishing a project
Management Console options. Despite these options, the publishing process is
basically the same for all projects. The following checklist describes the basic
steps for publishing.
Before you publish, your project must be valid and should be ready for a production
environment.
Table 6-1
Step
Publishing process
Description
Add the destination server to the Every published workflow resides in Workflow Server on a computer. This
task tray application.
computer can be the local design computer, a designated Workflow server, or
some other computer. The destination computer must be added to the task tray
application.
If the destination computer has already been added to the task tray application,
you do not need to add it again.
See “Adding a server in the task tray application” on page 106.
Set project start type
Project start type refers to how a workflow is actually invoked. A project's start
type is set in project data under the Properties tab.
See “Publishing tab” on page 552.
Select a publishing format.
Publishing format refers to the means by which you move a project to the
destination server. You can view the publishing format options by clicking the
publishing symbol in the toolbar of an open project in Workflow Designer.
See “About publishing a project” on page 105.
(Optional) Publish to Symantec
Management Console.
While you are publishing a process, you are prompted to publish to the Symantec
Management Console. A dialog box opens, asking if you want to "deploy this
workflow to Altiris NS."
See “Publishing projects to Symantec Management Console 7.0” on page 149.
See “About Workflow Server 7.0” on page 39.
See “Publishing projects to Symantec Management Console 7.0” on page 149.
See “Setting up how a project runs” on page 145.
See “Publishing a project” on page 111.
Adding a server in the task tray application
See “About publishing a project” on page 105.
The Workflow 7.0 task tray application runs in your computer's task tray. In
Windows, the task tray is located on the right side of the Start bar. Before
Working with projects
About publishing a project
publishing projects to a Workflow Server, you must add that server in the task
tray application.
To add a server in the task tray application
1
On the task tray, right-click the task tray application and select Settings.
2
Click the Local Machine Info tab.
3
In the Servers section, click Add.
4
Enter the required information for the server that you want to add.
Make sure that you assign the correct roles to the server you are adding. For
example, if your server is running Process Manager, make sure that the
Process Manager role is selected. You can set server roles at the bottom of
the server editor page.
5
Click OK.
6
Click OK.
Project start types
Start types refer to how a process is actually invoked. The start type that you
choose may affect which options you have while you are publishing. For example,
only a project that is set to Form Start can be published to Process Manager Forms.
Configure publishing options under the Publishing tab in a project's settings.
Refer to the following table to determine what start type you should use.
See “About publishing a project” on page 105.
107
108
Working with projects
About publishing a project
Table 6-2
Start options by project type
Project type
Start options
Workflow
Workflow-type projects have three publishing options:
Webservice
A project set to Webservice starts when it is invoked
by a webservice call.
See “About publishing a project” on page 105.
■ Auto Start
A project set to Auto Start must begin with an Auto
Start component. These components wait for
events. This event can happen in the Symantec
Management Console or in another program, as
long as it can be monitored by the Workflow Server.
■ Form Start
A project set to Form Start starts when a user clicks
a link to see a form.
See “About publishing a project” on page 105.
■
Decision-Only
Decision-Only projects have no publishing options
because they are always Webservices.
Integration
Integration-type projects do not have any publishing
options because they are not published. Integration
projects generate components; they are not processes.
Monitoring
Monitoring-type projects have three publishing
options:
Webservice
A project set to Webservice starts when it is invoked
by a webservice call.
See “About publishing a project” on page 105.
■ WindowsService
A project set to WindowsService starts when it is
invoked by a WindowsService call.
■ TaskTrayApplication
A project set to TaskTrayApplication becomes an
application that you can invoke in the task tray.
This lets you share and control your published
project more easily than if you published it as a
Web or windows service.
■
Web Forms
Web Form-type projects have no publishing options
because they are always Form Start.
Working with projects
About publishing a project
Table 6-2
Start options by project type (continued)
Project type
Start options
Windows Forms
Windows Form-type projects have no publishing
options because they are always Form Start.
Publishing formats
You can publish a project in one of the default publishing formats: to Zip file, to
directory, to server, and to installer. These options available in every project type.
You see these formats in Workflow Designer when you click the publishing symbol
in the toolbar. These four formats are simply different means of moving a project
to a Workflow Server. Each format compiles the process code differently to give
you different implementation options.
See “About publishing a project” on page 105.
See “Publishing a project” on page 111.
See “About publishing a project” on page 105.
Table 6-3
All publishing formats
Publishing format
Description
Create Publishing Zip File
Creates a Zip file of all the files associated with your
project. This format is helpful when you need to
transfer your project files across an internet
connection. For example, you may need to publish your
project onto a computer to which you do not have
access from your design computer. In such a case you
can create a zip file and send it easily (through email
or otherwise) to the destination computer.
Create Publishing Directory
Creates a directory on the local computer that contains
all the files associated with your project. This format
is helpful when you need to publish your project onto
a nearby computer to which you do not have access
from your design computer. For example, you can put
the directory onto a removable drive and deliver it to
the destination computer.
Publish Application to Server
Publishes all the files associated with your project to
a Workflow Server. All the files are also stored locally.
109
110
Working with projects
About publishing a project
Table 6-3
All publishing formats (continued)
Publishing format
Description
Create Publishing Installer
Creates an installer for your project. All the files
associated with your project are contained in the
installer. This format is helpful when you need to give
the project files to someone who does not know where
to put the files on a computer. The installer helps a
user put the project files in the correct location on the
destination computer.
Publish to Process Manager Forms Creates a link in the Process Manager service catalog.
When you use this publishing format, the project is
still published to Workflow Server, but the link is
created in the service catalog so that you can launch
it through Process Manager.
You can use this publishing format to publish to the
ServiceDesk service catalog.
This publishing format is available only in
Workflow-type and Webforms-type projects.
Workflow-type projects must be set to Form-Start
before they can use this publishing format.
See “Setting up how a project runs” on page 145.
This publishing format is available only if you have a
Process Manager server registered in the task tray
application.
See “Adding a server in the task tray application”
on page 106.
Publish to Process Manager
Services
Creates a link in the Process Manager service catalog.
With this publishing format the project is still
published to Workflow Server, but the link is created
in the service catalog so that you can launch it through
Process Manager.
This publishing format is available only in
Workflow-type and Decision Only-type projects.
This publishing format is available only if you have a
Process Manager server registered in the task tray
application.
See “Adding a server in the task tray application”
on page 106.
Working with projects
About publishing a project
Table 6-3
All publishing formats (continued)
Publishing format
Description
Publish Project as DLL
Generates the project as a DLL file. You can use this
DLL file in many contexts, such as a project in MS
Visual Studio.
This publishing format is an option only for Decision
Only-type projects.
Publish Project as EXE
Generates the project as an EXE file. This is a standard
EXE file that can be run in any environment.
This publishing format is an option only for Decision
Only-type projects.
Publish Project as WWF Runtime Publishes the project to Windows Workflow
Activity
Foundation.
This publishing format is an option only for Decision
Only-type projects.
Publishing a project
See “About publishing a project” on page 105.
See “Validating a project model” on page 77.
When your project is valid and ready for a production environment, publish it to
Workflow Server.
To publish a project
1
In Workflow Designer, open the project that you want to publish, and click
the publishing symbol in the toolbar.
2
Click the publishing format option that you have chosen for this project.
See “Publishing formats” on page 109.
Click Publish Application to Server if you want to publish immediately to a
server.
3
Set the virtual directory name, select one or more Workflow Servers to publish
the project to, and then click OK.
The project is published to all Workflow Servers selected.
111
112
Working with projects
About publishing a project
4
When the Application Properties Editor dialog box opens, make sure that the
properties are set correctly. If they are not, change them.
These properties come from the settings on the Publishing tab in the Project
properties (accessed by clicking the project name in Workflow Designer).
See “Publishing tab” on page 552.
5
When you are prompted to open the published workflow, click Yes if you
want to run the process immediately, or click No if you do not want to run it
immediately.
If you click No, you can run your published project later.
6
When you are prompted to deploy to the Altiris Notification Server, click Yes
if you want to publish to the Symantec Management Console, or click No if
you do not want to publish to the Symantec Management Console.
This terminology, "deploy" and "Altiris Notification Server," can be confusing.
Deploying to the Altiris Notification Server refers to publishing your project
to the Symantec Management Console.
You are not required to publish your project to the Symantec Management
Console. Publish to the Symantec Management Console if you want to be able
to access your project through the console.
If you are publishing to the Symantec Management Console, refer to the
following section on publishing to the console:
See “Publishing projects to Symantec Management Console 7.0” on page 149.
Publishing a process to Process Manager
See “About publishing a project” on page 105.
Publishing to Process Manager lets you invoke your published project from Process
Manager. You can publish to Process Manager in two different ways: publish to
Process Manager forms, and publish to Process Manager services.
Publishing to Process Manager Forms means publishing a Form Start workflow
to Process Manager. Publishing to Process Manager Services means publishing a
Webservice-start workflow to Process Manager. After you publish to Process
Manager Forms or Services, the new workflow appears in the service catalog.
Use the Process Manager publishing options (Forms or Services) only when you
are publishing a project to Process Manager for the first time. If you are
republishing a project that already exists in Process Manager, use the Publish
Application to Server publishing format and publish to the same server as the
original process (probably the Process Manager server).
Working with projects
About publishing a project
To publish to Process Manager Forms
1
From the Workflow Designer loading window, open the project you want to
publish to Process Manager forms.
See “Workflow Designer loading window” on page 53.
2
Click File > Publish Project > Publish to Process Manager Forms.
3
Select the server to which you want to publish, and then click OK.
You can publish to as many servers as you choose.
4
Make any desired changes, and then click OK.
5
In the properties editor, make any changes, and then click Save.
Workflow Solution will tell you if the publishing was successful or not.
To publish to Process Manager services
1
From the Workflow Designer loading window, open the project you want to
publish to Process Manager services.
See “Workflow Designer loading window” on page 53.
2
Click File > Publish Project > Publish to Process Manager Services.
3
Select the server to which you want to publish, and then click OK.
You can publish to as many servers as you choose.
4
Make any changes, and then click OK.
5
In the properties editor, make any changes, and then click Save.
Workflow Solution indicates if your publishing was successful.
Setting up Workflow Designer to publish to multiple Workflow Servers
When a project is finished, you publish it from the Workflow Designer to the
Workflow Server using the publishing wizard. The publishing wizard lets you
select one or more Workflow Servers where you can publish the project.
See “About publishing a project” on page 105.
To set up Workflow Designer to publish to multiple Workflow Servers
1
In the Designer loading window, select File > Edit Tool Preferences.
2
Scroll down to Deployment and select Deployment: Remote.
This lets you set up publishing to Workflow Servers.
3
For each Workflow Server you want to add, do the following:
■
In right pane, click Add.
113
114
Working with projects
Tracking the status of a published workflow
■
In the Edit Object dialog box, click the Address Info tab.
■
Enter the IP Address of the Workflow Server.
■
Click the Identity tab.
■
Enter the group where the Workflow Server is located.
■
Give the Workflow Server a nickname.
This is used when publishing a project.
4
Click OK.
5
Click OK.
When publishing a project, select all Workflow Servers you want to publish
it to.
Tracking the status of a published workflow
When a published workflow runs, you can check its status. If the process is
published to Process Manager, you can check the status of the running workflow
if the project is configured to display status data in the process view page.
See “Process View page” on page 214.
See “ProcessManagerTaskSource task configuration example with added features”
on page 93.
If a project is not published to Process Manager, you can still check its status.
Every workflow that is published has a Webservice for tracking its status. You
can query this service or make Webservice calls to the workflow to get workflow
status.
Working with projects
Packaging a project
To track the status of a workflow
1
On the server hosting the published workflow, open the IIS Website of your
workflow.
2
In the right pane, right-click WorkflowManagementService.asmx and select
Browse.
3
When the Workflow Management Service opens in a browser, you can view
different status reports on the project.
Packaging a project
Packaging a project lets you save all your package data and accompanying libraries
in a single, distributable file. This lets you share your project with others easily.
To load a packaged project, import it in the Workflow Designer loading window.
115
116
Working with projects
Testing a project
To package a project
1
In an open project in Workflow Designer, click the project name in the tree
structure on the left.
The project name is the top item in the tree structure.
2
Click File > Package Project.
3
In the Packaging Options dialog box, select from the following:
4
■
Include Custom Libraries
Select to include all custom libraries with the project.
■
Exclude Core Libraries
Select to exclude the libraries that are included with the Workflow
Designer installation.
■
Exclude Libraries in Search Path
Select to exclude all external libraries from the project.
■
Package as template
Select to package the project as a template.
Click OK.
Testing a project
A project can be tested at any time during creation. You test a project by running
it in the debugger. We recommend testing your project often to make sure that it
is working properly. You can test a project only when it is fully valid. A project is
fully valid when there are no validation errors (component connection or
configuration errors).
See “Validating a project model” on page 77.
While you are testing a project, if there are errors, an error report is shown in a
dialog box. The error report displays a list of error messages. Each error message
displays the cause, the error location, and the point where the component failed.
To test a project
1
Open the project you want to test in Workflow Designer.
2
In Workflow Designer, click the Run Project symbol located on the Symbol
toolbar to run your project.
The debugger opens to run your project.
Working with projects
Reloading a project
3
In the left pane, double-click the Execute link to run the project.
During testing, the project generates execution data to use for debugging.
4
If required, the Input Values window appears. Enter the required data to
continue testing.
For a project to successfully execute, any input data required must be provided,
unless set to Null Allowed.
If the project encounters any errors while it runs in the debugger, the debugger
displays an exception. If the project is valid, it executes properly and displays
the project's output.
As the project functionality executes, within the Model tab, the entire project
is highlighted. The yellow highlighting indicates the project has executed the
highlighted component or connection. If a project returned an error (an
exception), the arrow stops at the component that caused the error.
Reloading a project
Reloading your project closes your project workspace and re-opens it. This is
useful if your project is malfunctioning, or if you wish to undo all changes made
since you opened your project. You will be prompted to see if you want to save
your project before reloading it.
This lets you reload your original work area from the last saved edition and start
over.
To reload a project
1
In an open project in Workflow Designer, right-click the project name in the
tree structure on the left.
The project name is the top item in the tree structure.
2
Click Reload Project.
3
From the dialog box, select from the following:
■
Yes
Click if you want to save the project before reloading it.
■
No
Click if you do not want to save the project before reloading it.
■
Cancel
Click to return to the project without reloading it.
117
118
Working with projects
Reloading a project
Chapter
7
Using the component
generators
This chapter includes the following topics:
■
Introducing the component generators
■
About the component generators
■
Generating components
■
Generating the Symantec components with the generators
Introducing the component generators
Workflow Designer provides component generators for creating your own
integration library. Component generators let you create customized components
with specific functionality. You generate components using the Integration-type
projects.
See “Integration-type project” on page 59.
The component generators let you create custom component libraries without
writing any code.
You can create components that communicate with external systems, including
the following:
■
Database Tables
■
Database Stored Procedures
■
CSV Files
■
Fixed Length Values
■
Microsoft Info Path
120
Using the component generators
About the component generators
■
Microsoft Excel
■
Custom Business Objects
You can also create your own user-defined type that lets you combine datatypes
to simplify your project.
The libraries that you create yourself using Integrator can be shared with others
in your organization. These libraries are fully compiled, production quality libraries
just like those you create or those delivered by Workflow 7.0.
See “Generating components” on page 126.
See “Symantec workflow component generators” on page 125.
See “Generating the Symantec components with the generators” on page 127.
See “Importing Components” on page 68.
See “Workflow Designer project types” on page 55.
About the component generators
Component generators use a simple wizard to guide you through the component
creation process, giving you the power of custom production with the ease of
non-technical development.
See “Introducing the component generators” on page 119.
The following tables list and describe the generators.
See “Database” on page 120.
See “XML” on page 121.
See “Microsoft” on page 121.
See “Flat Files” on page 122.
See “Enterprise Resources” on page 123.
See “Authoring” on page 123.
See “Symantec Workflow” on page 123.
See “More” on page 124.
Database
See “About the component generators” on page 120.
See “Generating components” on page 126.
Using the component generators
About the component generators
Query/Script generator
Generates components that submit and process
user-specified SQL against a user-specified database.
Lets you query a variety of database providers and
drivers including SQL, Oracle, Firebird, ODBC, OLEDB,
and more. Components created with this generator can
be fully customized as to which queries to perform on
the database, which pieces of information to return
from the query and store, and in which organization
or scheme to store the retrieved data.
Stored procedure caller generator Generates components that run a user-specified stored
procedure against a user-specified database.
Table generator
Generates table-related components (retrieve data,
drop table, and so forth) from a user-specified table in
a user-specified database. Components created with
this generator can perform operations on the tables in
a database - adding tables, recording to a table,
renaming a table, reading information from a table, or
adding fields to a table.
Fast table generator
Identical to table generator, except with fewer options.
All component types are automatically generated
instead of being user-defined.
XML
See “About the component generators” on page 120.
See “Generating components” on page 126.
DTD generator
Generates read/write components based on a
user-specified document type definition file (.dtd). DTD
stands for Document Type Definition, and is used in
the creation of XML files.
XML Schema generator
Generates read/write components based on a
user-specified XML Schema Definition file (.xsd).
Microsoft
See “About the component generators” on page 120.
See “Generating components” on page 126.
121
122
Using the component generators
About the component generators
Excel generator
Generates read/write components based on a
user-specified MS Excel spreadsheet file (.xls).
InfoPath generator
Generates read/write components based on a
user-specified MS Office Infopath file (.xsn).
Active Directory
Generates read/write components to let you add,
remove, or modify entities in your Active Directory
Server. These components support Active Directory
schema customization, allowing information and
settings to be used in workflow projects as needed.
SharePoint lists generator
Generates components to add and remove items in a
SharePoint task list. Also, these components can handle
document exchanges to and from the document
repository in SharePoint. This generator inspects the
SharePoint list to discover all the available columns
and transposes them into properties in a component.
Flat Files
See “About the component generators” on page 120.
See “Generating components” on page 126.
Fixed length generator
Generates a read/write component and a customized
datatype (used for inputs and outputs) to handle
fixed-length pieces of information. Fixed-length
information can be user data (such as names, SS
numbers, email addresses, and so forth), impersonal
data like dates, or other static format data. The Fixed
length type generator wizard guides you through the
process of creating a datatype specific to your data.
Fixed length generator (extended) Generates read and write components and datatypes
against a fixed position file. This generator is similar
to separated values generator, but without the
delimiter.
Separated values generator
Generates read and write components based on a
user-specified comma-separated file (.csv).
Separated values generator
(extended)
Generates read and write components based on a
user-specified comma-separated values (.csv).
Using the component generators
About the component generators
Enterprise Resources
See “About the component generators” on page 120.
See “Generating components” on page 126.
LDAP generator
Generates components that interact with the directory
entries in a LDAP server. This generator inspects the
LDAP schema and creates components and datatypes
to interact with the various structures in your LDAP
environment.
Web Service caller generator
Generates components that make calls to user-specified
Webservices. Thus, specific methods available in the
Web Service Description Language (WSDL) can be
selected for use within workflows. Components created
with this generator can communicate with, post
requests to, and read responses from dynamic
Webservices.
Authoring
See “About the component generators” on page 120.
See “Generating components” on page 126.
User-defined type
Generates user-defined types for use in your project.
Does not create components, but exposes user-defined
types and structures when the integration library is
added or imported to your workflow.
Custom Workflow interaction
Generates custom workflow components, and a
webservice to interact with that component. This
generator is similar to using the Dialog Workflow
component because with it you can have multiple
outcomes, and each outcome defines its own data.
Symantec Workflow
Workflow 7.0 has two sets of Symantec generators: generators for Notification
Server 6.5 and generators for 7.0. Both sets of generators do the same thing but
for different versions of the platform.
See “Symantec workflow component generators” on page 125.
See “About the component generators” on page 120.
See “Generating components” on page 126.
123
124
Using the component generators
About the component generators
ASDK component generator
The ASDK Generator is run after installation by the
workflow developer and creates components out of
ASDK method calls. ASDK methods change less
frequently than task and resources change on the
Symantec Management Console. However, any changes
to an ASDK method contained within a component
requires the components to be regenerated.
Tasks component generator
The Task Generator is run after installation by the
workflow developer and gathers ASDK tasks on the
Symantec Management Console. A task is an action
taken on a resource or a collection of resources. Tasks
are managed in the Symantec Management Console,
and any component generated will need to be
regenerated to reflect changes from the Symantec
Management Console.
Reports component generator
The Report Generator is run after installation by the
workflow developer and gathers all reports available
in the Symantec Management Console. For every report
available, one component is created. Each report
component represents a SQL query that retrieves and
stores structured data back in a collection within a
workflow.
Resource component generator
The Resource Generator is run during installation and
gathers all resources available on the Symantec
Management Console. A resource is usually a tangible
item, like a computer, telephone, or printer, and has
data and associations to other resources on the
Symantec Management Console. Resources are
managed in the Symantec Management Console, and
any components generated will need to be regenerated
in order to reflect changes from the Symantec
Management Console.
More
See “About the component generators” on page 120.
See “Generating components” on page 126.
Using the component generators
About the component generators
.NET library generator
Generates components that execute .NET code in a
DLL. After you select a DLL and the class or methods
you want to utilize, this generator creates a custom
component to invoke and leverage code in the selected
DLL. With components created with this generator,
you can invoke the properties and methods of other
components.
Multiple Connection container
Does not generate component, but lets you group your
generators and assemblies into one .DLL library file.
This lets you import numerous generators and
assemblies into your project by importing only one
container file.
Remedy connector
Generates components that run interactions against
a Remedy server.
Script generator
Generates components that run user-specified C# code
or script.
Symantec workflow component generators
Workflow Designer has eight Symantec component generators that are divided
into two groups: generators for the Symantec Management Platform 6.5
(Notification Server 6.5) and generators for Symantec Management Platform 7.0.
The only difference between running a 6.5 generator and running a 7.0 generator
is the version of the Symantec Management Platform with which their components
communicate. The generators are as follows: ASDK, ASDK Tasks, Reports, and
Resource. Each Symantec generator builds or rebuilds custom libraries of available
Symantec components. After these custom libraries are built, you can use the
newly generated Symantec components in your projects.
Each Symantec component generator is an Integration-type project .
See “Introducing the component generators” on page 119.
See “Workflow Designer project types” on page 55.
See “Generating libraries with the Symantec Management Platform generators”
on page 136.
See “Generating the Symantec components with the generators” on page 127.
125
126
Using the component generators
Generating components
Table 7-1
The Symantec Management Platform 6.5 and 7.0 generators
Symantec
generator
Description
ASDK component
generator
The ASDK Generator is run after installation by the workflow
developer and creates components out of ASDK method calls. ASDK
methods change less frequently than task and resources change on
the Symantec Management Console. However, any changes to an ASDK
method contained within a component requires the components to
be regenerated.
ASDK Tasks
The Task Generator is run after installation by the workflow developer
and gathers ASDK tasks on the Symantec Management Console. A
task is an action taken on a resource or a collection of resources. Tasks
are managed in the Symantec Management Console, and any
component generated will need to be regenerated to reflect changes
from the Symantec Management Console.
Reports
component
generator
The Report Generator is run after installation by the workflow
developer and gathers all reports available in the Symantec
Management Console. For every report available, one component is
created. Each report component represents a SQL query that retrieves
and stores structured data back in a collection within a workflow.
Resource
component
generator
The Resource Generator is run during installation and gathers all
resources available on the Symantec Management Console. A resource
is usually a tangible item, like a computer, telephone, or printer, and
has data and associations to other resources on the Symantec
Management Console. Resources are managed in the Symantec
Management Console, and any components generated will need to be
regenerated in order to reflect changes from the Symantec
Management Console.
Generating components
Components are generated using the Integrator project type. When you generate
components, they get placed in component libraries. You can then import the
component libraries in your project.
See “Introducing the component generators” on page 119.
See “Workflow Designer project types” on page 55.
See “Importing Components” on page 68.
You can generate components in two ways: Create a new Integrator project and
use the Create Integration Library button.
Using the component generators
Generating the Symantec components with the generators
To generate components by creating a new Integrator project
1
From the Workflow Designer loading tool, click File > New Project.
2
In the Project Types tab, click Integration.
3
Enter a name for your component library and click OK.
4
Select the generator and click OK.
To generate components by using the Create Integration Library button
1
From the Workflow Designer tool, in the component toolbox, click Create
Integration Library.
2
Enter a name for your component library and click OK.
3
Select the generator and click OK.
Generating the Symantec components with the
generators
Workflow Designer has four Symantec component generators: ASDK, Task, Report,
and Resource. Each component generator is created using Workflow Designer
and builds or rebuilds custom libraries of available Symantec components. After
these custom libraries are generated, you can use them Symantec components in
your projects.
Any time there are modifications to the ASDK methods or webservices, resources,
reports, or tasks on the Symantec Management Console, you should rebuild the
appropriate component library. For example, if a new task instance is created in
the Symantec Management Console, the Symantec component corresponding to
that task will not be available to a workflow until the Task Generator is rebuilt.
See “Introducing the component generators” on page 119.
See “Generating libraries with the Symantec Management Platform generators”
on page 136.
See “Symantec workflow component generators” on page 125.
To generate the Symantec Resource, ASDK, and Task libraries
1
From the Workflow Designer loading tool, click File > New Project.
2
In the Project Types tab, click Integration.
3
Enter a name for your component library and click OK.
4
Select the Workflow Resource, ASDK, or Task generator for the libraries you
want to rebuild and click OK.
127
128
Using the component generators
Generating the Symantec components with the generators
5
Choose the Symantec Management Console to run the generator against and
then adjust definitions to select new components to include in the library.
6
Click Recompile and Close.
After the generator has recompiled the library and you open a project that
utilizes this library, the project is updated with new components.
To generate the Symantec Report library
1
From the Workflow Designer loading tool, click File > New Project.
2
In the Project Types tab, click Integration.
3
Enter a name for your component library and click OK.
4
Select the Symantec Workflow Report generator and click OK.
5
Enter the Symantec Management Console address and click Get Reports.
6
Select the reports that you want to rebuild.
7
Click Next.
8
Click Run to rebuild the reports.
9
Click Finish.
10 Click Compile and Close.
Existing projects are updated with library changes after they are re-opened.
Section
4
Integrating Workflow 7.0
■
Chapter 8. Workflow 7.0 and Active Directory
■
Chapter 9. Workflow 7.0 and SharePoint
■
Chapter 10. Workflow 7.0 and the Symantec Management Platform
130
Chapter
8
Workflow 7.0 and Active
Directory
This chapter includes the following topics:
■
Integrating Active Directory with a workflow process
Integrating Active Directory with a workflow process
Your workflow process must be integrated with Active Directory before the two
systems can work together.
To integrate Active Directory with a workflow process
1
In your opened project, import the Active Directory DLL into your process.
To import the DLL, in your opened project click Import Components. Next,
click ActiveDirectory.dll, and then click Add > OK.
2
In the left panel, click the name of your project.
The name of your project is the top item in the tree structure.
132
Workflow 7.0 and Active Directory
Integrating Active Directory with a workflow process
3
Click the Properties tab.
4
Configure the nine Active Directory properties (ActiveDirectoryHostName,
ActiveDirectoryUserName, ActiveDirectoryPassword, ActiveDirectoryDomain,
ADServer, ADServerPort, ADDomainName, ADDomainAdminUser,
ADDomainAdminPassword).
If these properties do not appear in the property list, add a Dialog Workflow
component to your process and set it to use the ActiveDirectoryTaskSource.
The properties are generated automatically. If you do not know how to
configure these properties, talk to your network administrator.
Chapter
9
Workflow 7.0 and
SharePoint
This chapter includes the following topics:
■
Integrating SharePoint with a workflow process
■
Using a Process Manager task list in SharePoint
Integrating SharePoint with a workflow process
Your workflow process must be integrated with SharePoint before the two systems
can work together.
See “SharePointTaskSource task configuration example” on page 97.
Integrating a workflow process with SharePoint includes the following main steps:
■
Setting up SharePoint to receive tasks from your process
■
Setting up your process to connect to SharePoint
To integrate SharePoint with a workflow process
1
In SharePoint, create a new list.
Click Site Actions > Create > Custom List. Complete the steps to create the
list. After you have created the custom list, you can make it a template. To
make a custom list a template, click on the list, then click Settings > List
Settings > Save List as Template.
2
With your opened project in Workflow Designer, import the SharePoint DLL
into your process.
To import the DLL, in your opened project click Import Components. Next,
click Sharepoint.dll, and then click Add > OK.
134
Workflow 7.0 and SharePoint
Using a Process Manager task list in SharePoint
3
In the left panel, click the name of your project.
The name of your project is the top item in the tree structure.
4
Click the Properties tab.
5
Configure the four SharePoint properties (SharepointHost,
SharepointUsername, SharepointPassword, SharepointDomain).
If these properties do not appear in the property list, add a Dialog Workflow
component to your process and set it to use the SharePointTaskSource. The
properties are generated automatically. If you do not know how to configure
these properties, talk to your network administrator.
Using a Process Manager task list in SharePoint
You can integrate Process Manager with SharePoint so that a task list from Process
Manager appears in a SharePoint page. While you cannot import the Process
Manager Web part directly into SharePoint, you can use a SharePoint Web part
to display a Process Manager task list.
To use a Process Manager task list in SharePoint
1
In SharePoint, create a new Web part page to display the Process Manager
task list.
2
Add a Page Viewer Web part to the page.
3
Configure the Web part to use the following URL:
http://localhost/ProcessManager/WorkflowTasks/AJAXWorkflowTaskList.aspx?notabs=1&sidebar=false
You may have to change this URL if you have customized your Process
Manager.
Chapter
10
Workflow 7.0 and the
Symantec Management
Platform
This chapter includes the following topics:
■
How to prepare for your first use of Workflow Designer on the Symantec
platform
■
Deployment Server connection settings
■
Publishing projects to Symantec Management Console 7.0
How to prepare for your first use of Workflow
Designer on the Symantec platform
When Workflow Designer is installed on a client computer, all the Symantec
integration facilities are included. However, there is some preparation work needed
to get started using Workflow Designer, using either workflow packs or a custom
built scenario.
The resource components are already available, but to have the task and reporting
components, their generators need to be run. The amount of components created
from this process are equal to the tasks and reports available on the Symantec
Management Console.
The component generators are Integration projects. The following tasks walk you
through adding the project through Workflow Designer and running the generator
to create the components; regardless of the generator run, the process is the same.
136
Workflow 7.0 and the Symantec Management Platform
How to prepare for your first use of Workflow Designer on the Symantec platform
When using Workflow Designer for the first time, the Task, ASDK, and Report
generators need to be run to load components into the component toolbox from
the tasks, ASDK methods, and reports available on the Symantec Management
Console. Due to the number of potential components added, these generators are
not run during installation.
See “Generating libraries with the Symantec Management Platform generators”
on page 136.
See “Importing Symantec components” on page 138.
See “Creating a new integration project” on page 138.
See “Managing connections to the Symantec Management Console” on page 139.
See “Design time and run time Symantec Management Console credentials”
on page 140.
See “Creating Symantec Management Console credentials” on page 142.
See “Creating design time Symantec Management Console credentials” on page 142.
See “Setting run time Symantec Management Console credentials” on page 143.
See “Setting up how a project runs” on page 145.
Generating libraries with the Symantec Management Platform
generators
Workflow Designer contains many hand-coded Symantec components. Most are
available when Workflow Designer is installed; however, some can only be run
based on the data from your Symantec Management Console. This data comes
from resources, tasks, reports, and the ASDK on the Symantec Management
Console. Workflow Designer provides component generators that generate custom
libraries of Symantec components based on the resource, task, report, and ASDK
data from the Symantec Management Console.
Workflow Designer has four Symantec component generators. Each component
generator is created using Workflow Designer and builds or rebuilds custom
libraries of available Symantec components. After these custom libraries are built,
you can use the included Symantec components in your workflow.
You can only have one project of each of the Resource, ASDK, and Task component
generators at a time. For example, when you run the Resource component
generator more than once, the previous project for that generator gets replaced.
You can create any number of Report component generators.
After Workflow Designer is installed, you should run the Resource, ASDK, and
Task component generators. These capture any custom resource types and
Workflow 7.0 and the Symantec Management Platform
How to prepare for your first use of Workflow Designer on the Symantec platform
generate custom libraries of Symantec components based on the Symantec
Management Console data.
You can run the Reports component generator whenever you need to generate
reports you need to use in your workflow.
Any time there are modifications to the ASDK methods or webservices, resources,
reports, or tasks on the Symantec Management Console, you should regenerate
the appropriate component generator. For example, if a new task instance is
created in the Symantec Management Console, the Symantec component
corresponding to that task will not be available to a workflow until the Task
Generator is rebuilt.
Symantec workflow component generators
Generating the Symantec components with the generators
To generate libraries with the Symantec Management Platform generators
1
In the Workflow Designer loading window, click New.
2
Select the Integration project type.
3
Type a name for your library and click OK.
4
Select the Workflow generator you want to use and click OK.
A pop up appears for Resource, ASDK, and Task generators that indicates
they are singleton generators. Only one project is allowed for these types of
generators, and running these generators overwrites the existing project.
5
If you chose the Report Component generator, select the configuration you
want to find the reports you want to generate.
6
Click Recompile and Close.
7
Repeat the above steps for each generator that you want to run.
The components generated by component generators are placed in custom
libraries. You add these libraries to your projects to use the generated components.
To import custom libraries of the Symantec Management Platform components
into the component toolbox
1
In Workflow Designer, open a project.
2
Click Import Components.
3
In the Add Library to Project dialog box, click the Custom Libraries tab.
137
138
Workflow 7.0 and the Symantec Management Platform
How to prepare for your first use of Workflow Designer on the Symantec platform
4
Select the library that was generated by the component generator.
5
Click Add, and then OK.
The new components show up under the Symantec branch and any branch
with an orange star appearing in the component toolbox.
Importing Symantec components
When Workflow Designer is installed, a Symantec branch appears in the
component list. This branch contains some of the Symantec components. You can
import more Symantec components as needed.
To import Symantec components
1
In Workflow Designer, open a project.
2
Under the component toolbox, click Import Components.
3
Click the Custom Libraries tab.
4
Select the libraries you want to import.
5
Click Add, and then OK.
The Symantec components show up under the Symantec branch and any
branch with an orange star appearing in the Component Toolbox.
Creating a new integration project
Besides the Symantec Management Platform generators, Workflow 7.0 provides
other integration points. If you have only a Process Automation Server license
and not a Workflow 7.0 license, you can use only the Symantec Management
Platform generators.
For more information on licensing, see the Workflow 7.0 Installation Guide.
Using the Symantec component generators you can create components that
integrate with database tables, other Webservices, XML files, Excel, and other file
types. You can also create custom workflow components and create compatible
libraries from other .NET libraries.
Every new project that is created in Workflow Designer already includes the
libraries for Resource, ASDK, and Task component generators as a default. These
libraries do not need to be re-imported on the Custom Library tab after
regeneration.
Workflow 7.0 and the Symantec Management Platform
How to prepare for your first use of Workflow Designer on the Symantec platform
To create a new integration project
1
Open the Designer loading window by clicking Start Menu > All Programs >
Altiris > Workflow Designer > Workflow Designer.
2
Click New.
3
From the New Project dialog box, select Integration.
4
In the Name box, type a logical name for the project.
For example, ASDK Generated Components.
5
If you want to use another directory besides the default directory for storing
the project, specify a new location using the Browse button to the right of
the Directory box.
6
Click OK.
7
From the list of the Symantec Management Platform generators, select ASDK
Component Generator and click OK.
8
Click Yes to acknowledge that this generator is a singleton generator and can
only have one library.
9
Click Recompile and close.
Managing connections to the Symantec Management Console
You need two parameters to make Webservice calls for data and functions on the
Symantec platform (at run time): an authentication token and a connection to a
Symantec Management Platform server. The Symantec Management Platform
server connection requirements are established by providing a user name,
password, and domain.
Workflow Designer provides a component that sets the default credentials when
new projects are created. This component is called the Create Notification Server
Credentials component. This component adds global properties for the Symantec
Management Console and an authentication token, which are pre-populated as
the default variables for all the Symantec components. When you enter your
Symantec Management Console and authentication settings in this one component,
all Symantec components pick up these values as a default.
See “Design time and run time Symantec Management Console credentials”
on page 140.
See “Setting run time Symantec Management Console credentials” on page 143.
139
140
Workflow 7.0 and the Symantec Management Platform
How to prepare for your first use of Workflow Designer on the Symantec platform
To manage connections to the Symantec Management Console
1
In the Designer loading window, create a new project.
See “Step 1: Create a new project” on page 348.
2
In Workflow Designer, right-click the Create Notification Server Credentials
component and select Edit Component.
3
Click the Basic Authentication tab.
4
To enter the Symantec Management Console, do the following in order:
5
6
7
8
■
In the Notification Server box, click the [...] button.
■
Enter the name of default run time Symantec Management Console server.
■
Click OK.
To enter the user name, do the following in order:
■
In the Username box, click the [...] button.
■
Enter the user name login credential for the default Symantec Management
Console server. This user name must be an administrator on the Symantec
Management Platform server .
■
Click OK.
To enter the password, do the following in order:
■
In the Password box, click the [...] button.
■
Enter the password for the user entered in the Username box.
■
Click OK.
To enter the Domain, do the following in order:
■
In the Domain box, click the [...] button.
■
Enter the domain for the Symantec Management Platform server.
■
Click OK.
Click OK.
Design time and run time Symantec Management Console credentials
Your workflow uses different Symantec Management Console credentials at design
time and at run time. You do not want to connect to production computers while
building workflows, but when you run projects, you want them to work properly.
By having different design time and run time Symantec Management Console
Workflow 7.0 and the Symantec Management Platform
How to prepare for your first use of Workflow Designer on the Symantec platform
credentials, you can safely design workflows in a test environment and run
workflows in your production environment.
The design time and run time Symantec Management Platform servers can be the
same. For your workflows to run well while being designed and being run, the
design time and run time Symantec Management Platform servers should be very
similar or identical. Generally, you will want your design time Symantec
Management Console to be in a test environment. Therefore, we recommend that
the Symantec Management Console in your test environment be a clone of the
Symantec Management Console in your production environment.
The only way to set run time credentials for a workflow is through variables that
are exposed and declared inside the workflow process.
See “Design Time Symantec Management Console credentials” on page 141.
See “Run Time Symantec Management Console credentials” on page 141.
See “Creating Symantec Management Console credentials” on page 142.
See “Managing connections to the Symantec Management Console” on page 139.
See “Creating design time Symantec Management Console credentials” on page 142.
See “Setting run time Symantec Management Console credentials” on page 143.
Design Time Symantec Management Console credentials
When you install Workflow 7.0, a message appears telling you that no Notification
Server has been configured and prompts you to configure one. The Symantec
Management Console you configure at this time has no effect on workflows at
run time. It is only used by Workflow Designer while a workflow is being designed.
When a project is opened, it recognizes the default design time Symantec
Management Console credential. This Symantec Management Console credential
has nothing to do with the settings in the Create Notification Server Credentials
component (which uses run time credentials). It is used by components to get
required data from the Symantec Management Console while a workflow is being
designed. For example, in the Create Ticket component, the Status Source section
in the Ticket Details tab is updated based on status information from the Symantec
Management Console and can be unique to each Symantec Management Platform
server.
Run Time Symantec Management Console credentials
At run time, every workflow component that communicates with the Symantec
Management Console needs run time Symantec Management Console credentials.
Each component that communicates with the Symantec Management Console
has a Notification Server tab for configuring run time Symantec Management
141
142
Workflow 7.0 and the Symantec Management Platform
How to prepare for your first use of Workflow Designer on the Symantec platform
Console credentials. This Symantec Management Console tab has a Symantec
Management Console Address and a Security Token. The Symantec Management
Console Address and Security Token can either come from the variables set in
the Create Notification Server Credentials component (default), any other variable
(such as from user input), a dynamic value, or a constant value. The most
convenient way to work with the run time Symantec Management Console
credentials is by using the Create Notification Server Credentials component.
Because of this, when a project is created, the Create Notification Server
Credentials component is added to the Model. The credentials you place in the
Create Notification Server Credentials component are used by default in each
component that communicates with the Symantec Management Console (in the
Notification Server tab). These credentials can be changed in any component,
providing you the flexibility of using multiple Symantec Management Platform
servers in a single project. You can have multiple Create Notification Server
Credentials components in a workflow.
Creating Symantec Management Console credentials
Before you create workflows in Workflow Designer, you need to enter the
credentials for the Symantec Management Console that will be used while
designing a project. You can add credentials for as many Symantec Management
Platform servers as you want, but only one will be designated as the default design
time Symantec Management Console.
See “Design time and run time Symantec Management Console credentials”
on page 140.
To create design time Symantec Management Console credentials in Workflow
Designer
1
During installation, in the New NS Credentials dialog box, enter a Machine
Name or IP Address, Domain, User Name, and Password.
2
Click OK.
The newly created credential is added to a list in the Credential Manager.
Creating design time Symantec Management Console credentials
During development, or design time, a default Symantec Management Console
credential needs to be established. More than one set of credentials can be
established, but only one can be designated as the default design time Symantec
Management Console connection.
Workflow 7.0 and the Symantec Management Platform
How to prepare for your first use of Workflow Designer on the Symantec platform
To create design time Symantec Management Console Credentials
1
In Workflow Designer, click Plugins > Notification Server Credentials.
2
In the Notification Server Credentials Manager dialog box, click Add.
3
In the New NS Credentials dialog box, enter a Machine Name or IP Address,
Domain, User Name, and Password.
4
If wanted, select Current NS to use this credential as the project default.
5
Click OK.
The newly added credential is added to a list in the Credential Manager.
To edit an existing credential
■
Highlight a credential row within the Credential Manager, select the Edit
button and change the values, or edit each property by typing over each value
within a row.
To remove an existing credential
■
Highlight a credential row and select the Remove button.
Setting run time Symantec Management Console credentials
Each component picks up default run time credentials to connect to the Symantec
Management Console, but default connections can be overwritten by individual
components.
143
144
Workflow 7.0 and the Symantec Management Platform
How to prepare for your first use of Workflow Designer on the Symantec platform
To override the default Symantec Management Console and security tokens in a
component
1
In Workflow Designer, right-click on a Symantec component and select Edit
Component.
2
Click the Notification Server tab.
3
To override the default Symantec Management Console for this component,
do the following in order:
4
■
In the Notification Server Address box, click the [...] button.
■
Enter the Symantec Management Console name as either a Constant Value,
Dynamic Value, or Process Variable.
■
Click OK.
To override the default security token for this component, do the following
in order:
■
In the Security Token box, click the [...] button.
■
Search for and select the token you want.
Workflow 7.0 and the Symantec Management Platform
How to prepare for your first use of Workflow Designer on the Symantec platform
■
5
Click OK.
Click OK.
Setting up how a project runs
The following are ways a project can be set up to run:
■
Webservice Start
Starts when a user makes a request (for example, through a Smart task in
Helpdesk or a resource Item Action). To start a Webservice workflow, you
select a resource or a Smart task, right-click, and select the workflow.
■
Form Start
Starts with a dialog workflow form that requires user input (for example, salary
advance requests or vacation requests). When a Form Start workflow starts,
the workflow is processed until it gets to a Dialog Workflow component. The
first workflow component you have must be a Dialog Workflow component.
Form Start workflows can be started when a user right-clicks on an asset or
data class in the Symantec Management Console.
■
Auto Start
The Workflow Server monitors an event and when that event happens, the
workflow runs. For example, when an e-mail appears in a mailbox, a particular
workflow runs.
See “Publishing projects to Symantec Management Console 7.0” on page 149.
To set up how you want a project to run
1
In the Workflow Designer Tool, in the project pane, select the project name.
See “Workflow Designer tool” on page 60.
2
In the right pane, click the Publishing tab.
3
Scroll down to the Workflow Type section and select one of the following:
■
Webservice
■
Auto Start
■
Form Start
Based on the workflow type you select, appropriate properties appear in the
Dialog Settings section.
Webservice and Form Start workflows can be published onto the Workflow Server
and enabled to run on the Symantec Management Console. Form Start workflows
can be created in the Symantec Management Console as basic published workflows
or as Item Actions tied to data classes. Webservice workflows can be created in
145
146
Workflow 7.0 and the Symantec Management Platform
Deployment Server connection settings
the Symantec Management Console in a service catalog as Helpdesk Smart tasks,
Task Server tasks, or as Item Actions.
Deployment Server connection settings
Your workflows can use Deployment Server functionality by using deployment
components. Before using deployment components, you should set up design time
Deployment Server connection settings. Run time Deployment Server connection
settings are set using deployment components.
See “Design time and run time Deployment Server connection settings” on page 146.
See “Setting design time Deployment Server connection settings” on page 148.
See “Setting run time Deployment Server connection settings” on page 149.
Design time and run time Deployment Server connection settings
Your workflow uses different Deployment Server connection settings at design
time and at run time. You don't want to connect to production computers while
building workflows, but when you run projects, you want them to work properly.
By having different design time and run time Deployment Server connection
settings, you can safely design workflows in a test environment and run workflows
in your production environment.
The design time and run time Deployment Servers can be the same Deployment
Server. For your workflows to run well while being designed and being run, the
design time and run time Deployment Servers should be very similar or identical
Deployment Servers. Generally, you will want your design time Deployment Server
to be in a test environment. Therefore, we recommend that the Deployment Server
in your test environment be a clone of the Deployment Server in your production
environment.
The only way to set run time connection settings for a workflow is through
variables that are exposed and declared inside the workflow process.
Summary of the use of design time versus run time connection settings
■
The connection settings in the Deployment Server Connections plugin are
used by all deployment components at design time.
■
The connection settings in the Create DS Connection Profile component are
used by deployment components at run time (by default). The Create DS
Connection Profile component lets you use the connection settings from the
Deployment Server Connections plugin (by default). If wanted, you can use
connection settings for another Deployment Solution in the Create DS
Workflow 7.0 and the Symantec Management Platform
Deployment Server connection settings
Connection Profile component. This lets you use another Deployment Server
for run time instead of the one used by the plugin.
■
Each deployment component can override the run time connection settings
in the Create DS Connection Profile component. This lets you use multiple
Deployment Servers in your workflow.
Design Time Deployment Server connection settings
After you install Workflow 7.0, you set up design time Deployment Server
connection settings.
See “Setting design time Deployment Server connection settings” on page 148.
The Deployment Server you configure at this time has no effect on workflows at
run time. It is only used by Workflow Designer while a workflow is being designed.
When a project is opened, it recognizes the default design time Deployment Server
connection settings. These connection settings are used by deployment
components to get required data from Deployment Server while a workflow is
being designed.
These Deployment Server connection settings can be passed to the Create DS
Connection Profile component, which is used for run time Deployment Solution
connection settings.
See “Setting design time Deployment Server connection settings” on page 148.
Run Time Deployment Server connection settings
At run time, every deployment component that communicates with Deployment
Server needs run time Deployment Server connection settings.
The way to set up this communication is by using the Create DS Connection Profile
component. You should place a Create DS Connection Profile component before
using any deployment components. The connection settings you place in the
Create DS Connection Profile component are used by default in each component
that communicates with Deployment Server. These credentials can be changed
in any deployment component, providing you the flexibility of using multiple
Deployment Servers in a single project. You can have multiple Create DS
Connection Profile components in a workflow.
Each deployment component has a Deployment Server tab for configuring run
time Deployment Server connection settings for that component. This Deployment
Server tab has a DS Connection Profile and lets you set DS credentials. The DS
Connection Profile and DS credentials can either come from the variables set in
the Create DS Connection Profile component (default), any other variable (such
as from user input), a dynamic value, or a constant value.
See “Setting run time Deployment Server connection settings” on page 149.
147
148
Workflow 7.0 and the Symantec Management Platform
Deployment Server connection settings
Setting design time Deployment Server connection settings
During development, or design time, default Deployment Server connection
settings need to be established if you use deployment components. More than one
set of connection settings can be established, but only one can be designated as
the default design time Deployment Server connection settings.
See “Design time and run time Deployment Server connection settings” on page 146.
To set Deployment Server connection settings for workflow design
1
In Workflow Designer, select the Plugins > Deployment Server Connections.
2
In the Deployment Server Connections Manager dialog box, click Add.
3
In the New DS Connections Profile dialog box, enter the Machine Name or
IP Address, Domain, User Name, and Password for connecting to the
Webservice.
4
For the Is HTTPS property, check the box if the Deployment Server uses
HTTPS.
5
For the Is Security Enabled property, check the box if you have security
enabled on the Deployment Server. The credentials you enter in the Default
Credentials box should be to a default administrator account on Deployment
Server.
6
Click OK.
After you click OK, Workflow Designer tries to connect to the Deployment
Server using the credentials. When it connects, it runs a setup routine that
creates a folder in the Deployment console called "Workflow".
The newly added credential is added to a list in the Connections Manager.
To edit an existing credential
1
Highlight a credential row within the Connections Manager, select the Edit
button and change the values, or edit each property by typing over each value
within a row.
2
Click Run Setup to connect to the Deployment Server and run the setup
routine.
To remove an existing credential
■
Highlight a credential row and select the Remove button.
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Setting run time Deployment Server connection settings
Each deployment component picks up default run time connection settings to
connect to Deployment Server, but default connections can be overwritten by
individual components.
See “Design time and run time Deployment Server connection settings” on page 146.
To override the default Deployment Server profile and DS credentials in a component
1
In Workflow Designer, right-click on a deployment component and select
Edit Component.
2
Click the Deployment Server tab.
3
To override the DS connection profile for this component, do the following
in order:
4
5
■
In the DS Connection Profile box, click the [...] button.
■
Enter or select the DS Connection Profile as either a Constant Value,
Dynamic Value, Dynamic Model, or Process Variable.
■
Click OK.
To set the DS credentials variable for this component, do the following in
order:
■
In the DS Credentials box, click the [...] button.
■
Enter or select the DS Credentials Override variable as either a Constant
Value, Dynamic Value, Dynamic Model, or Process Variable.
■
Click OK.
Click OK.
Publishing projects to Symantec Management Console
7.0
When you publish a project, it is always published to Workflow Server. However,
during the publishing process you have the option of publishing to the Symantec
Management Console. You are not required to publish your project to the Symantec
Management Console. Publish to the Symantec Management Console if you want
to be able to access your project through the console. When you publish to the
Symantec Management Console, you do not publish there instead of Workflow
Server. Publishing to the Symantec Management Console simply lets users can
invoke the process through the console.
149
150
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
The Workflow Server and the Symantec Management Platform servers it works
with must have two-way communication set up. They must be able to communicate
with each other. When a project is published to a Workflow Server, the Workflow
Server sets up the correct URLs to the Symantec Management Platform servers
that the project uses. It gets the correct URLs from the Workflow Designer Server
Extensions Configurator.
After a project is published to a Workflow Server, you can run it from Symantec
Management Console 7.0 if you set it up to do so. Where you start a project in the
Symantec Management Console depends on the project type and the publishing
option chosen.
See “Setting up how a project runs” on page 145.
See “About publishing a project” on page 105.
For projects published to the Symantec Management Console, you can set up a
project to start in one of the following ways: Auto Start, Webservice, and Form
Start. Auto Start projects start on an event. This event can happen in the Symantec
Management Console or in another program, as long as it can be monitored by
the Workflow Server. Webservice projects start when they are invoked by a
webservice call. Form Start projects start when a user clicks a link to see a form.
See “Project start types” on page 107.
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Table 10-1
Locations a workflow can appear in the Symantec Management
Console
Location
Description
Right-click action
Workflows published as right-click actions appear in
the console in the right-click menus of target class
items. Target class refers to the class of items (such as
Computer) that get the right-click action.
Note: Altiris Notification Server item actions have
been renamed as right-click actions for Symantec
Management Console 7.0. Workflow Designer uses the
term item action.
See “Publishing a workflow as a right-click action in
the Symantec Management Console” on page 152.
The Symantec Management Console has two kinds of
right-click actions:
Dialog right-click action
When invoked, this right-click action presents the
user with a dialog box.
■ Service right-click action
When invoked, this right-click action uses a
Webservice call to trigger a workflow that runs
without user interaction.
■
Published workflow
Workflows published to the Symantec Management
Console as plain published workflows appear under
Settings > All Settings and then in the tree structure
on the left under Notification Server > Published
Workflows.
See “Publishing a workflow to the Symantec
Management Console” on page 170.
Task
Workflows published as tasks become available task
objects in the console. After you have published a
workflow as a task in the Symantec Management
Console, you can use the task object as a single task or
in Jobs or Automation Policies. You can also schedule
the task or run it as needed. You can configure these
implementations in the Symantec Management Console
after you have published your project.
See “Publishing a workflow as a task to the Symantec
Management Console” on page 170.
151
152
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Publishing a workflow as a right-click action in the Symantec
Management Console
Right-click actions are functions you can perform on items in the Symantec
Management Console. Right-click actions can be either dialog right-click actions
or service right-click actions. Right-click actions are either dialog right-click
actions or service right-click actions based on how you designed the workflow.
Note: Altiris Notification Server item actions have been renamed as right-click
actions for Symantec Management Console 7.0. Workflow Designer uses the term
item action.
Table 10-2
Dialog and service right-click actions
Dialog right-click action
Service right-click action
Triggers a Form Start Workflow-type process
Triggers a Webservice start Workflow-type
process.
Opens a form for user input
Calls the process without asking for user input.
Takes a Text type input for item GUID
Takes a Unique Identifier type input for item GUID.
Workflow projects that will be published as right-click actions must have one
input variable: an array of GUIDs. You should add this array to the project's input
data using the Unique Identifier datatype.
For a user to be able to publish a workflow as a task in the Symantec Management
Console, that user must have two permissions: Publish Workflows and Read (for
the target resource types). The user must also be a member of a role that has
access to the console and can create new tasks.
See “Granting a user permission to publish workflows to the Symantec
Management Console” on page 172.
When you publish a workflow as a right-click action, the right-click action gets
published to the default Symantec Management Console. In the console, the new
right-click action appears in the right-click menu of applicable items in the console.
To publish a workflow as a right-click action in the Symantec Management Console
1
In Workflow Designer, after you have finished your project, click File >
Publish Project > Publish Application To Server.
2
Select the server to which you want to publish, and click OK.
3
In the Open Deployed Project dialog box, click Yes.
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
4
In the Deployment dialog box that asks if you want to deploy as a
ServiceWorkflowItem, click Yes.
5
After authentication, click Deploy as ItemAction and click OK.
If ItemAction is not an available option, you need to add an array of GUIDs
as an input parameter to your process. (Use datatype Unique Identifier). To
make this change, cancel publishing, add an array of GUIDs (datatype Unique
Identifier) to your project's input data, and publish again.
6
Select a class of item to be the target class of the right-click action.
The right-click action will appear as an option in the right-click menus of
target class items.
See “Viewing right-click actions in the Symantec Management Console”
on page 153.
Viewing right-click actions in the Symantec Management
Console
When you publish a workflow as a right-click action, the right-click action gets
published to the Symantec Management Console. In the console, the new right-click
action appears in the right-click menu of applicable items in the console, and in
the right-click settings folder.
See “Publishing a workflow as a right-click action in the Symantec Management
Console” on page 152.
To view right-click actions in the Symantec Management Console
1
In the Symantec Management Console, click Settings > All Settings.
2
In the left pane, expand Notification Server > Right Click Menu.
Right-click actions appear as tree node items.
Use case example of a service right-click action workflow
This example demonstrates how to build, publish, and run a workflow right-click
action for Symantec Management Console 7.0. The right-click action described
in this example lets a user request additional licenses.
153
154
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Figure 10-1
Workflow project of the right-click action
This is a Workflow-type project set to Webservice start.
See “About publishing a project” on page 105.
This project has one input parameter: an array of GUIDs (datatype Unique
Identifier). During runtime, this variable will receive the value of the selected
software resource. The process uses this GUID to identify which resource receives
the action.
Figure 10-2
Project input data
The Create Notification Server Credentials component gives this process access
to the Symantec Management Console. During runtime, the process needs these
credentials to communicate with the Symantec Management Platform.
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Figure 10-3
Get Resource for NS 7 component editor
This screen shot shows the editor for the Get Resource for NS 7 component. This
component uses the GUID of the selected resource to retrieve data on that resource.
The component returns many pieces of data on the resource, including the name
of the resource and the GUID of the resource owner.
Figure 10-4
Get Users By ID component editor
This screen shot shows the editor for the Get Users by ID component. This
component uses the resource owner GUID returned by the Get Resource for NS
155
156
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
7 component to retrieve data on the resource owner, including the owner's name
and email address.
Figure 10-5
Assignments tab of the Dialog Workflow component editor
This screen shot shows the editor for the Dialog Workflow component. This
component sends the license request to an approver. The Start Process of the
Dialog Workflow component contains a Send Email component that sends an
email with a link to the approval form. The approval form is contained in the
Dialog Workflow component's Dialog Model.
Figure 10-6
Event Configuration tab of the Dialog Workflow component editor
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
This screen shot shows the Event Configuration tab of the same editor in the
previous screen shot. The Start Process is configured with one element: a Send
Email component.
Figure 10-7
Start Process of the Dialog Workflow component
This screen shot shows the configured Start Process of the Dialog Workflow
component, and it also shows the email configuration.
157
158
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Figure 10-8
Dialog Model of the Dialog Workflow component
This screen shot shows the Dialog Model of the Dialog Workflow component. It
is configured with a single form.
When this entire project is configured as shown in the screen shots above, it is
ready to be published to the Symantec Management Console as a right-click action.
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Figure 10-9
Right-click action publishing dialog box
This screen shot shows the right-click action options you see during publishing.
For more information on the steps leading up to this window, see the section on
publishing as a right-click action to the Symantec Management Console.
See “Publishing a workflow as a right-click action in the Symantec Management
Console” on page 152.
After the workflow right-click action is published, the right-click action is
immediately available on target class resources (in this case, Software Release).
In the console, the right-click action appears in the right-click menu of target
class resource.
159
160
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Figure 10-10
Workflow right-click action in the Symantec Management Console
This screen shot shows the new right-click action available in the Symantec
Management Console. Clicking this action invokes the published workflow project.
In summary, this example demonstrates how to create, publish, and run a workflow
right-click action. During runtime, a user can right-click a target class resource
(in this case, Software Release) in the Symantec Management Console and select
the right-click action from the list of available actions. When the user invokes the
right-click action by clicking it, the console makes a webservice call to the
published workflow. The workflow runs, presenting data to an approver, getting
a decision, and returning the results of that decision to the requester in an email.
Use case example of a dialog right-click action workflow
This example demonstrates how to build, publish, and run a dialog right-click
action workflow for Symantec Management Console 7.0. This example
demonstrates a right-click action on software that lets a user request additional
licenses.
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Figure 10-11
Workflow project of the right-click action
This is a Workflow-type project set to Form Start.
See “About publishing a project” on page 105.
This project has one input parameter: an array of text (datatype Text). During
runtime, this variable will receive the GUID value of the selected software resource.
The process uses this GUID to identify which resource receives the action.
Figure 10-12
Project input data
This screen shot shows the necessary input data: an array of text.
161
162
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Figure 10-13
Dialog Model of Dialog Workflow component
This screen shot shows the Dialog Model of the first component in the process
(the Dialog Workflow component called Gather Request Data). The Dialog Model
is located in the Interaction Setup tab in the Dialog Workflow component's editor.
In this case, the Dialog Model contains a single Form Builder component.
The following screen shot shows the configured form:
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Figure 10-14
Submit request form
This screen shot shows the form where the user enters data that is used later by
the process.
Continuing in the process, the Create Notification Server Credentials component
gives this process access to the Symantec Management Console. During runtime,
the process needs these credentials to communicate with the Symantec
Management Platform.
The next component in the process is the Get Resource for NS 7 component.
163
164
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Figure 10-15
Get Resource for NS 7 component editor
This screen shot shows the Get Resource for NS 7 component editor. This
component uses the GUID of the selected resource to retrieve data on that resource.
The component returns many pieces of data on the resource including the name
of the resource and the GUID of the resource owner.
The next component in the process is the Dialog Workflow component called Send
License Request to Approver.
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Figure 10-16
Assignments tab of the Dialog Workflow component editor
This screen shot shows the editor for the Dialog Workflow component called Send
License Request to Approver.
Figure 10-17
Event Configuration tab of the Dialog Workflow component editor
This screen shot shows the Event Configuration tab of the same editor in the
previous screen shot. The Start Process is configured with one element: a Send
Email component.
165
166
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Figure 10-18
Start Process of the Dialog Workflow component
This screen shot shows the configured Start Process of the Dialog Workflow
component, and it also shows the email configuration.
Back in the main editor of the Send License Request to Approver component,
the Dialog Model contains the approval form. The Dialog Model is located in the
Interaction Setup tab in the component's editor. In this case, the Dialog Model
contains a single Form Builder component.
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Figure 10-19
Dialog Model of the Dialog Workflow component
This screen shot shows the configured Dialog Model of the Send License Request
to Approver Dialog Workflow component.
When this entire project is configured as shown in the screen shots above, it is
ready to be published to the Symantec Management Console as a right-click action.
167
168
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Figure 10-20
Publishing dialog box
This screen shot shows the right-click action options you see during publishing.
For more information on the steps leading up to this window, see the section on
publishing as a right-click action to the Symantec Management Console.
See “Publishing a workflow as a right-click action in the Symantec Management
Console” on page 152.
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Figure 10-21
Workflow dialog right-click action in the Symantec Management
Console
This screen shot shows the new right-click action available in the Symantec
Management Console. Clicking this action invokes the published workflow project.
After the workflow right-click action is published, the right-click action is
immediately available on target class resources (in this case, Software Release).
In the console, the right-click action appears in the right-click menu of target
class resource.
In summary, this example demonstrates how to create, publish, and run a dialog
workflow right-click action. During runtime, a user can right-click a target class
resource (in this case, Software Release) in the Symantec Management Console
and select the right-click action from the list of available actions. When the user
invokes the right-click action by clicking it, the console makes a webservice call
to the published workflow. A browser window opens with the first form of the
workflow (figure N-14).The workflow presents the gathered data to an approver,
gets a decision, and then returns the results of that decision to the requester in
an email.
169
170
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Publishing a workflow to the Symantec Management Console
You can publish a workflow as a plain Published Workflow in the Symantec
Management Console. When you publish a workflow to the console, it appears as
a node in the tree structure and you can run it from the console. A workflow
published to the console appears under Settings > All Settings, and then in the
tree structure on the left under Notification Server > Published Workflows.
For a user to be able to publish a workflow to the Symantec Management Console,
that user must have the Publish Workflows permission in the console.
See “Granting a user permission to publish workflows to the Symantec
Management Console” on page 172.
See “About publishing a project” on page 105.
To publish a workflow to the Symantec Management Console
1
In Workflow Designer, after you have finished your project, click File >
Publish Project > Publish Application To Server.
2
Select the server to which you want to publish, and click OK.
3
In the Open Deployed Project dialog box, click Yes.
4
In the Deployment dialog box that asks if you want to deploy as a
ServiceWorkflowItem, click Yes.
If you do not see this dialog box after the service browser opens, check your
minimized windows. The Deployment dialog box is running behind the other
windows.
5
After authentication, click Deploy as Published Workflow, and then click
OK.
Publishing a workflow as a task to the Symantec Management Console
You can publish a workflow as a task in the Symantec Management Console. When
you publish a task to the console, you can invoke the workflow from the console.
This task can also be used in Jobs or Automation Policies.
Your workflow must be set to Webservice start for you to publish it as a task in
the Symantec Management Console.
See “About publishing a project” on page 105.
For a user to be able to publish a workflow as a task in the Symantec Management
Console, that user must have the Publish Workflows permission in the console.
The user must also be a member of a role that has access to the console and can
create new tasks.
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
See “Granting a user permission to publish workflows to the Symantec
Management Console” on page 172.
To publish a workflow as a task in the Symantec Management Console
1
In Workflow Designer, after you have finished your project, click File >
Publish Project > Publish Application To Server.
Your project must be set to Webservice start for you to publish it as a task.
2
Select the server to which you want to publish, and click OK.
3
In the Open Deployed Project dialog box, click Yes.
4
In the Deployment dialog box that asks if you want to deploy as a
ServiceWorkflowItem, click Yes.
If you do not see this dialog box after the service browser opens, check your
minimized windows. The Deployment dialog box is running behind the other
windows.
5
After authentication, click Deploy as ItemAction, and then click OK.
If the ItemAction option is unavailable, you need to create a string array input
value for the process. This string array is necessary because the process needs
to take in the GUID for its target item.
6
After you have published the workflow, create a new task with it in the
Symantec Management Console.
See “Creating a new workflow task in the Symantec Management Console”
on page 171.
Creating a new workflow task in the Symantec Management
Console
After you have published a workflow as a task to the Symantec Management
Console, you can use it to create a new task.
See “Publishing a workflow as a task to the Symantec Management Console”
on page 170.
To create a new workflow task in the Symantec Management Console
1
In the Symantec Management Console, click Manage > Jobs and Tasks.
2
In the tree structure in the left pane, right-click Jobs and Tasks, and then
click New > Job or Task.
3
In the resulting dialog box, in the left pane, scroll down and expand Server
Tasks.
4
Click Workflow Task Type.
171
172
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
5
In the right pane, from the drop-down list select the item that you want to
use to create the task (select the name of the published workflow).
6
Name the new task, and click OK.
Scheduling a task workflow
After you have published a workflow as a task and created a new task with it in
the Symantec Management Console, you can run it immediately or schedule it to
run later.
See “Publishing a workflow as a task to the Symantec Management Console”
on page 170.
See “Creating a new workflow task in the Symantec Management Console”
on page 171.
See “Scheduling a task in the Symantec Management Console” on page 174.
To schedule a task workflow
1
In the Symantec Management Console, click Manage > Jobs and Tasks.
2
In the right pane, click Schedule a job or task.
3
In the resulting dialog box, click Select a Job or Task.
4
In the tree structure on the left, select your published workflow.
Published workflow tasks appear under System Jobs and Tasks > Notification
Server.
5
Click OK.
6
In the right pane, set a schedule, and then click Schedule.
You can also select Now to run the task immediately.
Granting a user permission to publish workflows to the Symantec
Management Console
Users who want to publish a workflow to the Symantec Management Console
must have permission to do so. Only an administrator can grant this permission.
See “Publishing projects to Symantec Management Console 7.0” on page 149.
See “Publishing a workflow as a task to the Symantec Management Console”
on page 170.
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
To grant a user permission to publish workflows to the Symantec Management
Console
1
In the Symantec Management Console, click Settings > Security > Roles.
2
In the left pane, select the role to which you want to add the permission.
3
In the right pane, under Workflow Privileges, click the Publish Workflows
checkbox.
4
Save all changes.
Distributing workflow components with the Symantec Management
Console
See “Publishing projects to Symantec Management Console 7.0” on page 149.
As new components are created for Workflow Designer, these components need
to be available to designers throughout your organization. Instead of distributing
them manually through email or portable drives, you can use the component
distribution functionality in the Symantec Management Console.
In a default installation, all components are saved in c:\Program
Files\Altiris\Workflow\Workflow Components. Using the component distribution
function in the Symantec Management Console, you can send components into
this directory on all computers running Workflow Server.
A user who wants to publish a workflow to the Symantec Management Console
must be a member of a role that has Modify access to Organizational Groups
containing computers running Workflow Server. A user must also be a member
of a role that has Read access to the Distribute Workflow Components page.
To distribute workflow components
1
In the Symantec Management Console, click Settings > Service and Asset
Management > Distribute Workflow Components.
2
In the right pane click Applied to, and then select a target resource class to
receive the workflow components.
Typically you should select Computers. All items in the target class receive
the components; you cannot filter items within a target class.
3
Under Schedule, set a schedule for the distribution to take place.
When the components are distributed, the old component directories are
overwritten with the new directory.
4
Under Distribute Workflow Components, click the red Off symbol and change
it to On.
173
174
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
5
At the bottom of the screen, click Save changes.
Scheduling a task in the Symantec Management Console
See “Publishing projects to Symantec Management Console 7.0” on page 149.
See “Publishing a workflow as a task to the Symantec Management Console”
on page 170.
While you can run tasks at any time in the Symantec Management Console, you
can also set them to run on a schedule. This is especially helpful for tasks that
need to be repeated or that need to be run at inconvenient times.
To schedule a task in the Symantec Management Console
1
In the Symantec Management Console, click Manage > Jobs and Tasks.
2
In the right pane, click Schedule a Job or Task.
3
In the resulting dialog box, click Select a Job or Task.
4
In the left pane, select a task to schedule and click OK.
5
In the task scheduler, create a schedule for the task and click Schedule.
Defining automation policies for workflows in the Symantec
Management Console
See “Publishing projects to Symantec Management Console 7.0” on page 149.
You can set automation policies to trigger workflows. Although automation policies
cannot trigger workflows directly, automation policies can trigger any workflow
that is registered in the Symantec Management Console as a task.
Automation policies read data from a source (report or query), evaluate the return,
and decide whether or not to trigger an action. Automation policies can trigger
two actions: tasks and jobs. Thus, if a workflow is configured as an available task
(or as a task in a job) in the console, automation policies can make use of it.
To define automation policies for workflows in the Symantec Management Console
1
In the Symantec Management Console, click Manage > Automation Policies.
2
In the right pane, click New policy.
The policy appears in the right pane.
If you do not want to make a new policy, click on the one that you want to
edit from the list in the left pane.
3
In the right pane, set a schedule for the policy.
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
4
Select and define a data source.
Click Edit query under the data source to define the data source.
5
Set the evaluation rule.
The evaluation rule determines whether the policy takes an action based on
the return data as a whole or on each piece of returned data. For example, if
a Resource Query returns four values, the policy could make its action decision
based on the four as a whole or individually.
6
Set a job or task as the policy action.
Select the task that contains the workflow you want this automation policy
to trigger.
See “Publishing a workflow as a task to the Symantec Management Console”
on page 170.
175
176
Workflow 7.0 and the Symantec Management Platform
Publishing projects to Symantec Management Console 7.0
Section
5
Using Workflow Process
Manager 7.0
■
Chapter 11. Introducing Workflow Process Manager 7.0
■
Chapter 12. Managing the Process Manager portal
■
Chapter 13. Managing Workflow processes in Process Manager
■
Chapter 14. Managing documents in Process Manager
■
Chapter 15. Managing the Knowledge Base and discussions in Process Manager
■
Chapter 16. Managing schedules in Process Manager
■
Chapter 17. Managing data in Process Manager
■
Chapter 18. Managing the service catalog in Process Manager
■
Chapter 19. Managing accounts in Process Manager
■
Chapter 20. Performing administrative tasks in Process Manager
■
Chapter 21. Reports in Process Manager
■
Chapter 22. Integrating Process Manager
178
Chapter
11
Introducing Workflow
Process Manager 7.0
This chapter includes the following topics:
■
About Process Manager
■
Logging on to Process Manager
■
Setting your opening portal page
■
Symbols in Process Manager
About Process Manager
Process Manager is a web portal for managing the various parts of a workflow
process—tasks, documents, data, and so on. It lets you create teams, processes,
document repositories, libraries, Wikis, FAQs, and more, quickly and easily. You
can launch or schedule a process, assign tasks to users, and track the task progress.
At a glance, users can see what the status of processes are, what is late, and where
to find needed information.
You can integrate Process Manager with Active Directory for user authentication,
proper access control, and user management. Process Manager has a graphical
interface that is intuitive and easy to use, making it simple for everyone from
management to developers to work with the system and get what they need,
quickly. Process Manager is also thoroughly customizable. You can change almost
everything about Process Manager—pages, symbols, webparts, and so on—to create
an interface that works for you. You can also add new pages to Process Manager
that embed either Process Manager contents, or content from the Web or other
servers. By letting you design a hierarchy of pages that suit your specific needs,
Process Manager lets you work the way you want to work, yet still work within a
larger process framework.
180
Introducing Workflow Process Manager 7.0
About Process Manager
Process Manager is an integrated application that is composed of several major
modules. Each one of these modules is represented by a tab in the Process Manager
portal.
The major modules are as follows:
■
Workflow: sets tasks, as well as assigns users to those tasks
■
Knowledge Base: manages a knowledge base, discussion forum, and process
deadlines which show day-by-day deliverables
■
Documents: contains a documentation repository
■
Admin: manages the users of Process Manager and their permissions, manages
the applications used in the process, manages the different processes and
subprocesses, and controls the behavior and look of Process Manager
You can also create your own modules to customize the interface to suit your
requirements. Access to some parts of these modules may be restricted based on
permissions assigned by the administrator.
You can also customize pages to combine and display information in a logical,
coherent manner. For example, users can create a custom symbol on the main
page for a process' document repository, making it easy to locate instead of
spending time navigating through other menus. Users can create a page with
contents extracted from existing external Web sites, as well as queries from inside
Process Manager. A project manager can, for example, create a page that has
current metrics for the process, a list of tasks due in the next week, the latest
postings to the FAQ and Wiki, as well as stock prices extracted from an external
Web site and a search engine page. Customization is the key; process pages can
be set up the way users both want and need.
See “About document management” on page 230.
See “About Knowledge Base and discussions” on page 254.
You can view, edit, delete, add new, and manage permissions for most objects in
the Process Manager. Access to each of these options may be limited by user
permissions.
Workflow Designer provides components specifically for use with Process Manager.
All components in the Ensemble toolbox path (in the Component Toolbox in
Workflow Designer) were created for use with Process Manager. You can use these
components to perform many important tasks in Process Manager.
See “About managing Workflow processes in Process Manager” on page 221.
See “Integrating Process Manager” on page ?.
Introducing Workflow Process Manager 7.0
Logging on to Process Manager
Logging on to Process Manager
During the setup of the Process Manager portal, each user is assigned a user name
and initial password. We recommend that you change your password after you
log on to the portal for the first time.
See “Changing your password” on page 294.
The permissions that you have been granted control all aspects of your use of the
Process Manager portal. They determine which parts of the ServiceDesk portal
you can access and what you can do in each part.rviceDesk portal 49 Logging on
to the ServiceDesk portal If you cannot see or work in any feature that you read
about in this documentation, you probably do not have the appropriate
permissions. Your ServiceDesk administrator can help you with any permissions
issues. When you log on to the ServiceDesk portal, the portal opens to a specific
page. Initially, your permissions determine which page opens. However, you can
set a different page to open when you log on.
To log on to the Process Manager portal
1
Open the Process Manager portal in one of the following ways:
■
On the Desktop, click the Altiris Process Manager shortcut.
■
Under the Start menu programs, click Altiris > Altiris Process Manager.
2
On the logon page, type your Email Address of Username and Password.
3
(Optional) Check Remember Me.
This option creates a cookie on your local computer, which automatically
logs you on to Process Manager. The cookie expires in one year.
4
Click Login.
Setting your opening portal page
Whenever you log on to the Process Manager portal, the portal opens to a specific
page. Initially, your permissions determine which page opens. However, you can
set a different page to open when you log on. This page does not necessarily have
to be the one that is labeled the Home page.
To set your opening page
1
In the Process Manager portal, open the page that you want to make your
home page.
2
At the bottom of the portal window, click Make Home Page.
181
182
Introducing Workflow Process Manager 7.0
Symbols in Process Manager
Symbols in Process Manager
Process Manager has a number of symbols that represent different actions. You
may not be able to see some symbols based on your permission level. All symbols
are available to administrator users.
Table 11-1
Symbol
Symbols in Process Manager
Description
Hides or shows content within a web part.
Takes an action. When you click this symbol you are
given additional options, such as edit, delete, or add
new.
Takes an action, searches, and changes reports,
respectively. These three symbols often appear
together.
See “Options for customizing a Process Manager page
list” on page 212.
Adds a new item to the list.
Adds a new reference item to the list, such as a report.
Adds a new category or division to the list, such as a
report category.
Launches a service catalog item.
Chapter
12
Managing the Process
Manager portal
This chapter includes the following topics:
■
About the Process Manager portal
■
Changing Process Manager master settings
■
Process Manager settings
■
About Process Manager pages
■
Uploading plug-ins
■
Adding Web part catalogs
■
Working with Web part catalogs
About the Process Manager portal
The Process Manager portal is the user interface of Process Manager. Portal
settings are located in Admin > Portal.
Table 12-1
Admin portal settings
Setting
Description
Master Settings
Lets you control the behavior of Process Manager on
a high level. Master settings include
See “Changing Process Manager master settings”
on page 184.
See “Process Manager settings” on page 185.
184
Managing the Process Manager portal
Changing Process Manager master settings
Table 12-1
Admin portal settings (continued)
Setting
Description
Manage Pages
Lets you view, modify, and add pages to Process
Manager.
The Manage Pages option window is divided into two
panes. The left pane displays a hierarchical view of the
pages in the site, broken down by category. The right
pane lets you view and edit the selected page.
See “About Process Manager pages” on page 196.
See “Managing pages” on page 196.
Plugin Upload
Lets you add plug-ins to Process Manager.
The Plugin Upload option window has one pane that
lets you load new plug-ins to Process Manager.
See “Uploading plug-ins” on page 219.
Web Parts Catalog
Lets you add and manage Web parts catalogs.
The Web Parts Catalog option window is divided into
two panes. The left pane displays the categories of Web
part catalogs. The right pane displays the Web part
catalogs in the selected category and lets you edit them.
See “Adding Web part catalogs” on page 219.
See “Working with Web part catalogs” on page 219.
Changing Process Manager master settings
Process Manager settings can be changed in the portal.
See “About the Process Manager portal” on page 183.
To change process manager settings
1
On the Process Manager home page, on the Admin tab, select Portal > Master
Settings.
2
Make the changes you want.
See “Process Manager settings” on page 185.
3
At the bottom of the screen, click Save.
Managing the Process Manager portal
Process Manager settings
Process Manager settings
Process Manager settings can be changed in the portal in Admin > Portal > Master
Settings. The settings appear under a series of headers. To expand any header
and see the details beneath it, click on the blue arrow to the left of the header
name. By default, the Account Management settings are expanded when you enter
this page.
See “Changing Process Manager master settings” on page 184.
The Account Management settings are used to control information required for
new users and how the users are handled.
Table 12-2
Account Management
Setting Name
Description
Default Permissions
The set of permissions given to a new user by default
(they may be overridden by the administrator). Clicking
Pick Permissions brings up a window with a list of
available permissions in a drop-down list. You can
choose directly from this list.
Default Groups
The groups that the user will be assigned to. You can
choose from the available groups by clicking Pick
Groups.
Default Organizations
The organizations the user is assigned to if not
specified or overridden. The existing organizations
can be seen by clicking Pick Organizations.
All Users Group
The users group that the user will be assigned to. You
can choose from the available groups by clicking Pick
Groups.
Password Expire Months
The number of months before the user's passwords
must be changed. The passwords can be changed before
this time, but users are forced to change passwords
after this many months.
Password Expire Days
The number of days to be added to the months before
the user's passwords must be changed. The passwords
can be changed before this time, but users are forced
to change passwords after this many days and months.
Required Phone Number
Selecting forces the user to provide their phone
number.
Required First Name
Selecting forces the user to provide their first name.
185
186
Managing the Process Manager portal
Process Manager settings
Table 12-2
Account Management (continued)
Setting Name
Description
Required Last Name
Selecting forces the user to provide their last name.
Required Address
Selecting forces the user to provide their address.
Required City
Selecting forces the user to provide their city.
Required State
Selecting forces the user to provide their state or
province.
Required Zip
Selecting forces the user to provide their zip code.
Required Country
Selecting forces the user to provide their country.
Required Password Hint
Selecting forces the user to choose both a password
and complete a password hint clue.
Required Key Value Pairs
Specific values that the user must provide that are not
already specified.
Optional Key Value Pairs
Values that the user may elect to complete.
Register Fail Email
The email address to which notifications of a failed
registration attempt are sent.
Register Fail Email Link
The email address that appears on the screen for a user
to request attention when a registration attempt is not
completed properly.
Users First Page
The page the user is directed to when they log in.
Users First Page Link
The text of the link displayed on the login page to direct
a user to their first page.
Minimum Security Answers
The minimum number of answers required (if any) for
security questions. If set to zero, no security answers
are required.
Security Question 1
The first security question to be asked.
Security Question 2
The second security question to be asked.
Security Question 3
The third security question to be asked.
Security Question 4
The fourth security question to be asked.
Security Question 5
The fifth security question to be asked.
Managing the Process Manager portal
Process Manager settings
Table 12-2
Account Management (continued)
Setting Name
Description
Contact Permission Group
The group a user is to contact for requests that have
to do with permissions.
Create Contact for New Users
Selecting creates a new contact for a user who registers.
Force Password Reset Default
Selecting sets password reset times to default values
for all users.
Session Timeout (days)
The number of days for the session to timeout. After
this number of days, the user needs to login to access
Process Manager.
Table 12-3
Application Management
Setting Name
Description
ServiceLauncher DocID
The document id if a service launcher is used.
LBStudio DocID
The document ID for LBStudio.
Application Document
RootCategoryID
The root category ID for the application.
Assign Group to Application
Document Category
The group name used for any application document
category added to the system.
Assign Permissions to
The permissions assigned to any application document
Applications Document Category category added to the system.
Services Root CategoryID
The root category ID of all services.
File lock Duration
The amount of time, in minutes, that a file lock is
maintained.
Default Publishing Server
The URL or IP address of the publishing server.
Default Directory Service
Permission
The permissions user (by default) for directory services.
The Articles settings lets you set up article and bulletin board entries.
187
188
Managing the Process Manager portal
Process Manager settings
Table 12-4
Articles
Setting Name
Description
Number of Last Entries to Show
on List
A numeric value showing the maximum number of
article entries that are retained on the list on the main
page.
Article Number Prefix
The prefix that gets prepended to the article number.
Article Entry Number Prefix
The prefix that gets prepended to the entry number.
Captured Image Category
The default category used for images sent from the
screen capture utility.
Bulletin Board Entry End Date
The number of days the bulletin board entry has before
it ends. This is based on its creation date.
Bulletin Board Entry Priority Low The color for the bulletin board entry low priority.
Color
Bulletin Board Entry Priority
Medium Color
The color for the bulletin board entry medium priority.
Bulletin Board Entry Priority High The color for the bulletin board entry high priority.
Color
Bulletin Board Entry Priority
Emergency Color
The color for the bulletin board entry emergency
priority.
Hide Recent Articles
Hides or shows the recent articles webpart.
The Chat settings let you control the chat function in Process Manager.
Table 12-5
Chat
Setting Name
Description
Message Retention Time (days)
Sets how long (in days) that a chat message is stored
in exchange.
Message HearBeat Expiration
Time (min)
Sets how long a user remains active without sending
a message.
Show Chat In Virtual Window
Sets whether the chat screen opens as a virtual window
or a regular window.
The Customization settings let you control the Process Manager site's appearance.
Managing the Process Manager portal
Process Manager settings
Table 12-6
Customization
Setting Name
Description
Home Page Content
The URL of the site home page. This can be an absolute
or relative address.
Logo URL
The URL of any logo to be displayed on the site. The
Pick option lets you browse the file system for a logo.
Edit Page in Header
Selecting displays a link allowing the page to be edited.
Show Breadcrumbs
Selecting displays the trail of pages to the current
location relative to the home page.
Show Secondary Menu
Selecting causes a drop-down menu to appear when
the user hovers the cursor over any section symbol at
the top of the page.
Show Account Link In Header
The Account link displays in the header of the Process
Manager page.
Show Support Link In Footer
The Support link displays in the footer of the Process
Manager page.
The Document Management settings let you control the management of
documents.
Table 12-7
Document Management
Setting Name
Description
Orphan CategoryID
A string assigned to any orphan categories.
Download Document Name Mask The formatting mask used for any documents that are
downloaded by users.
Silent Document Type Add
Selecting adds a type to new documents.
Default Compress for New
Document Type
Selecting uses compression on any new documents.
Projects Root CategoryID
The default category ID for any new project's root.
Max Categories in Tree
The maximum number of categories that can be in a
tree structure.
Show Browse Categories
Selecting displays the categories that are being
browsed.
189
190
Managing the Process Manager portal
Process Manager settings
Table 12-7
Document Management (continued)
Setting Name
Description
Show Search Categories
Selecting displays the categories examined when a
search is performed.
Checkout Functionality Enabled
Lets users lock files in the document repository.
Checkout Lasts(days)
The number of days that a file can be locked in the
document repository. After this number of days, the
file becomes available for other users to edit.
Hide Recent Documents
If checked, the Recent Documents folder does not
display in the Browse pane in the Documents window.
Hide Orphan Documents
If checked, the Orphan Documents folder does not
display in the Browse pane in the Documents window.
Orphaned documents are documents that do not belong
to a category.
Table 12-8
Email Settings
Setting Name
Description
SMTP Server
The SMTP server used by Process Manager.
Admin Email
The address that receives administration email.
The Not Logged-In Users settings control how users who are not logged in to the
Process Manager site are handled when they visit. This includes the ability to
block all access to users who do not log on, or allow such users to perform some
functions.
If the site is going to force all users who visit to log in, the Allow Not Logged-In
Users option should be cleared. All other settings in this section are ignored when
this option is not selected.
Table 12-9
Not Logged-in Users
Setting Name
Description
Allow Not logged-in users
Selecting lets users access the site without logging in.
If not selected, users must log in to perform any actions
on the site.
Managing the Process Manager portal
Process Manager settings
Table 12-9
Not Logged-in Users (continued)
Setting Name
Description
Not Logged-in User ID
The user ID for not logged in users.
All users need to have a working login to perform any
actions on the site, whether they are legitimately
logged in users or not. This option lets a user who does
not log in employ a login while they are in the site.
Usually, this is a login with restricted rights, such as
a guest account.
Not Logged-In Password
The password tied to the Not Logged-In User ID to let
visitors to the site access some functions.
Show Login Control in Header
Selecting displays the user's login name on the header
of the site. If not selected, the user name is suppressed.
Show Link to Login in Header
Selecting displays a login link in the page header if the
visitor has not logged in. If not selected, no such login
link is displayed.
Show Remember Me in Header
Selecting creates a "Remember me" link that writes a
cookie to the user's computer that appears in the
header. If this option is not selected, there is no ability
to remember the login name.
The Notifications settings let you set the home URL for the Process Manager site,
as well as the locations of plug-ins.
Table 12-10
Notifications
Setting Name
Description
Global Service Location URL
The URL or IP address of the site.
Get Base URL To Process Manager If checked, the base URL to Process Manager is
From Request
retrieved from the HTTP request. This setting is used
if you are exposing Process Manager on multiple URLs.
This setting lets you redirect to your public facing URL
found in the Base URL To Process Manager setting.
Base URL To Process Manager
The public facing URL for Process Manager.
Accounts Plugin
The location of the accounts plugin.
Projects Plugin
The location of the projects plugin.
Documents Plugin
The location of the documents plugin.
191
192
Managing the Process Manager portal
Process Manager settings
Table 12-10
Notifications (continued)
Setting Name
Description
Workflow Plugin
The location of the workflow plugin.
Discussions Plugin
The location of the discussions plugin.
Calendar Plugin
The location of the calendar plugin.
Articles Plugin
The location of the articles plugin.
Chat Plugin
The location of the chat plugin.
Process Manager Active Directory Settings manage how Process Manager interacts
with Active Directory.
Table 12-11
Process Manager Active Directory Settings
Setting Name
Description
Active Directory Authentication
Sets Process Manager to use Active Directory
authentication.
Process AD Changes Using
Workflow
Not available.
AD Sync Process Interval (in mins) Sets the interval between executions of the Active
Directory Sync process.
Ignore Ad Users (Comma
separated)
Lists users for Process Manager to ignore when running
the sync process.
Process Manager Events settings turn on or off event notifications. You must
publish the appropriate event listener processes before you can use event
notifications.
Table 12-12
Process Manager Events
Event notification settings
Turns on or off all event notifications. If you want to
use event notifications, open the event notification
processes (located in C:\Program File\Altiris\Workflow
Designer\Designer\Templates), configure them for
your environment (change at least the mail server
settings), publish them, and turn on the appropriate
event notifications under this heading in the Process
Manager settings.
Process Manager settings are general settings for the Process Manager site.
Managing the Process Manager portal
Process Manager settings
Table 12-13
Process Manager Settings
Setting Name
Description
Forgot Password Link
Selecting enables a link to a password recovery page.
Otherwise, a user who has forgotten their password
needs to communicate with a site administrator for a
password reset.
Register Account Link
Selecting lets a new user create an account for this site.
If this option is not selected, only the site administrator
can add access for new users.
Register Account URL
The URL of the register account.
Enable Full Text Search
Selecting lets users perform full text searches.
Display time in local time Zone
Selecting always displays the time local to user.
Use translation
This setting is not available.
Show Notifications
Sets whether the task notification window appears.
Show Notification Position
Lets you change the location of the task notification
window.
Update Business Hours
Updates in Process Manager the business hours stored
in the task tray application.
Help Link Url
Sets the URL for the Help link at the bottom of Process
Manager.
The Optimization settings let you control the behavior of the Process Manager.
The cache and fast cache retention time settings are used to allow a balance
between the amount of memory used by the application to store items in cache
and the available memory of the computer. The longer the cache time setting, the
faster the application retrieves previously-called pages, but also the more physical
memory or disk space is needed. The default settings are used for most servers,
but if heavy loads are expected in a system with a shortage of memory, reducing
the cache times can help prevent paging.
Table 12-14
Optimization
Setting Name
Description
Clean Cache Time
How often the cache is emptied (in minutes). The
higher the number, the larger the cache, but also the
faster the application can be perceived to be.
193
194
Managing the Process Manager portal
Process Manager settings
Table 12-14
Optimization (continued)
Setting Name
Description
Keep Objects Time
The amount of time (in minutes) that objects are kept
in memory for fast retrieval.
Fast Cache Objects Time
The amount of time (in minutes) that Fast Cache is
used to keep objects in memory.
Fast Cache Clean Time
The amount of time (in minutes) that the Fast Cache
is retained before being purged.
Table 12-15
Profile
Setting Name
Description
Show Count In Profile Tree
Displays the count in the Profile tree.
Profile Tree Date Not Set Text
The text that appears at the end of the profile tree
structure.
Table 12-16
Reports Settings
Setting Name
Description
Process Reporting Messages
If this setting is checked, the integration between
Process Manager and Workflow processes to capture
reporting messages is turned on.
See “Setting up workflow task integration with
Workflow Designer” on page 226.
Process Reporting Interval(Sec)
The interval, in seconds, that the Process View page
retrieves updated information about a process.
Message Exchange Name
The name of the message exchange. The message
exchange is how processes running on Workflow Server
communicate with Process Manager.
Auto Record User Time
Sets whether the user time spent working in a process
is stored in Process Mananger. Any process that has a
Process View page can have user time automatically
recorded in Process Manager.
The Workflow settings control the behavior of the workflow module.
Managing the Process Manager portal
Process Manager settings
Table 12-17
Workflow Settings
Setting Name
Description
Task Lease Time
The amount of time, in minutes, that a task is leased
to a user.
Show Leased Items in Task List
Selecting displays any leased items in the user's task
list.
Lease Tasks
Selecting lets tasks be leased. If this option is not
selected, tasks cannot be leased to a user.
Show Task in New Window
Selecting lets any task the user selects be opened in a
new window; otherwise, the same window is used.
Workflow Leased Error Message
The string displayed to a user if there is a problem
leasing a task.
Workflow Task Due Date
The default due date for a task (in days).
Workflow Task Late Date
The default late date for a task (in days).
Show Tasks in Different Color
Selecting displays the tasks in a different color than
the rest of the screen text.
Workflow Task Due Date Color
The color (in hex) for a task's due date.
Workflow Task Late Date Color
The color (in hex) for a task's late date.
Show Profiles On Task Page
Displays the Profiles section in the left pane on the
Task page. This lets you filter your task view by profiles
you create.
Show Pager On Task Page
Separates the items on the Task page into pages if there
are a certain number of items.
Show Count On Task Page
Displays the count on the Task page. This requires an
additional query.
Workflow Task Number Pad
The number or character to pad onto each workflow
task number. This lets you keep all workflow task
numbers the same length.
Workflow Task Number Prefix
The prefix to prepend to each workflow task number.
Auto Refresh Task Page
Lets the page selected in the Default Workflow Task
Page setting refresh automatically. Use this setting
for non-Ajax pages if you want them to refresh
automatically. Ajax pages refresh automatically.
195
196
Managing the Process Manager portal
About Process Manager pages
Table 12-17
Workflow Settings (continued)
Setting Name
Description
Task Refresh Time
The amount of time, in milliseconds, between page
refreshes for the Task page.
About Process Manager pages
The Process Manager portal is a Web-based interface that provides access to the
Process Manager application. The users of Process Manager access the portal
from their Web browsers and use it to run the workflow processes and perform
other Process Manager activities.
The Process Manager portal is made up of Process Manager pages. When you log
on to Process Manager, the Process Manager pages that are available to you are
determined by the permissions that you have. If you cannot access a Process
Manager page that is described in this documentation, then you probably do not
have the appropriate permission.
Process Manager pages can be customized for the entire organization or for users,
groups, or organizational groups, or permission groups. Administrators have
permission to customize Process Manager pages and to grant customization
permissions to other Process Manager users.
You can add new home pages to the main interface, and sub-pages to those home
pages. Each page can have content derived from inside the Process Manager
system, or gathered from anywhere your system has access to such as network
servers, or the World Wide Web. This lets you use Process Manager as a portal
both to the Web and to the existing Process Manager repository, creating the
content and displays you need to work more efficiently.
Creating a new page or sub-page for an existing home page is done through the
Site Actions link in the top right of the Process Manager portal.
See “About customizing Process Manager pages” on page 203.
Managing pages
Users can add pages to Process Manager and edit pages in Process Manager with
the right permissions. This lets users control how they use Process Manager.
Users can add new pages to Process Manager that embed either Process Manager
contents, or content from the Web or other servers. By letting users design a
hierarchy of pages that suit their specific needs, Process Manager lets users work
the way they want to work, yet still work within a larger project framework.
Managing the Process Manager portal
About Process Manager pages
See “About the Process Manager portal” on page 183.
See “Adding new Process Manager pages” on page 199.
See “Adding new Process Manager pages” on page 199.
See “Add Page page” on page 201.
See “New Page Wizard: Step 2 page” on page 202.
See “Adding a sub-page” on page 203.
See “About customizing Process Manager pages” on page 203.
See “Enabling the customization of a Process Manager page” on page 204.
See “Customizing a Process Manager page (administrator)” on page 205.
See “Customizing your Process Manager pages (non-administrator)” on page 205.
See “Options on the Site Actions drop-down list” on page 206.
See “Adding a Web part to a Process Manager page” on page 208.
See “Editing a Web part on a Process Manager page” on page 209.
See “Sharing a Process Manager page” on page 210.
See “Modifying existing Process Manager pages” on page 211.
See “Deleting Process Manager pages” on page 211.
See “Customizing a Process Manager page list” on page 212.
See “Options for customizing a Process Manager page list” on page 212.
See “Changing the report for a Process Manager page list” on page 214.
See “Process View page” on page 214.
See “Accessing the Process View page” on page 216.
See “ Actions in the Process View page” on page 217.
To go directly to a page
1
On the Process Manager home page, on the Admin tab, select Portal > Manage
Pages.
2
In the left pane, select the page you want to go directly to.
3
In the right pane, click Go To Page.
To add a sub page
This lets you add a new page underneath a page in the Pages List.
197
198
Managing the Process Manager portal
About Process Manager pages
1
On the Process Manager home page, on the Admin tab, select Portal > Manage
Pages.
2
In the left pane, select the page to add a sub page to.
3
In the right pane, click Add Sub Page.
4
Add the appropriate information for the page.
See “To edit a page” on page 198.
5
Click Save.
To edit a page
1
On the Process Manager home page, on the Admin tab, select Portal > Manage
Pages.
2
In the left pane, select the page to edit.
3
In the right pane, click Edit Page.
4
Enter the following:
Menu name
The name of the page.
Description
A text description of the purpose of the page.
Include In Menu
Indicates whether or not this page should
appear in the menu listing.
Template Page
The template page used to lay out the page
on the site.
Help Url
The URL of any help page associated with
this page.
Image Url
The URL of any image associated with this
page.
Default Parameters
Any parameters used for this page.
Enabled
Whether or not this page is enabled
(viewable).
Allow User Personalization
Whether or not users are allowed to
personalize this page.
5
Click the Permissions tab and click Add Permission to add permissions for
accessing this page.
6
Click Save.
Managing the Process Manager portal
About Process Manager pages
To delete a page
1
On the Process Manager home page, on the Admin tab, select Portal > Manage
Pages.
2
In the left pane, select the page you want to delete.
3
In the right pane, click Delete Page.
4
Click OK.
To move pages in the pages list
1
On the Process Manager home page, on the Admin tab, select Portal > Manage
Pages.
2
In the left pane, select the page you want to move.
3
To move the current page one level up in the hierarchy, in the right pane,
click Move Up.
4
To move the current page one level down in the hierarchy, in the right pane,
click Move Down.
5
To make the current page a sub-page to another page, in the right pane, click
Make As Sub Page.
Adding new Process Manager pages
In addition to the default Process Manager pages that appear when you log on to
the Process Manager portal, you can create new Process Manager pages.
Permissions control the ability to create Process Manager pages. Initially, the
Administrator role has the permission to create Process Manager pages, but any
user or group can be granted the permission to create Process Manager pages.
The permission for adding Process Manager pages is: Portal.CanAddPages.
See “Managing pages” on page 196.
When you create a new Process Manager page, a tab is added to the main Process
Manager interface with whatever title you assign. You can use Process Manager
pages as a high-level organizational unit for content covered in sub-pages
underneath the Process Manager page, or you can have a one-page portal that
displays specific information you access regularly.
You can obtain content for these pages from any source your system can access
so you could, for example, create a Process Manager page which gathers
information from the Web about weather, stock markets, news headlines, and so
on, assembled as you wish from various sources and available for viewing whenever
you want. Or you can create a Process Manager page that gathers statistics from
different locations within Process Manager, relating to your process, and use
sub-pages to contain more information that breaks down the Process Manager
199
200
Managing the Process Manager portal
About Process Manager pages
page content for more granularity. The layout and content of these pages is entirely
up to you.
The content of the new Process Manager page is similar to the standard page type
you select, but can be customized specifically to your requirements.
To create a new Process Manager page
1
In the Process Manager portal, in the Site Actions drop-down list, click Add
Root Page or Add Sub Page.
2
In the New Page Wizard: Step 1 page, click the page type, and then click Next.
3
Document Library
Contains documents (files such as text documents
or graphics that you can manually retrieve from
Process Manager or use in your Workflow
projects). A documents library page is usually a
subset of the Documents root page in Process
Manager.
Articles (Diary)
An article that lets you enter text regularly; this
may be for personal or process use (or a
combination of the two).
Wiki (NotePad)
Creates a wiki similar to those in the Articles
module, but specific to your use (or shared with
those you choose to share with).
FAQ (Frequently Asked
Questions)
Creates a FAQ page similar to those in the Articles
module, but specific to your use (or shared with
those you choose to share with).
Discussion
Creates a discussion forum which you can share.
Form Library
Contains forms, usually a subset of forms in the
larger Process Manager system.
Web Part
Contains content you define in HTML format or
gathered from the Web.
Site Aggregator
Contains content from the Web gathered from
one or more sources and displayed as a single unit.
Menu Placeholder
Adds a menu item that has no page associated
with it.
For Document Library, Articles, Wiki, FAQ, Discussion, Form Library, and
Menu Placeholder page types, do the following:
■
Enter the name for the root page.
Managing the Process Manager portal
About Process Manager pages
■
4
Click Create Page.
For Web Part page type:
See “Add Page page” on page 201.
5
For Site Aggregator page type:
See “New Page Wizard: Step 2 page” on page 202.
Add Page page
When you add a new page to Process Manager, you see the Add Page page.
See “Adding new Process Manager pages” on page 199.
See “Managing pages” on page 196.
The Add Page page lets you define a new page in the Process Manager portal. It
appears when you add a new Web Part Process Manager page.
Table 12-18
Options on the Add Page page
Option
Description
Menu Name
The text that appears in the menu for the page, regardless of where
in the menu hierarchy it appears. This field is required.
Description
An optional description of the page that appears only in the page
administration screen. It is used as a reference for whoever
manages the Process Manager pages.
Include In Menu
Select the check box to include the page in the menu you have
specified. If you do not select this check box, there is no menu path
to the page.
Not selecting this check box is useful if you want to create a page
that can only be linked to through custom content on another page.
201
202
Managing the Process Manager portal
About Process Manager pages
Table 12-18
Options on the Add Page page (continued)
Option
Description
Template Page
Select the template page that you want to use for the Process
Manager page. The template page specifies the number of zones
that you add to the Process Manager page. Each Process Manager
page is made up of Web parts, and the template page determines
the size and number of Web parts on the page.
Each entry on the template page drop-down list has a percentage
number. This number indicates how many Web parts the page is
broken into and how big those parts are.
To create a single Web part, choose the 100% option. A
“100%,66%/33%” template page divides the page into two. The
top part takes half the page, and the bottom half is divided into
two subparts. One subpart is 66% and the other 33% of the page.
This division lets you choose the page layout that best suits your
page requirements.
You can also specify URLs for help and image pages on the Portal
Page Edit window, as well as set any parameters you want. The last
two check boxes indicate whether the page is enabled when you
save it, and whether to allow users to personalize the page.
This field is required.
Help Url
This field is used if you want to include a URL to a separate page
you have created that has help content. If you add a help URL to
the page, you get a help link in the footer bar. This lets you provide
contextual help for a page.
Image Url
The path to the icon image for the main menu.
Default parameters
A default URL query string for the page.
Enabled
Select this check box to enable the page when you save it. This field
is required.
Allow User
Personalization
Select this check box to allow users to further personalize the
Process Manager page.
Add New Permission
Click this button to add permissions to the Process Manager page.
New Page Wizard: Step 2 page
When you add a new site aggregator page to Process Manager, you see additional
options on the New Page Wizard: Step 2 page.
See “Adding new Process Manager pages” on page 199.
Managing the Process Manager portal
About Process Manager pages
See “Managing pages” on page 196.
This page lets you define a new site aggregator page in the Process Manager portal.
It appears when you add a new Site Aggregator Process Manager page.
Table 12-19
Options on the New Page Wizard: Step 2 page
Option
Description
Page name
The name for this page.
Url
The URL for this page.
Pass Session
The session ID that this page passes.
Pass Email Address
The email address that this page passes.
Adding a sub-page
You can add a sub-page to an existing Process Manager page. Process Manager
pages are accessed by clicking on the module name (such as Documents). Sub-pages
are accessed by clicking a sub-tab in a module.
You can create sub-pages for a sub-page, allowing further granularity of
information.
To add a sub-page
1
On the Process Manager home page, select the module you want to add a
sub-page to.
2
Select Site Actions > Add Sub Page.
3
Follow the steps found in adding a root page.
See “Adding new Process Manager pages” on page 199.
About customizing Process Manager pages
The Process Manager portal is made up of pages, from which all Process Manager
activities are performed. The Process Manager pages can be customized to meet
your organization’s specific requirements.
Administrators can perform all the customization actions and can grant
customization permissions to other Process Manager users. Non-administrator
users typically have fewer options for customizing Process Manager pages.
See “Enabling the customization of a Process Manager page” on page 204.
See “Managing pages” on page 196.
Customizing Process Manager pages consists of the following actions:
203
204
Managing the Process Manager portal
About Process Manager pages
■
Adding and deleting pages.
■
Specifying which pages can be customized.
■
Adding, editing, and deleting the Web parts that appear on a page.
■
Sharing pages with other users.
See “Customizing a Process Manager page (administrator)” on page 205.
See “Customizing your Process Manager pages (non-administrator)” on page 205.
Enabling the customization of a Process Manager page
See “About customizing Process Manager pages” on page 203.
See “Managing pages” on page 196.
Before anyone can customize a Process Manager page, the administrator must
enable that page for customization. Enabling a page for customization consists
of setting the appropriate privileges and permissions.
Table 12-20
Process for enabling the customization of a Process Manager page
Step
Action
Description
Step 1
Set customization
privileges for a user or
group.
The privilege setting for groups is
Portal.PersonalCustomization.
Set customization
permissions on the
page.
For each page, set permissions for adding, editing,
or deleting the page.
Step 2
The privilege setting for users is
PersonalCustomization, which is under the Portal
category.
On the Admin tab, under Portal > Manage Pages,
you can edit the page to enable it for
customization as follows:
The Allow User Personalization setting
enables the Modify My Pageoption on the
Process Manager page, which lets a user edit
their own page without affecting that page for
other users.
■ The page’s Permissions settings let you allow
users, groups, organizations, or permission
groups to view, edit, or delete the page.
■
See “Managing pages” on page 196.
Managing the Process Manager portal
About Process Manager pages
Customizing a Process Manager page (administrator)
By default, the administrator can customize any Process Manager page that is
able to be customized.
See “About customizing Process Manager pages” on page 203.
See “Managing pages” on page 196.
To customize a Process Manager page
1
In the Process Manager portal, access the page to customize.
2
In the upper right of the page, in the Site Actions drop-down list, select an
action to perform.
See “Options on the Site Actions drop-down list” on page 206.
3
When you finish the customization, you can close the page.
Customizing your Process Manager pages (non-administrator)
You can customize any of your Process Manager pages if you have permission to
do so.
See “About customizing Process Manager pages” on page 203.
See “Managing pages” on page 196.
Before anyone can customize a Process Manager Process Manager page, the
administrator must enable that page for customization.
205
206
Managing the Process Manager portal
About Process Manager pages
To customize a Process Manager page
1
In the Process Manager portal, go to the page to customize.
2
In the upper right of the page, in the Site Actions drop-down list, select one
of the following options:
Modify Page
Lets you add, edit, and delete the Web parts that are on the page.
Modify My Page
The Modify Page option changes the page for everyone who has
access to it. The Modify My Page option changes your version
of the page only.
See “Adding a Web part to a Process Manager page” on page 208.
See “Editing a Web part on a Process Manager page” on page 209.
Reset to Default
Discards any changes that you made to the Process Manager page
and reverts it to its original configuration.
Share Page
Lets you specify a user, group, organization, or permission group
that can view your customized version of the Process Manager
page.
See “Sharing a Process Manager page” on page 210.
This drop-down list appears only on the pages that you have the permission
to customize. The options that are available depend on your permissions.
See “Options on the Site Actions drop-down list” on page 206.
3
When you finish the customization, you can close the page.
Options on the Site Actions drop-down list
The Site Actions drop-down list contains the options that are available for
customizing a Process Manager page. This drop-down list appears only on the
pages that you have the permission to customize. The options that are available
depend on your permissions.
See “Managing pages” on page 196.
The options that are available also depend on where you are in the editing process.
For example, when you are on a main Process Manager page, the Edit Page option
does not appear in the Site Actions drop-down list. However, after you click Site
Actions > Modify Page and the page opens for editing, the Edit Page option
becomes available.
Managing the Process Manager portal
About Process Manager pages
Table 12-21
Options on the Site Actions drop-down list
Option
Description
Add Root Page
Lets you add a new Process Manager page, which is visible from the top level of the Process
Manager portal. The page name appears on the tab bar in the upper area of the Process
Manager Portal.
Typically, only administrators have permission to create new pages.
See “Adding new Process Manager pages” on page 199.
Add Sub Page
Lets you add a new sub page, which is one or more levels under a root page. A sub page can
appear on the menu of a root page. For example, the Knowledge Base page is a root page.
You open it by clicking the Knowledge Base tab in the Process Manager portal. The
Discussions page is a sub page. You open it by clicking Discussions under the Knowledge
Base tab.
Typically, only administrators have permission to create new pages.
See “Adding a sub-page” on page 203.
Add Web Part
Lets you add one or more Web parts to the page. The sections on a Process Manager page
are in the form of Web parts.
See “Adding a Web part to a Process Manager page” on page 208.
Browse
Exits the editing mode and displays the page with the changes that you made.
Clear
Deletes all the Web parts from a Process Manager page.
Warning: This action cannot be undone. Use caution when you select this option because
you are not prompted to confirm this action before the deletion occurs.
Edit Definition
Displays the Pages List page, which lets you configure customization settings and
customization privileges for the current Process Manager page.
Typically, only administrators have permission to edit page definitions.
Edit Page
Lets you edit and delete the Web parts that are on the page.
See “Editing a Web part on a Process Manager page” on page 209.
Modify Page
Lets you add, edit, and delete the Web parts that are on the page. The page is changed for
everyone who has access to it.
Modify My Page
Lets you add, edit, and delete the Web parts that are on the page. Only your page is changed.
This option appears only if the page is configured to allow it.
Page List
(Administrator only) Displays the Pages List page that lets you configure settings and
customization permissions for any Process Manager page.
207
208
Managing the Process Manager portal
About Process Manager pages
Table 12-21
Options on the Site Actions drop-down list (continued)
Option
Description
Reset to Default
Discards any changes that were made to the Process Manager page and reverts it to its
original configuration.
Share Page
Lets you specify a user, group, organization, or permission group that can view your
customized version of a Process Manager page.
You can also provide additional permissions for this page as follows:
■
Let others edit this page.
■
Provide view, edit, and delete permissions to a specific user, group, organization, or
permission group.
For example, the administrator customizes a page, lets all users in a group view the page,
and then lets a specific user edit the page.
Adding a Web part to a Process Manager page
The sections on a Process Manager page are in the form of Web parts. You can
customize a Process Manager page by adding one or more Web parts.
See “Adding new Process Manager pages” on page 199.
See “Managing pages” on page 196.
After you add a Web part, you can edit its properties.
See “Editing a Web part on a Process Manager page” on page 209.
To add a Web part to a Process Manager page
1
In the Process Manager portal, access the page to customize.
2
In the upper right of the page, in the Site Actions drop-down list, select one
of the following options:
Modify Page
Changes the page for everyone who has access to it.
Modify My Page
Changes your version of the page only.
3
After the page refreshes, in the Site Actions drop-down list, click Add Web
Part.
4
In the Catalog Zone, select the catalog that contains the Web part to add.
5
In the Catalog Zone, under Profiles, select the check box for each Web part
to add.
Managing the Process Manager portal
About Process Manager pages
6
In the Catalog Zone, in the Add to drop-down list, select the page zone to add
the Web part to.
The zones that are available depend on the page’s Template Page setting,
which the administrator sets.
7
Click Add.
8
(Optional) To add another Web part, repeat from step 3.
9
When you finish adding Web parts, in the Catalog Zone, click Close.
Editing a Web part on a Process Manager page
The sections on a Process Manager page are in the form of Web parts. You can
customize a Process Manager page by deleting one or more Web parts.
See “Adding new Process Manager pages” on page 199.
See “Managing pages” on page 196.
See “Adding a Web part to a Process Manager page” on page 208.
To edit a Web part on a Process Manager page
1
In the Process Manager portal, access the page to customize.
2
In the upper right of the page, in the Site Actions drop-down list, select one
of the following options:
3
4
Modify Page
Changes the page for everyone who has access to it.
Modify My Page
Changes your version of the page only.
After the page refreshes, in the upper right of the Web part to edit, click the
Verbs symbol, and then select one of the following options:
Edit
Lets you edit the properties of the Web part.
Delete
Lets you delete the Web part.
If you clicked Edit, in the Editor Zone, edit the properties of the Web part,
and then select one of the following options:
Apply
Saves the changes without closing the Editor Zone.
OK
Saves the changes and closes the Editor Zone. Select this option when
you finish editing the properties for the current Web part.
209
210
Managing the Process Manager portal
About Process Manager pages
5
(Optional) To edit or delete another Web part, repeat from step 3.
6
When you finish editing the Web parts, you can close the page or continue
to edit it.
Sharing a Process Manager page
You can share your version of a Process Manager page with others to let them see
any customizations that are on your page. Typically, you share the pages that you
or someone else has customized.
See “Managing pages” on page 196.
You can share pages by providing view, edit, and delete permissions to specific
users, groups, organizations, or permission groups. For example, the administrator
can customize a page and let all users in a certain group view the page. Then the
administrator can let only one specific user within that group edit the page.
You can share pages by providing view, edit, and delete permissions to specific
users, groups, organizations, or permission groups. For example, the administrator
can customize a page and let all users in a certain group view the page. Then the
administrator can let only one specific user within that group edit the page.
The users’ portal permissions override any share permissions that you might
provide. For example, a user who does not normally have permission to view the
Documents page cannot view a shared version of that page.
To share a Process Manager page
1
In the Process Manager portal, access the page to share.
2
(Optional) Customize the page.
See “Customizing a Process Manager page (administrator)” on page 205.
See “Customizing your Process Manager pages (non-administrator)”
on page 205.
3
In the upper right of the page, in the Site Actions drop-down list, click Share
Page.
4
Under Page Permissions, review the users, groups, or other entities that have
permissions for this page.
5
Under Share Page, select an option in each of the following subsections:
Share With
Select the type of entity to give permissions for sharing this page.
Sharing Type
Select the type of share permissions to give.
The Custom(Advanced) option provides additional ways to
customize the permissions.
Managing the Process Manager portal
About Process Manager pages
6
Under Share Page, click Next.
7
Specify the user, group, or other entity to share this page with, and then click
Share Page.
8
When you are returned to the page, you can continue to edit it or close it.
Modifying existing Process Manager pages
If a Process Manager page is set to allow user personalization, you can modify the
page to better suit your needs. Only the users that are assigned the appropriate
permissions for modifying a Process Manager page can edit that page. The
permission for modifying Process Manager pages is Portal.Personal.Customization.
See “Managing pages” on page 196.
To modify a Process Manager page
1
In the Process Manager Portal, click Admin > Portal > Manage Pages.
2
From the pages list, select the page that you want to modify.
3
Click Edit Page. Refer to the topic on creating Process Manager pages for
information on the fields available for editing.
See “Adding new Process Manager pages” on page 199.
4
Make the necessary modifications to the Process Manager page.
5
Click Save.
Deleting Process Manager pages
You can delete Process Manager pages. Administrators and those with the
appropriate permissions can delete Process Manager pages. When a Process
Manager page is deleted, any users currently viewing the page are not able to save
any information on that page. Also, no users can access the page from that point
forward.
See “Managing pages” on page 196.
To delete a Process Manager page
1
In the Process Manager Portal, click Admin > Portal > Manage Pages.
2
From the pages list, select the page that you want to delete.
3
Click Delete Page.
4
Click OK in the confirmation dialog box that appears.
211
212
Managing the Process Manager portal
About Process Manager pages
Customizing a Process Manager page list
See “Managing pages” on page 196.
Several Process Manager pages contain the lists that you use to analyze or perform
Process Manager activities. You can customize the lists that appear on your pages
so that they display the information in the manner that is most useful to you. For
example, on the Workflow Task List page, you might want to change the task list
so that it displays only your overdue tasks.
The primary way to customize a Process Manager page list is to change the report
that determines the contents of the list. You can also sort and filter the list to
display a more specific subset of information. The changes that you make are
active for the current session only. When you log off of Process Manager, the
changes are lost. However, you can set a new default report that persists beyond
a single session.
See “Changing the report for a Process Manager page list” on page 214.
To customize a Process Manager page list
1
In the Process Manager portal, click the tab that contains the list to edit.
2
On the page, under the list section, you can customize the list in the following
ways:
■
Sort the columns.
■
Search and filter the list.
■
Limit the number of records that appear.
■
Select a new report.
■
Set a new default report.
■
Refresh the report.
See “Options for customizing a Process Manager page list” on page 212.
3
When you finish customizing the list, you can close the page or work on it.
Options for customizing a Process Manager page list
You can customize a Process Manager page list so that it displays information in
the manner that is most useful to you.
See “Managing pages” on page 196.
See “Customizing a Process Manager page list” on page 212.
Managing the Process Manager portal
About Process Manager pages
Table 12-22
Options for customizing a Process Manager page list
Option
Symbol
Description
Sort the columns.
None
You can click any column heading to sort by that heading.
Search and filter the
list.
You can search the list to filter the results. For example, to list only
those items that have to do with printers, you can search for “printer”.
You can filter a list by using either of the following options:
The Search symbol.
You can click the Search symbol to open a search box.
■ The search feature under Report Settings.
You can expand the Report Settings section and click Text contains
to open a search dialog box.
You might not see the Support Settings section because it appears
for certain reports only.
■
Limit the number of
records that appear.
Report Settings
Lets you change the number of records that appear in the list.
Typically, the list contains the first 50 records that match the report
criteria. You can change the number of records that appear by
expanding the Report Settings section, clicking Return 50 first
records, and specifying a new number.
You might not see the Support Settings section because it appears
for certain reports only.
Select a new report.
You can select a new report to display the list in a different
configuration. For example, you select a report that displays all your
open tasks.
You can select a new report by clicking either of the following options:
■
The Reports symbol
■
The Current report name
Both options open a list of folders, which contain the reports that are
available.
See “Changing the report for a Process Manager page list” on page 214.
Set a new default
report.
Lets you set the Current report as the default for this page.
Refresh the report.
Lets you refresh the display after you select a new report.
See “Changing the report for a Process Manager page list” on page 214.
213
214
Managing the Process Manager portal
About Process Manager pages
Changing the report for a Process Manager page list
Each list on a Process Manager page is associated with a default report that
determines the contents of the list. You can change the report to display the list
in a different configuration. For example, you can select a report that displays all
your open tasks.
See “Managing pages” on page 196.
When you change the report for a list, it is active for the current session only. The
next time that you log on, the default report reappears.
You can also set a new default report that persists beyond a single session. You
can select a predefined report or a customized report.
Setting the default report for a list does not save any additional filtering of the
list.
To change the default report for a Process Manager page list
1
In the Process Manager portal, click the tab that contains the list to edit.
2
On the page, under the list section, click either the Current report name or
the reports symbol.
3
Select the report group, and then select the report to use.
To quickly find a report, you can type a search string in the box and click
Find.
4
(Optional) To make the new report selection the default report, in the list
section, click the orange lightning bolt symbol, and then click Set default
report.
5
When you finish customizing the list, you can close the page or work on it.
Process View page
This page lets you view general information about a task as well as its history
(what has been done thus far and by whom), available actions, and permissions
associated with the process through which the task was created. The Process View
page appears when a user opens a task in Process Manager. By using certain special
components in your process, you can communicate values (such as process status)
to Process Manager that appear on the Process View page.
See “Managing pages” on page 196.
The following screen shot shows a Process View page:
Managing the Process Manager portal
About Process Manager pages
Process metadata appears in the top section of the Process View page. Under the
metadata on the left side are the process description and history. All of this
information comes from various sources within the process. For example, the
description may come from a textbox in a Web form that a user filled out.
The right side of the page contains a number of actions. The page selector lets
you pick between all available Process View page layouts. Other actions are listed
below the page selector. In this case, only the respond action is available for the
user.
See “ProcessManagerTaskSource task configuration example with added features”
on page 93.
If your organization uses customized Process View pages, you might see sections
other than those that are listed here.
215
216
Managing the Process Manager portal
About Process Manager pages
Table 12-23
Default sections on the Process View page
Section
Description
Top section (unlabeled)
Provides a quick view of the task’s details and statistics.
This section also contains the following action links:
■
Refresh
Add Comment
Opens the Add Comment to Process dialog box.
■ Edit Process
Opens the Edit Process dialog box, which lets you edit some of the process
details that appear in the top section.
■
Select page
Lets you switch between the Full Process View and the Basic Process View.
Open Chat on Process
Lets you initiate an instant messenger-type conversation with a process contact
or other worker. The chat function provides a real-time setting in which to
perform troubleshooting.
Description
(Read only) Displays the description that was entered during the task’s initial
creation.
Documents
Displays any documents that are attached to the process or task and lets you
attach additional documents.
History
Displays a record for each action that has occurred within the process. For
example, a record can represent a status change, a task, or a user comment.
Within the History section, you can view information about each record.
Actions
Lists the actions that you can take to effectively work the task. The actions that
appear depend on the type of task you open. For example, when a support
technician opens an incident, the available actions include resolving the incident,
escalating the incident, and suggesting a self service resolution.
Some actions are common to all tasks. For example, most types of tasks let you
send an email or search the Knowledge Base.
Accessing the Process View page
The Process View page is accessed from the Workflow Task List by clicking on
the Report Process ID number to the right of a listed process, or, depending on
the view currently enabled in the Workflow Task List, by clicking Open Task from
the Actions column of the listed task.
See “Managing pages” on page 196.
Managing the Process Manager portal
About Process Manager pages
Actions in the Process View page
Actions are the links that are shown on the right side of process viewer pages.
These links let you take actions or launch other processes that can help you with
your task or process. Having actions on the process view pages saves time, and
can result in quicker turnaround of tasks in Process Manager.
See “Managing pages” on page 196.
You can edit forms in Workflow Solution and add or remove actions to different
process view pages.
Some of the common actions you might see on process view pages by default:
■
Add/Manage Bulletin Boards
■
Manage Equipment
■
Send email
■
Search KB
■
Find Recent Changes
■
Request Change
■
View Forward Schedule Change
■
Search Google
■
Search Google Groups
■
Search MS Technet
■
Create Subtasks
■
Reclassify
■
Schedule for Later
■
Start Chat
■
Suggest Self Service
■
View Previous Submissions
■
View Problem
■
Go To Discussion
■
Invite Participant
■
Remove Problem
The actions that you see in the process view vary for different processes. Each
process view form is designed to include the actions that are most relevant and
useful for that particular process. For example, some of the actions an incident
217
218
Managing the Process Manager portal
About Process Manager pages
technician sees when they resolve an incident are : resolve incident, create a
problem ticket, suggest self service, and escalate incident. These actions are useful
for incident management, but would not be useful on the process view page for a
change request.
Setting the Process View page to automatically open another
task
You can set the Process View page to automatically open another task after you
have completed a task. Use this setting if you have multiple tasks that you need
to complete and you do not want to return to the main task list after you have
completed each task.
You can set the Process View page to automatically open another task in the
following ways:
Change the URL manually
With a Process View page open, you can change the
URL so that it opens the next task after you have
finished the first task. You must change the URL
manually every time you open a new Process View
page.
Create a process that sets a new
URL
You can create a workflow process that edits the
Process View page URL so that it opens another task
after you have finished the first task.
To set the Process View page to open another task by changing the URL manually
1
Open a Process View page in Process Manager.
In the task list in Process Manager, click a task to open a Process View page.
(The task that you click must be part of a process that supports Process View
pages.)
2
In the URL of the Process View page, after the TaskID, append this phrase
to the end of the URL: &SuggestNextProcessID=1.
If your Process View page opens in its own page and does not have a URL bar,
change your browser settings to open as a new tab.
3
After changing the URL, press Enter to reload the page with the correct URL.
4
Complete the task as usual.
After you complete the task, a dialog box appears to redirect you to the next
task. If you close the Process View page and open another one, you must
change the URL again.
Managing the Process Manager portal
Uploading plug-ins
Uploading plug-ins
You can upload plug-ins into Process Manager.
See “About the Process Manager portal” on page 183.
To upload plug-ins
1
On the Process Manager home page, on the Admin tab, select Portal > Plugin
Upload.
2
Select the type of plugin to upload.
3
Browse to and select the plugin to upload.
4
Click Upload.
Adding Web part catalogs
You can manage Web part catalogs.
See “About the Process Manager portal” on page 183.
To add Web part catalogs
1
On the Process Manager home page, on the Admin tab, select Portal > Web
Parts Catalog.
2
In the left pane, click the Add WebPart Catalog symbol.
3
In the Class name box, select the class name for this Web part catalog to
control.
4
In the Friendly name box, enter user-friendly name for this Web part catalog.
5
In the Category box, enter the browse category that this Web part catalog
will be placed into.
6
In the Description box, enter a detailed description of this Web part catalog.
7
Click the Permissions tab and click Add Permission to add permissions for
accessing this Web part catalog.
8
Click Save.
Working with Web part catalogs
After Web part catalogs are added in Process Manager, users can perform multiple
actions on them.
See “About the Process Manager portal” on page 183.
219
220
Managing the Process Manager portal
Working with Web part catalogs
To edit a Web part catalog
1
On the Process Manager home page, on the Admin tab, select Portal > Web
Parts Catalog.
2
In the left pane, select the category of the Web part catalog you want to edit.
3
In the right pane, next to the Web part catalog you want to edit, click the Edit
Parts Catalog symbol.
4
Edit the Web part catalog.
See “Adding Web part catalogs” on page 219.
5
Click Save.
To delete a Web part catalog
1
On the Process Manager home page, on the Admin tab, select Portal > Web
Parts Catalog.
2
In the left pane, select the category of the Web part catalog you want to delete.
3
In the right pane, next to the Web part catalog you want to delete, click the
Delete Parts Catalog symbol.
4
Click OK.
Chapter
13
Managing Workflow
processes in Process
Manager
This chapter includes the following topics:
■
About managing Workflow processes in Process Manager
■
Delegating a task
■
Adding a task
■
Working with tasks
■
Viewing a process
■
Setting up users to view the Process View page
■
Setting up workflow task integration with Workflow Designer
About managing Workflow processes in Process
Manager
In Process Manager, users can set milestones and tasks for workflows, as well as
assign other users to those tasks.
Access to these milestones and tasks can be restricted based on permissions
assigned by the administrator.
The Workflow tab provides a summary of the tasks that need to be completed.
Through this screen you can view the task list, manage the people responsible for
tasks, and control attributes of the different tasks.
222
Managing Workflow processes in Process Manager
Delegating a task
When you click the Workflow symbol, the following sub-tab options appear:
■
Delegations
Lets you assign a delegate for a task.
■
Workflow Reports
Lets you view reports specifically for your workflow.
■
Workflow Task List
Lets you add, view, and run the tasks assigned to you. Also lets you view a
workflow process.
The Delegations sub-tab window has one pane, which lets you delegate a task to
another user for a period of time.
See “Delegating a task” on page 222.
The Workflow Reports sub-tab window is divided into two panes. The left pane
lets you select a report to generate. The right pane displays the report.
The Workflow Task List sub-tab window is divided into two panes. The left pane
lets you add, view, open, and search for tasks as well as select how you want the
tasks grouped in the right pane. The View Tasks box in the left pane lets you see
all tasks that are assigned to you (based on your login, or click the My Tasks link)
as well as all available tasks (click the Show All link). The right pane displays the
details of the tasks you selected in the left pane.
See “Adding a task” on page 223.
See “Working with tasks” on page 224.
See “Viewing a process” on page 225.
See “Setting up users to view the Process View page” on page 226.
See “Setting up workflow task integration with Workflow Designer” on page 226.
Delegating a task
Tasks can be assigned to another user (the delegate) to complete some or all of
the task instead of the original user. From the Delegations window, you can view
all delegations assigned to you as well as delegate tasks.
See “About managing Workflow processes in Process Manager” on page 221.
To delegate a task
1
On the Process Manager home page, on the Workflow tab, click the
Delegations symbol.
2
In the Delegate From box, enter or select the current user assigned to the
task.
Managing Workflow processes in Process Manager
Adding a task
3
In the Delegate To box, enter or select the user to delegate the task to.
4
In the From box, select the starting date for the delegation.
5
In the Until box, select the ending date for the delegation.
6
Click Add Delegation.
Adding a task
You can add a task and assign it to a user, group, permission, or organization.
Process Manager is designed for workflow process integration. On every workflow
type component in Workflow Designer, there is an option to use the task source
type of processmanagertasksource. This adds a task to Process Manager.
See “Setting up workflow task integration with Workflow Designer” on page 226.
See “Dialog Workflow” on page 447.
See “About managing Workflow processes in Process Manager” on page 221.
To add a task
These steps are provided as information on adding a task inside Process Manager.
This is not the recommended way to add a task. The recommended way is to add
a workflow type component in your process.
1
On the Process Manager home page, click the Workflow tab.
2
In the left pane, click the Add Task symbol.
3
Enter the following:
4
■
Task Name: The name of the task, preferably descriptive.
■
Description: A lengthier, detailed description of the task.
■
Priority: The importance of this task (use the drop-down list).
■
Originator: The user name of the person creating the task.
■
URL Of Process: The URL of the process that this task applies to.
■
URL of Response Service: The URL of the response service for this task.
■
Due Date: The date the task is to be completed.
■
Assign to Me: If selected, this task is assigned to the person adding the
task.
If wanted, add a response by doing the following:
■
Click the Responses tab.
223
224
Managing Workflow processes in Process Manager
Working with tasks
5
6
■
Click Add Response.
■
Enter the response information.
■
Click Save.
If the task is not assigned to the person adding the task, do the following:
■
Click the Assignments tab.
■
Click Add Assignment.
■
In the Assignment for box, select the user, group, permission, or
organization to assign this task to.
■
In the User box, select the specific user, group, permission or organization
to assign the task to, based on the setting of the Assignment for box.
■
In the Assign From box, enter the starting date of the assignment.
■
In the Assign To box, enter the ending date of the assignment.
■
Click Add Assignment.
If wanted, add a default workflow profile.
The default workflow profile is attached to every process that gets created
in Process Manager. Use this to provide useful information for the process.
7
■
Click the Profiles tab.
■
Check Default Workflow Profile.
■
Enter the profile information.
Click Save.
Working with tasks
After tasks are added in Process Manager, users can perform multiple actions on
them.
See “About managing Workflow processes in Process Manager” on page 221.
Editing a task
1
On the Process Manager home page, click the Workflow tab.
2
In the right pane, click the orange lightning symbol.
If the task is not displayed, use the left pane to search for it.
3
Click Edit.
Managing Workflow processes in Process Manager
Viewing a process
4
Edit the task.
5
Click Save.
Editing the assignments
1
On the Process Manager home page, click the Workflow tab.
2
In the right pane, click the orange lightning symbol.
If the task is not displayed, use the left pane to search for it.
3
Click Edit Assignments.
4
Edit the assignments.
5
Click Add.
Marking a task complete
1
On the Process Manager home page, click the Workflow tab.
2
In the right pane, click the orange lightning symbol.
If the task is not displayed, use the left pane to search for it.
3
Click Complete Task.
4
If desired, enter a note.
5
Click Complete.
Postponing a task
1
On the Process Manager home page, click the Workflow tab.
2
In the right pane, click the orange lightning symbol.
If the task is not displayed, use the left pane to search for it.
3
Click Postpone Task.
4
In the Due Date box, select the new due date for the task.
5
Click Postpone.
Viewing a process
You can view a workflow process from a task in that process.
Permissions must be granted to view a workflow process.
See “About managing Workflow processes in Process Manager” on page 221.
225
226
Managing Workflow processes in Process Manager
Setting up users to view the Process View page
To view a process
1
On the Process Manager home page, on the Workflow tab, click the Workflow
Task List symbol.
2
In the left pane, search for the task from the process you want to view.
3
In the right pane, next to the task from the process you want to view, click
the Process View page symbol.
The Process View page can be configured using the Site Actions link.
Setting up users to view the Process View page
Users can view the Process View page by clicking on a task generated by the
process. Users must have permission to view the Process View page. Also, the
Process Manager server must have enough concurrent licenses available for
running Process Manager. If not, the Process View page is not available for viewing.
To set up users to view the Process View page
◆
Grant users the permissions to view the Process View page.
■
On the Process Manager home page, on the Admin tab, click Users >
Accounts > Manage Users.
■
In the right pane, next to the user you want to give permissions to, click
the orange lightning symbol and select Manage Permissions.
■
On the Manager User Permissions page, maximize Category:
UserLicenseLevel.
■
Check ProcessManager.
Setting up workflow task integration with Workflow
Designer
You can use the Workflow features of Process Manager to integrate with processes
developed with Workflow Designer. To do this, Process Manager and Workflow
Designer must be integrated.
See “About using tasks” on page 83.
See “Integrating Process Manager with Workflow Designer” on page 339.
See “About managing Workflow processes in Process Manager” on page 221.
See “Setup Process” on page 529.
See “Viewing a process” on page 225.
Managing Workflow processes in Process Manager
Setting up workflow task integration with Workflow Designer
See “Setting up users to view the Process View page” on page 226.
To set up workflow task integration with Workflow Designer
1
Turn on process reporting messages.
■
On the Process Manager home page, on the Admin tab, click Portal >
Master Settings.
■
In the Reports Settings section, check Process Reporting Messages.
2
In Workflow Designer, open a Workflow project.
3
In the Workflow Designer tool, click the project name.
4
Click the Reporting tab.
5
Click Add Process Component.
6
Click on the project's primary model.
The Global Logging Capture component is now on your process page. It does
not need to be connected to any other component. Do not delete the Global
Logging Capture component.
7
Add the Setup Process component to the start of your process.
8
Edit the Setup Process component by adding at least the name you want for
your process.
9
Add a Workflow component (for example, Approval Workflow Component)
to your process after the Setup Process component.
10 Open the Workflow component for editing.
11 In the Assignments tab, for the Task Source Type, select
processmanagertasksource.
This makes the Workflow component a task in Process Manager.
12 In the Assignments tab, in the Task Assignments section, select the person,
group, organizational unit, or permissions to assign this task to.
For example, if you added an Approval Workflow Component and assigned
it to a person; that person receives a task for an approval as part of this
process.
13 Publish the project.
When you publish a Workflow project, every Workflow component in that
project sets up a task in Process Manager (if that component's Task Source
Type is set to processmanagertasksource).
14 Open the Process View page in Process Manager. This lets you view your
processes and their tasks.
227
228
Managing Workflow processes in Process Manager
Setting up workflow task integration with Workflow Designer
■
On the Process Manager home page, on the Workflow tab, click the
Workflow Task List symbol.
■
In the left pane, search for the task that was created from your process.
■
In the right pane, click the folder symbol.
The Default Process View page appears.
Chapter
Managing documents in
Process Manager
This chapter includes the following topics:
■
About document management
■
About the Documents page
■
Searching for documents
■
Adding a document category
■
Editing a document category
■
Adding a document sub category
■
Category and Sub Category dialog boxes
■
Deleting a document category
■
Displaying the document category history
■
Displaying the document viewer
■
Setting document category permissions
■
Creating expected document messages
■
Adding simple documents to the Documents page
■
Add Documents dialog box
■
Adding advanced documents to the Documents page
■
Add Advanced Document dialog box
14
230
Managing documents in Process Manager
About document management
■
Downloading documents
■
Downloading ZIP files of documents
■
Viewing documents
■
Viewing document versions
■
Viewing the document history
■
Editing document data
■
Adding a new document version
■
Promoting a document version
■
Setting document permissions
■
Adding documents to additional categories
■
Emailing documents
■
Deleting documents
■
Adding a document in Process Manager using Workflow components
About document management
The Document management system in Process Manager lets you easily work with
the documents needed by your organization.
Document management contains the following key features:
■
The ability to set permissions at both the category and individual document
level.
■
The ability to add simple documents. Simple documents do not contain
versioning information and can be searched for by name only.
■
The ability to add advanced documents. Advanced documents contain
versioning information and can be customized with keywords for advanced
search.
■
The ability to add messages to the Documents page. The messages inform a
set of users that a document is expected from them by a certain date.
■
The ability to add whatever type of document the user needs to add. Documents
are not restricted to a set of defined types.
■
A name search, as well as an advanced keyword search, for finding documents.
Managing documents in Process Manager
About the Documents page
■
The ability to set up a nested category hierarchy to better organize documents
and make them easier for users to find.
■
The ability to email documents.
■
The ability to edit existing documents.
■
The ability to add additional versions of documents, and to display version
and document history.
■
The ability to download documents and download .zip files of documents.
See “Process Manager settings” on page 185.
About the Documents page
The Documents page in the Process Manager portal lets you view, download, email,
and perform other actions with documents in the document management system.
Your permissions determine which documents you can view, and what actions
you can take with those documents. For example, you may have permissions to
view certain documents, but not to delete or edit the document data for those
documents.
If your page was customized, its appearance and contents might differ from the
default page.
Table 14-1
Default sections on the Documents page
Section
Description
Bulletin Board
Lets you view the scrolling Bulletin Board messages that other workers
post. For example, the messages can advertise current issues, announce
outages, or provide information about a change that is planned to take
place within the organization. You can stop the scrolling if you prefer.
Bulletin Board messages can be made public or they can be restricted
to specific users, groups, or organizations.
Search Documents Lets you search the document management system for documents.
This search is conducted on document name only.
Browse
Lets you select document categories to display on the right side of the
page so that you can view the documents in that category.
You can also create a new document category.
See “Adding a document category” on page 233.
231
232
Managing documents in Process Manager
Searching for documents
Table 14-1
Default sections on the Documents page (continued)
Section
Description
Advanced Search
Lets you perform a more advanced search in the document
management system by specifying different areas to search. This
search is conducted on keywords.
Service Catalog
Lets you launch processes that are contained in the Service Catalog,
such as submitting a KB entry.
Right side of the
page
Displays the documents that are contained in the category you selected
under Browse. Your permissions determine the documents that appear.
Searching for documents
You can search for the documents that you or other users have added to the
Documents page. Permissions control documents and the categories that they
reside in. Your permissions influence the results that you see when you search
for documents, as well as what you can do with the documents.
For example, you may have permission to access a certain category, but only some
of the documents within it. Or, you may have access to download all of the
documents within a category, but not have permissions to delete any of those
documents.
Based on your particular permissions, you may be able to perform the following
actions:
■
Download the document.
See “Downloading documents” on page 243.
■
Download a .zip file of the document.
See “Downloading ZIP files of documents” on page 243.
■
View the document.
See “Viewing documents” on page 244.
■
View document versions.
See “Viewing document versions” on page 244.
■
View document history.
See “Viewing the document history” on page 245.
■
Edit document data.
See “Editing document data” on page 245.
■
Add a new document version.
See “Adding a new document version” on page 246.
Managing documents in Process Manager
Adding a document category
■
Promote a document version.
See “Promoting a document version” on page 246.
■
Set document permissions.
See “Setting document permissions” on page 247.
■
Add the document to additional categories.
See “Adding documents to additional categories” on page 247.
■
Email the document.
See “Emailing documents” on page 248.
■
Delete the document.
See “Deleting documents” on page 249.
To perform a basic search for documents
1
In the Process Manager portal, click Documents.
2
Under Search Documents, enter the text that you want to search for, and
click the Search symbol. The search applies to all of the document categories,
not only the selected category. This search is based on document name only.
Adding a document category
Document categories help you organize all the documents that are located on the
Documents page. Organizing the documents in categories helps users find the
documents they need more easily. You can also apply permissions to categories,
which deny or grant access to that category and all the documents within it.
See “Setting document category permissions” on page 238.
To add a document category
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, click the Add Root Category button.
3
In the Add Category dialog box, define the new category, and then click Save.
See “ Category and Sub Category dialog boxes” on page 234.
Editing a document category
Document categories assist you in organizing all of the documents that are located
on the Documents page. Organizing the documents in categories helps users find
the documents they need more easily. You can edit existing document categories
if you have the necessary permissions to do so.
233
234
Managing documents in Process Manager
Adding a document sub category
To edit a document category
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category that you want to
edit.
3
On the right side of the page, click the orange lightning symbol, and then
click Edit.
4
In the Edit Category dialog box, make the necessary modifications, and then
click Save.
See “ Category and Sub Category dialog boxes” on page 234.
Adding a document sub category
Document sub categories can assist with further organizing the categories and
documents that are located on the documents page. You can add sub categories
to any category if you have the necessary permissions to do so.
To add a document sub category
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category that you want to
add a sub category to.
3
On the right side of the page, click the orange lightning symbol, and then
click New Folder.
4
In the Add Sub Category dialog box, define the new sub category, and then
click Save.
See “ Category and Sub Category dialog boxes” on page 234.
Category and Sub Category dialog boxes
These dialog boxes appear when you add a document category, edit a document
category, or add a document sub category. The action that you take in Process
Manager determines which dialog box appears.
Table 14-2
Actions and resulting dialog boxes
Action
Dialog box
Add a document category
Add Category dialog box.
See “Adding a document category” on page 233.
Managing documents in Process Manager
Category and Sub Category dialog boxes
Table 14-2
Actions and resulting dialog boxes (continued)
Action
Dialog box
Edit a document category
Edit Category dialog box.
See “Editing a document category” on page 233.
Add a document sub category Add Sub Category dialog box.
See “Adding a document sub category” on page 234.
Some of the options differ depending on which dialog box appears.
These dialog boxes contain the following tabs:
Category Information
Lets you enter information about the category, some of
which is shown in the Documents page.
Table 14-3
Profiles
Lets you assign a profile to the category.
Advanced
Shows the category ID for informational purposes only. No
user actions are located on this tab. This tab appears only
in the Edit Category dialog box.
Table 14-3
Options in the Category Information tab
Option
Description
Name
Lets you type a brief name for the category. This name is
displayed in the Browse section and on the right side of the
Documents page when a user selects the category.
Header Text
(Optional) Lets you type the descriptive text that is displayed
under the category name on the right side of the Documents
page. The text is displayed when a user selects the category.
Category Type
(Optional) Lets you select a category type for the category.
If the Process Manager administrator has specified category
types, they appear in this drop-down list. Category types
further define the category and provide a category hierarchy
in the Browse section of the Documents tab.
Hidden
(Optional) Lets you specify whether this category should be
hidden from all other users.
235
236
Managing documents in Process Manager
Deleting a document category
Table 14-3
Options in the Category Information tab (continued)
Option
Description
Process Notifications
When this option is selected, notifications can be sent on
the events which occur on documents in this category. For
example, notifications can be sent when a document is
added, edited, or deleted. This option is selected by default.
If this check box is cleared, no notifications are sent on any
events occurring in this category.
Parent Category
(Optional) Lets you specify a parent category. This option
appears only in the Edit Category dialog box
Deleting a document category
Users with the appropriate permissions can delete document categories. When
you delete document categories, the sub categories and the documents that are
contained in that category are not necessarily deleted. You can make selections
during the deletion process which determines what happens to the sub categories
and the documents that are contained in a document category.
To delete a document category
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category you want to delete.
3
On the right side of the page, click the orange lightning symbol, and then
click Delete.
Managing documents in Process Manager
Displaying the document category history
4
In the Delete Category dialog box, select one of the following options for
handling any sub categories that are contained in the category:
Don’t delete SubCategories
Retains all sub categories that are
contained in the parent category. The sub
categories are moved up to the root level.
Delete SubCategories
Deletes all sub categories that are
contained in the parent category. If
documents in that category also belong to
another category, they remain in the other
categories. If documents do not belong to
other categories, they are moved to the
Orphan category.
Delete SubCategories and all files in them Deletes all sub categories and the
documents they contain.
Select one of the following options for handling any documents that are
contained in the category:
Don’t delete documents
Retains all documents that are contained
in the category.
Delete documents (that are linked only to Deletes all the documents that are
the deleted category)
contained in the category, as long as they
are linked only to the deleted category. If
the documents are linked to additional
categories, they are retained.
Delete documents even if linked to
multiple categories
5
Deletes all documents that are contained
in the category, even if they are linked
categories other than the one being
deleted.
Click Delete.
Displaying the document category history
Document category history displays creation and change history for each of the
categories on the Documents tab.
237
238
Managing documents in Process Manager
Displaying the document viewer
To display document category history
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category for which you
want to view category history.
3
On the right side of the page, click the orange lightning symbol, and then
click History.
Displaying the document viewer
The document viewer lets you scan documents in a category to quickly determine
whether you want to view or download the documents. A pop-up window appears,
with a preview of the document that you select on the right side of the screen.
This preview window lets you see if the document is one that you want to download.
The document viewer displays Microsoft Office documents and image files.
To open the document viewer
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category for which you
want to display the document viewer.
3
On the right side of the page, click the orange lightning symbol, and then
click Document Viewer.
Setting document category permissions
Document categories assist you in organizing all of the documents that are located
on the Documents page. Organizing the documents in categories helps users find
the documents they need more easily. You can apply permissions to categories,
which deny or grant access to that category and all the documents within it. By
default, the category inherits the permissions of the user who created it. If you
want the permissions to be different for other users of the category, you need to
modify the category permissions.
To set document category permissions
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category for which you
want to set permissions.
3
On the right side of the page, click the orange lightning symbol, and then
click Permissions.
Managing documents in Process Manager
Creating expected document messages
4
In the Permissions dialog box, add or modify permissions as needed. You can
take multiple actions with permissions.
The following table describes basic permissions procedures:
To edit existing permissions
Select the edit icon for the permission that you
want to modify. Make the necessary changes to
the permission and click Update.
To remove an existing permission Click the delete icon for the permission that you
want to remove.
To add a new permission
5
Click Add New Permission. Select the permission
type, and the user, group, permission, or
organization you want to set permissions for. Set
the appropriate permissions and click Add.
Click Close.
Creating expected document messages
Expected document messages display a notice to users on the Documents tab that
they need to provide a document by a certain date. You can select a user, group,
or organizational unit to display the message to.
To create an expected document message
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category for which you
want to add an expected document message.
3
On the right side of the page, click the orange lightning symbol and click
Expected Documents.
4
In the Expected Documents dialog box, type a name for the document in the
Document Name text box.
5
(Optional) In the Group Name text box, type a group name that the document
is expected from.
6
(Optional) In the Expected Date text box, type the expected date for the
document.
7
(Optional) In the Document Type drop-down list, select a document type.
8
(Optional) In the Description text box, type a description of the expected
document. This description is displayed with the expected document message.
239
240
Managing documents in Process Manager
Adding simple documents to the Documents page
9
In the Select Source drop-down list, select whether you want the message to
be shown to a user, group, or organizational unit.
10 Enter the user, group, or organizational unit and click Add Source.
11 Enter additional sources as necessary.
12 Click Save.
Adding simple documents to the Documents page
Simple documents are documents added to the document management system
that do not contain version information or search keywords.
To add a simple document
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category to which you want
to add a document.
3
On the right side of the page, click the orange lightning symbol and click Add
Simple.
4
In the Add Documents dialog box, specify and define the new document, and
then click Save.
The document is uploaded and added to the document repository with a
default version of 1.0.0.
See “ Add Documents dialog box” on page 240.
Add Documents dialog box
This dialog box appears when you add a simple document to the Documents page.
See “Adding simple documents to the Documents page” on page 240.
Table 14-4
Options in the Add Documents dialog box
Tab
Option
Description
Documents
Information
File
Lets you enter the file name and path to the file
that you want to add to the Documents page, or
to browse to the file.
Managing documents in Process Manager
Adding advanced documents to the Documents page
Table 14-4
Options in the Add Documents dialog box (continued)
Tab
Option
Description
Optional
Document Type
(Optional) Lets you select a document type from
the drop-down. The documents types available
are set up by the Process Manager administrator.
You can add any document type to the Documents
page, not only the document types that are listed
in this drop-down list.
Optional
Override Name
(Optional) Lets you type a meaningful name for
the document that appears on the Documents
page. If you do not enter an override name, the
name of the file is the document name.
Optional
Description
(Optional) Lets you type a description that appears
beneath the document on the Documents page.
Profiles
(Optional) Lets you apply profiles to the
document.
Adding advanced documents to the Documents page
Advanced documents are documents added to the document management system
that, in addition to standard document information, may contain version
information and search keywords.
To add an advanced document
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category to which you want
to add an advanced document.
3
On the right side of the page, click the orange lightning symbol and click Add
Advanced.
4
In the Add Advanced Document dialog box, specify and define the new
document, and then click Save.
See “Add Advanced Document dialog box” on page 241.
Add Advanced Document dialog box
This dialog box appears when you add an advanced document to the Documents
page, or when you edit a document’s data.
241
242
Managing documents in Process Manager
Add Advanced Document dialog box
See “Adding advanced documents to the Documents page” on page 241.
Table 14-5
Options in the Advanced Document dialog box
Tab
Option
Description
Document
Information
File
Lets you enter the file name and path to the file
that you want to add to the Documents page, or
to browse to the file.
Document
Information
Name
(Optional) Lets you type a meaningful name for
the document that appears on the Documents
page. If you do not enter an override name, the
name of the file is the document name.
Document
Information
Document Type
(Optional) Lets you select a document type from
the drop-down. The documents types available
are set up by the Process Manager administrator.
You can add any document type to the Documents
page, not only the document types that are listed
in this drop-down list.
Document
Information
Description
(Optional) Lets you type a description that appears
beneath the document on the Documents page.
Document
Information
Keywords
(Optional) Lets you type the keywords that are
associated with the document and that show up
during a document search.
Versions to Keep
Release
Lets you enter the number of release versions of
the document that Process Manager keeps. Any
versions beyond this number are removed.
Versions to Keep
Major
Lets you enter the number of major versions of
the document that Process Manager keeps. Any
versions beyond this number are removed.
Versions to Keep
Minor
Lets you enter the number of minor versions of
the document that Process Manager keeps. Any
versions beyond this number are removed.
Versions to Keep
Keep major
versions of prior
release versions
Lets you specify whether you want major versions
of previous release versions kept.
Versions to Keep
Keep minor
versions of prior
major versions
Lets you specify whether you want minor versions
of previous major versions kept.
Managing documents in Process Manager
Downloading documents
Table 14-5
Options in the Advanced Document dialog box (continued)
Tab
Option
Description
Version
Information
Release version
Lets you type a release version number for the
document.
Version
Information
Major version
Lets you type a major version number for the
document.
Version
Information
Minor version
Lets you type a minor version number for the
document.
Version
Information
Notes
(Optional) Lets you type additional information
to display with the document.
Profiles
(Optional) Lets you apply profiles to the
document.
Downloading documents
You can download any of the documents that you have access to from the
Documents tab.
To download a document
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category which contains
the document that you want to download.
3
On the right side of the page, click the download icon for the document that
you want to download.
4
Follow the prompts in the File Download dialog box.
Downloading ZIP files of documents
You can download any of the documents that you have access to from the
Documents tab as ZIP files. Downloading a document as a ZIP file compresses the
document for a faster download time.
To download a .zip file of a document
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category that contains the
document that you plan to download.
243
244
Managing documents in Process Manager
Viewing documents
3
On the right side of the page, click the Action symbol for the document to
download, and then click Download Zip.
4
Follow the prompts in the File Download dialog box.
Viewing documents
You can view any of the documents that you have access to from the Documents
tab. Only the categories and documents that you have permission to view are
visible, so you are able to view any documents that are displayed.
To view a document
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category which contains
the document that you want to view.
3
On the right side of the page, click the orange lightning symbol for the
document that you want to view, click View, and then click Open Document.
4
Follow the prompts in the File Download dialog box to pen the document.
Viewing document versions
You can view all of the available versions of the documents that you have access
to from the Documents tab. From the Document Versions dialog box, you can also
download any of the available document versions.
To view document version and history
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category which contains
the document that you want to view the versions of.
3
On the right side of the page, click the orange lightning symbol for the
document that you want to view, click View, and then click Show Versions.
4
In the Document Versions dialog box, you can do one of the following:
■
Click the download zip icon and follow the prompts in the File download
dialog box to download a .zip file of the document version.
■
Click the download icon and follow the prompts in the File download
dialog box to download the document version.
■
Click the Delete Version icon and click OK to confirm to delete the
document version.
Managing documents in Process Manager
Viewing the document history
Viewing the document history
You can view history data for the documents that you have access to from the
Documents tab.
Document history data includes the following items:
■
Actions
■
Action by user
■
Date
■
Time
■
Version
■
Notes
To view document history
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category which contains
the document that you want to view the versions of.
3
On the right side of the page, click the orange lightning symbol for the
document that you want to view, click View, and then click History.
Editing document data
Users with the appropriate permissions can edit data for existing documents.
To edit document data
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category which contains
the document that you want to edit data for.
3
On the right side of the page, click the orange lightning symbol for the
document that you want to view, click Edit, and then click Document Data.
4
In the Document Data dialog box, make the necessary changes to the
document data, and then click Save.
See “Add Advanced Document dialog box” on page 241.
245
246
Managing documents in Process Manager
Adding a new document version
Adding a new document version
Users with the appropriate permissions can add a new version of a document on
the Documents page.
To add a new document version
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category which contains
the document that you want to add a new version of.
3
On the right side of the page, click the orange lightning symbol for the
document that you want to view, click Edit, and then click Add New Version.
4
In the Document Versions dialog box, select the Add New Version tab.
5
Optional. In the Version Type drop-down list, select one of the following
options:
■
Minor. This option is the default.
■
Release
■
Major
6
Optional. In the Notes text box, enter notes to give other users more context
about the document version.
7
Click Browse, and in the Choose File dialog box, select a file and click Open.
8
Click Add.
Promoting a document version
Users with the appropriate permissions can promote document versions on the
Documents page.
To promote a document version
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category which contains
the document that you want to promote.
3
On the right side of the page, click the orange lightning symbol for the
document that you want to view, click Edit, and then click Promote Document
Version.
4
In the Promote Documents Version dialog box, select the Promote This
Document Version tab.
Managing documents in Process Manager
Setting document permissions
5
Optional. In the Notes text box, enter notes to give other users more context
about the document version.
6
Click Promote This Version.
Setting document permissions
Users with the appropriate permissions can set permissions on individual
documents on the Documents page. Granting or denying permissions for a
document controls what users have access to a document, and what those users
can do with the document.
To set document permissions
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category which contains
the document that you want to set permissions for.
3
On the right side of the page, click the orange lightning symbol for the
document that you want to set permissions for, click Edit, and then click
Permissions.
4
In the Permissions List dialog box, add or modify permissions as needed. You
can take multiple actions with permissions.
The following table describes basic permissions procedures:
To edit existing permissions
Select the edit icon for the permission that you
want to modify. Make the necessary changes to
the permission and click Update.
To remove an existing permission Click the delete icon for the permission that you
want to remove.
To add a new permission
5
Click Add New Permission. Select the permission
type, and the user, group, permission, or
organization you want to set permissions for. Set
the appropriate permissions and click Add.
Click Close.
Adding documents to additional categories
When you initially add documents to the Documents page, they are contained in
a single category. Users with the appropriate permissions can add documents to
247
248
Managing documents in Process Manager
Emailing documents
additional categories. The number of categories that a document can belong to is
unlimited.
To add documents to additional categories
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category which contains
the document that you want to add to additional categories.
3
On the right side of the page, click the orange lightning symbol for the
document that you want to add to additional categories, click Edit, and then
click Add To Category.
4
In the Add to Category dialog box, click the Add New Category tab.
5
In the Category text box, type the name of the category you want to add the
document to, or click Pick to search for the category.
6
Click Add.
Emailing documents
You can email the documents that you have access to from the Documents tab.
To email a document
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category which contains
the document that you want to email.
3
On the right side of the page, click the orange lightning symbol for the
document you want to email, and then click Send.
4
In the Send Document dialog box, in the Send To box, type the email address
or addresses of the intended document recipient.
5
(Optional) In the CC box, type the email address or addresses of the intended
document recipients.
6
(Optional) In the Subject box, type a descriptive subject for the email.
7
(Optional) In the Message box, type a message for the body of the email.
Managing documents in Process Manager
Deleting documents
8
9
In the Send Method drop-down list, select one of the following options:
send as attachment
Sends the document as an attachment to the
email. This option is the default.
send download link
Sends a link in the body of the email for
downloading the document.
Click Send Document.
Deleting documents
You can delete any document that you have delete permissions for from the
Documents tab.
To delete a document
1
In the Process Manager portal, click Documents.
2
On the Documents page, under Browse, select the category which contains
the document that you want to delete.
3
On the right side of the page, click the orange lightning symbol for the
document you want to delete, and then click Delete.
4
Click OK in the confirmation dialog box.
Adding a document in Process Manager using
Workflow components
You can add documents using Workflow components in your process in Workflow
Designer.
See “About document management” on page 230.
To add a document in Process Manager using Workflow components
1
In Workflow Designer, create a Workflow project.
2
Create a document category for the document you want to add.
■
In the Workflow project, add a Setup Process component.
■
Edit the Setup Process component (right-click Edit Component).
See “Setup Process” on page 529.
■
In the General tab, enter a name for the process.
■
Check Create Document Category.
249
250
Managing documents in Process Manager
Adding a document in Process Manager using Workflow components
3
4
5
■
In the Header Text box, enter the name of the category you want.
■
In the Output Process CategoryID Name box, accept the default or enter
a new output variable name for the category. Note the name of this box
for later.
■
Click OK.
Add and edit an AddDocument (0) component.
■
In the Workflow project, add a AddDocument (0) component.
■
Edit the AddDocument (0) component (right-click Edit Component).
■
In the Inputs tab, for the Service URL Source property, check Use Default.
■
For the Category Source property, check From Variable.
■
In the Document Category Id box, click the [...] button.
■
In the Document Category Id Variable dialog box, check Process Variables.
■
Click Add.
■
Select the Output Process CategoryID Name from step 2.
■
Click OK.
■
Click OK.
Add a document to the AddDocument (0) component.
■
In the Inputs tab, in the Document File box, click the [...] button.
■
Select a Value Source.
For example, check Constant Value, click Edit, and in the Contents box
click the [...] button to search for the file you want to add.
■
Click OK.
■
Click OK.
■
Click OK to close the AddDocument editor.
Publish the Workflow project.
See “About publishing a project” on page 105.
6
View the document in Process Manager.
■
Open Process Manager.
■
On the Process Manager home page, click the Documents menu.
■
In the left pane, browse to the category with the same name as the Output
Process CategoryID Name from step 2.
Managing documents in Process Manager
Adding a document in Process Manager using Workflow components
■
In the right pane, view the document.
251
252
Managing documents in Process Manager
Adding a document in Process Manager using Workflow components
Chapter
Managing the Knowledge
Base and discussions in
Process Manager
This chapter includes the following topics:
■
About Knowledge Base and discussions
■
Managing categories
■
Adding a Knowledge Base article
■
Adding a Bulletin board
■
Adding a Wiki
■
Adding a FAQ
■
Working with articles
■
Adding a new entry to an article
■
Setting permissions for a Knowledge Base entry
■
Adding a discussion
■
Working with discussions
■
Adding a new thread to a discussion
15
254
Managing the Knowledge Base and discussions in Process Manager
About Knowledge Base and discussions
About Knowledge Base and discussions
The Knowledge Base is a data repository holding information on incidents,
problems, and known errors. Collecting information in the Knowledge Base enables
organizations to match new articles against previous ones and reuse established
solutions and approaches.
The following types of Knowledge Base items can be added.
Table 15-1
Knowledge Base items
Knowledge Base Item
Description
Article
An article is a document that contains a date stamp and an author. It has no
restrictions on size, and can contain images, formatted HTML, and links.
FAQ
Provides a user with information in a question and an answer format.
Bulletin Board
An entry that is designed to provide users with time sensitive, critical information.
Bulletin board entries have date restrictions and a priority.
Bulletin Board entries are shown in the Bulletin Board in the Portal. The Bulletin
Board can be seen from each of the root pages in the Portal.
Wiki Entry
A group of related pages on a specific topic.
As with other parts of the Process Manager portal, access to the Knowledge Base
and the information it contains is controlled through the use of permissions.
Permissions at the user, group, and organizational unit level can be granted to
any entry in the Knowledge Base.
The key features of the Knowledge Base are:
■
The Bulletin Board, which facilitates proactive notification to all users.
■
The ability for users to rate all Knowledge Base entries based on their
usefulness. Process Manager automatically rates articles higher the more
frequently an article is used. Reports can then be run against the ratings to
determine which Knowledge Base entries should be removed or modified to
improve their content.
■
All of the Knowledge Base content is stored in a content management system
and is fully audited. This content can then be reported on to analyze the number
of times, and how recently entries were viewed, among other things.
The Knowledge Base window lets you view, manage, and add articles to the
repository. These include Knowledge Base articles, bulletin boards, Wikis, and
FAQs.
Managing the Knowledge Base and discussions in Process Manager
Managing categories
The Knowledge Base window is divided into two panes. The left pane lists categories
of articles and lets you search for articles. The right pane lists the articles found
in the selected category.
See “Managing categories” on page 255.
See “Adding a Knowledge Base article” on page 256.
See “Adding a Bulletin board” on page 257.
See “Adding a Wiki” on page 258.
See “Adding a FAQ” on page 258.
See “Working with articles” on page 259.
See “Adding a new entry to an article” on page 260.
See “Setting permissions for a Knowledge Base entry” on page 260.
The Discussions window lets you view, manage, and add to discussion groups.
These discussion groups can be used for a variety of purposes, including a general
discussion area about a process, technical repository, lists of issues or features,
and general information.
The Discussions window has one pane. It lists any discussion created. Each entry
in the list displays the discussion name, the date of the last posting on that
discussion, the number of threads that are currently active, and the total number
of posts in that discussion.
See “Adding a discussion” on page 261.
See “Working with discussions” on page 261.
See “Adding a new thread to a discussion” on page 262.
The Schedules window lets you view, manage, and add to schedules. You can use
schedules to plot out tasks, deliverables, and milestones.
The Schedules window has two panes. The left pane displays the schedules and
the right pane displays the calendar displaying the schedule entries.
See “Adding a schedule” on page 264.
See “Working with schedules” on page 266.
Managing categories
Articles are assigned to a category at creation. Categories let you keep track of
similar articles. Each article you create is assigned to the selected category when
it is created. Before you add an article, you must create and select the category
you want to add that article to.
255
256
Managing the Knowledge Base and discussions in Process Manager
Adding a Knowledge Base article
A default article category is provided. However, you can create as many categories
as you need.
See “About Knowledge Base and discussions” on page 254.
See “Adding a Knowledge Base article” on page 256.
See “Adding a Bulletin board” on page 257.
See “Adding a Wiki” on page 258.
See “Adding a FAQ” on page 258.
To add a root category
1
On the Process Manager home page, select the Knowledge Base tab.
2
In the left pane, click the Add Category symbol.
3
Select Add Root Category.
4
Enter the name and description for this category.
5
Click Add Permission to add permissions for this category.
6
Click Save.
To add a sub-category
1
On the Process Manager home page, select the Knowledge Base tab.
2
In the left pane, select the category you want to add a sub-category to.
3
Click the Add Category symbol.
4
Select Add Sub Category.
5
Enter the name and description for this sub-category.
6
Click Add Permission to add permissions for accessing this sub-category.
7
Click Save.
Adding a Knowledge Base article
Knowledge base articles can be added to the repository.
Knowledge base articles can also be added by adding a workflow task component
in your process in Workflow Designer.
See “Managing categories” on page 255.
To add a Knowledge Base article
1
On the Process Manager home page, select the Knowledge Base tab.
2
In the left pane, select the category you want to add the article to.
Managing the Knowledge Base and discussions in Process Manager
Adding a Bulletin board
3
In the right pane, click Add Article.
4
Enter the article title and description.
5
If there is a plug-in involved with this article, click the Plugins tab and choose
the plug-in from the drop-down list next to Add Plugin. Then specify whether
or not to override the global settings.
6
Click the Permissions tab and click Add Permission to add permissions for
accessing this article.
7
Click Save.
Adding a Bulletin board
Bulletin boards can be added to the repository. When bulletin boards are added,
their names scroll in a box in the left pane of the Documents, KB, and Workflow
modules.
Bulletin boards can also be added by adding a workflow task component in your
process in Workflow Designer.
See “Managing categories” on page 255.
To add a bulletin board
1
On the Process Manager home page, select the Knowledge Base tab.
2
In the left pane, select the category you want to add the bulletin board to.
3
In the right pane, click Add Bulletin Board.
4
Enter the bulletin board title and description.
5
Enter an Entry title, priority, start date, end date, and text.
This creates the first entry for the bulletin board.
When a bulletin board entry is added, a schedule with the bulletin board name
is created and entries based on the dates of the bulletin board entry are added
to that schedule.
See “Adding a schedule” on page 264.
6
If there is a plug-in involved with this bulletin board, click the Plugins tab
and choose the plug-in from the drop-down list next to Add Plugin. Then
specify whether or not to override the global settings.
7
Click the Permissions tab and click Add Permission to add permissions for
accessing this bulletin board.
8
Click Save.
257
258
Managing the Knowledge Base and discussions in Process Manager
Adding a Wiki
Adding a Wiki
Wikis can be added to Process Manager.
Wikis can also be added by adding a workflow task component in your process in
Workflow Designer.
See “Managing categories” on page 255.
To add a Wiki
1
On the Process Manager home page, select the Knowledge Base tab.
2
In the left pane, select the category you want to add the Wiki to.
3
In the right pane, click Add Wiki.
4
Enter the Wiki title and description.
5
Enter the text for the Wiki. The text must be in Wiki format.
6
If there is a plug-in involved with this Wiki, click the Plugins tab and choose
the plug-in from the drop-down list next to Add Plugin. Then specify whether
or not to override the global settings.
7
Click the Permissions tab and click Add Permission to add permissions for
accessing this Wiki.
8
Click Save.
Adding a FAQ
FAQs are frequently asked questions that provide an answer users.
FAQs can also be added by adding a workflow task component in your process in
Workflow Designer.
See “Managing categories” on page 255.
To add a FAQ
1
On the Process Manager home page, select the Knowledge Base tab.
2
In the left pane, select the category you want to add the FAQ to.
3
In the right pane, click Add FAQ.
4
Enter the FAQ question.
5
Enter the FAQ answer.
6
Maximize the Explanation of the Question section if you want to add more
explanation to the question.
Managing the Knowledge Base and discussions in Process Manager
Working with articles
7
If there is a plug-in involved with this FAQ, click the Plugins tab and choose
the plug-in from the drop-down list next to Add Plugin. Then specify whether
or not to override the global settings.
8
Click the Permissions tab and click Add Permission to add permissions for
accessing this FAQ.
9
Click Save.
Working with articles
After articles are posted in Process Manager, users can perform multiple actions
on them.
See “About Knowledge Base and discussions” on page 254.
To view an article
1
On the Process Manager home page, select the Knowledge Base tab.
2
In the left pane, select the category of the article you want to view.
You can also enter a term to search for the article you want to view.
3
In the right pane, under an Articles section, click the View symbol next to
the article you want to view.
To edit an article
1
On the Process Manager home page, select the Knowledge Base tab.
2
In the left pane, select the category of the article you want to edit.
You can also enter a term to search for the article you want to edit.
3
In the right pane, under an Articles section, click the orange lightning symbol
next to the article you want to edit and select Edit.
4
Edit the article.
5
Click Save.
To delete an article
1
On the Process Manager home page, select the Knowledge Base tab.
2
In the left pane, select the category of the article you want to delete.
You can also enter a term to search for the article you want to delete.
3
In the right pane, under an Articles section, click the orange lightning symbol
next to the article you want to delete and select Delete.
4
Click OK.
259
260
Managing the Knowledge Base and discussions in Process Manager
Adding a new entry to an article
Adding a new entry to an article
After KB articles and bulletin boards are created, users can add entries to them
as needed. Additionally, Wikis can have entry information added to them.
See “About Knowledge Base and discussions” on page 254.
To add a new entry to a KB article or bulletin board
1
On the Process Manager home page, select the Knowledge Base tab.
2
In the left pane, select the category of the article you want to add an entry
to.
You can also enter a term to search for the article you want to add an entry
to.
3
In the right pane, under an Articles section, click the article you want to add
an entry to.
4
Click Add New Entry.
5
Enter the entry information.
6
Click Save.
When a bulletin board entry is added, entries based on the dates of the bulletin
board entry are added to the schedule created for the bulletin board.
See “Adding a schedule” on page 264.
To add entry information to a Wiki
1
On the Process Manager home page, select the Knowledge Base tab.
2
In the left pane, select the category of the Wiki you want to add an entry to.
You can also enter a term to search for the Wiki you want to add an entry to.
3
In the right pane, under an Articles section, click the Wiki you want to add
an entry to.
4
Click the orange lightning symbol and then click Edit Entry.
You can also click the Wiki link.
5
Edit the text of the Wiki.
6
Click Save.
Setting permissions for a Knowledge Base entry
Access to Knowledge Base entries can be controlled through permissions.
Permissions can be set on any Knowledge Base entry at the user, group, or
Managing the Knowledge Base and discussions in Process Manager
Adding a discussion
organizational unit level. Only administrators or users with the appropriate
permissions can set permissions for a Knowledge Base entry.
To set permissions for a Knowledge Base entry
1
On the Process Manager home page, select the Knowledge Base tab.
2
Locate the Knowledge Base entry you want to set permissions for, click the
lightning bolt icon, and select Edit.
3
In the Edit Article dialog box, select Permissions.
4
Click Add New Permission.
5
Make the wanted modifications to the permissions for the Knowledge Base
article.
6
Click Save to implement the changes.
Adding a discussion
Users can start new discussions and post to existing discussions.
See “About Knowledge Base and discussions” on page 254.
See “Working with discussions” on page 261.
See “Adding a new thread to a discussion” on page 262.
To add a discussion
1
On the Process Manager home page, select theDiscussions tab.
2
Click Add Discussion.
3
Enter the discussion title and description.
4
If there is a plug-in involved with this discussion, click the Plugins tab and
choose the plug-in from the drop-down list next to Add Plugin. Then specify
whether or not to override the global settings.
5
Click the Permissions tab and click Add Permission to add permissions for
accessing this discussion.
6
Click Save.
Working with discussions
After discussions are posted in Process Manager, users can perform multiple
actions on them.
See “About Knowledge Base and discussions” on page 254.
261
262
Managing the Knowledge Base and discussions in Process Manager
Adding a new thread to a discussion
See “Adding a discussion” on page 261.
See “Adding a new thread to a discussion” on page 262.
To edit a discussion
1
On the Process Manager home page, select theDiscussions tab.
2
Click the orange lightning symbol next to the discussion you want to edit and
click Edit Discussion.
3
Edit the discussion.
4
Click Save.
To delete a discussion
1
On the Process Manager home page, select theDiscussions tab.
2
Click the orange lightning symbol next to the discussion you want to delete
and click Delete.
3
Click OK.
Adding a new thread to a discussion
Users can start new discussions and post to existing discussions. Posts can be
replied to or edited.
See “About Knowledge Base and discussions” on page 254.
See “Adding a discussion” on page 261.
See “Working with discussions” on page 261.
To add a new thread to a discussion
1
On the Process Manager home page, select theDiscussions tab.
2
Click the add thread symbol next to the discussion you want to add a thread
to.
3
Enter the thread name and text.
4
Click Save.
Chapter
16
Managing schedules in
Process Manager
This chapter includes the following topics:
■
About scheduling in Process Manager
■
Adding a schedule
■
Add Schedule dialog box
■
Working with schedules
About scheduling in Process Manager
In Process Manager, schedules record various date-related events and functions
in a the calendar. When you consider the scheduled events together instead of in
isolation, you can avoid unforeseen conflicts. The schedule also provides the
information that you can use to communicate planned downtime to management
and the users who the implementation affects.
Table 16-1
About schedules
Element
Description
Schedules
A group of entries that are of a specific type. Each
schedule contains entries for the events of the
appropriate type. All the entries in the individual
schedules are combined on a single calendar.
See “Adding a schedule” on page 264.
264
Managing schedules in Process Manager
Adding a schedule
Table 16-1
About schedules (continued)
Element
Description
Schedule entries
The scheduled time for a specific event. A schedule
entry is associated with a schedule.
Schedule entries can also be entered manually. For
example, you might add a company meeting, a training
session, or other non-process evernt that can affect
the process related schedules.
See “Adding a schedule entry” on page 266.
Calendar
A page that displays the schedule entries. You can
display the entries for all the schedules or for only the
schedules that you select.
The format options for viewing the schedule are as
follows:
■
Today
■
Three days
■
Work Week
■
Week
■
Month
■
Gantt View
Displays the schedule in a Gnatt style so that you
can see other task dependencies in one view. You
can select a start date and an end date, and then
click Go to display the interactions.
Adding a schedule
You can add as many schedules as you want. Schedules contain calendar items
that are displayed in the calendar. When you create a schedule, it does not contain
any calendar items. They can be added manually or automatically by adding an
entry to a bulletin board.
See “About Knowledge Base and discussions” on page 254.
See “Working with schedules” on page 266.
See “Adding a Bulletin board” on page 257.
To add a schedule
1
On the Process Manager home page, select theSchedules tab.
2
In the left pane, click the Add Schedule symbol.
Managing schedules in Process Manager
Add Schedule dialog box
3
Enter the schedule name and description.
4
Select the color background for items in this schedule to appear on the
calendar.
5
If there is a plug-in involved with this schedule, choose the plug-in from the
drop-down list next to Add Plugin. Then specify whether or not to override
the global settings.
6
Click the Permissions tab and click Add Permission to add permissions for
accessing this schedule.
7
Click Save.
Add Schedule dialog box
This dialog box lets you create a new schedule in the calendar. In Process Manager
a schedule represents a certain type of schedule entry.
See “Adding a schedule” on page 264.
The Add Schedule dialog box contains the following tabs:
Schedule Information
Lets you define the schedule.
Permissions
Lets you set the permissions for accessing this
schedule.
See “Setting up groups, permissions, and users”
on page 285.
Table 16-2
Options on the Add Schedule Information tab
Option
Description
Name
Identifies this schedule in any schedule list or display
in the Process Manager portal.
For example, if this schedule is for a specific ocation,
you might use the location name.
Description
Lets you provide additional information to describe
the schedule.
Color
Lets you select the color in which to display the items
that appear in this schedule.
265
266
Managing schedules in Process Manager
Working with schedules
Table 16-2
Options on the Add Schedule Information tab (continued)
Option
Description
Process Notifications
Sends the email notifications when events occur on
this schedule. For example, notifications can be sent
when a schedule entry is added, edited, or deleted.
The notifications are sent to those who have notify
permissions for this schedule.
Working with schedules
After schedules are added in Process Manager, users can perform multiple actions
on them.
See “About Knowledge Base and discussions” on page 254.
Editing a schedule
1
On the Process Manager home page, select theSchedules tab.
2
In the left pane, click the orange lightning symbol next to the schedule you
want to edit and click Edit.
3
Edit the schedule.
4
Click Save.
Deleting a schedule
1
On the Process Manager home page, select theSchedules tab.
2
In the left pane, click the orange lightning symbol next to the schedule you
want to delete and click Delete.
3
Click OK.
The schedule and all entries are deleted.
Adding a schedule entry
1
On the Process Manager home page, select theSchedules tab.
2
In the right pane, click the Add Entry symbol.
3
Select the schedule to add this entry to.
4
Enter the name of this entry.
5
Enter the start and end dates for this entry. These are the dates that this
entry displays on the schedule.
Managing schedules in Process Manager
Working with schedules
6
If wanted, enter a pop-up description.
This is the description that will appear when a user hovers over the entry.
7
Select the color background for this entry to appear on the calendar.
8
Enter a description for this entry.
9
Click Save.
Editing a schedule entry
1
On the Process Manager home page, select theSchedules tab.
2
In the right pane, double-click the entry in the calendar that you want to edit.
3
Edit the schedule entry.
4
Click Save.
Deleting a schedule entry
1
On the Process Manager home page, select theSchedules tab.
2
In the right pane, double-click the entry in the calendar that you want to
delete.
3
Click Delete.
4
Click OK.
Searching for a schedule entry
1
In the Process Manager portal, click Knowledge Base > Schedules.
2
Under Search Schedule Entry, enter one or more words from the entry's title
or description, and then click the Search symbol.
267
268
Managing schedules in Process Manager
Working with schedules
Chapter
17
Managing data in Process
Manager
This chapter includes the following topics:
■
About data management
■
Working with document types
■
Working with document category types
■
Adding a user relationship type
About data management
Process Manager lets you create different types of metadata that can be attached
to objects.
When you click the Data sub-tab in the Admin tab, the following options appear:
Document Type
Lets you define different types of documents
(such as Microsoft Word .DOC files and
Adobe Acrobat .PDF files) that are used in
Process Manager.
Document Category Type
Lets you manage document categories by
breaking your documents into different
categories (not types, such as .PDF or .DOC)
for better management.
270
Managing data in Process Manager
Working with document types
User Relationship Type
Lets you manage the relationship between
users. For example, you can set up the
relationship showing that User1 is the
manager of User2. You can also set up the
head user for groups and organizations.
The Document Type option window has one pane. It displays the types of
documents known to Process Manager.
See “Working with document types” on page 270.
The Document Category Type option window has one pane. It lets you manage
document categories.
See “Working with document category types” on page 271.
The User Relationship Type option window has one pane. It lets you manage
relationship types.
See “Adding a user relationship type” on page 271.
Working with document types
Users can add, edit, and delete document types.
See “About data management” on page 269.
To work with document types
1
On the Process Manager home page, on the Admin tab, select Data >
Document Type.
2
To add a document type, in the Document Type Name section, click the Add
Document Type symbol, enter the needed information and click Save.
Name
Name of document type. This appears in the list of
document types.
Extension
Extension of the document type.
MimeType
The MIME type, if any, associated with the document.
Compress
Select to compress all documents of this type.
3
Click the Edit symbol next to a document type to edit its properties.
4
Click the Delete symbol next to a document type to delete it.
Managing data in Process Manager
Working with document category types
Working with document category types
Users can add, edit, and delete document category types.
See “About data management” on page 269.
To work with document category types
1
On the Process Manager home page, on the Admin tab, select Data >
Document Category Type.
2
To add a document category type, in the Type Name section, click the Add
Document Category Type symbol, enter the needed information and click
Save.
3
Name
Name of the document category type. This appears in
the list of document category types.
Description
Description of the document category type.
Add Plugin
The plug-in used by the category type.
Plugin Use
Select how you want the plug-in used.
Click the orange lightning symbol next to a document category type to manage
it.
Edit
Edit the properties of this document category type.
Category Type Documents
Add a document to this category type.
Delete
Delete this document category type.
Adding a user relationship type
You can set up relationship types between users.
See “About data management” on page 269.
To add a user relationship type
1
On the Process Manager home page, on the Admin tab, select Data > User
Relationship Type.
2
To add a user relationship type, click the Add symbol.
3
Enter the relationship type name.
271
272
Managing data in Process Manager
Adding a user relationship type
4
In the Relates To box, select the relationship.
5
Click Save.
Chapter
18
Managing the service
catalog in Process Manager
This chapter includes the following topics:
■
About the service catalog
■
Working with categories
■
Adding a Web form
■
Adding a Webservice
■
Web form settings
■
Webservice settings
About the service catalog
The Service Catalog lists all the processes that are available to users in Process
Manager. Service Catalog processes are created to automate the routine actions
that are frequently performed in an organization.
Process Manager includes many processes that are already set up by default and
are available for use after installation. In addition, you can create custom processes
in Workflow Solution and make them available to users in Process Manager. You
use the Service Catalog area in the Administration tab to make custom processes
available to Process Manager users.
The Service Catalog is also where you set permissions on which Process Manager
users, groups, permissions, and organizational units have access to the specific
forms. Permissions determine what a user has access to when they log on to
Process Manager.
274
Managing the service catalog in Process Manager
Working with categories
The Service Catalog sub-tab window is divided into two panes. The left pane lets
you select the view and category of the processes that you want displayed in the
right pane. The right pane displays the running processes.
See “Working with categories” on page 274.
See “Adding a Web form” on page 275.
See “Adding a Webservice” on page 276.
Working with categories
Users can add, edit, and delete categories.
See “About the service catalog” on page 273.
To add a new category
1
On the Process Manager home page, on the Admin tab, select Service Catalog.
2
In the left pane, click the Add New Category symbol.
3
Enter a name and description for this category.
4
Click the Permissions tab and click Add Permission to add permissions for
accessing this category.
5
Click Save.
To add a new sub-category
1
On the Process Manager home page, on the Admin tab, select Service Catalog.
2
In the left pane, under the Browse Category section, select the category that
you want to add a sub-category to.
3
In the right pane, click the orange lightning symbol and select Add Sub
Category.
4
Enter a name and description for this sub-category.
5
Click the Permissions tab and click Add Permission to add permissions for
accessing this sub-category.
6
Click Save.
To edit a category
1
On the Process Manager home page, on the Admin tab, select Service Catalog.
2
In the left pane, under the Browse Category section, select the category that
you want to edit.
3
In the right pane, click the orange lightning symbol and select Edit Category.
Managing the service catalog in Process Manager
Adding a Web form
4
Edit the name and description as wanted.
5
Click the Permissions tab and click Add Permission to add permissions for
accessing this category.
6
Click Save.
To delete a category
1
On the Process Manager home page, on the Admin tab, select Service Catalog.
2
In the left pane, under the Browse Category section, select the category that
you want to delete.
3
In the right pane, click the orange lightning symbol and select Delete
Category.
4
Click OK.
Adding a Web form
Web forms can be added to the service catalog. The recommended way to do this
is through publishing processes in Workflow Designer. When Form Start dialog
processes are published in Workflow Designer to Workflow Server, they are added
as Web forms in Process Manager.
See “About publishing a project” on page 105.
See “About the service catalog” on page 273.
To add a Web form
These steps are provided as information on adding a Web form inside Process
Manager. This is not the recommended way to add a Web form. The recommended
way is to publish a Web form dialog process in Workflow Designer.
1
On the Process Manager home page, on the Admin tab, select Service Catalog.
2
In the left pane, under the Browse Category section, select the category that
you want to add a Web form to.
3
In the right pane, click the orange lightning symbol and select Add Web Form.
4
Edit the fields that you want.
See “Web form settings” on page 276.
Mandatory fields have the * symbol by them.
5
Click Save.
275
276
Managing the service catalog in Process Manager
Adding a Webservice
Adding a Webservice
Webservices can be added to the service catalog. The recommended way to do
this is through publishing processes in Workflow Designer. When Webservice
processes are published in Workflow Designer to Workflow Server, they are added
as Webservices in Process Manager.
See “About publishing a project” on page 105.
See “About the service catalog” on page 273.
To add a Webservice
These steps are provided as information on adding a Webservice inside Process
Manager. This is not the recommended way to add a Webservice. The recommended
way is to publish a Webservice process in Workflow Designer.
1
On the Process Manager home page, on the Admin tab, select Service Catalog.
2
In the left pane, under the Browse Category section, select the category that
you want to add a Webservice to.
3
In the right pane, click the orange lightning symbol and select Add Web
Service.
4
Edit the fields that you want.
See “Webservice settings” on page 278.
Mandatory fields have the * symbol by them.
5
Click Save.
Web form settings
Web form settings are used when adding a Web form to a catalog.
See “Adding a Web form” on page 275.
Table 18-1
Web form settings options
Tab
Option
Description
Form Information
Name
The name of the Web form.
Form Information
URL
The URL for the Web form.
Form Information
Description
The description of the Web
form.
Form Information
Forms Category
The category of the Web form.
Managing the service catalog in Process Manager
Web form settings
Table 18-1
Web form settings options (continued)
Tab
Option
Description
Form Information
Image URL
The image that is associated
with the URL.
Form Information
Open in New Window
If checked, the Web form opens
in a new window.
Form Information
With Chrome
If checked, the browser toolbar
is displayed (back buttons,
menu, and so forth). If not
checked, only the title bar is
displayed.
WebPart Information
Is Web Part
If checked, the Web form is a
Web part.
WebPart Information
Height
The height of the web part
window.
WebPart Information
Width
The width of the web part
window.
User Information
Pass UserID
If checked, the User ID (in the
UserID Parameter Name
option) is passed to the Web
form.
User Information
UserID Parameter Name
The User ID to be passed to the
Web form.
Session Information
Pass SessionID
If checked, the Session ID (in the
SessionID Parameter Name
option) is passed to the Web
form.
Session Information
SessionID Parameter Name
The Session ID to be passed to
the Web form.
Permissions
Add Permission
Adds permissions for accessing
this Web form.
Profiles
Default Form ProfileDefinition If checked, the default form is
used for the profile definition.
277
278
Managing the service catalog in Process Manager
Webservice settings
Webservice settings
Webservice settings are used when adding a Webservice to a catalog.
See “Adding a Webservice” on page 276.
Table 18-2
Webservice settings options
Tab
Option
Description
Main Information
Name
The name of the Webservice.
Main Information
Description
The description of the
Webservice.
Main Information
DefaultURL
The default URL for the
Webservice.
Main Information
Directory Service Type
The directory service type for
the Webservice.
Permissions
Add Permission
Adds permissions for accessing
this Web form.
Profiles
Default Form ProfileDefinition If checked, the default form is
used for the profile definition.
Chapter
Managing accounts in
Process Manager
This chapter includes the following topics:
■
About Process Manager security
■
About groups and permissions
■
About using Active Directory with Process Manager
■
How Active Directory groups are added to Process Manager
■
About the default user groups and permissions
■
Setting up groups, permissions, and users
■
Creating groups
■
Add Group dialog box
■
Modifying groups
■
Deleting groups
■
Adding users to groups
■
Adding or removing permissions for groups
■
Viewing the list of permissions
■
Viewing the permissions for a group
■
Creating organizational units
■
Creating a new user
19
280
Managing accounts in Process Manager
About Process Manager security
■
Clone User tab
■
Manually adding new Process Manager users from Active Directory
■
Modifying data for existing users
■
Deleting users
■
Viewing your Process Manager group memberships
■
Editing your user account
■
Changing your password
■
Sending an email to a user
■
Managing users
■
Managing a user’s groups
■
Managing a user’s permissions
■
Managing a user’s organizations
■
Working with users
■
Managing Permissions
■
Managing Organizations
About Process Manager security
Process Manager manages security by using Active Directory to obtain the user’s
authentication and authority. When the user logs on, they go through an Active
Directory page which grants them a session token. If this effort fails, the user is
directed to another login page which grants them a session token. This session
token is the only item that is passed back and forth between the Web Service layer
and the Process Manager user interface.
Within Process Manager, security is controlled through the use of users, groups,
organizational units, and permissions.
Security item
Description
User
Any user of the portal that can log on. Users can also belong to groups
and organizational units, and have permissions assigned to them.
Managing accounts in Process Manager
About groups and permissions
Security item
Description
Group
Collections of users. Users can be members of multiple groups.
Groups are used to assign permissions more efficiently. Instead of
assigning permissions to each user individually, you can specify the
permissions for a group. The permissions for a group are then valid
for each user that is a member of that group. Permissions are almost
always granted at the group level in Process Manager, rather than at
the user level.
Organizational
unit
Collections of users or groups. An organizational unit is generally a
very large group. For example, an organizational unit may be a
department, office, or division of a company.
Permission
Permissions control the access to and use of the Process Manager
portal. What users can view, and what actions they can perform, are
based on permissions.
For example, permissions may grant access to certain functions within
Process Manager, such as the ability to create users. Or permissions
may grant or deny access to view and edit articles in the knowledge
base. Access to everything in Process Manager is controlled through
permissions.
Managing permissions for users, groups, and organizational units can provide a
high level of security within Process Manager. Permissions are hierarchical. The
permission that is applied at the most specific level takes precedence. For example,
a group is denied access to view a knowledge base article. However, a specific user
within that group has permission to view the article. In this case, the user’s specific
permission overrides the group setting, and the user is able to view the article.
You can manage security at the page level within Process Manager. For any page,
you can manage access to that page at the user, group, or organizational unit
level.
About groups and permissions
Groups are collections of Process Manager users. The proper setup of your Groups
in Process Manager can make the ongoing administration of Process Manager
much simpler.
Permissions allow or deny users to view and access areas within Process Manager,
or to perform certain functions. As a general rule, permissions are applied to
Groups in Process Manager, as opposed to at the user level.
When you apply permissions at the group level, those permission settings apply
to each user that is a member of the group. When using Groups to apply
281
282
Managing accounts in Process Manager
About using Active Directory with Process Manager
permissions, you don’t have to edit the permission settings for each user that is
a member of that group. You can make the change at the group level and it is
updated for every user that is a member of that group. Using groups greatly
simplifies user and permission management.
User groups are defined and stored in Process Manager in Admin > Users >
Accounts > List Groups. You can use the default groups that are provided with
Process Manager, create new groups, or import groups from Active Directory
during installation.
See “About the default user groups and permissions” on page 284.
About using Active Directory with Process Manager
Process Manager can use Active Directory users and groups. You can save a lot
of time by using Active Directory users and groups instead of creating them in
Process Manager. Setting up Process Manager to integrate with Active Directory
gives Process Manager access to Active Directory authentication. When users log
on to Process Manager portal they use their Active Directory username and
password.
Process Manager authentication method is selected during Process Manager
installation. If you select Active Directory authentication, you can choose to use
existing users and groups in Process Manager. These are created in Process
Manager and then mapped to the existing users and groups in Active Directory.
Mapped users and groups retain their permissions settings from Active Directory.
For more information on integrating Active Directory with Process Manager, see
the Workflow 7.0 Installation and Configuration Guide.
See “Where to get more information about Symantec Workflow 7.0” on page 27.
The Process Manager users and groups are stored in the Process Manager database.
When you use Active Directory authentication, the Active Directory users and
groups are added to the Process Manager database.
The Active Directory users and groups can be added to Process Manager in the
following ways:
During installation
During the installation of the Process Manager application, the
users and groups from your Active Directory are imported to
Process Manager.
Managing accounts in Process Manager
About using Active Directory with Process Manager
During synchronization
between Process
Manager and Active
Directory
Periodically, Process Manager synchronizes with Active Directory
to obtain new and updated users and groups from Active
Directory. During synchronization, the user and the group data
from Active Directory overwrites the user and the group data
that is in Process Manager.
By default, Process Manager synchronizes with Active Directory
at midnight every night. You can change the synchronization
schedule in Workflow Designer.
For more information about changing the synchronization
schedule, see the Workflow Designer User’s Guide.
Manually
If a new user needs to access Process Manager between
synchronizations, you can add the user manually from Active
Directory.
Automatically when a
user logs on
Users who are in Active Directory but have not yet been added
to can still access Process Manager. When such a user tries to
log on to the Process Manager portal, Process Manager checks
the credentials against the Process Manager database. If the
credentials are not there, Process Manager checks the credentials
against Active Directory and adds the user to Process Manager.
This method is available only if the option Auto Create Users on
Initial Login was selected during the Process Manager
installation.
The synchronization between Process Manager and Active Directory affects
changes and deletions as follows:
Deleting a user from
When you delete a user from Process Manager but not from the
within Process Manager Active Directory, the user is not fully deleted. The users that
remain in the Active Directory are created again in Process
Manager during the next synchronization. To block Process
Manager access to an Active Directory user, you must delete the
user from the Active Directory.
Deleting a user from
Active Directory
When you delete a user from Active Directory, the user is disabled
in Process Manager but not deleted there. To fully delete the user
and all the associated information from Process Manager, you
must manually delete the user from Process Manager.
283
284
Managing accounts in Process Manager
How Active Directory groups are added to Process Manager
Editing a user in
Process Manager
Any changes that you make to a user in Process Manager is
overwritten during the next the synchronization. Instead, edit
user information in Active Directory, and the information is
updated in Process Manager during the next synchronization.
This rule applies to the user’s group, manager, and organizational
unit information.
How Active Directory groups are added to Process
Manager
When Active Directory authentication is selected during the Process Manager
installation, the user groups from Active Directory are imported along with the
users.
See “About using Active Directory with Process Manager” on page 282.
During the configuration segment of the Process Manager installation, your Active
Directory groups can be mapped to the default Process Manager groups. This
option lets the Active Directory groups take the permissions of the default Process
Manager groups. By mapping the groups, you can benefit from the predefined
permissions in the default Process Manager groups while using your organization’s
preferred group names.
During the Process Manager installation, the active directory groups are added
to Process Manager as follows:
■
All the groups in Active Directory are imported to Process Manager and stored
in the Process Manager database.
When the Active Directory users are imported to Process Manager, they retain
their group associations from Active Directory.
■
The Active Directory groups that are mapped to Process Manager groups take
the permissions of the groups that they are mapped to.
■
Any Active Directory groups that are not mapped to Process Manager groups
are added without permissions. You must assign permissions to those groups
after the installation.
About the default user groups and permissions
Process Manager comes with default user groups and permissions defined. You
can modify the default user groups and permissions, create new groups and
permissions, and import groups from Active Directory.
See “About groups and permissions” on page 281.
Managing accounts in Process Manager
Setting up groups, permissions, and users
Table 19-1
Default user groups and permissions
Group
Description
Tabs accessible
Administrators
Contains the users who
administer Process Manager.
■
Documents
■
Knowledge Base
■
Workflow
■
Admin
■
Submit Request
■
Reports
All Users
Permissions
The Administrators group is
generally granted all available
permissions.
Contains all Process Manager ■ Submit Request
users with valid accounts.
■ Knowledge Base
Users have individually
assigned permissions based
upon their group membership
(users can belong to more than
one group).
Application Users Contains only Process Manager ■ Submit Request
end users.
Users have individually
assigned permissions. By
default they have very limited
access to Process Manager.
Setting up groups, permissions, and users
Table 19-2
Process for setting up groups, permissions, and users
Step
Action
Description
Step 1
Set up groups.
You can set up groups in the following ways:
■
Import groups from Active Directory.
■
Create groups manually in the Process
Manager portal.
See “Creating groups” on page 286.
Step 2
(Optional) Set up
organizational units.
See “Creating organizational units” on page 290.
Step 3
Add permissions to
each group.
See “Adding or removing permissions for groups”
on page 289.
285
286
Managing accounts in Process Manager
Creating groups
Process for setting up groups, permissions, and users (continued)
Table 19-2
Step
Action
Description
Step 4
Create users.
You can add users to Process Manager in the
following ways:
■
Import users from Active Directory.
Add users manually from Active Directory.
See “Manually adding new Process Manager
users from Active Directory” on page 292.
■ Create users manually in the Process Manager
portal.
See “Creating a new user” on page 290.
■
Step 5
Add the users to groups. See “Adding users to groups” on page 288.
Creating groups
Groups are collections of Process Manager users. Groups assist in the security
and administration of Process Manager by controlling the permissions that are
granted to individual Process Manager users. When you assign permissions for
a group, each user that is a member of that group is granted those permissions.
Assigning permissions at the group level lets you control the permissions that
are granted to many users. You do not have to modify the permissions for each
group member individually. The permission for creating groups is
AccountManagement.Group.Create.
When Active Directory authentication is selected during the Process Manager
installation, the user groups from Active Directory are imported along with the
users.
See “How Active Directory groups are added to Process Manager” on page 284.
You can copy permissions from another group and assign them to the new group.
If you do not copy the permissions from another group, you must assign the
permissions to the new group in a separate task.
See “Adding or removing permissions for groups” on page 289.
To create a group
1
In the Process Manager portal, click Admin > Users > Accounts > List Groups.
2
In the upper right of the Browse Groups section, click the Add Groups symbol
(green plus sign).
Managing accounts in Process Manager
Add Group dialog box
3
In the Add Group dialog box, name the new group, copy permissions from
another group if desired, and specify the group’s home page and email address.
See “Add Group dialog box” on page 287.
4
Click Save.
Add Group dialog box
This dialog box lets you add a user group to the Process Manager portal.
See “Creating groups” on page 286.
Table 19-3
Options in the Add Group dialog box
Option
Description
Group Name
Lets you enter the name of the new group.
You can use special characters but you cannot enter a name that
is already assigned to another group.
Copy Permissions
From Group
Lets you use another group’s permissions for this group.
You can type the name of the other group or click Pick to select
a group from the Group Picker dialog box.
All the permissions from the group that you specify are replicated
for the new group.
If you do not copy the permissions from another group, you must
assign the permissions to the new group in a separate task.
See “Adding or removing permissions for groups” on page 289.
Homepage
Lets you specify the name of the portal page that should appear
when users in this group log on to the Process Manager portal.
Email Address
Lets you specify an email address that represents the group. You
can use this email address to give users a support contact.
Modifying groups
Administrators and users with the appropriate permissions can modify existing
groups. The permission for modifying groups is
AccountManagement.Group.Modify.
287
288
Managing accounts in Process Manager
Deleting groups
To modify groups
1
In the Process Manager portal, click Admin > Users > Accounts > List Groups.
2
Select the group that you want to modify from the Browse Groups list.
3
Click the Actions symbol (orange lighting), and then click Edit.
4
In the Edit Group dialog, make the necessary changes to the group.
5
Click Save.
Deleting groups
Administrators and users with the appropriate permissions can delete groups.
Deleting groups has nothing to do with deleting users. Users that belong to a
group are not deleted when the group is deleted.
To delete groups
1
In the Process Manager portal, select Admin > Users > Accounts > List
Groups.
2
Select the group that you want to delete from the Browse Groups list.
3
Click the Actions symbol (orange lighting), and then click Delete.
4
Click OK to confirm.
Adding users to groups
Groups are collections of Process Manager users. When you add users to a group,
each of the users inherit the permissions that are defined for that group. The
permissions at the user level can differ from those at the group level. A deny
permission at the user level overrides the group level setting, and the user does
not have access to the item.
To add users to a group
1
In the Process Manager portal, click Admin > Users > Accounts > List Groups.
2
Under Browse Groups, select a group.
3
In the upper right of the group section, click the Actions symbol (orange
lightning), and then click Add User.
4
In the Add User dialog box, in Add user to group, type the user’s email address
or click Pick to search for a user.
5
(Optional) In the Add User dialog box, in Relationship Type, select the type
of relationship.
Managing accounts in Process Manager
Adding or removing permissions for groups
6
Click Add to add the user to the list at the top of the Add User dialog box.
7
Repeat step 4 through step 6 as necessary to add all the users.
8
When you finish adding users, click Close.
Adding or removing permissions for groups
In Process Manager, a group’s permissions determine the permissions control
the permissions that are granted to individual Process Manager users. When you
assign permissions for a group, each user that is a member of that group is granted
those permissions.
See “About groups and permissions” on page 281.
Administrators and users with the appropriate permission can add or remove the
permissions that are associated with a group.
To add or remove permissions from a group
1
In the Process Manager portal, select Admin >Users > Accounts > List Groups.
2
Under Browse Groups, select the group to modify permissions for.
3
Click the Actions symbol (orange lighting), and then click Permissions.
4
In the Permissions For Group dialog box, select the check box for permissions
to assign to this group. Clear the checkbox for permissions you want to remove
from this group. Click Select All or Unselect All to add all available
permissions to a group, or remove all permissions from a group, respectively.
5
Click Save.
Viewing the list of permissions
See “About groups and permissions” on page 281.
Administrators and users with the appropriate permissions can view the
permissions.
To view the list of permissions
1
In the Process Manager portal, select Admin > Users > Accounts > List
Permissions.
2
Under Browse Permissions, select the category of permissions to view.
3
When you finish viewing the permissions, you can go to another page.
289
290
Managing accounts in Process Manager
Viewing the permissions for a group
Viewing the permissions for a group
In Process Manager, a group’s permissions determine what permissions are granted
to individual Process Manager users. When you assign permissions to a group,
each user that is a member of that group is granted those permissions.
See “About groups and permissions” on page 281.
Administrators and users with the appropriate permissions can view the
permissions that are associated with a specific group.
To view the permissions for a group
1
In the Process Manager portal, select Admin > Users > Accounts > List
Groups.
2
Under Browse Groups, select the group to view.
3
Click the Actions symbol (orange lighting), and then click Permissions.
4
When you finish viewing the permissions in the Permissions For Group
dialog box, click Cancel.
Creating organizational units
Organizational units are large groups of users or groups. A typical organizational
unit might be a department within a company.
To create organizational units
1
In the Process Manager portal, select Admin > Users > Accounts > List
Organizations.
2
In the Browse Organizations list, click Add Root Organization.
3
In the Add Organization dialog box, enter a name for the organization in
Organization Name. The name field allows special characters, has a limit of
256 characters, and does not allow duplicate names.
4
(Optional) Enter a description of the organization in the Description field.
5
Click Save.
Creating a new user
Administrators and users with the appropriate permissions can create new Process
Manager users.
Managing accounts in Process Manager
Creating a new user
To create a new user
1
In the Process Manager portal, select Admin > Users.
2
In the User Browser, click the Add New User icon in the top right portion of
the User Browser table.
3
In the Add User dialog, on the Main Information tab, enter all of the required
information for the user. All required fields are marked with a red asterisk.
4
Optionally, enter information in the remaining fields.
5
(Optional) Add additional user information on the following tabs:
Clone User
Lets you clone groups, permissions, or organizations for
this user from an existing user.
See “Clone User tab” on page 292.
Process Manager
Settings
Options for setting the theme, home page, and time zone.
Email Settings
Lets you add additional email addresses for the user.
Phone Numbers
Lets you add phone numbers, along with additional details
about the phone numbers, for the user.
Messengers ID
Lets you add multiple instant messenger IDs for the user,
and designate one messenger ID as the primary contact.
Profiles
Lets you add profile information for the user.
6
Click Save. The new user is added to the All Users list.
7
If you have not cloned the group settings for the new user, you need to specify
which groups this user belongs to. Locate the new user you added, click the
Actions symbol (orange lighting), and then click Manage Groups.
8
In the Manage User Groups dialog, select a group that you want to add this
user to and click Add. Select the Relationship type for the user. User
relationship types let you define the types of relationships that users can
have to other users and to groups.
9
Add any additional groups that you want to give this user access to and click
Close.
10 If you have not cloned the permissions settings for the new user, you need
to specify which permissions are assigned to this user. Locate the user you
added, click the Actions symbol (orange lighting), and then click Manage
Permissions.
291
292
Managing accounts in Process Manager
Clone User tab
11 In the Manage User Permissions dialog, expand the permissions categories
that contain the permissions you want to assign to this user.
12 Select the check box next to the permissions to assign to this user and click
Save.
Clone User tab
See “Creating a new user” on page 290.
Table 19-4
Options on the Clone User tab
Option
Description
User
Lets you specify the user to clone.
You can type the users’ name or click Pick and use the User
Picker dialog box to search for a user.
Clone User’s Groups
Clones the group settings of this user for the new user.
Clone User’s
Permissions
Clones the permissions settings of this user for the new user.
Clone User’s
Organization Units
Clones the organization unit settings of this user for the new
user.
Manually adding new Process Manager users from
Active Directory
You can manually add new users to Process Manager from Active Directory.
Process Manager synchronizes its data with Active Directory according to a
schedule that you configure (the default is each night at midnight). However, you
may want to add new users before the scheduled update.
See “About using Active Directory with Process Manager” on page 282.
Managing accounts in Process Manager
Modifying data for existing users
To manually add new Process Manager users from Active Directory
1
In the Process Manager portal, click Admin, and then click Users > AD Users.
2
The Add Active Directory Users page shows all the Process Manager users
that have been added from the Active Directory. The list of users that appears
here might not be the most current list of users in the Active Directory. The
list is only current with the state of the Active Directory as of the last
synchronization with Process Manager. To view the most current list from
Active Directory, click Show Details.
3
Select the user to add and click Add.
Modifying data for existing users
The admin can modify the data for existing Process Manager users. Any of the
information that you can set for a user during user creation can be modified from
the Manage User dialog.
To modify data for existing users
1
From the Process Manager portal, click Admin > Users.
2
In the User Browser, navigate to the user that you want to modify data for,
click the Actions symbol (orange lighting), and then click Manage User.
3
In the Manage User dialog box, modify the account information for the user
as needed. To learn about the fields and tabs in this dialog, refer to the Create
User topic.
See “Creating a new user” on page 290.
4
Click Save.
Deleting users
If you have the necessary permissions, you can delete existing users.
If a user that has been deleted is currently logged into the portal, they are not
immediately locked out of their session. Deleted users cannot save any data or
navigate to any other pages.
To delete users
1
From the Process Manager portal, click Admin > Users.
2
In the User Browser, navigate to the user to delete, and then click the symbol
(red x).
3
Click OK in the confirmation dialog box that appears.
293
294
Managing accounts in Process Manager
Viewing your Process Manager group memberships
Viewing your Process Manager group memberships
To view your Process Manager group memberships
1
In the upper right of the Process Manager portal, click Account.
2
Expand the User Information section.
The groups that you belong are listed to the right of Group.
3
When you finish, you can go to another page.
Editing your user account
To edit your user account
1
In the upper right of the Process Manager portal, click Account.
2
At the right of the User Information section, click the Actions symbol (orange
lightning), and then click Change Password.
3
In the Change Password dialog box, enter your current password and your
new password, and then confirm the new password.
4
Click Change Password.
■
User information
■
Password
■
User themes and settings
■
Email information
■
Phone numbers
■
Instant Messenger information
■
Addresses
■
Delegations
Changing your password
To change your password
1
In the upper right of the Process Manager portal, click Account.
2
At the right of the User Information section, click the Actions symbol (orange
lightning), and then click Change Password.
Managing accounts in Process Manager
Sending an email to a user
3
In the Change Password dialog box, enter your current password and your
new password, and then confirm the new password.
4
Click Change Password.
Sending an email to a user
You can send an email to another user of Process Manager.
See “Managing accounts in Process Manager” on page 279.
To send an email to a user
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > Manage Users.
2
In the left pane, select All Users or browse the Permissions and Groups to
find the user you want to send the email to.
3
In the right pane, next to the user you want to send the email to, click the
Email User symbol.
4
Enter the email information and click Send.
Managing users
After a user is added to Process Manager, you can make changes to the user's
basic information.
See “Managing accounts in Process Manager” on page 279.
To manage a user
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > Manage Users.
2
In the left pane, select All Users or browse the Permissions and Groups to
find the user you want to manage.
3
In the right pane, next to the user you want to manage, click the orange
lightning symbol and select Manage User.
4
Enter or change the information you want.
5
Click Save.
295
296
Managing accounts in Process Manager
Managing a user’s groups
Managing a user’s groups
Users can belong to groups. Groups are assigned permissions and all users in a
group have the permissions assigned to that group.
See “Managing accounts in Process Manager” on page 279.
To manage a user’s groups
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > Manage Users.
2
In the left pane, select All Users or browse the Permissions and Groups to
find the user whose groups you want to manage.
3
In the right pane, next to the user whose groups you want to manage, click
the orange lightning symbol and select Manage Groups.
The groups this user is assigned to appears in the Groups section.
4
To delete a group that the user is assigned to, click the Remove symbol next
to the group you want to delete.
5
If wanted, click Relationship Type to select the relationship type for this
group. This lets you establish relationships between groups.
Relationship types only appear after they have been added.
See “Adding a user relationship type” on page 271.
6
To add a group that the user is assigned to, in the Select Group To Add box,
select the group and click Add.
7
Click Close.
Managing a user’s permissions
After users are added, you can manage that user’s permissions.
See “Managing accounts in Process Manager” on page 279.
To manage a user's permissions
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > Manage Users.
2
In the left pane, select All Users or browse the Permissions and Groups to
find the user whose permissions you want to manage.
3
In the right pane, next to the user whose permissions you want to manage,
click the orange lightning symbol and select Manage Permissions.
Managing accounts in Process Manager
Managing a user’s organizations
4
Search the categories and select or clear the permissions for this user.
5
Click Save.
Managing a user’s organizations
Users and groups can belong to organizations. Organizations are assigned
permissions and all users and groups in an organization have the permissions
assigned to that organization.
See “Managing accounts in Process Manager” on page 279.
To manage a user's organizations
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > Manage Users.
2
In the left pane, select All Users or browse the Permissions and Groups to
find the user whose organizations you want to manage.
3
In the right pane, next to the user whose organizations you want to manage,
click the orange lightning symbol and select Manage Organizations.
The organizations this user is assigned to appears in the Organizational units
section.
4
If wanted, click Relationship Type to select the relationship type for this
organization. This lets you establish relationships between organizations.
Relationship types only appear after they have been added.
See “Adding a user relationship type” on page 271.
5
Select Is PrimaryOrganization if this organizational unit is the primary one
for this user.
6
In the Select organization to add box, select the organization you want to
assign to this user and click Add.
7
Click Close.
Working with users
After users are added to Process Manager, multiple actions (with the right
permissions) can be performed on them.
See “Managing accounts in Process Manager” on page 279.
297
298
Managing accounts in Process Manager
Working with users
To set up user relationships
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > Manage Users.
2
In the left pane, select All Users or browse the Permissions and Groups to
find the user whose user relationships you want to manage.
3
In the right pane, next to the user whose user relationships you want to
manage, click the orange lightning symbol and select User Relationship.
4
Click Relationship Type to select the relationship type between the users.
Relationship types only appear after they have been added.
See “Adding a user relationship type” on page 271.
5
In the Pick User To Relates box, enter a user name or click pick to search for
and select the user to add the relationship to and click Add.
6
If wanted, in the Reverse Relationship Type box, select the reverse
relationship type. This lets you establish a two-way relationship.
Relationship types only appear after they have been added.
See “Adding a user relationship type” on page 271.
7
Click Close.
To set a password for a user
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > Manage Users.
2
In the left pane, select All Users or browse the Permissions and Groups to
find the user whose password you want to change.
3
In the right pane, next to the user whose password you want to change, click
the orange lightning symbol and select Set Password.
4
Enter the new password.
5
Click Save.
To enable or disable a user
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > Manage Users.
2
In the left pane, select All Users or browse the Permissions and Groups to
find the user who you want to enable or disable.
3
In the right pane, next to the user who you want to enable or disable, click
the orange lightning symbol and select Enable/Disable.
Managing accounts in Process Manager
Working with users
4
If the user is disabled, click Enable This User.
5
If the user is enabled, click Disable This User.
An enabled user can access the site, while a disabled user cannot.
To view, add, or remove a user’s credit cards
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > Manage Users.
2
In the left pane, select All Users or browse the Permissions and Groups to
find the user whose credit cards you want to manage.
3
In the right pane, next to the user whose credit cards you want to manage,
click the orange lightning symbol and select Credit Cards.
4
To add a credit card, click Add Credit Card, enter the information and click
Save.
5
To edit a credit card, click the Edit Card symbol next to the card name, edit
the information and click Save.
6
To delete a credit card, click the Delete Card symbol next to the card name
and click OK.
7
Click Close.
To edit, add, or remove user’s financial transactions
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > Manage Users.
2
In the left pane, select All Users or browse the Permissions and Groups to
find the user whose financial transactions you want to manage.
3
In the right pane, next to the user whose financial transactions you want to
manage, click the orange lightning symbol and select Transactions.
4
To add a transaction, click Add Transaction, enter the information and click
Save.
5
To edit a transaction, click the Edit Credit Transaction symbol next to the
transaction name, edit the information and click Save.
6
To delete a transaction, click the Delete Credit Transaction symbol next to
the transaction name and click OK.
7
Click Close.
299
300
Managing accounts in Process Manager
Managing Permissions
To set key value pairs for user
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > Manage Users.
2
In the left pane, select All Users or browse the Permissions and Groups to
find the user whose financial transactions you want to manage.
3
In the right pane, next to the user whose financial transactions you want to
manage, click the orange lightning symbol and select Key Value Pairs.
4
To add a key value pair, click Add Key Value Pair, enter the information and
click Save.
5
To edit a key value pair, click the Edit symbol next to the key value pair name,
edit the information and click Save.
6
To delete a key value pair, click the Remove symbol next to the key value
pair name and click OK.
7
Click Close.
To delete a user
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > Manage Users.
2
In the left pane, select All Users or browse the Permissions and Groups to
find the user you want to delete.
3
In the right pane, next to the user you want to delete, click the Remove User
symbol.
4
Click OK.
Managing Permissions
Permissions are granted to users, groups, and organizations for accessing Process
Manager. You can add or edit permissions. These permissions are also available
to use when designing a workflow using Workflow Designer.
See “Managing accounts in Process Manager” on page 279.
To add a permission
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > List Permissions.
2
In the left pane, click the Add Permission symbol.
Managing accounts in Process Manager
Managing Organizations
3
Enter the name and description of the permission you want to add.
4
Click Save.
Your permission is placed in the NotSet category until you move it.
To edit a permission
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > List Permissions.
2
In the right pane, next to the permission you want to edit, click the orange
lightning symbol and select Edit.
3
Make the changes you want.
4
Click Save.
To grant a permission to a user
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > List Permissions.
2
In the right pane, next to the permission you want to grant to a user, click
the orange lightning symbol and select View Users.
3
Click the Permissions tab and enter a user name or click pick to search for
and select the user to grant this permission to. Then click Add.
4
If wanted, click Relationship Type to select the relationship type for this
permission. This lets you establish relationships between permissions.
Relationship types only appear after they have been added.
See “Adding a user relationship type” on page 271.
5
When finished, close the dialog box.
To grant a permission to a group
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > List Permissions.
2
In the right pane, next to the permission you want to grant to a group, click
the orange lightning symbol and select View Groups.
3
Enter a group name or click pick to search for and select the group to grant
this permission to and click AddGroup.
Managing Organizations
Organizations are logical groups that can be used to provide structure to large
Process Manager user groups, or can be the parent company for all users. Users
and groups can be added to organizations.
301
302
Managing accounts in Process Manager
Managing Organizations
Process Manager has two levels of organization: root organizations (the highest
level) and sub-organizations (subordinate to root organizations).
See “Managing accounts in Process Manager” on page 279.
To add a root organization
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > List Organizations.
2
In the left pane, click the Add Root Organization symbol.
3
Enter the name and description.
4
Click Save.
To edit an organization
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > List Organizations.
2
In the left pane, search for and select the organization name that you want
to edit.
3
In the right pane, click the orange lightning symbol, then click Edit
Organization.
4
Make the changes you want.
5
Click Save.
To add users or groups to an organization
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > List Organizations.
2
In the left pane, search for and select the organization name that you want
to add users to.
3
In the right pane, click the orange lightning symbol.
4
Click View User.
5
Click the Organization tab and enter a user or click pick to search for and
select the user to add to this organization and click AddUser.
6
If wanted, click Relationship Type to select the relationship type for this
organization. This lets you establish relationships between organizations.
Relationship types only appear after they have been added.
See “Adding a user relationship type” on page 271.
Managing accounts in Process Manager
Managing Organizations
7
Enter a group or click pick to search for and select the group to add to this
organization and click AddGroup.
8
When finished, close the dialog box.
To add a sub-organization
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > List Organizations.
2
In the left pane, search for and select the organization name that you want
to add a sub-organization to.
3
In the right pane, click the orange lightning symbol, then click
AddSubOrganization.
4
Enter the name and description.
5
Click Save.
To delete an organization
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > List Organizations.
2
In the left pane, search for and select the organization name that you want
to delete.
3
In the right pane, click the orange lightning symbol, then click Delete.
4
Click OK.
303
304
Managing accounts in Process Manager
Managing Organizations
Chapter
20
Performing administrative
tasks in Process Manager
This chapter includes the following topics:
■
Commands on the Admin menu
■
About the Process Manager portal master settings
■
Master Settings page
■
Editing the Process Manager portal master settings
■
About Actions in Process Manager
Commands on the Admin menu
The Admin menu gives users access to all the administrative functions that are
available in Process Manager. Only users with the appropriate permissions can
access this menu.
Table 20-1
Commands on the Admin menu
Command
Sub-command
Description
Data
Lists/Profiles
Lets you add new profile definitions, and view, edit, and
delete existing profile definitions. Profiles are used to
categorize the data by adding customizable fields that you
can then use for further sorting of data.
306
Performing administrative tasks in Process Manager
Commands on the Admin menu
Table 20-1
Commands on the Admin menu (continued)
Command
Sub-command
Description
Data
Application Properties Lets you add new application properties, and view, edit, and
delete existing ones. Typically, you define application
properties as part of the installation configuration process,
but you can also work with them from the Admin area.
Application properties are a type of profile. When you define
application properties, you set up the properties that any
process in the portal can then use. Defining application
properties is more efficient than setting up the same
properties multiple times in different processes.
For example, you may want to put a link to the PeopleSoft
portal in multiple Process Manager processes. Setting up
an application property for the PeopleSoft portal, allows
any of your process es to use this URL to create PeopleSoft
hyperlinks on forms.
Data
Document Type
Lets you add new document types and edit or delete existing
document types.
Document types that you add appear in the Document Type
drop-down list in the Add Documents dialogs. Users who
adding documents to the Documents page can select one of
these document types. However, users are not limited to
only adding documents of the type that is defined in the
drop-down list.
See “About document management” on page 230.
Data
Document Category
Type
Lets you define document category types, which assist in
the organization of categories in the Documents page.
Document category types are useful when you have many
categories defined in the Documents page. Defining
Document Category types lets you sort by type instead of
sorting alphabetically.
See “About document management” on page 230.
Data
HierarchyDataService Lets you:
■
Add categories to the hierarchy tree
■
Delete categories from the hierarchy tree
■
Edit existing categories
■
Add hierarchy items to a category
■
Delete hierarchy items from a category
Performing administrative tasks in Process Manager
Commands on the Admin menu
Table 20-1
Commands on the Admin menu (continued)
Command
Sub-command
Description
Data
UserRelationshipType Lets you add new user relationship types, and edit and delete
existing user relationship types.
User relationship types define the types of relationships
that users can have to other users and to groups. User
relationship types can reflect that one user is the manager
of another, or that a user is a member of a group.
You define the relationship types in the Administration
area, and make specific links between users in Users >
Manage Relationships.
Data
Profile Reference Type Lets you add a new profile reference type or edit an existing
profile reference type. Only users with Workflow Solution
installed see this option. You may want to call support for
assistance if you plan to change or add profile reference
types.
Profiles let you define data. When you set up a profile, you
set up the pieces of data that you want to see in different
Process Manager items. Process Manager items include
articles, schedules, or documents. For example, if you work
with mortgage applications, you might want to know the
property address, assessed value, and other information on
the properties. Setting up profile reference types lets you
define the property-specific data that you want to see.
Data
Process Type Actions
Lets you add new process type actions, edit and delete
existing process type actions, and add actions to process
types.
Sending an email is a common example of an action that
you may want to include in multiple processes. When you
create process type actions, Process Manager sees x process
type running, and adds y action as an option whenever x
process is running. Creating process type actions adds an
action in multiple places, without having to add the action
to each individual workflow.
Portal
Master Settings
Lets you configure the master settings for the Process
Manager portal. Master settings are related to Process
Manager performance and behavior.
307
308
Performing administrative tasks in Process Manager
Commands on the Admin menu
Table 20-1
Commands on the Admin menu (continued)
Command
Sub-command
Description
Portal
Manage Pages
Lets you manage the administration of all the pages in the
Process Manager portal. The portal is where you access the
Process Manager user interface. Many portal pages are part
of the default Process Manager installation. You can import,
edit, delete, export, and move pages up and down the menu
list. You can also add root and sub pages, and make a root
page a sub page.
See “About the Process Manager portal” on page 183.
Portal
Plugin Upload
Lets you upload plugins, web parts, resources, or pages. For
example, you can create a workflow project that you can
upload as a plugin. You can create a workflow for the
Document Management process, which requires users to
go through several steps before a document is approved.
You can load that workflow project into the Process Manager
portal as a plugin.
Portal
Web Parts Catalog
Lets you create new Web Parts to add to the catalog, and
edit and delete existing Web Parts.
Service Catalog Settings
Not applicable
Lets you work with the Service Catalog items. You can set
the permissions on which Process Manager users, groups,
and organizational units have access to the specific forms.
You can also edit, rename, create, and delete Service Catalog
items and categories, and modify Service Catalog item
attributes like form size.
Performing administrative tasks in Process Manager
About the Process Manager portal master settings
Table 20-1
Commands on the Admin menu (continued)
Command
Sub-command
Description
Users
Accounts
Lets you manage the various Process Manager user, group,
permission, and organization accounts.
This command has the following sub-commands:
Manage Users
Lets you add new users, delete, and email users. You can
also manage groups, organizations, and permissions for
users, merge users, and set user relationships. In
addition, you can set the user’s password, enable or
disable the user, add credit cards, transactions, and key
value pairs for the user.
■ List Permissions
Lets you add new permissions, delete permissions, edit
permissions, and view the users and groups that are
assigned a certain permission.
■ List Groups
Lets you add new groups, edit groups, add users to
groups, add permissions to groups, delete groups, and
remove users from groups.
■ List Organizations
Lets you add new organizations, edit organizations, add
users to organizations, add permissions to organizations,
delete organizations, and remove users from
organizations.
■
Users
AD Users
Lets you view the list of users currently in Active Directory,
and select users to update.
Users
Manage Delegations
Lets you add and delete delegations for users.
AD Servers
Not applicable
Lets you add and manage Active Directory servers.
About the Process Manager portal master settings
The Process Manager portal master settings determine the behavior of the Process
Manager application and portal.
The Process Manager portal master settings are established during the installation
of the Process Manager application. You can use the default settings or you can
edit them as necessary. We recommend that you review the settings to familiarize
yourself with them and then customize them for your organization.
See “Editing the Process Manager portal master settings” on page 311.
309
310
Performing administrative tasks in Process Manager
Master Settings page
Examples of the types of settings that you might change are as follows:
■
Settings under the Account Management section
Password Expire Months, Register Fail e-mail address, and Security Question
1
■
Settings under the Workflow Settings section
Workflow Task Due Date (default is 7 days) and Workflow Task Late Date
(default is 14 days)
Do not change the settings for URLs, or disable check boxes without fully
understanding the ramifications. Few organizations need to change that type of
information.
The portal master settings are arranged in sections. Expand each section to see
the settings that appear there.
See “Master Settings page” on page 310.
Master Settings page
See “About the Process Manager portal master settings” on page 309.
Table 20-2
Sections on the Master Settings page
Section
Description
Account Management Determines the information that is required for new users and
how the users are handled.
Application
Management
Sets the global behaviors for the Process Manager application.
Articles
Controls the appearance of the article site.
Chat
Controls settings for the chat feature.
Customization
Controls the site’s appearance.
Document
Management
Controls the management of documents by the system.
Email Settings
Sets the email settings for Process Manager, including SMTP
server.
Not Logged-in Users
Controls how users who are not logged on to the site are handled
when they visit. You can block all access to users who do not log
on, or allow such users to perform some functions.
Notifications
Sets the home URL for the site, as well as the locations of plugins.
Performing administrative tasks in Process Manager
Editing the Process Manager portal master settings
Table 20-2
Sections on the Master Settings page (continued)
Section
Description
Process Manager
Active Directory
Settings
Lets you edit the settings for using Active Directory to create and
authenticate the users who log on to the Process Manager portal.
Process Manager
Events
Controls which event notifications are turned on.
Process Manager
Settings
Sets various settings for Process Manager, including the URL for
the Forgot Password link.
Do not changes these settings without a specific purpose.
Optimization
Determines the times to keep items in various caches.
Controls the behavior of the Process Manager engine to some
extent.
Profile
Controls settings for profiles.
Reports Settings
Controls the behavior, look, and location of reports.
Workflow Settings
Determines the ability to lease tasks, the appearance of tasks
and the Task page, and task-related dates and times.
Editing the Process Manager portal master settings
The Process Manager portal master settings determine the behavior of the Process
Manager application and portal.
Although default master settings are established during the installation of the
Process Manager application, you can edit them as necessary to customize them
for your organization.
See “About the Process Manager portal master settings” on page 309.
Do not change the settings for URLs, or disable check boxes without fully
understanding the ramifications. Few organizations need to change that type of
information.
To edit the Process Manager portal master settings
1
In the Process Manager portal, click Admin, and then click Portal > Master
Settings.
2
On the Master Settings page, expand the section that contains the settings
to edit.
311
312
Performing administrative tasks in Process Manager
About Actions in Process Manager
3
Change the settings as necessary.
4
Continue to expand and edit additional sections as needed.
5
When you finish reviewing and editing the settings, at the lower right of the
page, click Save.
About Actions in Process Manager
Actions are the links that are shown on the right side of Process View pages.
These links let you take actions or launch other processes that can help you with
your task or process.
See “Process View page” on page 214.
You can edit forms in Workflow Solution and add or remove actions to different
Process View pages.
Examples of the default actions that might appear on Process View pages are as
follows:
■
Send email
■
Search KB
■
Search Google
■
Search Google Groups
■
Search MS Technet
■
Create Subtasks
■
Reclassify
■
Schedule for Later
■
Start Chat
■
Suggest Self Service
■
View Previous Submissions
■
Go To Discussion
■
Invite Participant
The actions that you see in the process view vary for different processes. Each
process view form is designed to include the actions that are most relevant and
useful for that particular process.
Chapter
21
Reports in Process Manager
This chapter includes the following topics:
■
About Process Manager reporting
■
About the Reports page
■
Viewing a report
■
Creating a standard report
■
Setting up or modifying the data in standard reports
■
Customizing the layout of grid standard reports
■
Setting up or modifying Web Service access for standard reports
■
Customizing filtering and sorting for standard reports
■
Modifying standard reports
■
Creating a cube report
■
Specifying filtering for cube reports
■
Customizing cube reports
■
Modifying cube reports
■
Setting permissions for reports
■
Exporting a report definition
■
Copying a report
■
Adding reports to a portal page
■
Creating a scheduled report
314
Reports in Process Manager
About Process Manager reporting
■
Adding report categories
■
Adding report sub categories
■
Deleting report categories
■
Setting report category permissions
■
Adding reports to additional categories
■
Deleting reports
■
Add/Edit Cube Report dialog box
■
Add/Edit Standard Report dialog box
■
Displaying reports in print view
■
Importing report categories
■
Importing reports
About Process Manager reporting
The reporting feature in Process Manager allows users to have easy access to
Process Manager data, in the form of predefined reports. Users can also create
custom reports.
The main Process Manager reporting features are as follows:
■
The predefined reports that are installed with Process Manager meet the ITIL
needs of many users.
■
Predefined reports can be easily customized by copying a report and changing
a few items so that the new report meets your exact needs.
■
A wizard interface is used to create new reports, which eliminates the need to
use SQL for report creation.
All reports can be included on portal pages and dashboards, and the size and
placement of the report is customizable by the administrator.
■
During report creation, you can add run-time filters to the report definition.
Run-time filters allow users to scope the reports based on the data that they
want to see.
■
All reports can be configured to represent Process Manager data in a graphical
format.
Reports in Process Manager
About the Reports page
Process Manager contains standard reports and cube reports. Both types of reports
are easily customizable and can contain any Process Manager data, but cube
reports show Process Manager data in a graphical format.
About the Reports page
The Reports page in the Process Manager portal lets you view, create, delete,
copy, email, and perform other actions with reports in Process Manager. Your
permissions determine which reports you can view, and what actions you can
take with those reports. For example, you might have permission to view certain
reports, but not to delete those reports or edit the report definitions.
If your page was customized, its appearance and contents might differ from the
default page.
See “About customizing Process Manager pages” on page 203.
Table 21-1
Default sections on the Reports page
Section
Description
Report Search
Lets you search for a specific report. This search is conducted on
the report name and the results are shown from all categories.
Report Categories
Lets you select the category for which to display the reports.
You can also import a report category to the list from another
Process Manager instance, and you can add a new report category.
See “Adding report categories” on page 329.
Report Templates
Lets you create a new report from a predefined template. You
can also edit, export, and delete a report template.
category section
Lets you edit the category that you selected under Report
Categories.
This title for this section is the same as the selected category
name.
Reports
Displays the reports that are in the category that you selected
under ReportCategories. Your permissions determine the reports
that appear.
You can select a report to view or select any of several report
actions. For example, you can edit, print, and export a report.
You can also add a new report.
315
316
Reports in Process Manager
Viewing a report
Viewing a report
In the Reports tab, you can view all of the reports that you have the view report
permission for. You also view reports on the portal pages that include reports.
To view a report
1
In the Process Manager portal, select Reports.
2
In the Report Categories area, select the category that contains the report
you want to view.
3
Click the report name, or select the action icon for the report that you want
to view, and click View.
Creating a standard report
Administrators and users with the appropriate permissions can create reports.
To create a new report
1
In the Process Manager portal, select Reports.
2
In the Report Categories area, select the category that you want the report
to reside in. The report that you create is added to the category that you select.
3
Click the Add Report icon, and select Add Standard Report.
4
In the Name field, enter a name for the report. Report names must be unique.
The Name field has a 100 character limit.
5
In the Report Designer tab, specify the data that you want included in the
report and the display of that data.
See “Setting up or modifying the data in standard reports” on page 317.
6
(Optional) In the Description tab, enter a description for the report which
appears on the Reports portal page underneath the report. The description
should make it easy for users to quickly understand the information that the
report contains. The description text is also searched when users search for
reports. The description has no character limit.
Reports in Process Manager
Setting up or modifying the data in standard reports
7
In the Permissions tab and add or modify permissions for the report as
needed. You can take multiple actions with permissions.
To edit existing permissions Select the edit icon for the permission that you want
to modify. Make the necessary changes to the
permission and click Update.
8
To remove an existing
permission
Click the delete icon for the permission that you want
to remove.
To add a new permission
Click Add New Permission. Select the permission type,
and the user, group, permission, or organization you
want to set permissions for. Set the appropriate
permissions and click Add.
(Optional) On the Web Services tab, set up Web Service access for the report.
See “Setting up or modifying Web Service access for standard reports”
on page 319.
9
Click Save.
Setting up or modifying the data in standard reports
The data that is included and displayed in reports is completely customizable. In
the Report Designer tab, you specify the information that should be included in
a report, as well as criteria to narrow the report results. The information that you
specify in this tab can both add to, and restrict the data that appears in the report.
Selecting a check box for a type of data that you want to add to the report includes
all of the fields available for that section in the report. The available fields are
displayed in the Data section. Selecting the check box for one of the fields lets
you apply filters to the data that is returned in that field.
To set up or modify the data and display of standard reports
1
In the Process Manager portal, select Reports.
2
On the Reports page, do one of the following:
3
■
Create a new report.
See “Creating a standard report” on page 316.
■
Modify an existing report.
See “Modifying standard reports” on page 321.
In the Add/Edit Standard Report dialog box, select the Report Designer tab.
See “Add/Edit Standard Report dialog box” on page 334.
317
318
Reports in Process Manager
Customizing the layout of grid standard reports
4
On the Data tab, select the check box for the type of data that you want to
include in the report. When you select a data type, all of the data fields of
that type are added to the report. All of the data fields are available for display
in the report. Data types that are included in the report have a green check
mark next to them. Repeat this step for all of the datatypes that you want to
include in the report.
5
(Optional) To filter the data that is included in the report, select the check
box next to the field that you want to filter. Fields to which you have applied
filtering have a green check mark next to them.
6
In the Columns area, select the check box for the columns that you want to
display in the report. Repeat this step for all of the columns that you want to
include in the report. Columns that are included in the report have a green
check mark next to them, and are displayed at the top of the columns area.
7
(Optional) Customize the layout of the report.
See “Customizing the layout of grid standard reports” on page 318.
8
(Optional) Customize the filtering and sorting of the report.
See “Customizing filtering and sorting for standard reports” on page 320.
9
Click Save.
Customizing the layout of grid standard reports
You can view the layout of the report as you work on it. The report preview pane,
in the center of the Report Designer tab, shows you how the report currently
looks.
See “Add/Edit Standard Report dialog box” on page 334.
When Auto Preview is selected (it is by default), the changes you make to your
report are shown as you make them. If you make a lot of changes, you may want
to turn off Auto Preview. When Auto Preview is turned off, you do not have to
wait for each change to be reflected in the preview pane. If you have turned off
Auto Preview , you can click Generate to see the current report with all of your
changes.
When Limit Results is selected (it is by default), the report results are limited to
the top 50 results. When you limit results, you can see how the report looks without
showing a huge amount of data in the report preview pane.
You can customize the layout of grid standard reports in the following ways:
■
Move columns in the report by selecting the left arrow or right arrow for the
column in the report preview pane.
Reports in Process Manager
Setting up or modifying Web Service access for standard reports
■
Delete a column by selecting the red x for the column in the report preview
pane.
■
Change the name of a column by moving your mouse over the column name
in the Columns section, and clicking the Edit button. Edit the title of the column
and click OK.
■
Adjust column width by placing the mouse arrow over the column and dragging
to get the desired width.
■
Apply special formatting to columns in the report by adding renderers.
Setting up or modifying Web Service access for
standard reports
Setting up web service access for a report allows programmatic access to that
report.
To set up or modify Web Service access for standard reports
1
In the Process Manager portal, click Reports.
2
On the Reports page, do one of the following:
3
■
Create a new report.
See “Creating a standard report” on page 316.
■
Modify an existing report.
See “Modifying standard reports” on page 321.
In the Add/Edit Standard Report dialog box, click the Web Services tab.
See “Add/Edit Standard Report dialog box” on page 334.
319
320
Reports in Process Manager
Customizing filtering and sorting for standard reports
4
On the WebService tab, click the check box to enable programmatic access
to the report. To enable WebService Access, enter data in the following fields:
Option
Description
Namespace
The namespace for the WebService and the objects that are
used in the web service.
Namespace URI
The URI for the namespace.
WebService Name
A name that describes the service.
Class Name
The results of the report are an array of the class name that
is supplied here. The class name has public properties for
each of the columns in the report.
Click Generate to compile the WebService and deploy it to a URL. The URL
is displayed on the screen and can be used to access the WebService. When
report data changes, you need to generate the WebService again to update
the class.
5
Click Save.
Customizing filtering and sorting for standard reports
In the Options tab, on the Report Designer tab of the Add/Edit Standard Report
dialog, you specify the grouping, sorting, and paging options for the report.
To customize the filtering, sorting, and grouping for a report
1
In the Process Manager portal, select Reports.
2
On the Reports page, do one of the following:
3
■
Create a new report.
See “Creating a standard report” on page 316.
■
Modify an existing report.
See “Modifying standard reports” on page 321.
In the Add/Edit Standard Report dialog box, select the Report Designer tab.
See “Add/Edit Standard Report dialog box” on page 334.
4
(Optional) In the Report Designer tab, select Options.
5
Select the Limit Rows check box to limit the number of rows that are returned
with the report. The default number of rows that are returned is 50. When
you select this option, the user is able to configure the number of rows that
are returned at run time.
Reports in Process Manager
Modifying standard reports
6
Select the Use Paging check box, and specify the number of rows per page
for the report.
7
Select a column in the Sort By drop-down list to sort the report by that
column, and select ascending or descending sort order.
8
Select up to three columns to group the report by in the Group By drop-down
lists.
9
To add aggregations to your groups, under Group Aggregations, select a
column to aggregate a group by and the type of aggregation, and then click
Add Aggregation. Aggregations summarize mathematical data at the group
level.
10 Click Display SQL to display the SQL statement that the report executes
against the database.
11 Click Save.
Modifying standard reports
You can modify any report for which you have the appropriate permissions. You
are more likely to spend time modifying existing reports than creating new reports.
Process Manager includes many predefined reports that meet most of your
reporting needs. When you want to make a small change to an existing report,
copy the existing report and make your changes in the new report. By copying
the report instead of making modifications directly to a predefined report, you
can always go back to the original report.
To modify a standard report
1
In the Process Manager portal, select Reports.
2
On the Reports page, under Report Categories, select the category that
contains the report that you want to modify.
3
On the right side of the page, click the orange lightning symbol for the report
that you want to modify, and then click Edit.
4
In the Edit Standard Report dialog box, make the necessary changes to the
report. The dialog and tabs for editing and adding standard reports are the
same.
See “Creating a standard report” on page 316.
See “Add/Edit Standard Report dialog box” on page 334.
5
Click Save.
321
322
Reports in Process Manager
Creating a cube report
Creating a cube report
Cube reports represent Process Manager data in an easy to understand graphical
format. In addition to the predefined cube reports that ship with Process Manager,
you can create your own custom cube reports.
Cubes store calculated information as well as additional information to provide
a more efficient search when you create the reports. You can create cube reports
more quickly than you can create reports with typical relational databases. With
cube reports, you also have more information available to include in the report.
To create a cube report
1
In the Process Manager portal, select Reports.
2
In the Report Categories area, select the category that you want the report
to reside in. The report that you create is added to the category that you select.
3
Click the Add Report icon, and select Add Cube Report.
See “Add/Edit Cube Report dialog box” on page 333.
4
In the Name field, enter a name for the report. Report names must be unique.
The character limit for this field is 100.
5
In the Setup tab, select a cube from the Selected Cube drop-down list.
Selecting a cube updates the data you can select in the dialog which you use
to build your report.
6
In the Measures and Dimensions section, select the measure that you want
to include in the report, and drag it onto the chart tab or grid tab.
A measure is selected by default for each cube. If you do not want the default
measure to be included in the report, select the Measures drop down in the
Series box. Uncheck the measure you want to remove, and click OK.
7
Add or remove additional measures as needed from the Measures drop down
in the Series section.
8
Select the dimension that you want to display, and drag it onto the x axis of
the graph. If you want to remove an existing dimension from the x axis, drag
it back to the Measures and Dimensions box.
9
Specify the information that you want in the x axis by selecting the dimension
drop down in the Categories box. Select the axis items you want to display
and click OK.
10 (Optional) Set filtering for the report.
See “Specifying filtering for cube reports” on page 323.
Reports in Process Manager
Specifying filtering for cube reports
11 (Optional) Click the Description tab and enter a description for the report.
This description is shown in the Reports tab and is intended to give users an
idea of what information the report contains.
12 Optionally, further customize the appearance of the report.
See “Customizing cube reports” on page 323.
13 Click Save.
Specifying filtering for cube reports
When you set up cube reports, you can set up filtering for the report to narrow
the results.
To specify filtering for cube reports
1
In the Process Manager portal, click Reports.
2
Create a new cube report, or open an existing report for editing by selecting
the report’s action icon and clicking Edit.
3
Select a dimension from the Measures and Dimensions section and drop it
in the Filter/Slicer box.
4
(Optional) To further narrow the focus of the filter, select the drop-down for
the filter, set the criteria, and click OK.
5
Click Save.
Customizing cube reports
When you set up cube reports, the appearance of those reports is first determined
by default settings. For example, by default, a chart legend is included in the
report, and the report is created with a certain color selected. Many aspects of
the report’s appearance can be customized to fit your needs.
To customize cube reports
1
In the Process Manager portal, click Reports.
2
Create a new cube report, or open an existing report for editing by selecting
the report’s action icon and clicking Edit.
3
In the Setup tab, use the following options to customize the appearance of
the report.
Tool tip Text
Action
323
324
Reports in Process Manager
Modifying cube reports
4
Select Chart Type
Select this icon to display a drop-down list showing all of
the chart types available. Select one of the chart types to
update the chart in the report.
Toggle Chart Legend
By default, a chart legend is included in all charts. Select
this icon to display or hide the chart legend.
Properties
Select this icon to display the Chart dialog and further
customize the following aspects of the report:
■
Chart
■
Legend
■
Labels
■
Appearance
■
X Axis
■
Y Axis
Select Color Palette
Select this icon to display a drop-down list showing the
different color palettes available. Select one of the color
palettes to update the chart in the report.
Grid Orientation
Select this icon to display a drop-down list from which you
can set your grid orientation as horizontal or vertical.
Show Grid Total
On the Grid tab, select this icon to add a grid total row to
the chart.
Pivots Data
Select this icon to switch the positions of the data that is
displayed in the legend and along the x axis of the chart.
Click Save.
Modifying cube reports
You can modify any report for which you have the appropriate permissions. You
are more likely to spend time modifying existing reports than creating new reports.
Process Manager contains many predefined reports that meet most of your
reporting needs. When you want to make a small change to an existing report,
copy the existing report and make your changes in the new report. By copying
the report instead of making modifications directly to a predefined report, you
can always go back to the original report.
Reports in Process Manager
Setting permissions for reports
To modify a cube report
1
In the Process Manager portal, select Reports.
2
On the Reports page, under Report Categories, select the category that
contains the report that you want to modify.
3
On the right side of the page, click the orange lightning symbol for the report
that you want to modify, and then click Edit.
4
In the Edit Cube Report dialog box, make the necessary changes to the report.
The dialog and tabs for editing and adding cube reports are the same.
See “Creating a cube report” on page 322.
See “Add/Edit Cube Report dialog box” on page 333.
5
Click Save.
Setting permissions for reports
Administrators and users who are assigned the appropriate permissions can set
permissions on a report. Specifying permissions on a report controls access to,
and use of that report. For example, you can determine through permissions what
users or groups can view, edit, delete, or create sub reports for a report.
To set permissions for a report
1
In the Process Manager portal, select Reports.
2
In the Report Categories area, select the category that contains the report
you want to set permissions for.
3
Select the action icon for the report that you want to set permissions for, and
click Permissions.
325
326
Reports in Process Manager
Exporting a report definition
4
5
In the Report Permissions dialog, add, edit, or modify permissions as needed.
You can take multiple actions with permissions.
To edit existing
permissions
Select the edit icon for the permission that you want to
modify. Make the necessary changes to the permission and
click Update.
To remove an existing
permission
Click the delete icon for the permission that you want to
remove.
To add a new
permission
Click Add New Permission. Select the permission type, and
the user, group, permission, or organization you want to
set permissions for. Set the appropriate permissions and
click Add.
Click Close.
Exporting a report definition
Any report definition can be exported to an .xml schema file. When you export a
report definition, the report settings are exported so that the report can be run
from another Process Manager system. The actual report data is not exported
when you use the export report feature. You have the option of saving or viewing
the .xml file. Any user that has access to view a report, has permission to export
it.
To export a report
1
In the Process Manager portal, select Reports.
2
In the Report Categories area, select the category that contains the report
you want to export.
3
Select the action icon for the report that you want to copy, and click Export
Report.
4
In the File Download dialog box, click either of the following options:
Open
Opens the XML file for viewing.
Save
Saves the file on your computer.
Reports in Process Manager
Copying a report
Copying a report
Copying an existing report lets you create a new report that is customized to your
needs, without having to recreate the report settings. You can copy a report that
has almost all of the information you need, and then add, remove, and edit the
report. Modifying the copied report lets you get what you are want in the report.
Administrators, and the users with the appropriate permissions can copy reports.
By default, Administrators can copy a report that is located in any category. Other
users can not copy a report that is in a category for which they do not have
permission to create reports.
To copy a report
1
In the Process Manager portal, select Reports.
2
In the Report Categories area, select the category that contains the report
you want to copy.
3
Select the action icon for the report that you want to copy, and click Copy.
4
In the Report Information dialog, enter a new name for the report in the
Report Name field.
5
Optionally, enter a description for the report in the Report Description field.
The description text you enter appears under the report name on the Reports
tab, when you expand a report entry.
6
Click Save.
Adding reports to a portal page
Any Process Manager reports can be added to a portal page. Administrators and
users with the appropriate permissions to modify portal pages can add reports.
To add a report to a portal page
1
In the Process Manager portal, select the portal page you want to add the
report to.
2
Select Site Actions > Modify Page.
3
Select Site Actions > Add Web Part.
4
Select Reports in the Catalog List..
5
Select the Standard Report Viewer check box to add a standard report or
OLAP Report Viewer to add a cube report.
6
Select the zone that you want to add the report to from the Add to drop-down
list.
327
328
Reports in Process Manager
Creating a scheduled report
7
Click Add. The Report Viewer web part is added to the portal page.
8
Click Close.
9
Click the Report Selection icon and select the report that you want to display
in the Report Viewer web part.
Creating a scheduled report
Scheduled reports are the cube reports that can be specified to run on a set
schedule that the report creator defines.
To create a scheduled report
1
In the Process Manager portal, click Reports > Cube Schedule.
2
Click Add Schedule .
3
In the New Schedule dialog, enter a name for the scheduled report in the
Name field. Scheduled report names must be unique.
4
Select the Active checkbox if you want the report to be run on the schedule
that you set. If you want to save the report definition, and not have it run at
this time, do not select the Active check box.
5
In the Select Type of Schedule drop-down , select how frequently you want
the report to run: daily, weekly, monthly, or one time only.
6
In the Start date and time fields, select the date and time for the initial run
of the report.
7
If you only want the report to run for a limited period of time, select the End
Date checkbox and enter an end date. If you do not set an end date, the report
continues to run on the schedule you have defined.
8
Define when the report should be run: Every day, Weekdays, or Every x
number of days.
9
If you want to run the report more frequently, select Advanced. Set up a
repeating task to run the report every x amount of time for a defined period.
10 Click Add Cube to add a cube to the report.
11 In the Add Schedule Cube dialog box, in the Cube drop-down list, select the
type of cube to add to the report. In the Process Type drop-down list, select
the type of process: Process Default, Process Full, Process Data, Process
Structure, Unprocess, Process Index or Process Incremental.
12 Click Add.
13 Continue to add additional cube and process types to the report as necessary.
Reports in Process Manager
Adding report categories
14 Click Add Dimension to add data fields to the report.
15 In the Add Schedule Dimension dialog, select the data field that you want
to add to the report in the Dimension drop-down list. In the Process Type
drop-down list, select the type of process: Process Default, Process Full,
Unprocess, or Process Data.
16 Click Add.
17 Click Save.
Adding report categories
Report categories assist you in organizing all of the reports that are located on
the Reports page. Organizing the reports in categories helps users find the reports
they need more easily. You can also apply permissions to categories, which deny
or grant access to that category and all the reports within it.
See “Setting report category permissions” on page 331.
To add a report category
1
In the Process Manager portal, click Reports.
2
On the Documents page, under Report Categories, click Add Report Category.
3
In the Category Information dialog box, in the Name text box, type a name
for the category.
4
(Optional) In the Header Text text box, type descriptive text. The text is
displayed under the category name on the right-hand side of the Reports
page when a user selects the category.
5
Click Save.
Adding report sub categories
Report sub categories can assist with further organizing the categories and reports
that are located on the Reports page. You can add sub categories to any category
if you have the necessary permissions to do so.
To add a report sub category
1
In the Process Manager portal, click Reports.
2
On the Reports page, under Report Categories, select the category that you
want to add a sub category to.
3
On the right side of the page, click the orange lightning symbol, and then
click New Sub Category.
329
330
Reports in Process Manager
Deleting report categories
4
In the Category Information dialog box, in the Name text box, type a name
for the sub category.
5
(Optional) In the Header Text text box, type some descriptive text. The text
is displayed under the category name on the right-hand side of the Reports
page when a user selects the category.
6
Click Save.
Deleting report categories
Users with the appropriate permissions can delete report categories. When you
delete report categories, the sub categories and the reports that are contained in
that category are not necessarily deleted. You can make selections during the
deletion process, which determines what happens to the subcategories and the
reports that are contained in a report category.
To delete a report category
1
In the Process Manager portal, click Reports.
2
On the Reports page, under Report Categories, select the category to delete.
3
On the right side of the page, click the Actions symbol (orange lightning),
and then click Delete.
Reports in Process Manager
Setting report category permissions
4
In the Delete Category dialog box, select one of the following options for
handling any sub categories that are contained in the category:
Don’t delete SubCategories
Retains all sub categories that are contained in the
parent category. The sub categories are moved up to
the root level.
Delete SubCategories
Deletes all sub categories that are contained in the
parent category. If reports in that category also belong
to another category, they remain in the other
categories. If reports do not belong to other categories,
they are moved to the Orphan category.
Delete SubCategories and all Deletes all sub categories and the reports they contain.
reports in them
Select one of the following options for handling any reports that are contained
in the category:
Don’t delete reports
Retains all reports that are contained in the category.
Delete reports (that are
linked only to the deleted
category)
Deletes all the reports that are contained in the
category, as long as they are linked only to the deleted
category. If the reports are linked to additional
categories, they are retained.
Delete reports even if linked Deletes all reports that are contained in the category,
to multiple categories
even if they are linked categories other than the one
being deleted.
5
Click Delete.
Setting report category permissions
Report categories assist you in organizing all of the reports that are located on
the Reports page. Organizing the reports in categories helps users find the reports
they need more easily. You can apply permissions to categories, which deny or
grant access to that category and all the reports within it. By default, the category
inherits the permissions of the user who created it. If you want the permissions
to be different for other users of the category, you need to modify the category
permissions.
331
332
Reports in Process Manager
Adding reports to additional categories
To set report category permissions
1
In the Process Manager portal, click Reports.
2
On the Reports page, under Report Categories, select the category that you
want to set permissions for.
3
On the right side of the page, click the orange lightning symbol, and then
click Permissions.
4
In the Category Permissions dialog box, add or modify permissions as needed.
You can take multiple actions with permissions.
To edit existing permissions Select the edit icon for the permission that you want
to modify. Make the necessary changes to the
permission and click Update.
5
To remove an existing
permission
Click the delete icon for the permission that you want
to remove.
To add a new permission
Click Add New Permission. Select the permission type,
and the user, group, permission, or organization you
want to set permissions for. Set the appropriate
permissions and click Add.
Click Close.
Adding reports to additional categories
When you initially add reports to the Reports page, they are contained in a single
category. Users with the appropriate permissions can add reports to additional
categories. A report can belong to an unlimited number of categories.
To add a report to additional categories
1
In the Process Manager portal, click Reports.
2
On the Reports page, under Report Categories, select the category that
contains the report which you want to add to additional categories.
3
On the right side of the page, click the orange lightning symbol for the report
that you want to add to additional categories, and click Categories.
4
In the Report Category Management dialog box, click the Add New Category
tab.
5
Select the category that you want to add the report to and click Add.
6
Click Close.
Reports in Process Manager
Deleting reports
Deleting reports
You can delete any report that you have delete permissions for from the Reports
tab.
To delete a report
1
In the Process Manager portal, click Reports.
2
On the Reports page, under Report Categories, select the category that
contains the report you want to delete.
3
On the right side of the page, click the orange lightning symbol for the report
that you want to delete, and click Delete.
4
Click OK in the confirmation dialog box.
Add/Edit Cube Report dialog box
This dialog box appears when you create a new cube report or edit an existing
cube report.
The Add/Edit Cube Report dialog box contains two tabs.
Table 21-2
Tabs in the Add/Edit Cube Report dialog box
Tab
Description
Setup
Lets you define the data that is included in the report, set up filtering
on that data, and customize the appearance of the report.
Description
(Optional) Lets you enter a description of the report. The description
appears on the Reports tab and gives users an idea of what kind of
data the report contains.
Table 21-3
Options on the Setup tab
Option
Description
Selected Cube
Lets you select the cube that you want the report based on.
When you select a cube, the measures and dimensions for
that cube are displayed.
Measures and Dimensions
Lets you select the measure and dimension that you want
to include in the report. The measures and dimensions that
are included in the report determine the data that is shown
in the report.
333
334
Reports in Process Manager
Add/Edit Standard Report dialog box
Table 21-3
Options on the Setup tab (continued)
Option
Description
Chart
Displays the report in chart form. When you save a report,
whatever view you currently have selected is the type of
report users see.
Grid
Displays the report in grid form. When you save a report,
whatever view you currently have selected is the type of
report users see.
Categories
Lets you drag measures onto this section for display on the
x axis in the report. You can also filter these categories by
clicking the drop-down option on a category and specifying
a filter.
Series
Shows the measures that are included in the report, and lets
you add and delete additional measures by selecting the
drop-down option on a measure.
Filter/Slicer
Lets you drag measures onto this section for filtering the
display of data in the report. You can apply additional filter
criteria by clicking the drop-down option on a filter and
specifying the criteria.
Add/Edit Standard Report dialog box
This dialog box appears when you create or edit a standard report.
The Add/Edit Standard Report dialog box has four tabs.
Table 21-4
Tabs in the Add/Edit Standard Report dialog box
Tab
Description
Report Designer
Lets you specify what data is included in the report and specify options
for that data. You can also specify the sorting and grouping of the
resulting data, and specify columns for the resulting data set.
Table 21-5
Description
Lets you specify a description of the report which is displayed on the
Reports page.
Permissions
Lets you specify the permissions for the report.
Table 21-6
Reports in Process Manager
Add/Edit Standard Report dialog box
Table 21-4
Tabs in the Add/Edit Standard Report dialog box (continued)
Tab
Description
Web Services
Lets you enable Web Service access to the report.
Table 21-7
Table 21-5
Options on the Report Designer tab
Option
Description
Data tab
Lets you specify the type of data that is included in the report.
Grid
Displays the current report in grid view in the report preview
pane. Whichever pane is displayed when you save the report is
the type of report that anyone viewing the report sees.
Chart
Displays the current report in chart view in the report preview
pane. Whichever pane is displayed when you save the report is
the type of report that anyone viewing the report sees.
Auto Preview
Displays a preview of the current report as you build it. Auto
Preview is selected by default.
Limit Results
Limits the result set of the report that is shown in the report
preview pane to 50. The Limit Results option is selected by
default.
Generate
When Auto Preview is not selected, clicking Generate lets you
view the report in the report preview pane with all the changes
you have made.
Columns
Lets you specify the columns that are displayed in the report.
Options tab
Lets you specify the grouping and sorting of the data in the
report.
Limit Rows
Lets you specify the maximum number of rows that are included
in the report. The default number of rows is 50, and users can
configure the number of rows they want to see in the report at
run time.
Use Paging
Lets you specify the number of rows per page in the report.
Sort By
Lets you specify the columns to sort by and whether the data in
those columns should be sorted in ascending or descending order.
Group By
Lets you specify the columns to group by.
335
336
Reports in Process Manager
Add/Edit Standard Report dialog box
Table 21-5
Options on the Report Designer tab (continued)
Option
Description
Group Aggregations
Lets you add group aggregations. Group aggregations summarize
mathematical data at the group level.
Add Aggregation
Lets you add aggregations to the report. Any number of
aggregations are allowed.
Display SQL
Displays the SQL statement for the report.
Table 21-6
Options on the Permissions tab
Option
Description
Rows in the tab
Lists the current permissions that are assigned to the report.
Edit icon
Lets you edit the permissions for that user, group, permission,
or organization.
Delete icon
Lets you delete that permission.
Add New Permission
Lets you add a new permission.
Table 21-7
Options on the Web Services tab
Option
Description
Enabled for
programmatic access
Lets you enable the report for programmatic access. Selecting
this check box displays the fields that you need to specify to set
up Web Service access.
Namespace
The namespace for the WebService and the objects that are used
in the webservice.
Namespace URI
The URI for the namespace.
WebService Name
A name that describes the service.
Class Name
The results of the report are an array of the class name that is
supplied here. The class name has public properties for each of
the columns in the report.
Generate
Compiles the Web Service and deploys it to a URL. The URL is
displayed on the screen and can be used to access the WebService.
When report data changes, you need to generate the WebService
again to update the class.
Reports in Process Manager
Displaying reports in print view
Displaying reports in print view
You can display any report that you have permissions to view in print view. Print
view shows you how the report will look once it is printed.
To display a report in print view
1
In the Process Manager portal, click Reports.
2
On the Reports page, under Report Categories, select the category that
contains the report you want to display in print view.
3
On the right side of the page, click the orange lightning symbol for the report
that you want to display in print view, and click Print View.
Importing report categories
You can import report categories from another instance of Process Manager.
To import a report category
1
In the Process Manager portal, click Reports.
2
On the Reports page, under Report Categories, click Import Category.
3
In the Import dialog box, click Browse and select the report file that you want
to import.
4
Select one of the following options to determine whether Process Manager
overwrites or copies existing reports:
5
■
Overwrite existing reports - Process Manager overwrites reports with the
same report ID
■
Create new copy - Process Manager creates new copies of all the reports
Click Import.
Importing reports
You can import reports from another instance of Process Manager.
To import reports
1
In the Process Manager portal, click Reports.
2
On the Reports page, under Report Categories, select the category that you
want to import reports into.
3
On the right side of the page, click the Add Report icon, and click Import
Reports.
337
338
Reports in Process Manager
Importing reports
4
In the Import dialog box, click Browse and select the report file that you want
to import.
5
Select one of the following options to determine whether Process Manager
overwrites or copies existing reports:
6
■
Overwrite existing reports - Process Manager overwrites reports with the
same report ID.
■
Create new copy - Process Manager creates new copies of all the reports.
Click Import.
Chapter
22
Integrating Process
Manager
This chapter includes the following topics:
■
About Process Manager integration
■
Integrating Process Manager with Workflow Designer
■
Integrating Process Manager with Active Directory authentication
■
Integrating Process Manager with Active Directory information
About Process Manager integration
Process Manager integrates with other applications seamlessly, including
Workflow Designer and Active Directory. This section examines integration
procedures and issues.
See “Integrating Process Manager with Workflow Designer” on page 339.
See “Integrating Process Manager with Active Directory authentication”
on page 340.
See “Setting up workflow task integration with Workflow Designer” on page 226.
Integrating Process Manager with Workflow Designer
Process Manager can be integrated with Workflow Designer for expanded
functionality. Process Manager integration is triggered from Workflow Designer.
See “About Process Manager integration” on page 339.
340
Integrating Process Manager
Integrating Process Manager with Active Directory authentication
To integrate Process Manager with Workflow Designer
1
On the task tray, right-click the task tray application and select Settings.
2
Select the Process Manager server you want to integrate and click Edit.
3
In the Server Extensions section, in the Server Role box, select
LogicBase_ProcessManager and click OK.
This is for design time interaction with Process Manager. When you are
designing a workflow and you use entities in Process Manager (such as users),
this lets the integration happen.
4
In the Process Manager section, in the Port Number box, enter 80.
The default port is 11080, which is used by the internal Web server. To use
the Process Manager in production, change the port number to 80.
5
Click OK.
6
In Workflow Designer, click File > Edit Tool Preferences.
7
From the list on the left pane, select Process Manager.
8
In the right pane, enter the actions you want.
See “Process Manager page” on page 570.
9
Click OK.
10 If you want to use the Process View page in Process Manager, set up Workflow
task integration.
See “Setting up workflow task integration with Workflow Designer”
on page 226.
Integrating Process Manager with Active Directory
authentication
Process Manager can be integrated with Active Directory after the installation of
Process Manager.
See “About Process Manager integration” on page 339.
Integrating Process Manager
Integrating Process Manager with Active Directory authentication
To integrate Process Manager with Active Directory
1
Add a group or add permissions to the All Users group so the users have the
permissions you want.
See “Creating groups” on page 286.
See “Managing Permissions” on page 300.
2
Run the DB Tool.
■
In Windows Internet Explorer, navigate to install path\Altiris\Workflow
Designer\Ensemble.
■
Run dbtool.exe.
3
On the Process Manager DB Setup dialog, check Update Existing Database
and click Proceed.
4
On the DB Integration Status dialog, click Authentication Settings.
5
Check Active Directory Authentication.
6
■
Native Authentication: Uses Process Manager authentication settings for
login.
■
Active Directory Authentication: Uses Active Directory authentication
settings for login.
Enter the following:
Server Path
The address of your Active Directory Server, as either
an IP address or the DNS name.
Domain Name
The domain name of your Active Directory.
Auto Create Users on Initial Select if users are auto-created when they first login
Login
to Process Manager.
Administrator Username
The user name of the account which has access to
connect to the Active Directory and retrieve user
information. This user needs to be a part of the Domain
Admins group on the Active Directory Domain.
Administrator Password
The password for the Administrator User name.
Default User Groups
The default Process Manager groups that new users
are added to. These are the groups that all users are
added to.
Ensemble Admin Username The user name of the Active Directory account that
you want to use as the Process Manager administrator.
341
342
Integrating Process Manager
Integrating Process Manager with Active Directory information
7
Open the Internet Information Services Manager and navigate to the Process
Manager virtual directory.
8
Right-click on the Process Manager virtual directory and select Properties.
9
Select the Directory Security tab.
10 In the Authentication and access control Section, click Edit.
11 Select the Integrated Windows authentication checkbox.
12 Select the Basic Authentication checkbox.
13 Click Yes.
14 Select the Active Directory domain as the Default Domain and Realm.
15 Click OK.
16 Restart IIS.
To test the Active Directory integration
1
Log in to the computer using the Process Manager Administrator ID that you
specified during setup.
2
Open Process Manager in the browser.
If you see the top menu, the installation has been successful.
Integrating Process Manager with Active Directory
information
When you enable Active Directory authentication for Process Manager, you can
manage your Process Manager user information in Active Directory, and import
that information into Process Manager automatically.
See “Integrating Process Manager with Active Directory authentication”
on page 340.
You can configure Process Manager to synchronize with Active Directory on
whatever schedule you want, but by default the sync occurs at midnight every
night. The Active Directory synchronization is done in Workflow Solution. During
Process Manager installation, you can base the user and the group assignments
on your Active Directory configuration. You set up this configuration when you
set up your Active Directory authentication. In addition to the scheduled
synchronization of Process Manager user data with Active Directory user data,
you can also manually add new users from Active Directory. Manually adding a
user is helpful when you want to give a user access to Process Manager without
waiting until the next scheduled synchronization.
Integrating Process Manager
Integrating Process Manager with Active Directory information
Users that are in the Active Directory, but have not yet been added to Process
Manager, either through a synchronization or manually, can still access Process
Manager. For example, a user may exist in the Active Directory, and attempt to
log on to Process Manager. If that user is not recognized as a user, Process Manager
looks up the user in Active Directory and adds them as a Process Manager user.
User and group data that is stored in Active Directory overwrites the user and
the group data that you enter in Process Manager upon synchronization. Because
of the synchronization with Active Directory, keep in mind the following things
when working with data from Active Directory users:
■
Deleting a user from within Process Manager but not from the Active Directory
does not fully delete the user. Users that remain in the Active Directory are
created again in Process Manager during the next synchronization. If you want
to block Process Manager access to an Active Directory user, you need to delete
the user from the Active Directory.
After a user is deleted from Active Directory, they are not deleted from Process
Manager - they are disabled. To fully delete the user and all their associated
information, the Admin would have to remove the user.
■
When you edit information for an Active Directory user from within Process
Manager, it is overwritten by the synchronization. You should do any editing
of Active Directory users from the Active Directory, and the information is
updated in Process Manager during the next synchronization. This rule applies
to the users group, manager, and organizational unit information.
343
344
Integrating Process Manager
Integrating Process Manager with Active Directory information
Section
Example Scenarios
■
Chapter 23. New Employee Set Up Scenario
■
Chapter 24. Scheduling conference room scenario
6
346
Chapter
23
New Employee Set Up
Scenario
This chapter includes the following topics:
■
About new employee set up
About new employee set up
This scenario helps you create and test a project that sets up a new employee.
In most companies, the new employee setup process begins when a member of a
department or business unit contacts the Human Resources department to either
recruit the right person or process a person already chosen. From this initial
contact, a Human Resources employee begins the process of organizing the
business units required to prepare for the new employees arrival. When the new
employee begins their first day of work, everything will be ready for them and
they can begin being productive right away.
Typically, at the start of the process, the employee's name, department, title, and
location will be known. Additional information may be available, such as whether
they are allocated to a project or budget, and possibly an employee number, but
little else. From this point, a verification and approval process is common to
ensure that all business units involved are aware of the new employee, thus keeping
everyone informed. In this scenario, the Human Resources person processing the
employee provides the first information using the My Service Request Console,
and chooses the New Employee Setup item from the Service Catalog. Development
of this scenario is focused on automating building access for the employee.
Step 1: Create a new project
Step 2: Edit the Create Notification Server Credentials component
Step 3: Add and Configure a Workflow Component
348
New Employee Set Up Scenario
About new employee set up
Step 4: Test the Project
Step 1: Create a new project
Workflow packs and custom projects are managed within the Designer loading
window.
To become familiar with using the Designer loading window and continue the
New Employee Setup, perform the following steps to create a new project.
To create a new project
1
Open the Designer loading window by clicking Start Menu > All Programs >
Altiris > Workflow Designer > Workflow Designer.
2
Click File > New Project.
3
In the New project window, select the Workflow symbol.
4
■
The project name can be changed by overwriting the default name in the
Name Field.
■
The local storage option can be changed by clicking on the Browse button
to the right of the Directory box.
To finish project creation, click OK. After clicking OK, Workflow Designer
tool opens.
Step 2: Edit the Create Notification Server Credentials component
To edit the Create Notification Server Credentials component
1
In the right pane, right-click the Create Notification Server Credentials
component and select Edit Component.
2
To enter the Symantec Management Console name, do the following in order:
3
■
In the Notification Server box, click the [...] button.
■
Enter the Symantec Management Console name for the default run time
Symantec Management Console.
■
Click OK.
To enter the Domain, do the following in order:
■
In the Domain box, click the [...] button.
■
Enter the domain for the Symantec Management Console.
■
Click OK.
New Employee Set Up Scenario
About new employee set up
4
5
6
To enter the Symantec Management Console administrator user name, do
the following in order:
■
In the Username box, click the [...] button.
■
Enter the user name login credential for the default Symantec Management
Console. This user name must be an administrator on the Symantec
Management Platform server.
■
Click OK.
To enter the password, do the following in order:
■
In the Password box, click the [...] button.
■
Enter the password for the user entered in the Username box.
■
Click OK.
Click OK.
Step 3: Add and Configure a Workflow Component
To add and configure a workflow component
1
In the Component Toolbox, use the search box to locate the Dialog Workflow
component.
2
Drag the component into the project workspace and add a link between the
Create...Credentials and Dialog Workflow components.
3
Double-click the Dialog Workflow component to edit the parameters.
The Dialog Workflow component has five tabs for configuration. For this
exercise, we will keep most of the default settings and focus on one tab in
particular, the Interaction Setup tab.
4
In the Interaction Setup tab, under the User Interaction section, click the
[...] to the far right of the Dialog Model box.
349
350
New Employee Set Up Scenario
About new employee set up
5
From the Edit Embedded Decision Model window, to build the New Employee
Setup form, add a Form Builder component to the workspace and connect
the Start and Form Builder components.
6
Double-click the component to edit the form and when the Form Builder
dialog box appears asking whether to add an outcome component, click Yes.
7
From the Edit Object dialog box, click Submit and a Submit button is added
to the form.
8
In this form, the following fields are captured and their type is listed next to
each form component that is listed.
■
User Name (TextBox Component)
New Employee Set Up Scenario
About new employee set up
9
■
Start Date (DatePicker Component)
■
Organization Unit (TextBox Component)
■
Location (TextBox Component)
■
Phone Extension (TextBox Component)
■
Equipment Needed (DropDownList Component)
■
Supervisor Name (TextBox Component)
■
Type of Employee (RadioButtonList Component)
Add Label components for each box of information to collect, using the order
listed above, making sure to line them up under each other. This presents
the fields to the workflow approver.
351
352
New Employee Set Up Scenario
About new employee set up
10 Add a Text Box component for each box requiring text entry.
When editing the first Text Box component, notice that an output variable
name is required. Enter a name relevant to the data, without adding spaces
or special characters.
11 After adding and arranging all the text fields, add the Date Picker component
to capture the Start Date.
12 Add a Drop Down List component to capture equipment needs.
This component requires that a list of items be specified for the drop down.
■
Click the [...] to the far right of the Items box. From the Items Array
Variable dialog box, enter Laptop Computer, Desktop Component, and No
Computer as Constant Values, click OK, then click OK again to close the
Edit Object dialog box.
New Employee Set Up Scenario
About new employee set up
13 Add the Radio Button List component, specifying the following options in
the Items Array Variable dialog box: Temporary Employee, Part Time
Employee, Full Time Employee, and Contract Employee.
14 Add a theme to finish the form.
A theme is a form template with a background image and look and feel
settings.
■
In the toolbar, locate and click the theme symbol.
■
From the Select Theme dialog box, highlight the default project theme
option, click the Edit Project Themes button to display the Project Themes
Dialog box, click the Add button to search through the available themes,
and select the 'small white glossy square' theme under Business, Small
Forms.
353
354
New Employee Set Up Scenario
About new employee set up
15 Rearrange your Form elements, if required, to look appropriate with the
theme.
16 Click OK to close the form builder.
New Employee Set Up Scenario
About new employee set up
17 Connect Form Builder and the End components.
18 Click OK to close the embedded model.
19 Configure the Dialog Workflow component by doing the following in order.
■
Click the Event Configuration Tab.
■
Under the Start Configuration section, next to the embedded model called
Start Process, click [...].
This is one place where the project task distribution can be configured.
For this exercise, an email with an embedded link to the form will initiate
the process.
■
Without disconnecting the link between the Start and End components,
add a Send Email component by dragging the component over the
connection string between the two components.
This adds the component into the process without making additional
connections.
20 Configure the email component by setting the From Address, To Address,
and Subject.
355
356
New Employee Set Up Scenario
About new employee set up
21 Set the HTML Content box by clicking on [...] to the far right of the box and
typing the content that will appear as the body of the email.
22 In the Data window, a piece of data called Response Page Link is shown.
Highlight and drag this into the body of the email. When finished updating
the HTML Content, click OK.
This configures a link to the form for the workflow approver to open in
addition to email text.
23 Configure information about the email server by doing the following steps
in order:
■
In the SMTPServer Name box, enter a real server address for the process
to run.
■
Click OK.
■
Click OK one more time to close the Dialog Workflow component.
New Employee Set Up Scenario
About new employee set up
Step 4: Test the Project
To test the project
1
Click the Debug symbol and, in the Running... window, double-click the
Execute command.
The project executes and pauses when it reaches the Dialog Workflow
component. This is because the form must be filled before continuing
execution.
357
358
New Employee Set Up Scenario
About new employee set up
2
Click the Respond link to open the form, enter the correct information into
the form, and click Submit.
After the test is finished executing, the model appears highlighted through
the End component.
New Employee Set Up Scenario
About new employee set up
359
360
New Employee Set Up Scenario
About new employee set up
Chapter
24
Scheduling conference
room scenario
This chapter includes the following topics:
■
About conference room scheduling
About conference room scheduling
This scenario helps you create a project that lets users login, check for availability,
and reserve a conference room for use. This has one step of approval –the facilities
manager accepts or rejects the request.
This scenario uses Process Manager to manage users and set up the conference
room schedules.
When Process Manager is installed, there are two users automatically created:
Admin and Guest. The Admin user has full rights for all areas of Process Manager.
The Guest user has no permissions and no password. An administrator can grant
permissions to the Guest user as needed.
Step 1: Setting up
Step 2: Create a Workflow project of type Form Start
Step 3: Publish the Form Start project to Process Manager
Step 4: View the project (as a service) in Process Manager
Step 5: Request to book the conference room
Step 6: View the status of a workflow process
Step 7: Approve the request for the conference room
Step 8: Check the schedule for the conference room
362
Scheduling conference room scenario
About conference room scheduling
Step 1: Setting up
This project has some set up steps you should perform for the conference room
scheduling scenario. You need to create a facilities manager user and assign that
user to the Facilities group. You also need to create a user and assign to a group.
You then need to create a schedule for the conference room. You also need to
integrate Process Manager with Workflow Designer. These steps should be done
using an administrator account in Process Manager.
To create a facilities manager user
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > Manage Users.
2
Create a user for facilities manager (named "Facilities Manager").
See “Creating a new user” on page 290.
To create a Facilities group
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > List Groups.
2
Create a group named "Facilities".
See “Creating groups” on page 286.
The Facilities group must have permissions to view the KB, the Workflow
task list, and the Service Catalog.
See “Managing Permissions” on page 300.
3
In the left pane, select the Facilities group.
4
Add the Facilities Manager user to the Facilities group.
See “Adding users to groups” on page 288.
To create a user
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > Manage Users.
2
Create a user for scheduling the conference room (named "Booking User").
See “Creating a new user” on page 290.
Scheduling conference room scenario
About conference room scheduling
To create a Booking group
1
On the Process Manager home page, on the Admin tab, select Users >
Accounts > List Groups.
2
Create a group named "Booking".
See “Creating groups” on page 286.
The Booking group must have permissions to view the KB, the Workflow task
list, and the Service Catalog.
See “Managing Permissions” on page 300.
3
In the left pane, select the Booking group.
4
Add the Booking User to the Booking group.
See “Adding users to groups” on page 288.
To create a schedule for the conference room
1
On the Process Manager home page, on the Knowledge Base tab, select
Schedules.
2
Add a schedule called "Main Conference Room".
See “To add a schedule” on page 264.
To set up Workflow Designer to integrate with Process Manager
◆
Integrate Process Manager with Workflow Designer
■
On the task tray, right-click the task tray application and select Settings.
■
Select the Process Manager server you want to integrate and click Edit
(For example, local).
■
In the Server Extensions section, in the Server Role box, select
LogicBase_ProcessManager and click OK.
This is for design time interaction with Process Manager. When you are
designing a workflow and you use entities in Process Manager (such as
users), this lets the integration happen.
■
In the Process Manager section, in the Port Number box, enter 80.
The default port is 11080, which is used by the internal Web server. To
use the Process Manager in production, change the port number to 80.
■
Click OK.
■
Click OK.
See “Integrating Process Manager with Workflow Designer” on page 339.
363
364
Scheduling conference room scenario
About conference room scheduling
Step 2: Create a Workflow project of type Form Start
This project should start with a form that is a Form Start workflow. This form
lets the user select the date and time for booking the conference room. Add a
second dialog workflow component that lets the facilities manager approve or
reject the request.
Each Workflow component gets added as a task in Process Manager when you
publish the project to Workflow Manager. You can set up assignments to persons,
groups, organizational units, workflow queues, and permissions for performing
each task in Process Manager.
To create a Conference Room Booking project
1
In Workflow Designer, create a Workflow project and name it
"ConferenceRoomBooking".
Step 1: Setting up
2
3
Make the project a Form Start type by doing the following:
■
In the Workflow Designer tool, in the Project pane, select the project name
(ConferenceRoomBooking).
■
In the right pane, click the Publishing tab.
■
Scroll down to the Workflow Type section and check Form Start.
Make sure that run time access to Process Manager is set up by doing the
following:
■
In the right pane, click the Properties tab.
■
Make sure that the following properties are listed:
EnsembleURL –contains the URL for accessing Process Manager. (Example:
$(MachineDefaultEnsembleURL))
EnsemblePASSWORD –contains the password for accessing Process
Manager. (Example: $(MachineDefaultEnsemblePassword))
EnsembleUSERID –Contains the user ID for accessing Process Manager.
(Example: $(MachineDefaultEnsembleUserID))
These properties should appear because they are added when you set up
Workflow Designer to integrate with Process Manager.
See “To set up Workflow Designer to integrate with Process Manager”
on page 363.
■
If these properties are not listed, restart Server Extensions (on the task
tray, right-click the task tray application and select Restart Server
Extensions).
It may take a few moments for these properties to appear.
Scheduling conference room scenario
About conference room scheduling
4
In the Workflow Designer tool, in the Project pane, select the primary model
(Model:Primary).
5
In the workspace, delete the Create Notification Server Credentials
component.
You do not need this component for the scenario.
6
Add a Dialog Workflow component to your project.
This is the first of two Dialog Workflow components you are to add to your
project.
7
In the first Dialog Workflow component, in the Assignments tab, in the Task
Name box, enter "Conference Room Request". This name appears in Process
Manager.
8
In the Task Description box, enter a description for the task that appears in
Process Manager. For example, "User requests the main conference room".
9
In the first Dialog Workflow component, create a form that lets a user request
to book the conference room.
See “To create a Dialog Model for the first Dialog Workflow component”
on page 368.
10 Add a second Dialog Workflow component to your project.
11 In the second Dialog Workflow component, in the Assignments tab, in the
Task Name box, enter "Approve/Reject Conference Room Request". This
name appears in Process Manager in the task list for the facilities manager.
12 In the Task Description box, enter a description for the task that appears in
Process Manager. For example, "Someone has requested to use the main
conference room. Please review and either approve or reject their request."
365
366
Scheduling conference room scenario
About conference room scheduling
13 In the Assignments tab, in the Task Source Type box, select
ProcessManagerTaskSource.
14 In the Assignments tab, view the Task Assignments section.
These assignments all come from Process Manager. They are available in the
component because we set up integration between Process Manager and
Workflow Designer.
We already set up the users in Process Manager in Step 1: Setting up. The
users we added in Process manager now appear for this component when we
search in the Task Assignments section.
See “Managing users” on page 295.
See “Managing a user’s groups” on page 296.
See “Managing a user’s permissions” on page 296.
See “Managing a user’s organizations” on page 297.
15 Set up the Person Assignment for the facilities manager user by doing the
following:
Scheduling conference room scenario
About conference room scheduling
■
In the Dialog Workflow component, in the Assignments tab, in the Person
Assignments box, click the [...] button.
■
Click Add and select From List.
■
Select the Facilities Manager user and click OK.
■
Click OK.
You can optionally add the Facilities group in the Group Assignments box
instead of the Facilities Manager user in the Person Assignments box. All
users in the Facilities group are then allowed to use this task to approve and
reject conference room requests.
16 In the Assignments tab, in the Task Type box, select Approval.
This Dialog Workflow component becomes an Approval task type because
the purpose of this task is to approve or reject a request.
17 In the second Dialog Workflow component, create a form that lets the facilities
manager approve or reject the request.
See “To create a Dialog Model for the second Dialog Workflow component”
on page 371.
18 Add a AddScheduleEntry component to your project.
Add this after the second Dialog Workflow component. This component adds
the booking to the Main Conference Room schedule.
■
In the AddScheduleEntry component, in the Inputs tab, in the Schedule
Source box, select From Picker.
■
In the Schedule box, click the [...] button, select Main Conference Room,
and click Select.
■
In the Schedule Entry Title box, click the [...] button and select the title
for the schedule entry (for example, select Process Variables, then Add,
then select ConferenceRoomReason).
This is the title that gets placed on the calendar date.
■
In the Start Date box, click the [...] button, choose Process Variables, click
Add, and select RequestedDate.
■
In the End Date box, click the [...] button, choose Process Variables, click
Add, and select RequestedDate.
■
Click OK.
19 Save the project.
367
368
Scheduling conference room scenario
About conference room scheduling
To create a Dialog Model for the first Dialog Workflow component
1
In the first Dialog Workflow component, in the Interaction Setup tab, in the
Dialog Model box, click the [...] button.
See “Dialog Workflow”on page 447 on page 447.
2
In the workspace, add a Form Builder component.
3
Create a button (the output path for the Form Builder component) called
"Request Conference Room".
Scheduling conference room scenario
About conference room scheduling
4
Add the components you want to your form.
The components used in the example form are:
LabelComponent
Lets you label the screen and fields and ask the
questions you want.
TextBoxComponent
Provides one line of space for the user to enter text.
This is used to enter the user’s email address. Name
the output name for this component
"requester_email_address" and make the output
path Required.
DateTimePickerComponent
Lets the user choose the date and time for the
request. This is used to enter the requested date
and time. Name the output name for this
component "RequestedDate" and make the output
path Required.
369
370
Scheduling conference room scenario
About conference room scheduling
MultilineTextBoxComponent
5
Click OK.
Provides multiple lines of space for the user to
enter text. This is used to enter the reason for the
request. Name the output data for this component
"ConferenceRoomReason" and make the output
path Required.
Scheduling conference room scenario
About conference room scheduling
6
Connect the Form Builder component with the Start and End components.
7
Click OK.
To create a Dialog Model for the second Dialog Workflow component
1
In the second Dialog Workflow component, in the Interaction Setup tab, in
the Dialog Model box, click the [...] button.
See “Dialog Workflow”on page 447 on page 447.
2
In the workspace, add a Form Builder component.
■
Create two buttons (the output paths for the Form Builder component),
one called "Approve" and the other called "Reject".
■
Add the components you want to your form.
The main component used in the example form is:
LabelComponent
■
Lets you label the screen and fields and ask the questions
you want.
Add the appropriate variables next to the label components.
The variables used in the example form are:
requester_email_address
The output variable from the TextBoxComponent
next to the Enter your email address box in the
first Dialog Workflow component form. After you
drag and drop requester_email_address to your
form, in the Build Wizard, select LabelBuilder
[String].
371
372
Scheduling conference room scenario
About conference room scheduling
■
3
RequestedDate
The output variable from the
DateTimePickerComponent in the first Dialog
Workflow component form. After you drag and
drop RequestedDate to your form, in the Build
Wizard, select LabelBuilder [String].
ConferenceRoomReason
The output variable from the
MultilineTextBoxComponent under the Why do
you need the conference room? box in the first
Dialog Workflow component form. After you drag
and drop ConferenceRoomReason to your form, in
the Build Wizard, select LabelBuilder [String].
Click OK.
Add other components around the model to improve security and notify
requester.
See “To add other components to Dialog Model of second Dialog Workflow
component” on page 372.
To add other components to Dialog Model of second Dialog Workflow component
1
In the second Dialog Workflow component, in the Interaction Setup tab, in
the Dialog Model box, click the [...] button.
See “Dialog Workflow”on page 447 on page 447.
2
Add the following components to your dialog model as wanted:
These components help you secure your process and send email to appropriate
persons. In your working processes, you should consider setting timeouts
less than the default of 180 days. This scenario keeps the timeout defaults.
Scheduling conference room scenario
About conference room scheduling
Ensemble Login Component Detects if you already have a valid session. If not, it asks for the user to log in to
Process Manager. This provides an active session token that can be used in your
process.
GetGroupByName
Retrieves the Facilities group. This component is needed to verify that the user is a
member of the Facilities group.
■
In the project, create a property called ApproverGroupName and give it the value
of "Facilities".
See “Properties tab”on page 557 on page 557..
Inputs tab, Parameters section, name box - The value source of Process Variables
should be set to [ProjectProperties].ApproverGroupName.
■ Outputs tab, Outputs section, Result box - The value should be set to
"FacilitiesGroup". This helps you find the variable when using it in the
GetUsersInGroup component.
■
GetUsersInGroup
Retrieves the users in the Facilities group. This component is needed to verify that
the user is a member of the Facilities group.
Inputs tab, Parameters section, group ID box - The value source of Process
Variables should be set to [FacilitiesGroup.GroupID]. This was the output from
the GetGroupByName component.
■ Outputs tab, Outputs section, Result box - The value should be set to
"UsersInGroup". This helps you find the variable when using it in the Item is in
Collection component.
■
373
374
Scheduling conference room scenario
About conference room scheduling
Item is in Collection
Checks that the user logged in to the Ensemble Login Component is found in the
Facilities group. If true, proceeds to form. If false, displays some content, sends an
email, and exits.
■
Definition tab, Definition section, Data Type box - "Text" should be selected.
Definition tab, Definition section, Array Variable Name box - "UsersInGroup"
should be selected. This is the array output from the GetUsersInGroup component.
■ Definition tab, Definition section, Item box - The value source of Process Variables
should be set to [EnsembleSecurityToken.Email]. This is the email name that was
entered in the Ensemble Login Component.
■
Display Content
Displays content stating that the logged in user is not allowed to view the form.
Contents tab, Contents section, Message box - A message for the user should be
entered ("You are not authorized to view"). This message is displayed in a dialog
box with a Submit button.
■ Contents tab, Contents section, Title box - A title for the message should be entered
("Authorization Error").
■
Send Email (Send user not
found email to sys admin)
Sends email to system administrator stating that the logged in user does not have
permissions to view form.
Send Email (Send login
failure email to sys admin)
Sends email to system administrator stating that the process failed because the user
could not log in.
Send Email (Send approve
email to requester)
Sends email to requester stating that the request has been approved.
Send Email (Send reject email Sends email to requester stating that the request has been rejected.
to requester)
Scheduling conference room scenario
About conference room scheduling
3
Click OK.
Step 3: Publish the Form Start project to Process Manager
Publish your Form Start project to Process Manager. The published project gets
placed on Workflow Server and a pointer to that project is sent to Process Manager.
Process Manager, like the Symantec Management Console, accesses all projects
from Workflow Server.
To publish a Form Start project to Process Manager
1
In Workflow Designer, select File > Publish Project > Publish to Process
Manager Forms.
2
In the Name box, enter the name you want displayed in Process Manager.
Name the project "Conference Room Booking".
3
In the Category box, select the category (in this case, Default).
4
In the Virtual Folder box, enter the name of the virtual folder that is created
in IIS for this project (in this case, ConferenceRoomBooking).
5
Check Open In New Window to open this project in a new window in Process
Manager.
375
376
Scheduling conference room scenario
About conference room scheduling
6
In the Description box, enter the description you want displayed in Process
Manager.
7
Click OK.
8
Select Yes to use Process Manager workflow persistence. This stores workflow
data in Process Manager while the process is running.
9
Click Save (all of the defaults on the Application Properties Editor are alright
for our purposes).
Step 4: View the project (as a service) in Process Manager
Published workflow projects can be viewed as processes in Process Manager.
To view the project (as a service) in Process Manager
1
Login to Process Manager using the Facilities Manager credentials.
2
In Process Manager, select Admin > Service Catalog and find the Conference
Room Booking service.
3
Next to the Conference Room Booking service, click the orange lightning
symbol and select View Form.
Step 5: Request to book the conference room
Any user who has permissions to view the Conference Room Booking service in
the Service Catalog can book a conference room.
Scheduling conference room scenario
About conference room scheduling
To request to book the conference room
1
Log in to Process Manager using the Booking User credentials.
2
In Process Manager, select Workflow.
3
In the left pane, open Service Catalog.
4
Click the Conference Room Booking link.
5
Fill in the request form.
Step 6: View the status of a workflow process
The Facilities Manager can check the status of the process.
377
378
Scheduling conference room scenario
About conference room scheduling
To view the status of a workflow process
1
Login to Process Manager using the Facilities Manager credentials.
2
In Process Manager, select Workflow.
3
In the left pane, select My Tasks.
4
In the right pane, find the Approve/Reject Conference Room Request task.
The task information is displayed.
Step 7: Approve the request for the conference room
The Facilities Manager can approve the request if the conference room if
appropriate.
To accept the request for the conference room
1
Login to Process Manager using the Facilities Manager credentials.
2
In Process Manager, select Workflow.
3
In the left pane, select My Tasks.
4
In the right pane, click the Respond symbol to open the Approve/Reject
Conference Room Request task.
5
Approve the request.
Scheduling conference room scenario
About conference room scheduling
Step 8: Check the schedule for the conference room
The Facilities Manager can check the schedule for the conference room at any
time.
To check the schedule for the conference room
1
Login to Process Manager using the Facilities Manager credentials.
2
In Process Manager, select KB > Schedules.
3
In the left pane, select the Main Conference Room schedule.
4
In the calendar, view the schedule items for the Main Conference Room.
379
380
Scheduling conference room scenario
About conference room scheduling
Section
Reference Material
■
Chapter 25. Component properties
7
382
Chapter
25
Component properties
This chapter includes the following topics:
■
Common tabs throughout components
■
Components
Common tabs throughout components
Every component in Workflow Designer has an editor. You can view and edit a
component's properties in its editor. You open the editor by double-clicking the
component, or on some components (such as Form Builder) you open the editor
by right-clicking the component and clicking Edit Component. The contents of
the editor depend on the function of the component. Different components have
different functions, so different properties appear in their editors. This section
includes the following topics:
■
Settings tab in all components
■
Deployment Server tab in deployment components
■
Notification Server tab in Symantec components
■
Message Listeners tab in some components
Settings tab in all components
All components have a common Settings tab available when you edit the
component. Because it is available in all components, the Settings tab is
documented here.
384
Component properties
Common tabs throughout components
Option Name
Description
Component Class
Name
The class name of this component. This is not editable. This is useful
if you call Symantec support.
Description
The description of this component. This lets you describe how the
component is used. You can use it to provide any wanted
documentation for this component. This description is included in
model reports that are created when you click Plugins > Generate
Business Model.
When you click the [...] button, you can open the value source selector
and enter the description.
Location
The physical location of the top left point of this component on the
workflow model.
Name
The name of this component. You can change the name if wanted. If
you changed the component name when you double-clicked it on the
workflow model, it is reflected here.
Override
Lets you change the background color of this component.
Background Color
When you click the [...] button, you can open the value source selector
to change the background color.
To Do
A text string, generated by you, that contains anything that you want
to remember about this component. The string in the To Do option
appears at the bottom of the component editor and when you validate
a component. When any text is in this option, a checklist symbol
appears on the component in the workflow model.
When you click the [...] button, you can enter text in this option.
Is Enabled
Lets you enable or disable this component. By default, components
are enabled. When a component is disabled, it has no affect on the
project. When a component with more than one outcome path is
disabled, you must choose the outcome path for the component to
take.
When you clear the Is Enabled checkbox, the component is disabled.
If the component has more than one outcome path, click the Execution
Outcome list and select the outcome path for the workflow to follow.
If the component has output parameters, you must configure all output
parameters with fixed data to pass on. This configuration can be
performed in the Disabled Mapping option. When you click the [...]
button, you can open the value source selector and add the wanted
value for each output parameter.
Component properties
Common tabs throughout components
Context tab in Active Directory components
Most Active Directory components have a common Context tab available when
you edit the component. Because it is available in most Active Directory
components, the Context tab is documented here.
See “Active Directory components” on page 392.
Option Name
Description
Setup Properties
Input Method
■
Container Type
The branch of the Active Directory tree you want to perform the action
on.
Get Settings From The Default Properties
Use the Active Directory settings in the project properties.
■ Custom Settings
Use unique Active Directory settings for this component only.
When this is clicked, Server, Server Port, Authentication Token,
and Domain fields appear.
Server: The name of the Active Directory server.
Server Port: The port that Active Directory uses.
Authentication Token: The security token that contains the
Administrator account and the password for the Administrator
account.
Domain:The name of the Active Directory domain.
Organization Path If Organization Unit is selected, this is the path to the organization
to perform the action on.
Deployment Server tab in deployment components
All deployment components have a common Deployment Server tab available
when you edit the component. Because it is available in all deployment components,
the Deployment Server tab is documented here.
See “Design time and run time Deployment Server connection settings” on page 146.
See “Create DS Connection Profile” on page 421.
Option Name
Description
DS Connection
Profile
The DS connection profile for this component. The default is the
DSConnectionProfile global variable.
When you click the [...] button, you can enter or select the DS
Connection Profile as either a Constant Value, Dynamic Value,
Dynamic Model, or Process Variable.
385
386
Component properties
Common tabs throughout components
Option Name
Description
Set DS Credentials Lets you override the default Deployment Server security for this
component.
This should be checked if you have enabled security (in the Deployment
Server Connections plug-in) and want to override that security.
See “Setting design time Deployment Server connection settings”
on page 148.
DS Credentials
The DS credentials to override Deployment Server security for this
component.
When you click the [...] button, you can enter or select the DS
Credentials as either a Constant Value, Dynamic Value, Dynamic
Model, or Process Variable.
Notification Server tab in Symantec components
All Symantec components have a common Notification Server tab available when
you edit the component. Because it is available in all Symantec components, the
Notification Server tab is documented here.
See “Design time and run time Symantec Management Console credentials”
on page 140.
See “Create Notification Server Credentials” on page 424.
Option Name
Description
Notification Server The address of the run time Symantec Management Platform server.
Address
By default, the Notification Server Address option uses the Notification
Server token. Notification Server is only updated in the Create
Notification Server Credentials component.
When you click the [...] button, you can open the value source selector
and change the default.
Security Token
The Domain, User Name, and Password of the run time Symantec
Management Console.
By default, the Security Token is a reference to
NSAuthenticationToken.
At run time, when a component that communicates with the Symantec
Management Console runs, the component gives itself to the Security
Token and the Security Token sets up the credentials that are required
for the Workflow Server-to-Symantec Management Console
relationship to happen.
Component properties
Components
Message Listeners tab in some components
The Message Listeners tab is available in some components.
Option Name
Description
Allow Exit Via
Message
Monitoring
Allows for an exit (output path) in the component when a message by
another application or project is received. Each message created places
a unique output path in the component.
Each component that has message listening turned on receives
messages from Microsoft Exchange and if the message matches the
Path Name, the output path for that message is used.
You can use the Send Complete Workflow Message component to place
messages into Microsoft Exchange.
See “Send Complete Workflow Message” on page 524.
Message
Responses
When Add is clicked, the Edit Object dialog box opens.
Path tab
Path Name: The property path name. This is the name of the output
path that is added to the Workflow component.
■ Path Data tab
Empty Message: Allows message data when unchecked.
Payload Data Type: The message datatype from the other
application or project.
Variable Name: The message variable name. This is the name of
the variable that contains the message data.
■
Components
This section includes the following topics:
■
Active Directory components
■
Add Computer To Organization Unit
■
Add Group To Group
■
Add Group To Organization Unit
■
Add Group To Share
■
Add Items To Collection
■
Add New Data Element
■
Add Organization Unit To Organization Unit
387
388
Component properties
Components
■
Add User To Group
■
Add User To Organization Unit
■
Add User To Share
■
Add Ticket Comment
■
Add Values
■
Approval Workflow
■
AsciiMergeLabelComponent
■
Assign Manager To Computer
■
Assign Manager To Group
■
Assign Manager To Shared Folder
■
Assign Manager To User
■
Compare Numbers Rule
■
Configurable Auto Start
■
Create Anonymous Access Token
■
Create Basic Authentication Token
■
Create Collection
■
Create Computer
■
Create Default Access Token
■
Create DS Connection Profile
■
Create Group
■
Create Kerberos Authentication Token
■
Create Notification Server Credentials
■
Create Organization Unit
■
Create Resource
■
Create Shared Folder
■
Create Ticket
■
Create User
■
Date Greater Than
■
DatePickerComponent
■
Date Range Rule
Component properties
Components
■
Decision Path Component
■
Delete Computer
■
Delete Group
■
Delete Organization Unit
■
Delete Shared Folder
■
Delete User
■
Dialog Workflow
■
Display Content
■
Embedded Merge
■
End component
■
Exception Trigger
■
Exception Trigger By Component
■
Exception Trigger By Components
■
Exception Trigger By Exception Type
■
Find Help Desk Contact
■
Folder Watch Start
■
For Each Element in Collection
■
Form Builder
■
Gain Approval
■
Get All Children For Parent Ticket
■
Get All Users And Groups
■
Get Computer
■
Get Computer List
■
Get Current Date
■
Get Folder Permission List
■
Get Group List
■
Get Groups For User
■
Get Job
■
Get Number From String
■
Get Organization Units List
389
390
Component properties
Components
■
Get Scheduled Job
■
Get Help Desk Assets For Contact
■
Get Help Desk Contact Manager
■
Get Share Permission List
■
Get Shared Folders List
■
Get Task Definition from Task
■
Get Ticket Status
■
Get User List
■
Get Users in Group
■
Global Logging Capture
■
Hanging Path Trigger
■
Hanging Path Trigger By Components
■
Hanging Path Trigger By Path
■
HTMLMergeComponent
■
Initialize Data
■
LabelComponent
■
List Computers
■
List Jobs In Folder
■
List Schedules For Job
■
Matches Rule
■
Move Object To Container
■
New File Auto Start
■
Number Range Rule
■
Password String Generator
■
Quick Link Dialog Workflow
■
Remove Computer from Organization Units
■
Remove Group from Group
■
Remove Group from Organization Units
■
Remove Group from Share
■
Remove Manager from Computer
Component properties
Components
■
Remove Manager from Group
■
Remove Manager from Shared Folder
■
Remove Manager from User
■
Remove Organization Unit out of Organization Unit
■
Remove User from Group
■
Remove User from Organization Units
■
Remove User from Share
■
Reset User Password
■
Run Job On Computer
■
Schedule Job On Computer
■
Send Email
■
Setup Process
■
Send Complete Workflow Message
■
Set Ticket Status
■
Single Value Mapping
■
Start component
■
Subtract Days
■
Terminate Window and Close Dialog
■
TextBoxComponent
■
True False Rule
■
Update Computer
■
Update Group
■
Update Organization Unit
■
Update Shared Folder
■
Update User
■
Wait For All Workflow Components (Merge)
■
Wait For Ticket Change
■
Wait On External Event
391
392
Component properties
Components
Active Directory components
All Active Directory components are located in the Active Directory library. You
need to import the Active Directory library into the project before you can use
any Active Directory components.
When any Active Directory component is first dragged onto the project workspace,
several pop-ups appear. Each pop-up informs you about a project global property
that is about to be created for this component. These project global properties are
used by the Active Directory components and are only created once. After the
Active Directory project global properties are created, you need to edit them for
your environment.
See “Project Global Properties” on page 549.
See “Create Kerberos Authentication Token” on page 424.
The following Active Directory project global properties are created.
■
ADDomainName
The domain containing the Active Directory administrator account using the
following format: sub-domain.root-domain.xxx
■
ADServer
The name of the domain controller for the domain.
■
ADDomainAdminUser
The user name for an account in the Domain Admins group. The administrator
account is used to pull data from Active Directory. The default value is
“Administrator”.
■
ADDomainAdminPassword
The password of the administrator account. The default value is the default
password for the administrator account.
■
ADServerPort
The port used by the domain controller for Kerberos protocol authentication.
The default value is 0, which causes Workflow Designer to use the default port
for Active Directory (port 88). However, any port number can be entered.
The following are the Active Directory components that are added from the
ActiveDirectory library:
■
Add Computer To Organization Unit
■
Add Group To Group
■
Add Group To Organization Unit
■
Add Group To Share
■
Add Organization Unit To Organization Unit
Component properties
Components
■
Add User To Group
■
Add User To Organization Unit
■
Add User To Share
■
Assign Manager To Computer
■
Assign Manager To Group
■
Assign Manager To Shared Folder
■
Assign Manager To User
■
Create Computer
■
Create Group
■
Create Kerberos Authentication Token
■
Create Organization Unit
■
Create Shared Folder
■
Create User
■
Delete Computer
■
Delete Group
■
Delete Organization Unit
■
Delete Shared Folder
■
Delete User
■
Get All Users And Groups
■
Get Computer List
■
Get Folder Permission List
■
Get Group List
■
Get Groups For User
■
Get Organization Units List
■
Get Share Permission List
■
Get Shared Folders List
■
Get User List
■
Get Users in Group
■
Move Object To Container
■
Password String Generator
393
394
Component properties
Components
■
Remove Computer from Organization Units
■
Remove Group from Group
■
Remove Group from Organization Units
■
Remove Group from Share
■
Remove Manager from Computer
■
Remove Manager from Group
■
Remove Manager from Shared Folder
■
Remove Manager from User
■
Remove Organization Unit out of Organization Unit
■
Remove User from Group
■
Remove User from Organization Units
■
Remove User from Share
■
Reset User Password
■
Update Computer
■
Update Group
■
Update Organization Unit
■
Update Shared Folder
■
Update User
Add Computer To Organization Unit
This component adds a computer to an Organization Unit in Active Directory.
See “Active Directory components” on page 392.
Table 25-1
Output Paths
Option
Description
Added
This path is followed if a computer was added to an Organization Unit
in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Component properties
Components
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Computer Name
The name of the computer to add to the Organization Unit.
Input
■
Organization Unit Name
The name of the Organization Unit to add the computer to.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Add Group To Group
This component adds a group to a group in Active Directory.
See “Active Directory components” on page 392.
Table 25-2
Output Paths
Option
Description
Added
This path is followed if a group was added to a group in Active
Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Target Group Name
The name of the target group.
Input
■
Group To Add Name
The name of the group to add to the target group.
395
396
Component properties
Components
Tab name
Options with descriptions
Output
■
Settings
See “Settings tab in all components” on page 383.
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Add Group To Organization Unit
This component moves a group to a different organization unit in Active Directory.
See “Active Directory components” on page 392.
Table 25-3
Output Paths
Option
Description
Moved
This path is followed if a group was moved to a different organization
unit Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Group Name
The name of the group that you want to move.
Input
■
Organization Unit Name
The name of the organization unit to move the group to.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Add Group To Share
This component adds a group to a shared folder on the drive in Active Directory.
Component properties
Components
See “Active Directory components” on page 392.
Table 25-4
Output Paths
Option
Description
Add
This path is followed if a group was added to a share in Active
Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Shared Folder Name
The name of the shared folder to add the group to.
Input
■
Group Name
The name of the group to add to the Active Directory share.
Input
■
Set Security Access To Folder
Allows the same NTFS permissions to be set on the folder as the
Share permissions which are applied in Active Directory.
Full Folder Path: The path of the folder to set the security access
to.
Input
■
Use Domain Admin Credential
Uses the domain administrator credential to add the group to the
share.
Input
■
Administrator Name
If Use Domain Admin Credential is not checked, the administrator
name to use for the credential.
Input
■
Administrator Password
If Use Domain Admin Credential is not checked, the administrator
password to use for the credential.
Input
■
Full Control
If checked, full control is granted to the group on the shared folder.
Input
■
Change
If checked, change control is granted to the group on the shared
folder.
397
398
Component properties
Components
Tab name
Options with descriptions
Input
■
Read
If checked, read control is granted to the group on the shared
folder.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Add Items To Collection
This component lets you add an item to a collection. In Workflow Designer, a
collection is an advanced array, or list of multiple objects of a certain datatype.
The item is added as a row to the array.
Tab name
Options with descriptions
Definition
■
Data Type
The datatype of your collection. This lets Workflow Designer
customize your input information to fit the collection.
Definition
■
Array Variable Name
The variable name that stores the collection to which to add
information. The collection must be pre-defined in your project,
and, therefore, available as a variable.
See “Add New Data Element” on page 398.
Definition
■
Items To Add
The items (variables, arrays, or constant values) to add to your
collection. You can also create a Dynamic Model that outputs the
items that you want added to your collection.
Settings
See “Settings tab in all components” on page 383.
Add New Data Element
This component is used to add data to a variable. This gives you a quick way to
create any type of variable to be used throughout your workflow. Every component
that is down the path of this component can use its output variable.
Component properties
Components
This component not only lets you add new data, it also lets you change the value
of an existing variable. To do this, you should select a variable as the Variable
Name and the data in the Value option replaces the data in the chosen variable.
If the Value option is left blank, the variable data gets cleared.
This component can be used to populate the IP address (or fully qualified domain
name) of the run time Symantec Management Console. If used for this purpose,
this component is normally used with the Create Basic Authentication Token
component to set up the full authentication (the Symantec Management Console
IP address and authentication credentials) that components can use to access the
run time Symantec Management Console.
Generally, if you use the Create Notification Server Credentials component, you
do not need to use this component to create a Symantec Management Console IP
address variable. However, you may use an output Symantec Management Console
IP address variable generated by this component at any place in your workflow
instead of the output Symantec Management Console variable generated by the
Create Notification Server Credentials component.
One way you can use this component is for forms validation. You can set the
component data to logical and the Value to true. Then, in a form, the output
variable can be analyzed to see if data was entered into an option.
See “Create Basic Authentication Token” on page 418.
Tab name
Options with descriptions
Configuration
■
Definition
Data Type: The type of your variable. You may choose from many
variable types, including string and long (decimals).
Is Array: If checked, the variable you want to write is in array
format (contains multiple instances of the same variable type).
Value: The value you want for your variable. This is how you
initialize your variable. The value or values you can enter depend
on the datatype you chose and whether or not it is an array.
Configuration
■
Output Variables
Variable Name: The variable name you want to use to store your
value. You can use a new variable name or the name of an already
created variable. The variable type of an already created variable
must match the datatype you chose.
Settings
See “Settings tab in all components” on page 383.
399
400
Component properties
Components
Add Organization Unit To Organization Unit
This component moves an organization unit to another organization unit in Active
Directory.
See “Active Directory components” on page 392.
Table 25-5
Output Paths
Option
Description
Moved
This path is followed if an organization unit was moved to another
organization unit in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Organization Unit Name
The name of the target organization unit.
Input
■
Destination Organization Unit Name
The name of the destination organization unit.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Add Ticket Comment
This component lets you add a comment to a ticket.
Tab name
Options with descriptions
Configuration
■
Incident Number
The incident number to add the comment to when you click the
[...] button. You can choose a constant or variable value (such as
the output variable for the Create Ticket component).
Component properties
Components
Tab name
Options with descriptions
Configuration
■
Comment
The comment you want to add to the incident. When you click the
[...] button, you can add variables to the comment.
Notification Server See “Notification Server tab in Symantec components” on page 386.
Settings
See “Settings tab in all components” on page 383.
Add User To Group
This component adds a user to a group in Active Directory.
See “Active Directory components” on page 392.
Table 25-6
Output Paths
Option
Description
Added
This path is followed if a user was added to a group in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
User Name
The name of the user to add to the group.
Input
■
Group Name
The name of the group to add to the user to.
Input
■
Set Primary
If checked, sets the primary contact for the group.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
401
402
Component properties
Components
Add User To Organization Unit
This component moves a user to a different organization unit in Active Directory.
See “Active Directory components” on page 392.
Table 25-7
Output Paths
Option
Description
Moved
This path is followed if a user was moved to a different organization
unit Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
User Name
The name of the user that you want to move.
Input
■
Organization Unit Name
The name of the organization unit to move the user to.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Add User To Share
This component adds a user to a shared folder in Active Directory.
See “Active Directory components” on page 392.
Table 25-8
Output Paths
Option
Description
Add
This path is followed if a user was added to a share in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Component properties
Components
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Shared Folder Name
The name of the shared folder to add the user to.
Input
■
User Name
The name of the user to add to the share.
Input
■
Set Security Access To Folder
Allows the same NTFS permissions to be set on the folder as the
Share permissions which are applied in Active Directory.
Full Folder Path: The path of the folder to set the security access
to.
Input
■
Use Domain Admin Credential
Uses the domain administrator credential to add the user to the
share.
Input
■
Administrator Name
If Use Domain Admin Credential is not checked, the administrator
name to use for the credential.
Input
■
Administrator Password
If Use Domain Admin Credential is not checked, the administrator
password to use for the credential.
Input
■
Full Control
If checked, full control is granted to the group on the shared folder.
Input
■
Change
If checked, change control is granted to the group on the shared
folder.
Input
■
Read
If checked, read control is granted to the group on the shared
folder.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
403
404
Component properties
Components
Add Values
This component lets you add two separate values and returns the sum.
Component Toolbox Path - Math; Process Components > Math
Tab name
Options with descriptions
Configuration
■
First Value
The first value to add. When you click the [...] button, you can
choose a constant or variable value.
A variable array value can be selected when you drill into the array
and select a value.
Configuration
■
Second Value
The second value to add. When you click the [...] button, you can
choose a constant or variable value.
A variable array value can be selected when you drill into the array
and select a value.
Configuration
■
Output Variable Name
The output variable name.
A variable array value can be selected when you drill into the array
and select a value.
Settings
See “Settings tab in all components” on page 383.
Approval Workflow
This component lets users propose, accept, and reject workflow processes.
Processes, after they are proposed, can either be accepted and allowed to begin,
rejected and blocked from proceeding, or, if the user does not return a decision,
can timeout.
For example, if you have a new database action, you may want administrators or
project users to accept it before it runs. Therefore, you would use the Approval
Workflow Component to ask users to accept or reject your process before it
executes.
Table 25-9
Output Paths
Option
Description
accepted
This path is followed if the workflow process is accepted.
rejected
This path is followed if the workflow process is rejected.
Component properties
Components
Table 25-9
Output Paths (continued)
Option
Description
timed out
If the time in the Timeout Time Span option (in the Event
Configuration tab) is reached, the workflow follows this output path.
Tab name
Options with descriptions
Assignments
■
Task Source Type
The source type for the task.
ActiveDirectoryTaskSource: Uses Active Directory as the source.
AltirisTaskSource: Uses the Altiris task as the source.
DefaultTaskSource: Uses the default task source. Workflow
Solution manages this default task source. The default task source
is primarily used for email.
ProcessManagerTaskSource: Creates this workflow as a task in
Process Manager (for Workflow Solution Advanced users).
SharePointTaskSource: Uses Share Point as the source.
TaskListTaskSource: Uses a list as the task source.
Assignments
■
Require Assignment
Requires this task be assigned to someone or some group. When
selected, this component will not execute unless at least one
assignment is made.
Assignments
■
Task Source Configuration
The Symantec Management Console configuration and
authentication settings.
Assignments
■
Task Name
A descriptive name for the task tied to this component. The name
is displayed in Process Manager and can describe briefly the
operations required to satisfy this workflow component. The name
of the task can be entered directly or when you click the [...] button.
Assignments
■
Task Description
Enter into this option a description for your task. The description
can describe in Process Manager precisely what a user must do to
satisfy this workflow component. The description of the task can
be entered directly or when you click the [...] button.
Assignments
■
Task Priority By Variable Value
Sets the task priority by use of a variable.
405
406
Component properties
Components
Tab name
Options with descriptions
Assignments
■
Assignments
■
Profile Name
If Process Manager is selected as the Integration method, and you
want to attach a Process Manager data profile to this workflow
task, this option is the name of the profile that you want to attach.
Assignments
■
Profile Values
If Process Manager is selected as the Integration method, and you
attached a Process Manager data profile to this workflow task, this
option lets you edit the data mappings of the profile that you
attached.
Assignments
■
Set Late Date And Due Date
If Process Manager is selected as the Integration method, this
option lets you set late and due dates for this workflow task in
Process Manager.
Assignments
■
Created By Use As Project Name
If Process Manager is selected as the Integration method, this
option lets you use the project name for the Process Manager
Created By variable. When this option is unchecked, the Created
By option appears. In the Created By option, you can select the
Created By variable when you click the [...] button.
Assignments
■
On Bad Assignment
If Process Manager is selected as the Integration method, this
option lets you select how to handle the case where the Process
Manager assigned person is not found.
Assignments
■
Person Assignments
Lets you select the person assignments to assign your component's
task to an individual user or individual users in Process Manager.
When you click the [...] button, the value source selector opens.
Task Priority
The priority (urgency) of this Process Manager task. The task for
this component is to enter all data required by the component.
This is available if Task Priority By Variable Value is not selected.
■ Priority
The variable that contains the task priority. When you click the
[...] button, the value source selector opens. This option is available
if Task Priority By Variable Value is selected.
Component properties
Components
Tab name
Options with descriptions
Assignments
■
Group Assignments
Lets you select the group assignments you want to assign a task
in Process Manager. When you click the [...] button, the value source
selector opens.
Assignments
■
Org Unit Assignments
Lets you select the organizational unit assignments you want for
the task in Process Manager. When you click the [...] button, the
value source selector opens.
Assignments
■
Workflow Queue Assignments
Lets you select the workflow queue assignments you want for the
task in Process Manager. When you click the [...] button, the value
source selector opens.
Assignments
■
Permission Assignments
Lets you select the permission assignments you want for this
component's task in Process Manager. When you click the [...]
button, the value source selector opens.
Assignments
■
Respond Page Link Name
The specific label of the response page link. For example, you may
want the response page link to read "Click here to respond to the
process."
Assignments
■
Response Page Link Page Location
The reference to the URL of the response page.
For example, to respond to a proposed process, a user must visit
a specific Web page. Add into this option a variable or a constant
value which contains the URL of the response page.
Assignments
■
Tracking Page Link Name
The specific label of the tracking page link.
For example, you may want the tracking page link to read "Click
here to track progress."
Assignments
■
Respond Display Format
If Process Manager is selected as the Integration method, this
option lets you select the format to display the task response in
Process Manager.
Default: The task response is displayed in a pop-up.
Embedded: The task response is displayed inside the form.
ChildForm: The task response is displayed in a child form.
407
408
Component properties
Components
Tab name
Options with descriptions
Assignments
■
Form Width
If Process Manager is selected as the Integration method, this
option lets you enter the width for the Process Manager form.
Assignments
■
Form Height
If Process Manager is selected as the Integration method, this
option lets you enter the height for the Process Manager form.
Event
Configuration
■
Start Description
A description of the process you want for your Start Process. You
may include specific information on how the process works and
what it does.
Event
Configuration
■
Start Process
The process which is executed at the beginning of your workflow
process. When you click the [...] button, you can create the start
process.
The start process is executed when the workflow process is
approved and before the workflow process itself is executed.
Event
Configuration
■
Escalations
Lets you set escalations for your event. When you click Add, you
can set the escalations. Escalations are events in your workflow
process which cause the workflow to continue or move to a
different level.
Event
Configuration
■
Finish Description
A description of the process you want for your Finish Process.
You may include specific information on how the process works
and what it does.
Event
Configuration
■
Finish Process
The process which is executed at the end of your workflow process.
When you click the [...] button, you can create the finish process.
The finish process is executed when the workflow process is
approved and after the workflow process itself is executed.
Event
Configuration
■
Timeout Type
The timeout type. A process times out when a user does not respond
within a certain date or time span.
Component properties
Components
Tab name
Options with descriptions
Event
Configuration
■
Timeout Date
Sets a specific date when a process times out.
When you click the [...] button, the value source selector opens.
This option contains a reference to a variable within your project
which holds the date you want your process to time out.
This option appears when Date is selected in the Timeout Type
option.
Event
Configuration
■
Timeout Time Span
Sets how long to wait before a process times out. When you click
the [...] button, the value source selector opens.
This option appears when Time Span is selected in the Timeout
Type option.
Event
Configuration
■
Timeout Description
The description for your users of how and why a process times out.
You may include specific information or instructions.
Event
Configuration
■
Timeout Process
Declares a process which is executed when your workflow
component times out.
Message Listeners See “Message Listeners tab in some components” on page 387.
Response
■
Accept Button Text
The text you want to use in the Accept button. This button is used
to accept and begin the proposed workflow process.
Response
■
Accept Response
The text you want displayed when a user accepts a process.
Response
■
Reject Button Text
The text you want to use in the Reject button. This button is used
to reject and prevent the proposed workflow process from
executing.
Response
■
Rejection Response
The text you want displayed when a user rejects a process.
Response
■
Default Reject Reason
The default or standard response if the user does not enter data
and you have required a reason for the rejection.
409
410
Component properties
Components
Tab name
Options with descriptions
Response
■
Reject Reason Label
A brief description that informs users to submit the reason that
the process was rejected.
Response
■
Reject Reason Default Exception Text
The default exceptions to the Reject Reason Required option. If
you set that rejection reasons are required, but want to exclude
some users from this rule, enter a brief description of any
exceptions.
Response
■
Reject Reason Required
If checked, the user is required to supply a reason for the rejection.
Response
■
Reject Reason Variable Name
The variable that contains the reason the user rejected the process.
This variable can be used later by other components in your project.
Response
■
Show Reject Reasons
If checked, the reasons why the user rejected the process are stored
to be used later in the project.
Settings
See “Settings tab in all components” on page 383.
Setup: Page Look
■
Page Title
The title for the Web page created for this component. This is the
Web page that is displayed to the user that requires the user to
accept or reject a workflow process.
Setup: Page Look
■
HTMLLogo URL
The URL of the logo to use in the Web page created for this
component.
Setup: Page Look
■
Item Description
The item description to use on the Web page created for this
component.
Setup: Page Look
■
Show Tracking Link On Page
If checked, the link to the tracking page on the Workflow Approval
page is displayed. This lets users track the progress of the workflow
process from their approval page.
Component properties
Components
AsciiMergeLabelComponent
This component lets you create a label with text merged together using an
advanced text editor. You can use this to assemble and display variable data from
your project. It accepts text in only standard ASCII code.
To validate this component, you must enter text in the Text option on the
Appearance tab.
This component is available in a Forms project by using a form component that
utilizes the Web Form Editor (for example, See “Form Builder” on page 467.).
Tab name
Options with descriptions
Functionality
■
Custom Events
The list of customized events that you want this component to
respond to. When you click Add and scroll to the event name, you
can add an event handler. You can then select the behavior
configuration for the event handler you chose.
Functionality
■
Specify Control ID
Specifies your own control ID. If this option is not selected, an
automatically created control ID is specified for this component.
Functionality
■
Control ID
A unique identifier for this component. This identifies this
component to the Web browser.
Functionality
■
Tab Index
The tab order for this component on the page.
When a user presses the tab key, the curser moves to the
component with the next consecutive numbered Tab Index on the
form.
Functionality
■
Tab Stop
Select to allow this component to be a tab stop. If this is cleared,
a user cannot get to this component by using the tab key.
Functionality
■
Tool Tip
The tool tip for this component. Tool tips are displayed when the
user hovers the cursor over the text box.
Functionality
■
Visible
Lets you select whether or not you want this text box to be visible.
If you use a variable for this, your workflow can change the variable
so that this component only appears on the form in certain
instances; for example, only on Tuesday.
411
412
Component properties
Components
Tab name
Options with descriptions
Appearance
■
Component Size
The size you want for the component.
You can also adjust the component size when you click on it and
drag on the box.
Appearance
■
Overflow Behavior
Lets you select the behavior if a user types in text that is wider
than the component.
Overflow - The component expands as the user types.
Clip - Does not show the words that go past the edge of the
component.
Scroll - Places a scroll bar on the component, which lets the user
scroll to see all the text.
Appearance
■
Text
The text for this component. You can enter the text or select it
when you click the [...] button.
The text can be assembled when you use the advanced text editor.
This lets you string together variable data or customized constant
data to form your text.
Look And Feel
■
Style
The style information you want for this component. Style
information includes font name, font face, font color, background
color, and so forth.
Look And Feel
■
Theme Style
The theme style for this component.
Theme styles are only available when a theme is added to the form.
Settings
See “Settings tab in all components” on page 383.
Assign Manager To Computer
This component assigns a manager to a computer in Active Directory.
See “Active Directory components” on page 392.
Table 25-10
Output Paths
Option
Description
Assigned
This path is followed if the manager was assigned to a computer in
Active Directory.
Component properties
Components
Table 25-10
Output Paths (continued)
Option
Description
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Computer Name
The name of the computer to assign the manager to.
Input
■
Manager Type
The manager type.
Input
■
Manager Type
You can specify the manager type.
User: You want to assign a manager user to the computer.
Group: You want to assign a manager group to the computer.
Input
■
User Name
If User is selected, the name of the manager to add to the computer.
Input
■
Group Name
If Group is selected, the name of the manager group to add to the
computer.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Assign Manager To Group
This component assigns a manager to a group in Active Directory.
See “Active Directory components” on page 392.
413
414
Component properties
Components
Table 25-11
Output Paths
Option
Description
Assigned
This path is followed if the manager was assigned to a group in Active
Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Manager Name
The name of the manager to assign to the group.
Input
■
Group Name
The name of the group to assign the manager to.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Assign Manager To Shared Folder
This component assigns a manager to a shared folder in Active Directory.
See “Active Directory components” on page 392.
Table 25-12
Output Paths
Option
Description
Assigned
This path is followed if the manager was assigned to a shared folder
in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Component properties
Components
Tab name
Options with descriptions
Input
■
Shared Folder Name
The name of the shared folder to assign the manager to.
Input
■
Manager Name
The name of the manager to assign to the shared folder.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Assign Manager To User
This component assigns a manager to a user in Active Directory.
See “Active Directory components” on page 392.
Table 25-13
Output Paths
Option
Description
Assigned
This path is followed if a manager was assigned to the user in Active
Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
User Name
The name of the user to whom the manager is assigned.
Input
■
Manager Name
The name of the manager to assign to the user.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
415
416
Component properties
Components
Tab name
Options with descriptions
Settings
See “Settings tab in all components” on page 383.
Compare Numbers Rule
This component compares two numbers. Based on the compare, one of three
output paths is taken.
Component Toolbox Paths - Math; Rules > Math
Table 25-14
Output Paths
Option
Description
less than
This path is followed if Value1 is less than Value2.
equal to
This path is followed if Value1 is equal to Value2.
greater than
This path is followed if Value1 is greater than Value2.
Tab name
Options with descriptions
Evaluation
■
Value1
A number or number variable. When you click the [...] button, the
value source selector opens. This number is compared to Value2.
A variable array value can be selected when you drill into the array
and select a value.
Evaluation
■
Value2
A number or number variable. When you click the [...] button, the
value source selector opens. This number is compared to Value1.
A variable array value can be selected when you drill into the array
and select a value.
Settings
See “Settings tab in all components” on page 383.
Configurable Auto Start
This component, based on a configurable event, starts the workflow with the data
provided in the Input Data of the embedded model.
This component takes the place of the Start component. When you use this
component, you first delete the Start component.
This component lets you attach workflows to systems that cannot make Webservice
calls.
Component properties
Components
This component runs according to a schedule that is set in the project global
properties in the Workflow Type section of the Publishing tab.
See “Publishing tab” on page 552.
See “Start component” on page 532.
See “New File Auto Start” on page 501.
See “Folder Watch Start” on page 464.
Tab name
Options with descriptions
Model
■
Embedded Model
The model for the process.
An embedded model can be created when you click the [...] button.
This model should contain, at the minimum, a process that
monitors for a configurable event. When the external event occurs,
the output path for that event should be connected to the End
component that has the Start Workflow Variable Name mapped
to True.
This embedded model can contain multiple End components that
has the Start Workflow Variable Name mapped to False, but only
one End component that has the Start Workflow Variable Name
mapped to True.
The workflow begins when the path is followed to the End
component that has the Start Workflow Variable Name mapped
to True.
Model
■
Start Workflow Variable Name
The name of the variable that maps to True or False in the End
component. This variable needs to be set in the End component of
the embedded model.
Settings
See “Settings tab in all components” on page 383.
Create Anonymous Access Token
This component is used to create an anonymous network credential. This output
token lets you connect to other network servers in your environment besides the
Symantec Management Console.
417
418
Component properties
Components
Tab name
Options with descriptions
Create Token
■
Settings
See “Settings tab in all components” on page 383.
Output
The name of the output token variable.
When you click the [...] button, the value source selector opens and
lets you select the token variable name.
Create Basic Authentication Token
This component lets you set up run time Symantec Management Console
authentication credentials (Username, Password, and Domain) and place them in
an output security token. However, it cannot be used to set up the IP address (or
fully qualified domain name) of a Symantec Management Console. This component
is normally used with the Add New Data Element component to set up the full
authentication (the Symantec Management Console IP address and authentication
credentials) that components can use to access the run time Symantec Management
Console. Every Symantec component that is down the path of this component can
use its output parameter.
The Create Basic Authentication Token component is used inside of the Create
Notification Server Credentials component when you set up an embedded model.
Generally, if you use the Create Notification Server Credentials component, you
do not need to use this component. However, you may use the output security
token generated by this component at any place in your workflow instead of the
security token generated by the Create Notification Server Credentials component.
See “Add New Data Element” on page 398.
Component Toolbox Path - Security
Tab name
Options with descriptions
Create Token
■
Basic Authentication
The options in this section let you enter the credentials of the
Symantec Management Console that components can use at run
time.
When you click the [...] button, the value source selector opens and
lets you set an option’s value.
These credentials get placed in the security token selected in the
Output Token Variable Name option in the Output section.
Component properties
Components
Tab name
Options with descriptions
Create Token
■
Settings
See “Settings tab in all components” on page 383.
Output
The Output Token Variable Name option lets you select the
security token that you want to contain the credentials set in the
Basic Authentication section.
The NSAuthenticationToken global variable is available to use as
the security token. The NSAuthenticationToken global variable is
also available to use for the Create Notification Server Credentials
component. You can create more global security tokens in the
project global properties in the Global Data tab. The security token
must be of type ProxySecurityToken.
When you click the [...] button, the value source selector opens and
lets you change the security token.
Create Collection
This component creates a new collection. It requires a collection name and a
parent folder GUID. A SQL query behind the collection may be specified.
Component Toolbox Path - Symantec > Platform > Collections
Tab name
Options with descriptions
Configuration
■
Collection Name
The name of the collection to be created. When you click the [...]
button, the value source selector opens.
Configuration
■
Folder
The parent folder GUID. You can enter a value or select one when
you click the [...] button.
Configuration
■
SQL Query
The SQL query behind the collection. When you click the [...] button,
the Advanced Text Creator opens.
Configuration
■
Collection Guid Variable Name
Lets you select a variable or enter the output variable name to hold
the Guid assigned to the new collection. When you click the [...]
button, the value source selector opens.
Notification Server See “Notification Server tab in Symantec components” on page 386.
Settings
See “Settings tab in all components” on page 383.
419
420
Component properties
Components
Create Computer
This component creates a computer in Active Directory.
See “Active Directory components” on page 392.
Table 25-15
Output Paths
Option
Description
Created
This path is followed if the computer was created in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Computer Name
The name of the computer to create.
Input
■
SAM Account Name
The SAM Account name of the computer to create.
Input
■
Computer Description
The description of the computer to create.
Input
■
DNS Name
The DNS name of the computer to create.
Input
■
Operating System Name
The name of the operating system on the computer to create.
Input
■
Operating System Version
The version of the operating system on the computer to create.
Input
■
Operating System Service Pack
The service pack number of the operating system on the computer
to create.
Input
■
Managed By
The name of the manager of the computer to create.
Input
■
Is Disabled
If checked, the computer to create is disabled.
Input
■
Additional Attributes
The additional attributes of the computer to create.
Component properties
Components
Tab name
Options with descriptions
Output
■
Computer Guid Variable Name
The name of the Computer Guid output variable. This variable gets
populated with the Guid of the created computer.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Create Default Access Token
This component creates an output token variable that contains the current logged
in user’s credentials through SSPI or integrated security.
Tab name
Options with descriptions
Create Token
■
Settings
See “Settings tab in all components” on page 383.
Output Token Variable Name
The name of the output token variable.
When you click the [...] button, the value source selector opens and
lets you select the token variable name.
Create DS Connection Profile
This component is used to create the Deployment Server connection profile that
components can use to access the run time Deployment Server. It should be placed
before any Deployment components in your workflow. Every deployment
component that is down the path of this component can use its output parameters.
The deployment components are as follows:
■
Get Computer
■
Get Job
■
Get Scheduled Job
■
Get Task Definition from Task
■
List Computers
■
List Jobs In Folder
421
422
Component properties
Components
■
List Schedules For Job
■
Run Job On Computer
■
Schedule Job On Computer
■
Wait For Job Completion
See “Design time and run time Deployment Server connection settings” on page 146.
Component Toolbox Path - Symantec > Deployment
Tab name
Options with descriptions
Input
■
Input
If the Use default DS settings from plugin option is unchecked, the
following options get placed in the DSConnectionProfile global token.
The DSConnectionProfile token is found in the project global
properties in the Global Data tab. By default, deployment components
use the DSConnectionProfile global token. However, the Deployment
Server connection settings can be changed in each deployment
component.
■
■
■
■
■
Settings
Use default DS settings from plug-in
If checked, the Deployment Server settings from the default
Deployment Server listed in the Deployment Server Connections
plug-in are used. The default Deployment Server connections
options are placed in the DSConnectionProfile global token.
If unchecked, the following options appear.
See “Setting design time Deployment Server connection settings”
on page 148.
Base DS Web Services IPAddress
The DS Webservices IP address (or fully qualified domain name)
for components to use to access the run time Deployment Server.
Enable HTTPS
The true/false setting that enables HTTPS on the Deployment
Server.
Remote User
The name of the remote user on Deployment Server.
Remote Password
The password of the remote user on Deployment Server.
Domain
The domain of the remote user on Deployment Server.
See “Settings tab in all components” on page 383.
Component properties
Components
Create Group
This component creates a group in Active Directory.
See “Active Directory components” on page 392.
Table 25-16
Output Paths
Option
Description
Created
This path is followed if the group was created in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Group Name
The name of the group to create.
Input
■
SAM Account Name
The SAM Account name of the group to create.
Input
■
Group Description
The description of the group to create.
Input
■
Email Address
The email address of the group to create.
Input
■
Group Scope
The scope of the group to create.
Input
■
Is Security Group
If checked, the group to create is a security group.
Input
■
Notes
The notes about the group to create.
Input
■
Managed By
The name of the manager of the group to create.
Input
■
Additional Attributes
The additional attributes of the group to create.
Output
■
Group Guid Output Variable Name
The name of the Group Guid output variable. This variable gets
populated with the Guid of the created group.
423
424
Component properties
Components
Tab name
Options with descriptions
Output
■
Settings
See “Settings tab in all components” on page 383.
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Create Kerberos Authentication Token
This component lets you set up run time Active Directory authentication
credentials (Username, Password, and Domain) and place them in an output
security token. Every Active Directory component that is down the path of this
component can use its output parameter.
Active Directory components
Tab name
Options with descriptions
Create Token
■
Authentication
The options in this section let you enter the credentials of the
account in the Domain Admins group in Active Directory that
components can use at run time.
When you click the [...] button, the value source selector opens and
lets you set an option’s value.
These credentials get placed in the security token selected in the
Output Token Variable Name option in the Output section.
Create Token
■
Output
The Output Token Variable Name option lets you select the
security token that you want to contain the credentials set in the
Authentication section.
When you click the [...] button, the value source selector opens and
lets you change the security token.
Settings
See “Settings tab in all components” on page 383.
Create Notification Server Credentials
This component is used to create the Symantec Management Platform server IP
address (or fully qualified domain name) and authentication credentials that
components can use to access the run time Symantec Management Platform
Component properties
Components
server. Every Symantec component that is down the path of this component can
use its output parameters.
See “Design time and run time Symantec Management Console credentials”
on page 140.
This component appears at the start of every newly created Workflow-type project.
If your project does not use a Symantec Management Platform server, it can be
deleted. You can use this component to create credentials for one or more Symantec
Management Platform servers. Use the Advanced tab to create credentials for
multiple Symantec Management Platform servers.
This component does the same thing as both the Create Basic Authentication
Token component and the Add New Data Element component combined.
See “Create Basic Authentication Token” on page 418.
See “Add New Data Element” on page 398.
Component Toolbox Path - Symantec > Authentication
Tab name
Options with descriptions
Configuration
■
Set Method
The set method refers to the method whereby the published process
retrieves the needed Symantec Management Console credentials.
Credentials are comprised of the following values: Symantec
Management Platform server name, optional use of HTTPS, user
name and password, and domain. All methods must retrieve those
values.
■ Use Default
This method uses credentials from the Notification Server
Credentials Manager plugin on the computer that runs the
workflow. When you click this method, the other options are
hidden. This prevents you from entering credential data that
could conflict with the credential data from the Credentials
Manager. When you use this method, the published workflow
retrieves its credentials from the Credential Manager on the
Workflow server.
■ Enter Manually
This method lets you input manually all of the credential data,
including the Symantec Management Console server name,
optional use of HTTPS, user name and password, and domain.
■ Configure Custom Logic
This method lets you create an embedded model to acquire the
Symantec Management Console credentials.
425
426
Component properties
Components
Tab name
Options with descriptions
Configuration
■
Symantec Management Console
The Symantec Management Console IP address (or fully qualified
domain name) for components to use to access the run time
Symantec Management Console.
The Symantec Management Console IP address gets placed in the
global token called Notification Server. By default, the Symantec
Management Console Address option in the Symantec Management
Console tab of each Symantec component uses the Notification
Server token. Notification Server is only updated in the Create
Notification Server Credentials component.
Configuration
■
Use HTTPS
This option lets you indicate whether or not your Symantec
Management Console uses HTTPS.
Configuration
■
User Name, Password, and Domain
The authentication credentials for components to use to access
the run time Symantec Management Console.
The options in the Authentication section get placed in the global
token called NSAuthenticationToken. By default, the Security
Token used in the Notification Server tab of each Symantec
component is a reference to NSAuthenticationToken. When you
put these credentials in a Security Token, you can pass credentials
to a Symantec component without disclosing the details of those
credentials to the rest of the data flow. This prevents you from
exposing the Symantec Management Console credentials to those
who are not supposed to have it.
The NSAuthenticationToken and Notification Server tokens are
found in the project global properties in the Global Data tab.
NSAuthenticationToken is of type ProxySecurityToken. The
ProxySecurityToken type is extendable. See Symantec customer
support for more information.
Component properties
Components
Tab name
Options with descriptions
Configuration
■
Custom Configuration
When you use Custom Configuration, an embedded model is
provided which lets you use logic and decisioning around
authenticating to multiple Symantec Management Platform servers
or use a single Symantec Management Console with multiple
credentials or any combination of these.
When you select Configure Custom Logic for the Set Method, an
Embedded Model option appears and basic authentication hides.
The [...] button is used to open the embedded model.
■ Embedded model
The embedded model has two components in it:
CreateBasicAuthenticationTokenComponent and
InsertDataComponent.
CreateBasicAuthenticationTokenComponent contains your
basic authentication settings and is a Create Basic
Authentication Token component. InsertDataComponent
contains the IP address (or fully qualified domain name) settings
of the run time Symantec Management Platform server and is
an Add New Data Element component. Now, you can create
multiple copies of InsertDataComponent based on the number
of Symantec Management Platform servers your workflow may
use. Change the IP address for each copy of
InsertDataComponent based on each Symantec Management
Platform server you use. When the workflow runs, the
appropriate Symantec Management Platform server gets used.
For example, suppose your workflow needs to use the Symantec
Management Platform server that is closest to a sales
representative and you have sales representatives in New York
and Sydney. You can create a matches rule where if the sales
representative is from New York, the workflow goes through
the InsertDataComponent with the IP address of the Symantec
Management Platform server in New York.
■ Output Data
Although the default variables in the embedded model are global
(and thus do not need to be declared as output data), you need
to declare as output data any other variables you used in the
embedded model. If you have no variables to declare, you do
not need to change the output data.
Settings
See “Settings tab in all components” on page 383.
Create Organization Unit
This component creates an organization unit in Active Directory.
427
428
Component properties
Components
See “Active Directory components” on page 392.
Table 25-17
Output Paths
Option
Description
Created
This path is followed if the organization unit was created in Active
Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
OUName
The name of the organization unit to create.
Input
■
OUDescription
The description of the organization unit to create.
Input
■
Street
The street address of the organization unit to create.
Input
■
City
The city of the organization unit to create.
Input
■
State
The state of the organization unit to create.
Input
■
Postal Code
The postal code of the organization unit to create.
Input
■
Country
The country of the organization unit to create.
Input
■
Additional Attributes
The additional attributes of the organization unit to create.
Output
■
Organization Unit Guid Variable Name
The name of the Organization Unit Guid output variable. This
variable gets populated with the Guid of the created organization
unit.
Component properties
Components
Tab name
Options with descriptions
Output
■
Settings
See “Settings tab in all components” on page 383.
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Create Resource
This component lets you create a new resource and associated data classes and
optionally, save the resource to CMDB. This is done by mapping process data to
the new resource and data classes similar to the Single Value Mapping component.
If the resource is saved, it is updated with its assigned resource GUID.
To use this component, select the Resource Type that you want created. Then, if
desired, define the data mapping for the resource and for appropriate data classes.
See “Single Value Mapping” on page 530.
Component Toolbox Path - Symantec > Platform > Resource Management
Tab name
Options with descriptions
Configuration
■
Mapping Definition
Lets you set the specific mapping definition for your convergence.
When you click the [...] button, the value source selector opens.
You can select which values of a resource type are mapped when
you click an arrow on the line under Data definitions and, while
you hold the mouse button, drag to an arrow on the line under
chosen datatype and let go of the mouse button. More arrows
appear under Data definitions when you expand data definitions.
You can click Validate to see if your mapping is valid.
This option only appears after you enter the Resource Type.
Configuration
■
Optional
Lets you select if you have data that can be handled in more than
one way (for example, in two different resource types).
If it is inconvenient for data to be mapped in the way you propose,
you can select this control to cause this component to opt out of
mapping the data and handle the data in its original form.
429
430
Component properties
Components
Tab name
Options with descriptions
Configuration
■
Map Into Existing Value
Lets you select to overwrite an existing variable with the output
data. You can then choose the target variable in the Target Variable
Name option.
Configuration
■
Target Variable Name
Lets you select the variable to overwrite with the output data. When
you click the [...] button, the value source selector opens. This
variable holds the output, mapped array and must be the same
datatype as the resource type.
This option appears if you select Map Into Existing Value.
Configuration
■
Resource Type
Lets you select the type of resource to be created. After it is set,
the data mapping can be defined for the resource and for
appropriate data classes.
Configuration
■
Save Resource to CMDB
Lets you select to save the created resource to the CMDB and have
the GUID generated from the save be stored back on the resource.
If not selected, the resource exists as process data but will not be
saved to the CMDB.
Configuration
■
Timeout
The amount of time (in Milliseconds) for this component to try to
create the resource.
Notification Server See “Notification Server tab in Symantec components” on page 386.
Settings
See “Settings tab in all components” on page 383.
Create Shared Folder
This component creates an Active Directory shared folder for an existing folder.
See “Active Directory components” on page 392.
Table 25-18
Output Paths
Option
Description
Created
This path is followed if the shared folder was created in Active
Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Component properties
Components
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Name
The name of the shared folder to create.
Input
■
Description
The description of the shared folder to create.
Input
■
UNC Name
The UNC name of the shared folder to create.
Input
■
Additional Attributes
The additional attributes of the shared folder to create.
Output
■
Shared Folder Guid Variable Name
The name of the Shared Folder Guid output variable. This variable
gets populated with the Guid of the created shared folder.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Create Ticket
This component creates a new ticket in Helpdesk Solution. It allows entry of all
writable options. The required options are Title and Comment. This component
returns the new ticket number as a variable.
Component Toolbox Path - Symantec > Help Desk > Tickets
Tab name
Options with descriptions
Ticket Details
■
Basic Details
Title: The ticket title.
Comment: A comment for the ticket. This should describe why the
ticket was created; it will appear in ticket lists.
431
432
Component properties
Components
Tab name
Options with descriptions
Ticket Details
■
Dates
Start On: The ticket start date. When you click the [...] button, the
value source selector opens.
Due On: The ticket due date. When you click the [...] button, the
value source selector opens.
Component properties
Components
Tab name
Options with descriptions
Ticket Details
■
Classification
Category Source: The value for retrieving the category source.
The value must be one of the valid category sources in Helpdesk.
If you select From Variable, enter the value variable in the
Category Tree Value option (usage example: create a form that
lets the user enter the desired value). If you select From Picker,
choose the value in the Category drop-down list. Use this if you
want to force the value for retrieving the category source.
Category Tree Value: The variable that contains the value for
retrieving the category source if you chose From Variable in the
Category Source option. The value must be one of the valid
category sources in Helpdesk.
Category: The value for retrieving the category source if you chose
From Picker in the Category Source option. The value must be
one of the valid category sources in Helpdesk.
Status Source: The value for retrieving the status source. The value
must be one of the valid status sources in Helpdesk. If you select
From Variable, enter the value variable in the Status Lookup Id
option (usage example: create a form that lets the user enter the
desired value). If you select From Picker, choose the value in the
Status drop-down list. Use this if you want to force the value for
retrieving the status source.
Status Lookup Id: The variable that contains the value for
retrieving the status source if you chose From Variable in the
Status Source option. The value must be one of the valid status
sources in Helpdesk.
Status: The value for retrieving the status source if you chose From
Picker in the Status Source option. The value must be one of the
valid status sources in Helpdesk.
Type Source: The value for retrieving the type source. The value
must be one of the valid type sources in Helpdesk. If you select
From Variable, enter the value variable in the Type Lookup Id
option (usage example: create a form that lets the user enter the
desired value). If you select From Picker, choose the value in the
Type drop-down list. Use this if you want to force the value for
retrieving the type source.
Type Lookup Id: The variable that contains the value for retrieving
the type source if you chose From Variable in the Type Source
option. The value must be one of the valid type sources in Helpdesk.
Type: The value for retrieving the type source if you chose From
Picker in the Type Source option. The value must be one of the
valid type sources in Helpdesk.
433
434
Component properties
Components
Tab name
Options with descriptions
Associations
■
Contact
Contact Id: The ID of the contact for this ticket. When you click
the [...] button, the value source selector opens.
Managed Object Id: The managed object ID of the contact for this
ticket. When you click the [...] button, the value source selector
opens.
Associations
■
Workers
Assigned Worker Source: The value for retrieving the assigned
worker. The value must be one of the valid assigned workers in
Helpdesk. If you select From Variable, enter the value variable in
the Assigned To Worker Id option (usage example: create a form
that lets the user enter the desired value). If you select From Picker,
choose the value in the Assigned Worker drop-down list. Use this
if you want to force the value for retrieving the assigned worker.
Assigned To Worker Id: The variable that contains the value for
retrieving the assigned worker if you chose From Variable in the
Assigned Worker Source option. The value must be one of the
valid assigned workers in Helpdesk.
Assigned Worker: The worker queue to assign the incident to if
you chose From Picker in the Assigned Worker Source option.
The value must be one of the valid assigned workers in Helpdesk.
Owner Worker Source: The value for retrieving the worker
responsible for the incident. The value must be one of the valid
owner workers in Helpdesk. If you select From Variable, enter the
value variable in the Owned By Worker Id option (usage example:
create a form that lets the user enter the desired value). If you
select From Picker, choose the value in the Assigned Owner
drop-down list. Use this if you want to force the value for retrieving
the responsible worker.
Owned By Worker Id: The variable that contains the value for
retrieving the worker responsible for the incident if you chose
From Variable in the Owner Worker Source option. The value
must be one of the valid owner workers in Helpdesk.
Assigned Owner: The worker to be responsible for the incident if
you chose From Picker in the Owner Worker Source option. The
value must be one of the valid owner workers in Helpdesk.
Associations
■
Parent Ticket
Parent Ticket Number: The ticket number of the parent. When
you click the [...] button, the value source selector opens.
Ticket Link Type: The parent ticket link type. When you click the
[...] button, the value source selector opens.
Component properties
Components
Tab name
Options with descriptions
Associations
■
References
External Reference: The external reference. When you click the
[...] button, the value source selector opens.
Source: The source reference. When you click the [...] button, the
value source selector opens.
Escalation
■
Priority Source
The value for retrieving the priority source. The value must be one
of the valid priority sources in Helpdesk. If you select From
Variable, enter the value variable in the Priority Lookup Id option
(usage example: create a form that lets the user enter the desired
value). If you select From Picker, choose the value in the Priority
drop-down list. Use this if you want to force the value for retrieving
the priority source.
Escalation
■
Priority Lookup Id
The variable that contains the value for retrieving the priority
source if you chose From Variable in the Priority Source option.
The value must be one of the valid priority sources in Helpdesk.
Escalation
■
Priority
The value for retrieving the priority source if you chose From
Picker in the Priority Source option. The value must be one of the
valid priority sources in Helpdesk.
Escalation
■
Impact Source
The value for retrieving the impact source. The value must be one
of the valid impact sources in Helpdesk. If you select From
Variable, enter the value variable in the Impact Lookup Id option
(usage example: create a form that lets the user enter the desired
value). If you select From Picker, choose the value in the Impact
drop-down list. Use this if you want to force the value for retrieving
the impact source.
Escalation
■
Impact Lookup Id
The variable that contains the value for retrieving the impact
source if you chose From Variable in the Impact Source option.
The value must be one of the valid impact sources in Helpdesk.
Escalation
■
Impact
The value for retrieving the impact source if you chose From Picker
in the Impact Source option. The value must be one of the valid
impact sources in Helpdesk.
435
436
Component properties
Components
Tab name
Options with descriptions
Escalation
■
Urgency Source
The value for retrieving the urgency source. The value must be
one of the valid urgency sources in Helpdesk. If you select From
Variable, enter the value variable in the Urgency Lookup Id option
(usage example: create a form that lets the user enter the desired
value). If you select From Picker, choose the value in the Urgency
drop-down list. Use this if you want to force the value for retrieving
the urgency source.
Escalation
■
Urgency Lookup Id
The variable that contains the value for retrieving the urgency
source if you chose From Variable in the Urgency Source option.
The value must be one of the valid urgency sources in Helpdesk.
Escalation
■
Urgency
The value for retrieving the urgency source if you chose From
Picker in the Urgency Source option. The value must be one of
the valid urgency sources in Helpdesk.
Output
■
New Incident Number Variable
The name of the variable to contain the new incident number. We
recommend that you rename this variable for each Create Ticket
component in your process.
Notification Server See “Notification Server tab in Symantec components” on page 386.
Settings
See “Settings tab in all components” on page 383.
Create User
This component creates a user in Active Directory.
See “Active Directory components” on page 392.
Table 25-19
Output Paths
Option
Description
Created
This path is followed if the user was created in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Component properties
Components
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
User Info Source
You can specify the source from which to retrieve the information
that is used to create the user.
From Editor: Creates the user from information in the editor. You
can enter the user information in the User Information Editor in
the User Info option.
From Variable: Creates the user from information from a variable.
You can enter the user information in the User Info option.
Input
■
User Info
If From Editor is clicked, you can enter the user information in
the User Information Editor by clicking the […] button. If From
Variable is clicked, you can enter the user information by clicking
the […] button.
Output
■
User Guid Output Variable Name
The name of the User Guid output variable. This variable gets
populated with the Guid of the created user.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Date Greater Than
This component lets you test a date against a date in a variable.
Component Toolbox Paths - Date Handling > Rules; Process Components > Date
Handling > Rules; Rules > Date
Table 25-20
Output Paths
Option
Description
true
The path followed if the first date occurs after the second date.
false
The path followed if the first date occurs before or at the same time
as the second date.
437
438
Component properties
Components
Tab name
Options with descriptions
Configuration
■
First Date Variable Name
The variable name for the first date you are comparing. When you
click the [...] button, the value source selector opens.
A variable array value can be selected when you drill into the array
and select a value.
Configuration
■
Second Date
The date or variable name that contains the date you want to
compare your first date against. When you click the [...] button,
the value source selector opens.
A variable array value can be selected when you drill into the array
and select a value.
Configuration
■
Second Date is Minimum
If selected, Second Date becomes the minimum value (usually
01.01.0001).
This is useful for assuring that the first date is not zero.
Settings
See “Settings tab in all components” on page 383.
DatePickerComponent
This component lets users select a date from a pop-up calendar. The date is then
stored in the text box, ready for submission through the Web form.
When you place this component on the form, a dialog box opens which displays
the minimum required options. You must first enter the Output Name, which is
the date variable. You can then choose which output paths are required or optional
for this component. At least one output path must be required for this component.
After you click OK, you can view other available options when you double-click
this component.
This component is available in a Forms project when you use a form component
that utilizes the Web Form Editor (for example, See “Form Builder” on page 467.).
Tab name
Options with descriptions
Functionality
■
Output Paths
Select how you want this component to be used by each output
path on the Web form.
Required - This component is required for this output path.
Optional - This component is optional for this output path.
Ignored - This component is ignored for this output path.
Component properties
Components
Tab name
Options with descriptions
Functionality
■
Output Data
A variable from within your project to hold the output data. When
you click the [...] button, the value source selector opens.
If you do not have a variable already declared, enter the name you
want for the variable. A variable of this name is created when the
project is created.
Functionality
■
Start Today
If selected, the display starts with the current month. This uses
the computer’s current date.
Functionality
■
Date
The start date for your calendar. When you click the [...] button,
the value source selector opens.
If you chose not to Start Today, the start date you specify in this
option dictates which month and day the calendar displays.
Functionality
■
Custom Events
A list of customized events you want this component to respond
to. You can click Add and scroll to the event name to add an event
handler. In the Edit Object dialog box, you can select the behavior
configuration for the event handler you chose.
Functionality
■
Specify Control ID
Lets you specify your own control ID. If this option is not selected,
an automatically created control ID is specified for this component.
Functionality
■
Control ID
A unique identifier for this component. This identifies this
component to the Web browser.
Functionality
■
Tab Index
The tab order for this component on the page.
When a user presses the tab key, the curser moves to the
component with the next consecutive numbered Tab Index on the
form.
Functionality
■
Tab Stop
Allows this component to be a tab stop. If this is cleared, a user
cannot get to this component when the tab key is used.
Functionality
■
Tool Tip
A tool tip for this component. Tool tips are displayed when the
user hovers the cursor over the component.
439
440
Component properties
Components
Tab name
Options with descriptions
Functionality
■
Visible
Lets you select whether or not you want this component to be
visible.
If you use a variable for this, your workflow can change the variable
so that this component only appears on the form in certain
instances; for example, only on Tuesday.
Functionality
■
Required Error Message
The error message to display if you set this component to Required
(it is required for the successful completion of your form) but the
user failed to select a value.
Appearance
■
Component Size
The size you want for the component.
You can also adjust the component size when you click on it and
drag on the box.
Appearance
■
Drop Down Image
The image to display behind the calendar. When you click the [...]
button, the value source selector opens.
Appearance
■
Overflow Behavior
The behavior to use if a user types in text that is wider than the
component.
Overflow - The component expands as the user types.
Clip - Does not show the words that go past the edge of the
component.
Scroll - Places a scroll bar on the component, which lets the user
scroll to see all the text.
Settings
See “Settings tab in all components” on page 383.
Date Range Rule
This component evaluates a date variable to determine where in the defined date
ranges the specified date falls. You determine the date ranges that the component
uses and output paths are generated based on the date ranges.
Component Toolbox Paths - Rules > Date; Process Components > Date Handling
> Rules; Date Handling > Rules
Component properties
Components
Table 25-21
Output Paths
Option
Description
[Date Ranges]
Up to three output paths are created for each item in the Days Array.
When the input date variable falls in a defined date range, the workflow
follows that output path.
Tab name
Options with descriptions
Evaluation
■
Input Date Variable Name
The input date variable name. When you click the [...] button, the
value source selector opens. The date in the date variable is
compared against the ranges specified in the Days Array.
Evaluation
■
Base Date
The date from which to start comparing the input date variable.
This is used to evaluate if the input date variable is within a certain
number of days from this date. The number of days is based on the
Days option and the direction is based on the Direction option
when setting up the Days Array.
Evaluation
■
Days Array
The date ranges to compare the input date variable to. Each line
you add creates up to three rules (output paths).
Days: The number of days from the Base Date to compare the input
date variable against.
Direction: The direction in time (after and before) from the Base
Date to compare against.
Evaluation
■
Handle Equals By
Lets you select how you want to handle cases where the date equals
a day in the array.
MakeExplicit: Lets you make the rules explicit. A rule is then
created for exactly the date specified, as well as greater than or
less than the date specified.
RoundDown: Lets you make the rules round down.
RoundUp: Lets you make the rules round up.
Settings
See “Settings tab in all components” on page 383.
Decision Path Component
This component lets you create a set of decision paths which navigate information
to the components which require it.
441
442
Component properties
Components
Example: You may want to sort or order users based on their country of origin.
Use this component to set up a decision system to transfer a user’s data based on
their country of origin.
You set up and edit this component through a wizard.
Component Toolbox Paths - Process Components > Advanced Decisioning; Rules
> Advanced Decisioning
Table 25-22
Output Paths
Option
Description
[Decision Paths]
A decision path is created for each Output Path added in the first
Wizard step. When the input date variable falls in a defined date range,
the workflow follows that output path.
Wizard step
Options with descriptions
Output Paths
This step lets you add and edit all paths you want to use. These paths
are the specific paths by which data can be channeled.
Example: If you want to channel users based on their location (America,
Europe, or Asia), you would create three paths: America, Europe, and
Asia.
When you click Add and input a value, a path is added. The value is
the name for the path.
Component properties
Components
Wizard step
Options with descriptions
Decision Table
This step lets you create a table that sorts your data into the correct
path.
In the decision table, there are two plus signs that form a grid.
To set up the table:
1
Click the plus sign to the side and browse to the component you
want to use.
The selected component is only used within the Decision Path
component to determine the output path. You can use any
available component, but rules components work best for
decisioning. For example, Matches Rule.
2
Click the plus sign at the top and browse to the component you
want to use.
The selected component is only used within the Decision Path
component to determine the output path. You can use any
available component, but rules components work best for
decisioning. For example, Day of Week rule.
3
If the components you selected are not validated (Not Valid
symbol is displayed), double-click on the component name and
enter the required options.
4
Continue step 1 and step 2 until you have created the table you
want.
This table is very powerful and you can use it to simplify very
complicated decisioning. In most cases, there will usually be
available plus signs to add more components to your table.
5
When a grid is displayed and each cell contains the Not Valid
symbol, click inside each cell and choose the appropriate output
path for that cell.
Continue this step until there are no more Not Valid symbols.
6
When your decision table is complete, click Validate Model to
make sure that all components and cells are valid.
7
Click Finish.
Delete Computer
This component deletes a computer from Active Directory.
See “Active Directory components” on page 392.
443
444
Component properties
Components
Table 25-23
Output Paths
Option
Description
Deleted
This path is followed if the computer was deleted from Active
Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Name
The name of the computer to delete.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Delete Group
This component deletes a group from Active Directory.
See “Active Directory components” on page 392.
Table 25-24
Output Paths
Option
Description
Deleted
This path is followed if the group was deleted from Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Name
The name of the group to delete.
Component properties
Components
Tab name
Options with descriptions
Output
■
Settings
See “Settings tab in all components” on page 383.
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Delete Organization Unit
This component deletes an organization unit from Active Directory.
See “Active Directory components” on page 392.
Table 25-25
Output Paths
Option
Description
Deleted
This path is followed if the organization unit was deleted from Active
Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Name
The name of the organization unit to delete.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Delete Shared Folder
This component deletes a shared folder from Active Directory.
See “Active Directory components” on page 392.
445
446
Component properties
Components
Table 25-26
Output Paths
Option
Description
Deleted
This path is followed if the shared folder was deleted from Active
Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Name
The name of the shared folder to delete.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Delete User
This component deletes a user from Active Directory.
See “Active Directory components” on page 392.
Table 25-27
Output Paths
Option
Description
Deleted
This path is followed if the user was deleted from Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Name
The name of the user to delete.
Component properties
Components
Tab name
Options with descriptions
Output
■
Settings
See “Settings tab in all components” on page 383.
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Dialog Workflow
This component lets you create dialog boxes to display to users within your
workflow project. These dialog boxes typically let the user make decisions. This
component can have multiple output paths based on the decisions made by the
user.
For example, you might want to ask users, within a Form Builder component, to
make a decision (for example, approving a request). The decision is made when a
button is clicked. After the decision button is clicked, the workflow follows the
prescribed path for that decision.
Table 25-28
Output Paths
Option
Description
timed out
If the time in the Timeout Time Span option (in the Event
Configuration tab) is reached, the workflow follows this output path.
[Links]
An output path is created for each end component added in the Dialog
Model (accessed in the Interaction Setup tab).
Tab name
Options with descriptions
Assignments
■
Task Source Type
The source type for the task.
ActiveDirectoryTaskSource: Uses Active Directory as the source.
AltirisTaskSource: Uses the Altiris task as the source.
DefaultTaskSource: Uses the default task source. Workflow
Solution manages this default task source. The default task source
is primarily used for email.
ProcessManagerTaskSource: Creates this workflow as a task in
Process Manager (for Workflow Solution Advanced users).
SharePointTaskSource: Uses Share Point as the source.
TaskListTaskSource: Uses a list as the task source.
447
448
Component properties
Components
Tab name
Options with descriptions
Assignments
■
Require Assignment
Requires this task be assigned to someone or some group. When
selected, this component will not execute unless at least one
assignment is made.
Assignments
■
Task Name
A descriptive name for the task tied to this component. The name
is displayed in Process Manager and can describe briefly the
operations required to satisfy this workflow component. The name
of the task can be entered directly or when you click the [...] button.
Assignments
■
Task Description
A description for your task. The description can describe in Process
Manager precisely what a user must do to satisfy this workflow
component. The description of the task can be entered directly or
when you click the [...] button.
Assignments
■
Task Priority By Variable Value
Sets the task priority through a variable.
Assignments
■
Assignments
■
Profile Name
If Process Manager is selected as the Integration method, and you
want to attach a Process Manager data profile to this workflow
task, this option is the name of the profile that you want to attach.
Assignments
■
Profile Values
If Process Manager is selected as the Integration method, and you
attached a Process Manager data profile to this workflow task, this
option lets you edit the data mappings of the profile that you
attached.
Assignments
■
Set Late Date And Due Date
If Process Manager is selected as the Integration method, this
option lets you set late and due dates for this workflow task in
Process Manager.
Task Priority
The priority (urgency) of this Process Manager task. The task for
this component is to enter all data required by the component.
This is available if Task Priority By Variable Value is not selected.
■ Priority
The variable that contains the task priority. When you click the
[...] button, the value source selector opens. This option is available
if Task Priority By Variable Value is selected.
Component properties
Components
Tab name
Options with descriptions
Assignments
■
Created By Use As Project Name
If Process Manager is selected as the Integration method, this
option lets you use the project name for the Process Manager
Created By variable. When this option is unchecked, the Created
By option appears. In the Created By option, you can select the
Created By variable when you click the [...] button.
Assignments
■
On Bad Assignment
If Process Manager is selected as the Integration method, this
option lets you select how to handle the case where the Process
Manager assigned person is not found.
Assignments
■
Is Dialog Start
Lets you select if you want this form to be the start of the workflow.
When this is selected, the Expose As Webservice tab appears.
Assignments
■
Person Assignments
Lets you select the person assignments to assign your component's
task to an individual user or individual users in Process Manager.
When you click the [...] button, the value source selector opens.
Assignments
■
Group Assignments
Lets you select the group assignments you want to assign a task
in Process Manager. When you click the [...] button, the value source
selector opens.
Assignments
■
Org Unit Assignments
Lets you select the organizational unit assignments you want for
the task in Process Manager. When you click the [...] button, the
value source selector opens.
Assignments
■
Workflow Queue Assignments
Lets you select the workflow queue assignments you want for the
task in Process Manager. When you click the [...] button, the value
source selector opens.
Assignments
■
Permission Assignments
Lets you select the permission assignments you want for this
component's task in Process Manager. When you click the [...]
button, the value source selector opens.
449
450
Component properties
Components
Tab name
Options with descriptions
Assignments
■
Respond Display Format
If Process Manager is selected as the Integration method, this
option lets you select the format to display the task response in
Process Manager.
Default: The task response is displayed in a pop-up.
Embedded: The task response is displayed inside the form.
ChildForm: The task response is displayed in a child form.
Assignments
■
Task Type
If Process Manager is selected as the Integration method, this
option lets you select the Process Manager task type.
Assignments
■
Auto Height Width
If Process Manager is selected as the Integration method, this
option lets you select to keep the auto height and width for the
Process Manager form. When you clear this option, you can enter
the height and width.
Interaction Setup
■
Dialog Model
Lets you create a model that includes the dialog box you want users
to see. When you click the [...] button, the dialog model appears.
The dialog model is a built-in Webforms project. It lets you create
the workflow needed to design your Webforms.
An output path is created on the Dialog Workflow component for
each End component added in this model. You should have an End
component for each possible outcome of the dialog model.
For example, you can create an "Approve" End component, a "Deny"
End component, and an "Alternate" End component.
Interaction Setup
■
Respond Link Name
The name you want to use for the respond link. The respond link
is clicked by users to respond to the question at hand, and when
clicked, submits any information the user entered into the dialog
box.
Component properties
Components
Tab name
Options with descriptions
Interaction Setup
■
Allow Multiple Responses
Lets you create multiple responses through unique dialog models.
These dialog models can perform tasks that are related to the
Dialog Workflow component, but may not necessarily affect the
outcome directly (such as helping a manager make a decision).
For example, suppose the Dialog Workflow component lets a
manager approve or deny the purchase of a cell phone. The
manager has received multiple cell phone requests of the same
model, but rejects the requests because the company does not
support it. The manager decides to send in a request to see if the
company will support that model of phone. For instances like this,
you can create a response that shows a button that lets the manager
send a request to IT.
Interaction Setup
■
Dialog Models
Lets you create a response dialog model. When you click Add, a
response dialog model appears.
■ Category
The category for this response. This helps you keep track of
similar responses.
■ Name
The name of the response. This is displayed to the user in the
Dialog Workflow component.
■ Dialog Model
Lets you create a model that includes the dialog box you want
displayed to users. When you click the [...] button, the dialog
model appears.
■ Resolve Workflow Task On Exit
Lets you close the Dialog Workflow process when this Dialog
Model exits.
■ Conditionally Use
Lets you use this Dialog Model only in certain conditions. This
lets you create a unique dialog model that defines the conditions
to show and not to show this Dialog Model.
■ Set Start Date
Sets a start date for this Dialog Model.
■ Set End Date
Sets an end date for this Dialog Model.
Interaction Setup
■
Do Not Exit On Some Outputs
Lets you select if you do not want this component to exit on one
or more outputs.
451
452
Component properties
Components
Tab name
Options with descriptions
Interaction Setup
■
Do Not Exit On Outputs
Lets you select one or more outputs that this component will not
exit on. All outputs that are selected are removed as output paths
on this component.
This is useful if you have a button that lets the user return to the
dialog box, such as a Save As Draft button.
Interaction Setup
■
Form Position
Lets you select where you want the forms built in the Dialog Model
to appear on the Web browser. Default uses the Web browser
settings.
Interaction Setup
■
Form Theme
Lets you select the theme to use for the forms built in the Dialog
Model.
Interaction Setup
■
Form Type
The form type you want to use for the forms built in the Dialog
Model. Use the Web form type if your forms are built to view on
the Web. Use the Mobile form type to display forms through a
mobile device. Use the MobileAndWeb form type to cause each
form to use the browser’s declarations to discover whether or not
it is being used on a mobile device and renders itself accordingly.
Event
Configuration
■
Start Description
A description of the process you chose as your Start Process. You
may include specific information on how the process works and
what it does.
Event
Configuration
■
Start Process
The process which is executed at the beginning of your workflow
process. When you click the [...] button, you can create the start
process.
The start process is executed when the workflow process is
approved and before the workflow process itself is executed.
Event
Configuration
■
Escalations
Lets you set escalations for your event. When you click Add, you
can set the escalations. Escalations are events in your workflow
process which cause the workflow to continue or move to a
different level.
Component properties
Components
Tab name
Options with descriptions
Event
Configuration
■
Finish Description
A description of the process you want for your Finish Process.
You may include specific information on how the process works
and what it does.
Event
Configuration
■
Finish Process
The process which is executed at the end of your workflow process.
When you click the [...] button, you can create the finish process.
The finish process is executed when the workflow process is
approved and after the workflow process itself is executed.
Event
Configuration
■
Timeout Type
The timeout type. A process times out when a user does not respond
within a certain date or time span.
Event
Configuration
■
Timeout Date
Sets a specific date when a process times out.
When you click the [...] button, the value source selector opens.
This option contains a reference to a variable within your project
which holds the date you want your process to time out.
This option appears when Date is selected in the Timeout Type
option.
Event
Configuration
■
Timeout Time Span
Sets how long to wait before a process times out. When you click
the [...] button, the value source selector opens.
This option appears when Time Span is selected in the Timeout
Type option.
Event
Configuration
■
Timeout Description
The description for your users of how and why a process times out.
You may include specific information or instructions.
Event
Configuration
■
Timeout Process
Declares a process which is executed when your workflow
component times out.
453
454
Component properties
Components
Tab name
Options with descriptions
Expose as
webservice
■
Expose As Webservice
Lets you expose the Dialog Workflow and its output paths as a
Webservice. This lets you create an API accessible version of the
Dialog Workflow, which lets you make Webservice calls into your
workflow.
The Expose As Webservice tab appears when the Is Dialog Start
option is selected in the Assignments tab.
■ Defined Webservice Name
The Webservice name.
■ Variables To Expose
The workflow variables to expose to the Webservice.
■ Paths To Expose
The paths to expose to the Webservice.
Message Listeners See “Message Listeners tab in some components” on page 387.
Settings
See “Settings tab in all components” on page 383.
Display Content
This component lets you display content to a user through a Web browser.
This displays basic content. If you want more flexibility when content is displayed,
including adding a theme, use the Form Builder component.
This is available in a Forms project.
Tab name
Options with descriptions
Contents
■
Message
The message that you want displayed to the user. When you click
the [...] button, the value source selector opens.
Contents
■
Title
The title that you want displayed on the title bar of the message.
When you click the [...] button, the value source selector opens.
Submit
■
Submit Button Name
A label for your submit button. The user clicks this button to move
out of the Web browser screen.
Go Back
■
Allow Go Back
Lets you place a go back button on the Web browser screen. When
a user clicks the go back button, the user is taken back to the
previous screen in the browser.
Component properties
Components
Tab name
Options with descriptions
Go Back
■
Settings
See “Settings tab in all components” on page 383.
Go Back Button Name
The name of the go back button on the browser.
Embedded Merge
This component lets you create an embedded model to process rules for whether
or not the process should continue. This is a Workflow merge component.
Workflow merge components are used in a branching workflow to determine if a
process should continue or not based on the state of the workflow or external
interactions. If a workflow is branched and has multiple threads of executions, it
is common for it to merge into a Workflow merge component. The Embedded
Merge component waits until the specified number of threads have completed
before it allows the process to continue. In some cases merging happens based on
some conditions (for example, two out of three approvers have approved). These
special cases are handled by the Embedded Merge component.
This component is in the Workflow.Advanced.dll. The Workflow.Advanced.dll
needs to be imported (Import Components button) before you can use the
Embedded Merge component.
Component Toolbox Paths - Workflow Components > Merge
Table 25-29
Output Paths
Option
Description
done
When the embedded model’s rules are processed, the workflow follows
this output path.
455
456
Component properties
Components
Tab name
Options with descriptions
Filter
■
Merge Data
This tab handles process data. If you handle global data under the
Merge Data tab, you must map the data changes back into the global
variables.
Merge Data
Do IContinue Model
An embedded model that you create when you click the […] button.
This model should contains rules or conditions for continuing the
process. When the rules or conditions have been met, the process
continues through the done output path.
Each End component in this embedded model must receive a Logical
(true/false) variable as input. When an End component in this
model receives a Logical variable that is set to true, the rules or
conditions have been met.
For example, you can set an End component to true and an End
component to false. When the End component that is set to true
is reached, the rules or conditions have been met.
While in this model, a variable called PendingTasks is available.
This is an array of all the tasks coming into the Embedded Merge
component that are still open. This array has a Count that can be
evaluated to see if all (or a number of) tasks have been completed.
■
Merge Type
No Merge - No data is merged. The data from the last thread is
used, and all other data is lost.
Simple Merge - All incoming branch data is exposed. Variables
with the same name overwrite each other, but each distinct variable
from the branches are retained.
Model Merge - Lets you create a data merge model.
■
Data Merge Model
When you click the [...] button for this option, the data merge model
opens.
While in this model, a variable called _Previous_Run_Data_ is
available. The _Previous_Run_Data_ variable contains the previous
run data on all available variables in the project. It does not contain
the current data from all available variables in the project.
Component properties
Components
Tab name
Options with descriptions
Merge Global Data This tab handles global data. These settings read and write directly
to the project global data.
■
Global Data Merge Type
No Merge - No data is merged. The data from the last thread is
used, and all other data is lost.
Simple Merge - All incoming branch data is exposed. Variables
with the same name overwrite each other, but each distinct variable
from the branches are retained.
Model Merge - Lets you create a global data merge model.
Merge Global Data ■ Global Data Merge Model
When you click the [...] button for this option, the global data merge
model opens.
While in this model, a variable called _Previous_Run_Data_ is
available. The _Previous_Run_Data_ variable contains the previous
run data on all available variables in the project. It does not contain
the current data from all available variables in the project.
Message Listeners See “Message Listeners tab in some components” on page 387.
Passive Merging
■
Check Passive Completion
Checks for the termination of workflow components in any model
in this workflow. Only turn this off if you have all paths terminating
into this component.
Passive Merging
■
Check Time Span
Sets the time to wait between checks. The system checks repeatedly
to see if all workflow components have completed execution. The
system waits a certain amount of time (Check Time Span) between
checks.
Settings
See “Settings tab in all components” on page 383.
End component
This component is the last component in any project. All components converge
and end at the End component.
The End component lets you set up data mapping for Decision Only-type projects.
Data mapping is a way to organize project output data. The data variables you
entered in the Output Data tab must be mapped.
A project creates multiple pieces of output data because each component generates
its own output. Data mapping lets you combine all of this data into one project
output data, which acts as the result of the entire project's execution.
457
458
Component properties
Components
See “Workflow Designer project types” on page ?.
Tab name
Options with descriptions
Configuration
■
Mapping
Lets you edit the mapping for your project’s output variables. When
you click the [...] button next to a variable, the mapping editor
opens.
Each of your project's output variables created on the Output Data
tab is listed. You must edit the mapping for each variable. Mapping
lets you dictate what data is placed in that variable at the end of
your project's execution.
When Value from Data is selected, you can specify values from
other variables in your project.
Settings
See “Settings tab in all components” on page 383.
Exception Component
This component is an ending component. Exceptions don’t go through it. It is the
end of an exception. You can channel your exceptions to this component instead
of an End component. The Exception Trigger components can connect to this
component.
This component is particularly useful inside of a Dialog Workflow component. In
a Dialog Workflow component, when the process goes to the end component, the
task is complete. If you do not want the task to complete on an exception, you can
use the Exception Component.
See “Exception Trigger” on page 459.
See “Dialog Workflow” on page 447.
Tab name
Options with descriptions
Exception
■
Avoid Exception Triggers
If selected, exception triggers are avoided.
Exception
■
Message
The message for the exception.
Settings
See “Settings tab in all components” on page 383.
Component properties
Components
Exception Trigger
This component lets you trigger an exception (an error). This is useful if you want
to customize error messages displayed to users.
All trigger information is saved in a set of variables for future use in your project.
The output variables always contain data from the last triggered exception.
This component catches any exception that happens in the model. When an
exception happens in the project, the project jumps to the Exception Trigger
component and follows the path out of the Exception Trigger component (usually
to the End component). Because of this, you should only have one Exception
Trigger component in a model. If you want to be more specific with your exception
handling, use one of the other Exception Trigger components (for example,
Exception Trigger By Component).
See “Exception Trigger By Component” on page 460.
See “Exception Trigger By Components” on page 461.
See “Exception Trigger By Exception Type” on page 462.
See “Exception Component” on page 458.
Component Toolbox Paths - Infrastructure > Exceptions; Infrastructure > Flow
Control; Infrastructure > Triggers; Process Components > Flow Control
Tab name
Options with descriptions
Trigger
■
Component Class Name
The variable name that is used to output the message of the
exception.
Trigger
■
Component IDVariable Name
The name of the variable that contains the ID of the component
that triggered the exception.
Trigger
■
Component Name
The name of the variable that contains the component name that
triggered the exception.
Trigger
■
Exception Class Variable Name
The name of the variable that contains the name of the exception’s
class. This can be used to identify what part of the project caused
the exception.
459
460
Component properties
Components
Tab name
Options with descriptions
Trigger
■
Exception Message Variable Name
The name of the variable that contains the message of the
exception. This is displayed to the user when the exception is
encountered.
Trigger
■
Exception Stack Trace Variable Name
The name of the variable that contains the stack trace of the
exception. Stack traces are used to trace the source of the
exception.
Settings
See “Settings tab in all components” on page 383.
Exception Trigger By Component
This component lets you trigger exceptions based on components in your project.
Use this component if you want an exception to occur as the result of a specific
component’s actions.
All trigger information is saved in a set of variables for future use in your project.
If this component is in the same model as an Exception Trigger component, this
component holds priority and is used first.
See “Exception Trigger” on page 459.
Component Toolbox Paths - Infrastructure > Exceptions; Infrastructure > Flow
Control; Infrastructure > Triggers; Process Components > Flow Control
Tab name
Options with descriptions
Trigger
■
Component Class Name
The variable name that is used to output the message of the
exception.
Trigger
■
Component IDVariable Name
The name of the variable that contains the ID of the component
that triggered the exception.
Trigger
■
Component Name
The name of the variable that contains the component name that
triggered the exception.
Trigger
■
Exception Class Variable Name
The name of the variable that contains the name of the exception’s
class. This can be used to identify what part of the project caused
the exception.
Component properties
Components
Tab name
Options with descriptions
Trigger
■
Exception Message Variable Name
The name of the variable that contains the message of the
exception. This is displayed to the user when the exception is
encountered.
Trigger
■
Exception Stack Trace Variable Name
The name of the variable that contains the stack trace of the
exception. Stack traces are used to trace the source of the
exception.
Trigger
■
Component
The component you want to use to trigger this exception.
Settings
See “Settings tab in all components” on page 383.
Exception Trigger By Components
This component lets you trigger exceptions based on components in your project.
Use this component if you want an exception to occur as the result of the actions
of multiple components.
All trigger information is saved in a set of variables for future use in your project.
If this component is in the same model as an Exception Trigger component, this
component holds priority and is used first.
See “Exception Trigger” on page 459.
Component Toolbox Paths - Infrastructure > Exceptions; Infrastructure > Flow
Control; Infrastructure > Triggers; Process Components > Flow Control
Tab name
Options with descriptions
Trigger
■
Component Class Name
The variable name that is used to output the message of the
exception.
Trigger
■
Component IDVariable Name
The name of the variable that contains the ID of the component
that triggered the exception.
Trigger
■
Component Name
The name of the variable that contains the component name that
triggered the exception.
461
462
Component properties
Components
Tab name
Options with descriptions
Trigger
■
Exception Class Variable Name
The name of the variable that contains the name of the exception’s
class. This can be used to identify what part of the project caused
the exception.
Trigger
■
Exception Message Variable Name
The name of the variable that contains the message of the
exception. This is displayed to the user when the exception is
encountered.
Trigger
■
Exception Stack Trace Variable Name
The name of the variable that contains the stack trace of the
exception. Stack traces are used to trace the source of the
exception.
Trigger
■
Components
The components you want to use to trigger this exception. When
you click the [...] button, the value source selector opens.
Settings
See “Settings tab in all components” on page 383.
Exception Trigger By Exception Type
This component lets you trigger a specific type of exception (an error). This is
similar to the Exception Trigger component except this component lets you choose
a specific type of exception to trigger.
All trigger information is saved in a set of variables for future use in your project.
If this component is in the same model as an Exception Trigger component, this
component holds priority and is used first.
See “Exception Trigger” on page 459.
Component Toolbox Paths - Infrastructure > Exceptions; Infrastructure > Flow
Control; Infrastructure > Triggers; Process Components > Flow Control
Tab name
Options with descriptions
Trigger
■
Component Class Name
The variable name that is used to output the message of the
exception.
Trigger
■
Component IDVariable Name
The name of the variable that contains the ID of the component
that triggered the exception.
Component properties
Components
Tab name
Options with descriptions
Trigger
■
Component Name
The name of the variable that contains the component name that
triggered the exception.
Trigger
■
Exception Class Variable Name
The name of the variable that contains the name of the exception’s
class. This can be used to identify what part of the project caused
the exception.
Trigger
■
Exception Message Variable Name
The name of the variable that contains the message of the
exception. This is displayed to the user when the exception is
encountered.
Trigger
■
Exception Stack Trace Variable Name
The name of the variable that contains the stack trace of the
exception. Stack traces are used to trace the source of the
exception.
Trigger
■
Case Sensitive
Lets you select for the trigger type you specify to be considered
case sensitive.
Trigger
■
Contains
Lets you select to consider the entire trigger type or just sections
of it.
If this is selected, "DivideByZero" is considered equal to "DivideBy"
because "DivideByZero" contains the string "DivideBy."
Trigger
■
Trigger Type
The type of exception you want to trigger.
Sample exceptions might be "ValueNotFound" and "DivideByZero."
Settings
See “Settings tab in all components” on page 383.
Find Help Desk Contact
This component retrieves one or more contacts that match the search criterion
from Helpdesk Solution. Contacts can be retrieved by exactly matching the contact
type (contact name, NT ID, or email address).
Component Toolbox Path - Symantec > Help Desk > Contacts
463
464
Component properties
Components
Tab name
Options with descriptions
Configuration
■
Inputs
Search Value: The value to search. When you click the [...] button,
the value source selector opens.
Select Contact By: The value for finding a contact. The value must
be Name, NTId, or Email. If you select From Variable, enter the
value variable in the Contact Type Value option (usage example:
create a form that lets the user enter the desired value). If you
select From Picker, choose the value in the Contact Type
drop-down list. Use this if you want to force the value for finding
a contact.
Contact Type: The value (Name, NTId, or Email) for selecting a
Help Desk contact if you chose From Picker in the Select Contact
By option. Name, NTId, and Email are options in a contact entity.
Contact Type Value: The variable that contains the value for
selecting a Help Desk contact if you chose From Variable in the
Select Contact By option. The contact type value must be either
Name, NTId, or Email.
Configuration
■
Outputs
Result: The name of the result variable. This holds the found
contacts from the search.
When you click the [...] button, you can select the variable name
Notification Server See “Notification Server tab in Symantec components” on page 386.
Settings
See “Settings tab in all components” on page 383.
Folder Watch Start
This component monitors a directory for new, modified, or deleted files and starts
a workflow for each file that is modified.
This component takes the place of the Start component. When you use this
component, you first delete the Start component.
See “New File Auto Start” on page 501.
See “Configurable Auto Start” on page 416.
Tab name
Options with descriptions
File Watcher
■
Source Directory
The source directory for this component to monitor. When you
click the [...] button, the value source selector opens.
Component properties
Components
Tab name
Options with descriptions
File Watcher
■
File Variable Name
The name of the File output variable. This variable gets populated
with the contents of the file.
File Watcher
■
Filename Variable Name
The name of the Filename output variable. This variable gets
populated with the name of the file.
File Watcher
■
Use Filter
Filters the file type to monitor in the directory.
File Watcher
■
Filter
The file type to monitor in the directory.
File Watcher
■
Event Type Info Variable Name
The name of the Event Type info variable. This variable gets
populated with the type of event that occurred.
Settings
See “Settings tab in all components” on page 383.
For Each Element in Collection
This component loops or iterates through a collection. It lets you perform the
same operations on all items in a collection with options to perform special
operations on the first and last elements in the collection.
For example, if you have a collection variable that holds a list of email addresses,
you could link from the next element output path to a Send Email component that
sends an email to the next addressee in the collection. Then, the Send Email
component can link back to this component. This forms a loop that sends the
same email to all addressees in the collection.
Component Toolbox Path - Collection Handling; Infrastructure > Flow Control;
Process Components > Collection Handling
Table 25-30
Output Paths
Option
Description
next element
Connect to a component (or chain of components) that contains
operations you want to perform on each entry in your collection.
The component (or chain of components) that you connect to should
then connect back to this component.
465
466
Component properties
Components
Table 25-30
Output Paths (continued)
Option
Description
finished
Connect to the next component in your workflow after this component
has finished iterating through your collection.
first element
If you select to show the first and last paths, this option appears. You
can connect to a component (or chain of components) that contains
operations you want to perform on the first element in your collection.
The component (or chain of components) that you connect to should
then connect back to this component.
last element
If you select to show the first and last paths, this option appears. You
can connect to a component (or chain of components) that contains
operations you want to perform on the last element in your collection.
The component (or chain of components) that you connect to should
then connect back to this component.
Tab name
Options with descriptions
Configuration
■
Array Variable Type
The collection variable you want to manipulate. When you click
the [...] button, the value source selector opens.
To select a collection variable inside an array, drill into the array
and select a variable.
Show convertible types - Lets you select variables with datatypes
that may not be text (examples are phone numbers and birth dates)
but which can be converted to text.
Show optional data - Lets you select variables which are not
required, and therefore may not contain data.
Configuration
■
Item Variable Type
The datatype of the collection you want to perform operations on.
When you click the [...] button, the value source selector opens.
Configuration
■
Item Output Variable Name
The variable that contains the reference to the item in your
collection that this component is working with at any given
moment. This is the variable you can use in the components that
you connect to from an output path.
As this component iterates through your collection, the value of
this variable is changed.
Configuration
■
Show First And Last Paths
Provides first element and last element output paths.
Component properties
Components
Tab name
Options with descriptions
Settings
See “Settings tab in all components” on page 383.
Form Builder
This component lets you create a form that lets users enter data.
This component opens the Web Form Editor, which lets you build the Web form
you want. All components that are available to use in the form are listed in the
component toolbox in the Web Form Editor.
When you first double-click this component to edit it, you are asked if you want
to add an outcome component (output path). Each form must have an output path.
If you choose to not add one now, you can add one later.
If you want to add one now, you can click Yes, supply the output path name, and
then click OK.
Multiple output paths can be created. The easiest way to do this is to copy the
first output button you create.
To copy an output button
1
Click and hold the ctrl key.
2
Click on the button and drag it to another part of the form.
A new button is created and you are asked to supply the output path name.
To select a theme for your form
1
Select the Select Theme button.
2
In the Select Theme dialog box, click Edit Project Themes.
3
In the Project Themes dialog box, click Add.
4
In the left pane, select the theme you want to add and click OK.
5
Click Close.
6
Select the theme you want for your form and click OK.
To set a background image on your form
1
Select the Background Image button.
2
Click Browse to find the image you want to use.
3
Click OK.
To edit default settings on the form
◆
Right-click in the form and select Edit Form.
467
468
Component properties
Components
Table 25-31
Default Settings on form
Tab name
Options with descriptions
Appearance
■
Position
The position for where you want the title placed on the form.
Appearance
■
Title
The title you want on your form.
Behavior
These options let you provide JavaScript that gets executed when this
form is rendered or in the body tag of this form. You can also call
functions from other controls. These are for advanced programmers.
Body Custom Events
Lets you enter custom events for the body of the form.
■ Form Custom Events
Lets you enter custom events for the form.
■ Script
Lets you enter scripts for the form.
■
Processing
■
Show Processing Message
Displays a message to the user when the form closes.
Processing
■
Processing Message
The message you want displayed to the user when the form closes.
Processing
■
Message Back Color
The background color of the message.
Processing
■
Message Text Color
The message text color.
Processing
■
Message Position
The message position on the dialog box.
Table 25-32
Edit Component tabs
Tab name
Options with descriptions
Goback
■
Disable Go Back By Browser Button
Prevents the user from using a Go Back button on this form.
Goback
■
Go Back Path
The button (output path) to be used as the Go Back button on the
form.
Component properties
Components
Table 25-32
Edit Component tabs (continued)
Tab name
Options with descriptions
Goback
■
Settings
See “Settings tab in all components” on page 383.
Skip In Go Back
Skips this form when using a Go Back button.
Gain Approval
This component gets an approval from the service desk through an email. This
component is designed to let you send an email and provide links to the output
paths. This lets the receiver of the email provide approval or rejection. You can
add other output paths or delete the default output paths (Approve and Reject)
as needed (in the Links tab).
Table 25-33
Output Paths
Option
Description
Approve
The path followed if the component gets approved.
Reject
The path followed if the component gets rejected.
[Links]
An output path is created for each link added in the Links tab.
timed out
If the time in the Timeout Time Span option (in the Event
Configuration tab) is reached, the workflow follows this output path.
Tab name
Options with descriptions
Assignments
■
Task Source Configuration
The task source Symantec Management Console configuration and
authentication. When you click the [...] button, the Symantec
Management Console configuration and authentication window
appears.
See “Notification Server tab in Symantec components” on page 386.
Assignments
■
Task Name
A descriptive name for the task tied to this component. The name
is displayed in Process Manager and can describe briefly the
operations required to satisfy this workflow component. The name
of the task can be entered directly or when you click the [...] button.
469
470
Component properties
Components
Tab name
Options with descriptions
Assignments
■
Task Description
A description for your task. The description can describe in Process
Manager precisely what a user must do to satisfy this workflow
component. The description of the task can be entered directly or
when you click the [...] button.
Assignments
■
Task Priority By Variable Value
Sets the task priority using a variable.
Assignments
■
Task Priority
The priority (urgency) of this Process Manager task. The task for
this component is to enter all data required by the component.
This is available if Task Priority By Variable Value is not selected.
Assignments
■
Priority
The variable that contains the task priority. When you click the
[...] button, the value source selector opens. This option is available
if Task Priority By Variable Value is selected.
Assignments
■
Profile Name
If Process Manager is selected as the Integration method, and you
want to attach a Process Manager data profile to this workflow
task, this option is the name of the profile that you want to attach.
Assignments
■
Profile Values
If Process Manager is selected as the Integration method, and you
attached a Process Manager data profile to this workflow task, this
option lets you edit the data mappings of the profile that you
attached.
Assignments
■
Set Late Date And Due Date
If Process Manager is selected as the Integration method, this
option lets you set late and due dates for this workflow task in
Process Manager.
Assignments
■
Created By Use As Project Name
If Process Manager is selected as the Integration method, this
option lets you use the project name for the Process Manager
Created By variable. When this option is unchecked, the Created
By option appears. In the Created By option, you can select the
Created By variable when you click the [...] button.
Component properties
Components
Tab name
Options with descriptions
Assignments
■
On Bad Assignment
If Process Manager is selected as the Integration method, this
option lets you select how to handle the case where the Process
Manager assigned person is not found.
Assignments
■
Person Assignments
Lets you select the person assignments to assign your component's
task to an individual user or individual users in Process Manager.
When you click the [...] button, the value source selector opens.
Assignments
■
Workflow Queue Assignments
Lets you select the workflow queue assignments you want for the
task in Process Manager. When you click the [...] button, the value
source selector opens.
Assignments
■
Respond Display Format
If Process Manager is selected as the Integration method, this
option lets you select the format to display the task response in
Process Manager.
Default: The task response is displayed in a pop-up.
Embedded: The task response is displayed inside the form.
ChildForm: The task response is displayed in a child form.
Assignments
■
Task Type
If Process Manager is selected as the Integration method, this
option lets you select the Process Manager task type.
Assignments
■
Auto Height Width
If Process Manager is selected as the Integration method, this
option lets you select to keep the auto height and width for the
Process Manager form. To enter the height and width, clear this
option.
Interaction Setup
■
Is Dialog Model Active
Displays Dialog Model options.
Interaction Setup
■
Do Not Exit On Some Outputs
Lets you select if you do not want this component to exit on one
or more outputs.
471
472
Component properties
Components
Tab name
Options with descriptions
Interaction Setup
■
Do Not Exit On Outputs
Lets you select one or more outputs that this component will not
exit on. All outputs that are selected are removed as output paths
on this component.
This is useful if you have a button that lets the user return to the
dialog box, such as a Save As Draft button.
Email
■
Send Email
Lets you send an email.
See “Send Email” on page 527.
Event
Configuration
■
Start Description
A description of the process you chose as your Start Process. You
may include specific information on how the process works and
what it does.
Event
Configuration
■
Escalations
Lets you set escalations for your event. When you click Add, you
can set the escalations. Escalations are events in your workflow
process which cause the workflow to continue or move to a
different level.
Event
Configuration
■
Finish Description
A description of the process you want for your Finish Process.
You may include specific information on how the process works
and what it does.
Event
Configuration
■
Finish Process
The process which is executed at the end of your workflow process.
When you click the [...] button, you can create the finish process.
The finish process is executed when the workflow process is
approved and after the workflow process itself is executed.
Event
Configuration
■
Timeout Type
The timeout type. A process times out when a user does not respond
within a certain date or time span.
Event
Configuration
■
Timeout Date
Sets a specific date when a process times out.
When you click the [...] button, the value source selector opens.
This option contains a reference to a variable within your project
which holds the date you want your process to time out.
This option appears when Date is selected in the Timeout Type
option.
Component properties
Components
Tab name
Options with descriptions
Event
Configuration
■
Timeout Time Span
Sets how long to wait before a process times out. When you click
the [...] button, the value source selector opens.
This option appears when Time Span is selected in the Timeout
Type option.
Event
Configuration
■
Timeout Description
The description for your users of how and why a process times out.
You may include specific information or instructions.
Event
Configuration
■
Timeout Process
Declares a process which is executed when your workflow
component times out.
Expose as
webservice
■
Helpdesk
■
Help Desk Ticket Check Period
The amount of time in between checks for Helpdesk tickets. When
you click the [...] button, the time selector opens.
Links
■
Quick Links
When you select Add, you can add a link that also becomes an
output path.
Name: The name of the link.
Response Behavior: The behavior of the link.
Text: The text for the link.
Expose As Webservice
Exposes the Dialog Workflow and its output paths as a Webservice.
This lets you create an API accessible version of the Dialog
Workflow, which lets you make Webservice calls into your
workflow.
The Expose As Webservice tab appears when the Is Dialog Start
option is selected in the Assignments tab.
■ Defined Webservice Name
The Webservice name.
■ Variables To Expose
The workflow variables to expose to the Webservice.
■ Paths To Expose
The paths to expose to the Webservice.
Message Listeners See “Message Listeners tab in some components” on page 387.
Settings
See “Settings tab in all components” on page 383.
473
474
Component properties
Components
Get All Children For Parent Ticket
This component returns a list of ticket numbers that are associated with a single
parent ticket. The input is the parent ticket number and the output is a list of
child tickets associated with the parent.
Component Toolbox Path - Symantec > Help Desk > Tickets
Table 25-34
Output Paths
Option
Description
Found
One or more tickets are associated with the parent.
None Found
No tickets are associated with the parent.
Tab name
Options with descriptions
Configuration
■
Parent Ticket Number
The parent ticket number. When you click the [...] button, the value
source selector opens.
Configuration
■
Output Variable Name
The output variable name. When you click the [...] button, the value
source selector opens.
Notification Server See “Notification Server tab in Symantec components” on page 386.
Settings
See “Settings tab in all components” on page 383.
Get All Users And Groups
This component returns all users and groups found in Active Directory. Care
should be taken when using this component because a large amount of data can
be returned. In large domains, the Get Users in Group component is preferable
unless the process absolutely requires the full membership list for all groups.
See “Get Users in Group” on page 490.
See “Active Directory components” on page 392.
Table 25-35
Output Paths
Option
Description
OK
This path is followed if there was no error.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Component properties
Components
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Output
■
Found Groups Variable Name
The name of the Found Groups variable. This variable gets
populated with the data of the found groups.
Output
■
User Memberships Variable Name
The name of the User Memberships variable. This variable gets
populated with the data of the found users.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Get Computer
This component retrieves detailed information on a single computer.
This is a deployment component.
See “Create DS Connection Profile” on page 421.
Component Toolbox Path - Symantec > Deployment Solution
For example, you can use the List Computers component to retrieve a list of
computers. Then, you can iteratively call the Get Computer component (when you
use the For Each Element in Collection component) and retrieve detailed
information for all the computers in the list.
Table 25-36
Output Paths
Option
Description
Computer Found
A computer was found based on the search criteria.
Computer Not
Found
The computer could not be found based on the search criteria.
475
476
Component properties
Components
Tab name
Options with descriptions
Input
■
Computer Lookup Method
Lets you select the method for retrieving the computer information.
By Id - Retrieve the computer information using a computer’s ID.
By Name - Retrieve the computer information using a computer’s
name.
Input
■
Computer Id
The computer ID. When you click the [...] button, the value source
selector opens.
Input
■
Computer Name
The computer name. When you click the [...] button, the value
source selector opens.
Output
■
Computer Found
The name of the Computer Found output variable. This variable
gets populated with the information of the found computer.
Deployment
Server
See “Deployment Server tab in deployment components” on page 385.
Settings
See “Settings tab in all components” on page 383.
Get Computer List
This component retrieves a list of computers in Active Directory.
See “Active Directory components” on page 392.
Table 25-37
Output Paths
Option
Description
Found
This path is followed if the list of computers was retrieved from Active
Directory based on the criteria.
Not Found
This path is followed if the list of computers was not retrieved from
Active Directory based on the criteria.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Component properties
Components
Tab name
Options with descriptions
Input
■
Search Type
You can specify to return a list of all computers or a list of
computers based on search criteria.
All Computers: Returns a list of all computers.
Set of Fields: Lists the options you can set. You can specify the
computer search criteria by setting one or more of the options.
Output
■
Found Computers Variable Name
The name of the Found Computers output variable. This variable
gets populated with the list of computers that were retrieved from
Active Directory.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Get Current Date
This component captures and saves the current system date. After the date is
captured, you can use it down your project.
Component Toolbox Paths - Date Handling; Process Components > Date Handling
Tab name
Options with descriptions
Configuration
■
Settings
See “Settings tab in all components” on page 383.
Output Variable Name
Lets you select a variable or enter the output variable name. When
you click the [...] button, the value source selector opens. This is
the variable that the current system date.
A variable array value can be selected when you drill into the array
and select a value.
Get Folder Permission List
This component retrieves a list of folder permissions in Active Directory.
See “Active Directory components” on page 392.
477
478
Component properties
Components
Table 25-38
Output Paths
Option
Description
OK
This path is followed if there was no error.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Host Name
The name of the host to retrieve the folder permission information
from.
Input
■
Full Folder Path
The name of the full folder path to retrieve the folder permission
information from.
Input
■
Use Domain Admin Credential
Uses the domain administrator credential to retrieve folder
permission information from.
Input
■
Administrator Name
If Use Domain Admin Credential is not checked, the administrator
name to use for the credential.
Input
■
Administrator Password
If Use Domain Admin Credential is not checked, the administrator
password to use for the credential.
Output
■
Permission List Variable Name
The name of the Output Data output variable. This variable gets
populated with the permission list that was retrieved from Active
Directory.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Component properties
Components
Get Group List
This component returns a list of groups found in Active Directory.
See “Active Directory components” on page 392.
Table 25-39
Output Paths
Option
Description
Found
This path is followed if a group list was found based on the search
criteria.
Not Found
This path is followed if no group list was found based on the search
criteria.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Search Type
You can specify to return a list of all groups or a list of groups
based on search criteria.
All Groups: Returns a list of all groups.
Set of Fields: Lists the options you can set. You can specify the
group search criteria by setting one or more of the options.
Output
■
Found Groups Variable Name
The name of the Found Groups variable. This variable gets
populated with the data of the found groups.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Get Groups For User
This component returns a list of groups that a user is assigned to in Active
Directory.
See “Active Directory components” on page 392.
479
480
Component properties
Components
Table 25-40
Output Paths
Option
Description
Found
This path is followed if a list of groups was found that a user is
assigned.
Not Found
This path is followed if a list of groups was not found that a user is
assigned.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Name
The name of the user whose assigned groups you want to find.
Output
■
Found Groups Variable Name
The name of the Found Groups variable. This variable gets
populated with the data of the found groups.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Get Job
This component retrieves detailed information on a deployment job.
This is a deployment component.
See “Create DS Connection Profile” on page 421.
Component Toolbox Path - Symantec > Deployment Solution
Table 25-41
Output Paths
Option
Description
Job Found
A job was found based on the search criteria.
Job Not Found
The job could not be found based on the search criteria.
Component properties
Components
Tab name
Options with descriptions
Input
■
Job Source
Lets you select the source for retrieving the job information.
From Picker - Retrieve the job information from a picker.
From Variable - Retrieve the job information using a job ID.
Input
■
Job Id
The job ID.
If From Picker is selected, this option lets you click the [...] button,
enter a folder name (for example, Workflow), and choose the job.
The Job ID option gets populated with the ID of the job you want
information for.
If From Variable is selected, this option lets you click the [...] button
and enter a job ID.
Output
■
Job Variable Name
The name of the Job Variable output variable. This variable gets
populated with the information of the found job.
Deployment
Server
See “Deployment Server tab in deployment components” on page 385.
Settings
See “Settings tab in all components” on page 383.
Get Number From String
This component takes in a string and, if the string can be translated to a number,
returns a number from that string.
Table 25-42
Output Paths
Option
Description
value is a number
This path is followed if a number is generated from the string.
value is not a
number
This path is followed if a number cannot be translated from the string.
Tab name
Options with descriptions
Configuration
■
Input Variable Name
Lets you select the variable that contains the string being passed
in. When you click the [...] button, the value source selector opens.
A variable array value can be selected when you drill into the array
and select a value.
481
482
Component properties
Components
Tab name
Options with descriptions
Configuration
■
Settings
See “Settings tab in all components” on page 383.
Output Variable Name
Lets you select a variable or enter the output variable name. When
you click the [...] button, the value source selector opens. This is
the variable that holds the translated number.
A variable array value can be selected when you drill into the array
and select a value.
Get Organization Units List
This component returns a list of organization units found in Active Directory.
See “Active Directory components” on page 392.
Table 25-43
Output Paths
Option
Description
Found
This path is followed if an organization units list was found based on
the search criteria.
Not Found
This path is followed if an organization units list was not found based
on the search criteria.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Search Type
You can specify to return a list of all organization units or a list of
organization units based on search criteria.
All Organization Units: Returns a list of all organization units.
Set of Fields: Lists the options you can set. You can specify the
organization units search criteria by setting one or more of the
options.
Output
■
Found Organizations Variable Name
The name of the Found Organizations variable. This variable gets
populated with the data of the found organization units.
Component properties
Components
Tab name
Options with descriptions
Output
■
Settings
See “Settings tab in all components” on page 383.
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Get Scheduled Job
This component lets you retrieve information on a scheduled job. You choose the
job and the computer you want to retrieve the job information from.
This is a deployment component.
See “Create DS Connection Profile” on page 421.
Component Toolbox Path - Symantec > Deployment Solution
Table 25-44
Output Paths
Option
Description
Scheduled Job
Found
A scheduled job was found based on the search criteria.
Scheduled Job Not The scheduled job could not be found based on the search criteria.
Found
Tab name
Options with descriptions
Input
■
Job Source
Lets you select the scheduled job you want to retrieve information
from.
From Picker - Retrieve the scheduled job information from a picker.
From Variable - Retrieve the scheduled job information using a job
ID.
483
484
Component properties
Components
Tab name
Options with descriptions
Input
■
Job Id
The job ID.
If From Picker is selected, this option lets you click the [...] button,
enter a folder name (for example, Workflow), and choose the
scheduled job. The Job ID option gets populated with the ID of the
scheduled job you want to retrieve information from.
If From Variable is selected, this option lets you click the [...] button
and enter a job ID.
Input
■
Computer Source
Lets you select the computer you want to retrieve the scheduled
job information from.
From Picker - Retrieve the computer from a picker.
From Variable - Retrieve the computer using a computer ID.
Input
■
Computer Id
The computer ID.
If From Picker is selected, this option lets you click the [...] button,
enter a group name or criteria, and choose the computer. The
Computer ID option gets populated with the ID of the computer
you want to retrieve the scheduled job information from.
If From Variable is selected, this option lets you click the [...] button
and enter a computer ID.
Output
■
Scheduled Job Variable Name
The name of the output variable that contains the scheduled job
information.
Deployment
Server
See “Deployment Server tab in deployment components” on page 385.
Settings
See “Settings tab in all components” on page 383.
Get Help Desk Assets For Contact
This component returns a collection of Help Desk assets for a given contact. This
component makes use of the existing functionality of Helpdesk Webservice to
find assets belonging to the given contact ID and return that list.
Component Toolbox Path - Symantec > Help Desk > Assets
Component properties
Components
Tab name
Options with descriptions
Configuration
■
Contact Id
The ID of the contact for which to retrieve the Help Desk asset list.
When you click the [...] button, the value source selector opens.
The ID corresponds to the contact_id option in the incident
database and to the ID option of the ServiceDeskContact datatype.
Configuration
■
Help Desk Asset List Variable Name
The name of the variable that contains the Help Desk asset list for
the given contact ID. When you click the [...] button, the value
source selector opens.
Notification Server See “Notification Server tab in Symantec components” on page 386.
Settings
See “Settings tab in all components” on page 383.
Get Help Desk Contact Manager
This component returns the manager for a given contact. The input is the contact
ID option from the Helpdesk incident database. A typical use is to use the Find
Help Desk Contact or Pick Help Desk Contact component to add an instance of
the ServiceDeskContact datatype into the process. This component expects the
ID option of the ServiceDeskContact datatype. The returned manager is another
instance of a ServiceDeskContact datatype.
Component Toolbox Path - Symantec > Help Desk > Contacts
Tab name
Options with descriptions
Configuration
■
Contact Id
The ID of the contact for which to retrieve the manager. When you
click the [...] button, the value source selector opens. The ID
corresponds to the contact_id option in the incident database and
to the ID option of the ServiceDeskContact datatype.
Configuration
■
Contact Manager Variable Name
The name of the variable that contains the manager for the given
contact ID. When you click the [...] button, the value source selector
opens. The manager is an instance of a ServiceDeskContact
datatype.
Notification Server See “Notification Server tab in Symantec components” on page 386.
Settings
See “Settings tab in all components” on page 383.
485
486
Component properties
Components
Get Share Permission List
This component retrieves a list of share permissions in Active Directory.
See “Active Directory components” on page 392.
Table 25-45
Output Paths
Option
Description
OK
This path is followed if there was no error.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Shared Folder Name
The name of the shared folder to retrieve the permission
information from.
Input
■
Use Domain Admin Credential
Uses the domain administrator credential to retrieve share
permission information from.
Input
■
Administrator Name
If Use Domain Admin Credential is not checked, the administrator
name to use for the credential.
Input
■
Administrator Password
If Use Domain Admin Credential is not checked, the administrator
password to use for the credential.
Output
■
Permission List Variable Name
The name of the Output Data output variable. This variable gets
populated with the permission list that was retrieved from Active
Directory.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Component properties
Components
Get Shared Folders List
This component returns a list of shared folders found in Active Directory.
See “Active Directory components” on page 392.
Table 25-46
Output Paths
Option
Description
Found
This path is followed if a shared folders list was found based on the
search criteria.
Not Found
This path is followed if a shared folders list was not found based on
the search criteria.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Search Type
You can specify to return a list of all shared folders or a list of
shared folders based on search criteria.
All Shared Folders: Returns a list of all shared folders.
Set of Fields: Lists the options you can set. You can specify the
shared folders search criteria by setting one or more of the options.
Output
■
Found Shared Folders Variable Name
The name of the Found Shared Folders variable. This variable gets
populated with the data of the found shared folders.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Get Task Definition from Task
This component retrieves details about a task that was run on a job. These details
are then output for you to use in your workflow.
This is a deployment component.
487
488
Component properties
Components
See “Create DS Connection Profile” on page 421.
Component Toolbox Path - Symantec > Deployment Solution
Tab name
Options with descriptions
Input
■
Task
The task whose definition information you want to retrieve from
the deployment task editor.
Input
■
Task Type
The type of task that is selected or entered in the Task option.
Deployment Solution has multiple task types. Each task type has
its own set of parameters. You must enter a Task Type in order to
retrieve task definition information.
Output
■
Hide Exception On Failure
If this component cannot retrieve the task definition information,
a check in this box hides the exception that is returned.
Output
■
Task Definition
The name of the task definition output variable. This variable
contains details of a task.
Deployment
Server
See “Deployment Server tab in deployment components” on page 385.
Settings
See “Settings tab in all components” on page 383.
Get Ticket Status
This component returns the status of a Help Desk incident.
Component Toolbox Path - Symantec > Help Desk > Tickets
Tab name
Options with descriptions
Configuration
■
Incident Number
The incident number to get the status from. When you click the
[...] button, the value source selector opens. You can choose a
constant, dynamic, or variable value (such as the output variable
for the Create Ticket component).
Configuration
■
Status Variable Name
The name of the variable that contains the incident status.
Notification Server See “Notification Server tab in Symantec components” on page 386.
Component properties
Components
Tab name
Options with descriptions
Settings
See “Settings tab in all components” on page 383.
Get User List
This component returns a list of users found in Active Directory.
See “Active Directory components” on page 392.
Table 25-47
Output Paths
Option
Description
Found
This path is followed if a user list was found based on the search
criteria.
Not Found
This path is followed if no user list was found based on the search
criteria.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Search Type
You can specify to return a list of all users or a list of users based
on search criteria.
All Users: Returns a list of all users.
Set of Fields: Lists the options you can set. You can specify the
user search criteria by setting one or more of the options.
Output
■
Found Users Variable Name
The name of the Found Users variable. This variable gets populated
with the data of the found users.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
489
490
Component properties
Components
Get Users in Group
This component returns a list of users that are assigned to a group in Active
Directory.
See “Active Directory components” on page 392.
Table 25-48
Output Paths
Option
Description
Found
This path is followed if a list of users was found.
Not Found
This path is followed if a list of users was not found.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Name
The name of the group whose assigned users you want to find.
Output
■
Found Users Variable Name
The name of the Found Users variable. This variable gets populated
with the data of the found users.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Global Logging Capture
This component lets you enable reporting. Unlike other components, it does not
need to have any connections coming into or going out of it.
This component appears on your workflow when the Add Process Component
checkbox is clicked in the Project Global Properties Reporting tab.
See “Reporting tab”on page 558 on page 558.
Component properties
Components
Hanging Path Trigger
This component lets you trigger a hanging path. A hanging path is a path which
leads to the end of a project. A hanging path is a dead end and is not connected
to any component. This component lets you end a project prematurely.
When you drop this component on your model, all paths from components that
are not connected (hanging paths) become valid. This component catches all
hanging paths and sends them to the end of the project.
See “Hanging Path Trigger By Path” on page 492.
See “Hanging Path Trigger By Components” on page 491.
Tab name
Options with descriptions
Output Variables
■
Component IDVariable Name
The variable name that holds the component ID of the component
involved in your hanging path. The variable name you enter is
created after the hanging path is triggered.
Output Variables
■
Path Name Variable
The variable name that contains information about the hanging
path you are triggering. The variable contains identification
information which can be referenced later in the project. The
variable name you enter is created after the hanging path is
triggered.
Settings
See “Settings tab in all components” on page 383.
Hanging Path Trigger By Components
This component lets you trigger a hanging path by referencing the component
that acts as the hanging path’s source. Hanging paths cause the end of projects,
because they are paths with no destination component.
See “Hanging Path Trigger” on page 491.
Tab name
Options with descriptions
Configuration
■
Components
The name of one or more components that you want to act as the
path’s source. These are the components that originate the hanging
path. When you click the [...] button, the value source selector
opens.
491
492
Component properties
Components
Tab name
Options with descriptions
Configuration
■
Component IDVariable Name
The variable name that holds the component ID of the component
involved in your hanging path. The variable name you enter is
created after the hanging path is triggered.
Configuration
■
Path Name Variable
The variable name that contains information about the hanging
path you are triggering. The variable contains identification
information which can be referenced later in the project. The
variable name you enter is created after the hanging path is
triggered.
Settings
See “Settings tab in all components” on page 383.
Hanging Path Trigger By Path
This component lets you trigger a hanging path by referencing the hanging path
itself. Hanging paths cause the end of projects, because they are paths with no
destination component.
See “Hanging Path Trigger” on page 491.
Tab name
Options with descriptions
Configuration
■
Paths
The name of one or more paths that you want to make into hanging
paths. When you click Add, you can add the names of one or more
paths.
Configuration
■
Component IDVariable Name
The variable name that holds the component ID of the component
involved in your hanging path. The variable name you enter is
created after the hanging path is triggered.
Configuration
■
Path Name Variable
The variable name that contains information about the hanging
path you are triggering. The variable contains identification
information which can be referenced later in the project. The
variable name you enter is created after the hanging path is
triggered.
Settings
See “Settings tab in all components” on page 383.
Component properties
Components
HTMLMergeComponent
This component lets you create a label with data formed from HTML code. The
HTML can contain data from variables in your project or constant data you specify.
This lets your labels and text be dynamic and adjusts to variable data within your
project.
If you want to validate this component, you must enter text in the Text option on
the Appearance tab.
This component is available in a Forms project through a form component that
utilizes the Web Form Editor (for example, Form Builder).
Tab name
Options with descriptions
Functionality
■
Custom Events
A list of customized events you want this component to respond
to.
If you want to add an event handler, you must click Add and scroll
to the event name. Then in the Edit Object dialog box, you must
select the behavior configuration for the event handler you chose.
Functionality
■
Specify Control ID
Specifies your own control ID. If this option is not selected, an
automatically created control ID is specified for this component.
Functionality
■
Control ID
Lets you enter a unique identifier for this component. This
identifies this component to the Web browser.
Functionality
■
Tab Index
Lets you enter the tab order for this component on the page.
When a user presses the tab key, the curser moves to the
component with the next consecutive numbered Tab Index on the
form.
Functionality
■
Tab Stop
Allows this component to be a tab stop. If this is cleared, a user
cannot get to this component by using the tab key.
Functionality
■
Tool Tip
Lets you enter a tool tip for this component. Tool tips are displayed
when the user hovers the cursor over the text box.
493
494
Component properties
Components
Tab name
Options with descriptions
Functionality
■
Visible
Lets you select whether or not you want this text box to be visible.
If you use a variable for this, your workflow can change the variable
so that this component only appears on the form in certain
instances; for example, only on Tuesday.
Appearance
■
Component Size
The size you want for the component.
You can also adjust the component size when you click on it and
drag on the box.
Appearance
■
Overflow Behavior
The behavior if a user types in text that is wider than the
component.
Overflow - The component expands as the user types.
Clip - Does not show the words that go past the edge of the
component.
Scroll - Places a scroll bar on the component, which lets the user
scroll to see all the text.
Appearance
■
Text
The text for this component. When you click the [...] button, the
value source selector opens.
The text can be assembled through standard HTML tags using the
advanced text editor, which lets you string together variable data
or customized constant data to form your text.
Look And Feel
■
Settings
See “Settings tab in all components” on page 383.
Style
The style information you want for this component. Style
information includes font name, font face, font color, background
color, and so forth.
■ Theme Style
The theme style for this component.
Theme styles are only available when a theme is added to the form.
Initialize Data
This lets you create and initialize data variables. These variables can be used
anywhere down your process.
Component Toolbox Path - Infrastructure > Data
Component properties
Components
Tab name
Options with descriptions
Configuration
■
Settings
See “Settings tab in all components” on page 383.
Variables
You can create and initialize a data variable when you click Add.
Data Type: The type of your variable. When you click the [...]
button, the value source selector opens. You may choose from
many variable types, including string and long (decimals).
Is Array: You can select this if the variable you want to write is in
array format (contains multiple instances of the same variable
type).
Value: The value you want for your variable. When you click the
[...] button, the value source selector opens. This is how you
initialize your variable. The value or values you can enter depend
on the datatype you chose and whether or not it is an array.
Variable Name: The variable name you want to use to store your
value. When you click the [...] button, the value source selector
opens. You can use a new variable name or the name of an already
created variable. The variable type of an already created variable
must match the datatype you chose.
LabelComponent
This component lets you place text anywhere on your Web form.
The text on your form is the backbone of the form operations. It lets you convey
to the user precisely how to fill out the form and why the form needs to be filled
out.
This component is available in a Forms project through a form component that
utilizes the Web Form Editor (for example, See “Form Builder” on page 467.).
Tab name
Options with descriptions
Functionality
■
Custom Events
A list of customized events you want this component to respond
to.
If you want to add an event handler, you must click Add and scroll
to the event name. Then in the Edit Object dialog box, you must
select the behavior configuration for the event handler you chose.
Functionality
■
Specify Control ID
Specifies your own control ID. If this option is not selected, an
automatically created control ID is specified for this component.
495
496
Component properties
Components
Tab name
Options with descriptions
Functionality
■
Control ID
A unique identifier for this component. This identifies this
component to the Web browser.
Functionality
■
Tab Index
The tab order for this component on the page.
When a user presses the tab key, the curser moves to the
component with the next consecutive numbered Tab Index on the
form.
Functionality
■
Tab Stop
Allows this component to be a tab stop. If this is cleared, a user
cannot get to this component by using the tab key.
Functionality
■
Tool Tip
A tool tip for this component. Tool tips are displayed when the
user hovers the cursor over the text box.
Functionality
■
Visible
Lets you select whether or not you want this text box to be visible.
If you use a variable for this, your workflow can change the variable
so that this component only appears on the form in certain
instances; for example, only on Tuesday.
Appearance
■
Component Size
The size you want for the component.
You can also adjust the component size when you click on it and
drag on the box.
Appearance
■
Overflow Behavior
The behavior if a user types in text that is wider than the
component.
Overflow - The component expands as the user types.
Clip - Does not show the words that go past the edge of the
component.
Scroll - Places a scroll bar on the component, which lets the user
scroll to see all the text.
Appearance
■
Text
The text for the label.
Look And Feel
■
Style
The style information you want for this component. Style
information includes font name, font face, font color, background
color, and so forth.
Component properties
Components
Tab name
Options with descriptions
Look And Feel
■
Settings
See “Settings tab in all components” on page 383.
Theme Style
The theme style for this component.
Theme styles are only available when a theme is added to the form.
List Computers
This component lets you retrieve a list computers from Deployment Solution.
This only retrieves general computer information. To retrieve more detailed
computer information, use the Get Computer component.
See “Get Computer” on page 475.
This is a deployment component.
See “Create DS Connection Profile” on page 421.
Component Toolbox Path - Symantec > Deployment Solution
Tab name
Options with descriptions
Input
■
List Computers In All Groups
If checked, lets you retrieve a list of computers in all groups using
a search phrase.
If not checked, lets you retrieve a list of computers by group.
Input
■
Search Phrase
Lets you retrieve a list of computers in all groups by entering a
search phrase. This is a powerful feature that lets you search by
such things as IP address, name by FQDN, name as it appears in
Deployment Solution, and OS type. For more information on using
this search feature, see the ASDK help.
Note: If you have a large number of computers, we recommend
that you enter a value when you use this option. If you use this
option and do not enter a value, a list of all of your computers is
retrieved.
This is available when List Computers In All Groups is not checked.
497
498
Component properties
Components
Tab name
Options with descriptions
Input
■
Group Lookup Method
Lets you select the method for retrieving the list of computers by
group. This is available when List Computers In All Groups is
checked.
ByID - Retrieve the list of computers using a group’s ID.
ByName - Retrieve the list of computers using a group’s name.
Input
■
Group Id
The group ID. When you click the [...] button, the value source
selector opens.
This is available when List Computers In All Groups is checked.
Input
■
Group Name
The group name. When you click the [...] button, the value source
selector opens.
This is available when List Computers In All Groups is checked.
Output
■
Group ID
The name of the Group ID output variable. This variable gets
populated with the list of computers.
Deployment
Server
See “Deployment Server tab in deployment components” on page 385.
Settings
See “Settings tab in all components” on page 383.
List Jobs In Folder
This component lets you retrieve a list of jobs in a folder from Deployment
Solution.
This is a deployment component.
See “Create DS Connection Profile” on page 421.
Component Toolbox Path - Symantec > Deployment Solution
Tab name
Options with descriptions
Input
■
Lookup Method
Lets you select the method for retrieving the folder containing the
list of jobs you want.
By Id - Retrieve the list of jobs using a folder’s ID.
By Name - Retrieve the list of jobs using a folder’s name.
Component properties
Components
Tab name
Options with descriptions
Input
■
Folder ID
The folder ID. When you click the [...] button, the value source
selector opens.
Input
■
Folder Name
The folder name. When you click the [...] button, the value source
selector opens.
Output
■
Job List Variable Name
The name of the output variable that contains the list of jobs.
Deployment
Server
See “Deployment Server tab in deployment components” on page 385.
Settings
See “Settings tab in all components” on page 383.
List Schedules For Job
This component lets you retrieve a list of the instances of a job that are scheduled
on computers. This only lists schedules for a job that has not successfully executed.
This is a deployment component.
See “Create DS Connection Profile” on page 421.
Component Toolbox Path - Symantec > Deployment Solution
Tab name
Options with descriptions
Input
■
Job ID
The job ID whose schedule you want to see. When you click the [...]
button, the value source selector opens.
Output
■
Schedule List Variable Name
The name of the output variable that contains the schedules of a
job.
Deployment
Server
See “Deployment Server tab in deployment components” on page 385.
Settings
See “Settings tab in all components” on page 383.
Matches Rule
This component lets you check whether an input variable matches any item in a
list you provide.
499
500
Component properties
Components
Example: You may use this component to check whether an input variable in a
form is a match to any of a set of possible user names.
Component Toolbox Path - Rules > Text
Table 25-49
Output Paths
Option
Description
no match
The variable does not match any item in the list.
[List Item]
Each item in the Compare To List becomes an output path. If the
variable matches an item, the workflow follows that output path.
Tab name
Options with descriptions
Evaluation
■
Case Insensitive
You can select this component if you want the comparison to be
case insensitive.
Evaluation
■
Compare To List
The list of values to compare to the Compare To Variable option.
Evaluation
■
Compare To Variable
A variable from within your project which contains the value you
are comparing. When you click the [...] button, the value source
selector opens.
Settings
See “Settings tab in all components” on page 383.
Move Object To Container
This component moves an object to a container in Active Directory.
See “Active Directory components” on page 392.
Table 25-50
Output Paths
Option
Description
Moved
This path is followed if the object was moved to the specified container
in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Component properties
Components
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Object Type
The type of the object being moved.
Input
■
Object Name
The name of the object being moved.
Input
■
Destination Container Type
The branch of the Active Directory tree you want to move the object
to.
Input
■
Destination Organization Path
If Organization Unit is selected, this is the path to the organization
to move the object to.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
New File Auto Start
This component monitors a directory for new files, starts a new workflow with
each file, modifies the file (renames, moves, deletes), and gives that file to the
next component in the workflow.
This component takes the place of the Start component. When you use this
component, you first delete the Start component.
See “Configurable Auto Start” on page 416.
See “Folder Watch Start” on page 464.
Tab name
Options with descriptions
Input
■
Source Directory
The source directory for this component to monitor. When you
click the [...] button, the value source selector opens.
Monitoring
■
Use Filter
Lets you filter the file type to monitor in the directory.
501
502
Component properties
Components
Tab name
Options with descriptions
Monitoring
■
Filter
The file type to monitor in the directory.
Output
■
File Variable Name
The name of the File output variable. This variable gets populated
with the contents of the file.
File Watcher
■
Action
The action to perform on the file.
File Watcher
■
Move To Directory
The directory to move the file to. When you click the [...] button,
the value source selector opens. This is available if you chose the
Move action.
File Watcher
■
Add To File Name
The new name for the file. This is available if you chose the Rename
action.
Settings
See “Settings tab in all components” on page 383.
Number Range Rule
This component lets you check a variable number to see if it is within a range of
numbers. You may check to see if it is greater than, less than, equal to, or within
a range of specific set values. You determine the number ranges that the
component uses and output paths are generated based on those number ranges.
Component Toolbox Paths - Math; Rules > Math
Table 25-51
Output Paths
Option
Description
[Number Ranges]
When the input number variable falls in a defined number range, the
workflow follows that output path.
Tab name
Options with descriptions
Evaluation
■
Compare Variable
A number variable to compare against. When you click the [...]
button, the value source selector opens. The number in the number
variable is compared against the ranges specified in the Values.
Component properties
Components
Tab name
Options with descriptions
Evaluation
■
Handle Equals By
Lets you select how you want to handle cases where the number
equals the number in Values.
MakeExplicit: Makes the rules explicit (no rounding). A rule is
then created for exactly the number specified, as well as greater
than or less than the number specified.
RoundDown: Makes the rules round down.
RoundUp: Makes the rules round up.
Evaluation
■
Values
The values you want to check your number variable against. You
can enter values when you click Add.
Settings
See “Settings tab in all components” on page 383.
Password String Generator
This component generates a password based on the policies you set. Generated
passwords can be fed into Active Directory that allow password input (for example,
Reset User Password).
See “Active Directory components” on page 392.
Table 25-52
Output Path
Option
Description
Generated
This path is followed if the password string was generated.
Tab name
Options with descriptions
Input
■
Number of Characters
The minimum number of characters the password has to contain.
Input
■
Strong Password
Forces the password to be strong (contains alpha numeric
characters, at least one case change, and at least one symbol
character).
Input
■
Must Be Alpha Numeric
If Strong Password is not selected, this option forces the password
to be alpha numeric.
503
504
Component properties
Components
Tab name
Options with descriptions
Input
■
Have Case Change
If Strong Password is not selected, this option forces the password
to have a case change.
Output
■
Generated Password Variable Name
The name of the Generated Password variable. This variable gets
populated with the password that was generated to use in Active
Directory.
Settings
See “Settings tab in all components” on page 383.
Quick Link Dialog Workflow
This component lets you place buttons in an email for users to click in response
to the email. An output path is followed based on the button that is clicked.
For example, if you want a user to approve or deny a request, use this component
to place Approve and Deny buttons in an email to the user.
Component Toolbox Paths - Workflow Components
Table 25-53
Output Paths
Option
Description
timed out
If the time in the Timeout Time Span option (in the Event
Configuration tab) is reached, the workflow follows this output path.
[Links]
An output path is created for each link added in the Links tab.
Tab name
Options with descriptions
Assignments
■
Task Source Type
The source type for the task.
ActiveDirectoryTaskSource: Uses Active Directory as the source.
AltirisTaskSource: Uses the Altiris task as the source.
DefaultTaskSource: Uses the default task source. Workflow
Solution manages this default task source. The default task source
is primarily used for email.
ProcessManagerTaskSource: Creates this workflow as a task in
Process Manager (for Workflow Solution Advanced users).
SharePointTaskSource: Uses Share Point as the source.
TaskListTaskSource: Uses a list as the task source.
Component properties
Components
Tab name
Options with descriptions
Assignments
■
Require Assignment
Requires this task be assigned to someone or some group. When
selected, this component will not execute unless at least one
assignment is made.
Assignments
■
Task Name
A descriptive name for the task tied to this component. The name
is displayed in Process Manager and can describe briefly the
operations required to satisfy this workflow component. The name
of the task can be entered directly or when you click the [...] button.
Assignments
■
Task Description
A description for your task. The description can describe in Process
Manager precisely what a user must do to satisfy this workflow
component. The description of the task can be entered directly or
when you click the [...] button.
Assignments
■
Task Priority By Variable Value
Sets the task priority using a variable.
Assignments
■
Assignments
■
Profile Name
If Process Manager is selected as the Integration method, and you
want to attach a Process Manager data profile to this workflow
task, this option is the name of the profile that you want to attach.
Assignments
■
Profile Values
If Process Manager is selected as the Integration method, and you
attached a Process Manager data profile to this workflow task, this
option lets you edit the data mappings of the profile that you
attached.
Assignments
■
Set Late Date And Due Date
If Process Manager is selected as the Integration method, this
option lets you set late and due dates for this workflow task in
Process Manager.
Task Priority
The priority (urgency) of this Process Manager task. The task for
this component is to enter all data required by the component.
This is available if Task Priority By Variable Value is not selected.
■ Priority
The variable that contains the task priority. When you click the
[...] button, the value source selector opens. This option is available
if Task Priority By Variable Value is selected.
505
506
Component properties
Components
Tab name
Options with descriptions
Assignments
■
Created By Use As Project Name
If Process Manager is selected as the Integration method, this
option lets you use the project name for the Process Manager
Created By variable. When this option is unchecked, the Created
By option appears. In the Created By option, you can select the
Created By variable when you click the [...] button.
Assignments
■
On Bad Assignment
If Process Manager is selected as the Integration method, this
option lets you select how to handle the case where the Process
Manager assigned person is not found.
Assignments
■
Is Dialog Start
Lets you select if you want this form to be the start of the workflow.
When this is selected, the Expose As Webservice tab appears.
Assignments
■
Person Assignments
Lets you select the person assignments to assign your component's
task to an individual user or individual users in Process Manager.
When you click the [...] button, the value source selector opens.
Assignments
■
Group Assignments
Lets you select the group assignments you want to assign a task
in Process Manager. When you click the [...] button, the value source
selector opens.
Assignments
■
Org Unit Assignments
Lets you select the organizational unit assignments you want for
the task in Process Manager. When you click the [...] button, the
value source selector opens.
Assignments
■
Workflow Queue Assignments
Lets you select the workflow queue assignments you want for the
task in Process Manager. When you click the [...] button, the value
source selector opens.
Assignments
■
Permission Assignments
Lets you select the permission assignments you want for this
component's task in Process Manager. When you click the [...]
button, the value source selector opens.
Component properties
Components
Tab name
Options with descriptions
Assignments
■
Respond Display Format
If Process Manager is selected as the Integration method, this
option lets you select the format to display the task response in
Process Manager.
Default: The task response is displayed in a pop-up.
Embedded: The task response is displayed inside the form.
ChildForm: The task response is displayed in a child form.
Assignments
■
Task Type
If Process Manager is selected as the Integration method, this
option lets you select the Process Manager task type.
Assignments
■
Auto Height Width
If Process Manager is selected as the Integration method, this
option lets you select to keep the auto height and width for the
Process Manager form. To enter the height and width, clear this
option.
Interaction Setup
■
Is Dialog Model Active
Displays Dialog Model options.
Interaction Setup
■
Dialog Model
Lets you create a model that includes the dialog box you want
displayed to users. The dialog model is a built-in Webforms project.
It lets you create the workflow needed to design your Webforms.
An output path is created on the Dialog Workflow component for
each End component added in this model. You should have an End
component for each possible outcome of the dialog model.
For example, you can create an "Approve" End component, a "Deny"
End component, and an "Alternate" End component.
Interaction Setup
■
Respond Link Name
The name you want to use for the respond link. The respond link
is clicked by users to respond to the question at hand, and when
clicked, submits any information the user entered into the dialog
box.
507
508
Component properties
Components
Tab name
Options with descriptions
Interaction Setup
■
Allow Multiple Responses
Lets you create multiple responses through unique dialog models.
These dialog models can perform tasks that are related to the
Dialog Workflow component, but may not necessarily affect the
outcome directly (such as helping a manager make a decision).
For example, suppose the Dialog Workflow component lets a
manager approve or deny the purchase of a cell phone. The
manager has received multiple cell phone requests of the same
model, but rejects the requests because the company does not
support it. The manager decides to send in a request to see if the
company will support that model of phone. For instances like this,
you can create a response that shows a button that lets the manager
send a request to IT.
Interaction Setup
■
Dialog Models
When you click Add, you can create a response dialog model.
Category
The category for this response. This helps you keep track of similar
responses.
Name
The name of the response. This is displayed to the user in the Dialog
Workflow component.
Dialog Model
Lets you create a model that includes the dialog box you want
displayed to users. When you click the [...] button, the dialog model
appears.
Resolve Workflow Task On Exit
Closes the Dialog Workflow process when this Dialog Model exits.
Conditionally Use
Lets you select to use this Dialog Model only in certain conditions.
This lets you create a unique dialog model that defines the
conditions to show and not to show this Dialog Model.
Set Start Date
Sets a start date for this Dialog Model.
Set End Date
Sets an end date for this Dialog Model.
■
■
■
■
■
■
■
Interaction Setup
■
Do Not Exit On Some Outputs
Lets you select if you do not want this component to exit on one
or more outputs.
Component properties
Components
Tab name
Options with descriptions
Interaction Setup
■
Do Not Exit On Outputs
Lets you select one or more outputs that this component will not
exit on. All outputs that are selected are removed as output paths
on this component.
This is useful if you have a button that lets the user return to the
dialog box, such as a Save As Draft button.
Interaction Setup
■
Form Position
Lets you select where you want the forms built in the Dialog Model
to appear on the Web browser. Default uses the Web browser
settings.
Interaction Setup
■
Form Theme
The theme to use for the forms built in the Dialog Model.
Interaction Setup
■
Form Type
The form type you want to use for the forms built in the Dialog
Model. Use the Web form type if your forms are built to be viewed
on the Web. Use the Mobile form type to display forms on a mobile
device. Use the MobileAndWeb form type to cause each form to
use the browser’s declarations to discover whether or not it is being
used on a mobile device and renders itself accordingly.
Links
■
Quick Links
When you select Add, you can add a link that also becomes an
output path. These links can be added in the message of the Email.
Name: The name of the link.
Response Behavior: The behavior of the link.
Text: The text for the link.
Email
■
Send Email
Lets you send an email.
See “Send Email” on page 527.
509
510
Component properties
Components
Tab name
Options with descriptions
Expose as
webservice
■
Event
Configuration
■
Start Description
A description of the process you chose as your Start Process. You
may include specific information on how the process works and
what it does.
Event
Configuration
■
Start Process
The process which is executed at the beginning of your workflow
process. When you click the [...] button, you can create the start
process.
The start process is executed when the workflow process is
approved and before the workflow process itself is executed.
Event
Configuration
■
Escalations
Lets you set escalations for your event. When you click Add, you
can set the escalations. Escalations are events in your workflow
process which cause the workflow to continue or move to a
different level.
Event
Configuration
■
Finish Description
A description of the process you want for your Finish Process.
You may include specific information on how the process works
and what it does.
Event
Configuration
■
Finish Process
The process which is executed at the end of your workflow process.
When you click the [...] button, you can create the finish process.
The finish process is executed when the workflow process is
approved and after the workflow process itself is executed.
Expose As Webservice
Exposes the Dialog Workflow and its output paths as a Webservice.
This lets you create an API accessible version of the Dialog
Workflow, which lets you make Webservice calls into your
workflow.
The Expose As Webservice tab appears when the Is Dialog Start
option is selected in the Assignments tab.
■ Defined Webservice Name
The Webservice name.
■ Variables To Expose
The workflow variables to expose to the Webservice.
■ Paths To Expose
The paths to expose to the Webservice.
Component properties
Components
Tab name
Options with descriptions
Event
Configuration
■
Timeout Type
The timeout type. A process times out when a user does not respond
within a certain date or time span.
Event
Configuration
■
Timeout Date
Sets a specific date when a process times out.
When you click the [...] button, the value source selector opens.
This option contains a reference to a variable within your project
which holds the date you want your process to time out.
This option appears when Date is selected in the Timeout Type
option.
Event
Configuration
■
Timeout Time Span
Sets how long to wait before a process times out. When you click
the [...] button, the value source selector opens.
This option appears when Time Span is selected in the Timeout
Type option.
Event
Configuration
■
Timeout Description
The description for your users of how and why a process times out.
You may include specific information or instructions.
Event
Configuration
■
Timeout Process
Declares a process which is executed when your workflow
component times out.
Settings
See “Settings tab in all components” on page 383.
Message Listeners See “Message Listeners tab in some components” on page 387.
Remove Computer from Organization Units
This component removes a computer from all Organization Units in Active
Directory.
See “Active Directory components” on page 392.
Table 25-54
Output Paths
Option
Description
Removed
This path is followed if the computer was removed from all
Organization Units in Active Directory.
511
512
Component properties
Components
Table 25-54
Output Paths (continued)
Option
Description
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Computer Name
The name of the computer to remove from the Organization Units.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Remove Group from Group
This component removes a group from a group in Active Directory.
See “Active Directory components” on page 392.
Table 25-55
Output Paths
Option
Description
Removed
This path is followed if the target group was removed from the source
group in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Group Name
The name of the target group to remove from the source group.
Input
■
Group From Delete Name
The name of the source group from which to remove the target
group.
Component properties
Components
Tab name
Options with descriptions
Output
■
Settings
See “Settings tab in all components” on page 383.
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Remove Group from Organization Units
This component removes a group from all Organization Units in Active Directory.
See “Active Directory components” on page 392.
Table 25-56
Output Paths
Option
Description
Removed
This path is followed if the group was removed from all Organization
Units in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Group Name
The name of the group to remove from the Organization Units.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Remove Group from Share
This component removes a group from a shared folder in Active Directory.
See “Active Directory components” on page 392.
513
514
Component properties
Components
Table 25-57
Output Paths
Option
Description
Remove
This path is followed if the group was removed from the share in
Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Shared Folder Name
The name of the shared folder to remove the group from.
Input
■
Group Name
The name of the group to remove from the share.
Input
■
Set Security Access To Folder
Allows the same NTFS permissions to be set on the folder as the
Share permissions which are applied in Active Directory.
Full Folder Path: The path of the folder to set the security access
to.
Input
■
Use Domain Admin Credential
Uses the domain administrator credential to remove the group
from the share.
Input
■
Administrator Name
If Use Domain Admin Credential is not checked, the administrator
name to use for the credential.
Input
■
Administrator Password
If Use Domain Admin Credential is not checked, the administrator
password to use for the credential.
Input
■
Full Control
If checked, full control is granted to the group on the shared folder.
Input
■
Change
If checked, change control is granted to the group on the shared
folder.
Input
■
Read
If checked, read control is granted to the group on the shared
folder.
Component properties
Components
Tab name
Options with descriptions
Output
■
Settings
See “Settings tab in all components” on page 383.
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Remove Manager from Computer
This component removes the assigned manager from a computer in Active
Directory.
See “Active Directory components” on page 392.
Table 25-58
Output Paths
Option
Description
Removed
This path is followed if the manager was removed from a computer
in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Computer Name
The name of the computer to remove the manager from.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Remove Manager from Group
This component removes the assigned manager from a group in Active Directory.
See “Active Directory components” on page 392.
515
516
Component properties
Components
Table 25-59
Output Paths
Option
Description
Removed
This path is followed if the manager was removed from a group in
Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Group Name
The name of the group to remove the manager from.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Remove Manager from Shared Folder
This component removes the assigned manager from a shared folder in Active
Directory.
See “Active Directory components” on page 392.
Table 25-60
Output Paths
Option
Description
Removed
This path is followed if the manager was removed from a shared folder
in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Shared Folder Name
The name of the shared folder to remove the manager from.
Component properties
Components
Tab name
Options with descriptions
Output
■
Settings
See “Settings tab in all components” on page 383.
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Remove Manager from User
This component removes the assigned manager from a user in Active Directory.
See “Active Directory components” on page 392.
Table 25-61
Output Paths
Option
Description
Removed
This path is followed if the manager was removed from a user in Active
Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
User Name
The name of the user to remove the manager from.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Remove Organization Unit out of Organization Unit
This component removes an organization unit out of an organization unit in
Active Directory.
517
518
Component properties
Components
The organization unit from which you want to remove the organization unit is
specified in the Context tab in the Container Type option.
See “Active Directory components” on page 392.
Table 25-62
Output Paths
Option
Description
Moved
This path is followed if the organization unit was removed from an
organization unit in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Organization Unit Name
The name of the organization unit to remove from an organization
unit.
The organization unit from which you want to remove the
organization unit is specified in the Context tab in the Container
Type option.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Remove User from Group
This component removes a user from a group in Active Directory.
See “Active Directory components” on page 392.
Table 25-63
Output Paths
Option
Description
Removed
This path is followed if the user was removed from a group in Active
Directory.
Component properties
Components
Table 25-63
Output Paths (continued)
Option
Description
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
User Name
The name of the user to remove from the group.
Input
■
Group Name
The name of the group to remove the user from.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Remove User from Organization Units
This component removes a user from all Organization Units in Active Directory.
See “Active Directory components” on page 392.
Table 25-64
Output Paths
Option
Description
Moved
This path is followed if the user was removed from all Organization
Units in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
User Name
The name of the user to remove from all Organization Units.
519
520
Component properties
Components
Tab name
Options with descriptions
Output
■
Settings
See “Settings tab in all components” on page 383.
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Remove User from Share
This component removes a user from a shared folder in Active Directory.
See “Active Directory components” on page 392.
Table 25-65
Output Paths
Option
Description
Remove
This path is followed if the user was removed from a share in Active
Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Shared Folder Name
The name of the shared folder to remove user from.
Input
■
User Name
The name of the user to remove from the shared folder.
Input
■
Set Security Access To Folder
Allows the same NTFS permissions to be set on the folder as the
Share permissions which are applied in Active Directory.
Full Folder Path: The path of the folder to set the security access
to.
Input
■
Use Domain Admin Credential
Uses the domain administrator credential to remove the user from
the share.
Component properties
Components
Tab name
Options with descriptions
Input
■
Administrator Name
If Use Domain Admin Credential is not checked, the administrator
name to use for the credential.
Input
■
Administrator Password
If Use Domain Admin Credential is not checked, the administrator
password to use for the credential.
Input
■
Full Control
If checked, full control is granted to the user on the shared folder.
Input
■
Change
If checked, change control is granted to the user on the shared
folder.
Input
■
Read
If checked, read control is granted to the user on the shared folder.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Reset User Password
This component resets a user password in Active Directory.
See “Active Directory components” on page 392.
Table 25-66
Output Paths
Option
Description
Reset
This path is followed if the user password was reset in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
521
522
Component properties
Components
Tab name
Options with descriptions
Input
■
Password Input Method
You can specify how you want the user to input the password.
User Input: Lets the user input the user name and the password
of that user name to reset.
Random Value: Resets the user password with a random value
instead of letting the user select the password.
Input
■
Password
Specifies how the user password is retrieved by clicking the […]
button.
Input
■
User Name
Specifies how the user name is retrieved by clicking the […] button.
This is the user name whose password needs to be reset.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Run Job On Computer
This component lets you run a deployment job on a computer right away. You
choose the job and the computer you want to run it on.
This is a deployment component.
See “Create DS Connection Profile” on page 421.
Component Toolbox Path - Symantec > Deployment Solution
Tab name
Options with descriptions
Input
■
Job Source
Lets you select the job you want to run.
From Picker - Retrieve the job from a picker.
From Variable - Retrieve the job using a job ID.
Component properties
Components
Tab name
Options with descriptions
Input
■
Job Id
The job ID.
If From Picker is selected, this option lets you click the [...] button,
enter a folder name (for example, Workflow), and choose the job.
The Job ID option gets populated with the ID of the job you want
to run.
If From Variable is selected, this option lets you click the [...] button
and enter a job ID.
Input
■
Computer Source
Lets you select the computer you want to run the job on.
From Picker - Retrieve the computer from a picker.
From Variable - Retrieve the computer using a computer ID.
Input
■
Computer Id
The computer ID.
If From Picker is selected, this option lets you click the [...] button,
enter a group name or criteria, and choose the computer. The
Computer ID option gets populated with the ID of the computer
you want to run the job on.
If From Variable is selected, this option lets you click the [...] button
and enter a computer ID.
Output
■
Job Id Output Variable Name
The name of the output variable that contains the Job ID.
Output
■
Computer Id Output Variable Name
The name of the output variable that contains the Computer ID.
Deployment
Server
See “Deployment Server tab in deployment components” on page 385.
Settings
See “Settings tab in all components” on page 383.
Schedule Job On Computer
This component lets you schedule a deployment job to run. You choose the schedule
as well as the job and the computer you want to run it on.
This is a deployment component.
See “Create DS Connection Profile” on page 421.
Component Toolbox Path - Symantec > Deployment Solution
523
524
Component properties
Components
Tab name
Options with descriptions
Input
■
Job Source
Lets you select the job you want to run.
From Picker - Retrieve the job from a picker.
From Variable - Retrieve the job using a job ID.
Input
■
Job Id
The job ID.
If From Picker is selected, this option lets you click the [...] button,
enter a folder name (for example, Workflow), and choose the job.
The Job ID option gets populated with the ID of the job you want
to run.
If From Variable is selected, this option lets you click the [...] button
and enter a job ID.
Input
■
Schedule Settings
The settings for the schedule you want for the job. This option lets
you click the [...] button to enter or choose a schedule. These
schedule settings are documented in the ASDK Help.
Input
■
Computer Source
Lets you select the computer you want to run the job on.
From Picker - Retrieve the computer from a picker.
From Variable - Retrieve the computer using a computer ID.
Input
■
Computer Id
The computer ID.
If From Picker is selected, this option lets you click the [...] button,
enter a group name or criteria, and choose the computer. The
Computer ID option gets populated with the ID of the computer
you want to run the job on.
If From Variable is selected, this option lets you click the [...] button
and enter a computer ID.
Output
■
Schedule Id Variable Name
Deployment
Server
See “Deployment Server tab in deployment components” on page 385.
Settings
See “Settings tab in all components” on page 383.
Send Complete Workflow Message
This component lets two processes communicate with each other. This component
sends a message to the exchange message bus. You set up another process to use
Component properties
Components
message listeners to receive the message. In the receiving process, you can set
what datatype the process is listening for (text, number, and so forth).
A process (Process A) uses this component to send a message to another process
(Process B). The other process (Process B) must be a Workflow project and must
have a Workflow type component set up to listen for the message (for example,
Dialog Workflow). The other process (Process B) then continues through the path
set up in the Message Listeners tab of the Workflow type component.
See “Message Listeners tab in some components” on page 387.
A message can send any type of data to the Workflow type component. The
Workflow type component only responds to the type of data it has been set up to
look for.
Tab name
Options with descriptions
Settings
See “Settings tab in all components” on page 383.
Workflow Close
Setup
■
Task ID
The task ID of the Workflow type component that is set up to listen
for the message. This is normally input from a process variable.
This option lets you click the […] button to enter or choose a task
ID.
Each Workflow type component generates a task ID in the Start
Process (found under the Event Configuration tab). In the Start
Process model, you can right-click on the End component and
select Browse Data to view the available data. The workflowTaskId
variable contains the task ID. The workflowTaskId variable is an
internal variable only to the Start Process model. In order to use
the task ID in later components, you should save the
workflowTaskId variable to the database using the Database
component (for example, create a table of Workflow task IDs). The
Database component must be generated using an Integration-type
project.
Workflow Close
Setup
■
Specify Service ID
If this option is checked, the Service ID option appears.
525
526
Component properties
Components
Tab name
Options with descriptions
Workflow Close
Setup
■
Service ID
The service ID of the Workflow type component that is set up to
listen for the message. If you are using a custom datatype, or think
that there will only be one message of a specific type on the
message bus, you do not need to specify a service ID. If you are not
using a custom datatype or if you think that multiple processes
are listening for a certain datatype, you should specify the service
ID.
This option lets you click the […] button to enter or choose a service
ID.
The service ID is an ID assigned to each Workflow process (you
can view the service ID in the process metadata). If you specify the
service ID in the Send Complete Workflow Message component,
the component sends out its message with a specific service ID.
When the receiving process is set to listen to a message from that
service ID, the message can go through without threat of
interception.
Workflow Close
Setup
■
Empty Message
If this option is unchecked, the Data Type Of Message and Message
Data options appear. If this option is checked, no message is sent
to the Workflow type component.
Workflow Close
Setup
■
Data Type Of Message
The datatype of the message sent to the Workflow type component.
Workflow Close
Setup
■
Message Data
The message to be sent to the Workflow type component.
Workflow Close
Setup
■
Dynamically Determine Path
If this option is unchecked, the Path Name option appears.
Workflow Close
Setup
■
Path Name
The path name to use if the Workflow type component has multiple
paths set up in the Message Listeners tab.
Workflow Close
Setup
■
Local Server
If this option is unchecked, the Server Name option appears.
Workflow Close
Setup
■
Server Name
The message server that you want to use to send the message
instead of the message bus (Microsoft Exchange).
Component properties
Components
Send Email
This component is a primitive SMTP mail component that can be used to send
Ascii or Html email messages, including file attachments.
You must have an SMTP server available to use this component.
To validate this component, the From Address, To Addresses, and Subject options
must have content.
Component Toolbox Paths - Communications; Process Components > Email
Tab name
Options with descriptions
Email Contents
■
From Address
The address from which the message will appear to come. When
you click the [...] button, the value source selector opens. This
address must be able to be sent by your SMTP server.
Email Contents
■
Reply To Address
The reply to address for this message. When you click the [...]
button, the value source selector opens.
Email Contents
■
To Addresses
The list of recipients for this message. When you click the [...]
button, the value source selector opens. You can use properties,
variables, or manually entered text to form the list of recipients.
Email Contents
■
CCAddresses
The list of Carbon Copy recipients for this message. When you
click the [...] button, the value source selector opens. You can use
properties, variables, or manually entered text to form the list of
recipients.
Email Contents
■
BCCAddresses
The list of Blind Carbon Copy recipients for this message. When
you click the [...] button, the value source selector opens. You can
use properties, variables, or manually entered text to form the list
of recipients.
Email Contents
■
Send Confirmation To
The address that will receive a confirmation when the email has
been sent successfully. When you click the [...] button, the value
source selector opens.
527
528
Component properties
Components
Tab name
Options with descriptions
Email Contents
■
Subject
The subject for this message. When you click the [...] button, the
value source selector opens. This can be any combination of text
elements and variables.
Email Contents
■
Send Html Content
Lets you select if you want the body of your message to be Html
content.
Email Contents
■
Html Content
The body of your message using Html. When you click the [...]
button, the value source selector opens.
Email Contents
■
Send Text Content
Lets you select if you want the body of your message to be Text
content.
Email Contents
■
Text Content
The body of your message using Text. When you click the [...]
button, the value source selector opens.
Email Contents
■
File Attachments
Lets you select file attachments for this message. When you click
the [...] button, the value source selector opens.
Email Settings
■
SMTPServer Name
The name or IP address of the SMTP server through which mail
will be sent. When you click the [...] button, the value source
selector opens. This can be an IP address or a name like
mail.myhost.com.
We recommend that you place your SMTP server name in a project
property and access it when you select Process Variables (See
“Properties tab”on page 557 on page 557.). Then, if your SMTP server
changes, you only need to change the project property and all your
Send Email components will still work.
Email Settings
■
SMTP Server Port
The port number of the SMTP server through which mail will be
sent.
Email Settings
■
Priority
The priority for this message.
Email Settings
■
Save Content
Saves the email content to a variable.
Component properties
Components
Tab name
Options with descriptions
Email Settings
■
Settings
See “Settings tab in all components” on page 383.
Save Content File
The variable to save the email content to. When you click the [...]
button, the value source selector opens.
Setup Process
This component lets you create data about your process that gets placed in a
Process View page in Process Manager. Process Manager is available in Workflow
Solution Advanced.
Use this component for reporting process information to Process Manager. This
process information can be viewed on the Process View page.
See “Global Logging Capture” on page 490.
Component Toolbox Path - Reporting > Inline
Tab name
Options with descriptions
General
■
Process Name
The name you want for your process.
General
■
Process Description
The description you want for your process.
General
■
Override Title
Lets you override the process title.
General
■
Select Process View Page
If you have multiple Process View pages, this lets you select the
page you want this information to apply to.
From Picker - Retrieve the page from a picker using the page ID.
From Data - Retrieve the page using a page data.
General
■
Create Document Category
Lets you create a document category in Process Manager for this
process.
This is useful if this process creates documents.
General
■
Output Process CategoryID Name
The variable that contains the process category ID name.
529
530
Component properties
Components
Tab name
Options with descriptions
General
■
Settings
See “Settings tab in all components” on page 383.
Permissions
Lets you add, remove, or edit permissions for the process in Process
Manager.
Set Ticket Status
This component changes the status of the given Help Desk incident. Input is the
incident number and the new status. Status can be set at run time as a process
variable or it can be set at design time using the status drop-down list.
Component Toolbox Path - Symantec > Help Desk > Tickets
Tab name
Options with descriptions
Configuration
■
Incident Number
The incident number to set the status. When you click the [...]
button, the value source selector opens. You can choose a constant
or variable value (such as the output variable for the Create Ticket
component).
Configuration
■
Status
The incident status. When you click the [...] button, the value source
selector opens. Available status comes from the incident database.
Notification Server See “Notification Server tab in Symantec components” on page 386.
Settings
See “Settings tab in all components” on page 383.
Single Value Mapping
This component lets you take any combination of variables and properties that
exist in your project and selectively map them into a target datatype. You can
map variables, values, and constants into properties directly or you can transform
them using simple rules or embedded process models.
For example, suppose you have a user-defined type of Person with three properties:
Name, Age, Job. Also, you have a form that gathers input into three global variables
named LocalName, LocalAge, and LocalJob. You can use this component to map
LocalName to Person[Name], LocalAge to Person[Age], and LocalJob to Person[Job].
Component Toolbox Path - Process Components > Data
Component properties
Components
Tab name
Options with descriptions
Configuration
■
Mapping Definition
The specific mapping definition for your convergence. When you
click the [...] button, the value source selector opens. You can select
which values of a datatype are mapped when you click an arrow
on the line under Data definitions and, while you hold the mouse
button, drag to an arrow on the line under chosen datatype and
let go of the mouse button. More arrows appear under Data
definitions when you expand data definitions. You can click
Validate to see if your mapping is valid.
This option only appears after you enter the Target Type.
Configuration
■
Optional
Lets you select if you have data that can be handled in more than
one way (for example, in two different datatypes).
If it is inconvenient for data to be mapped in the way you propose,
you can select this control to cause this component to opt out of
mapping the data and handle the data in its original form.
Configuration
■
Target Type
The type of array you want to map your source array into. When
you click the [...] button, the value source selector opens.
For example, if transferring from type A to B, you would set the B
to this option.
Configuration
■
Map Into Existing Value
Lets you select to overwrite an existing variable with the output
data. You then choose the target variable in the Target Variable
Name option.
Configuration
■
Target Variable Name
The variable to overwrite with the output data. When you click the
[...] button, the value source selector opens. This variable holds
the output, mapped array and must be the same datatype as the
target type.
This option appears if you select Map Into Existing Value.
Configuration
■
Output Variable Name
The output variable name. When you click the [...] button, the value
source selector opens. This variable holds the output, mapped
array and must be the same datatype as the target type.
This option only appears after you enter the Target Type and if
Map Into Existing Value is not selected.
Settings
See “Settings tab in all components” on page 383.
531
532
Component properties
Components
Start component
This component is the first component in any project. It provides a platform to
configure and specify your input variables. All components in your project must
have a line which originates with the Start component.
See “Settings tab in all components” on page 383.
Subtract Days
This component subtracts the number of specified days from a specified start
date and places the result into a date variable.
Formula: date - days = Result Variable Name
Component Toolbox Paths - Date Handling > Subtract; Process Components >
Date Handling > Subtract
Table 25-67
Output Paths
Option
Description
Done
When the specified number of days have been subtracted, the workflow
follows this output path.
Tab name
Options with descriptions
Properties
■
date
The start date. When you click the [...] button, the value source
selector opens. This can be a variable, dynamic value, or constant
value.
Properties
■
days
The number of days you want to subtract from the date. When you
click the [...] button, the value source selector opens. Result Variable
Name
You can enter the name of the date variable to hold the result of
the subtraction.
Settings
See “Settings tab in all components” on page 383.
Terminate Window and Close Dialog
This component lets you close a window or dialog box which was displayed
previously to the user.
This can be used to show the user that the project has ended.
Component properties
Components
Component Toolbox Path - Web User Interface
This is only available in a Forms project.
Table 25-68
Output Paths
Option
Description
after terminate
When the window or dialog box has been closed, or the user has been
presented the message to close, the workflow follows this output path.
Tab name
Options with descriptions
No Category
■
Seconds to Wait before Closing
The number of seconds to wait before the window or dialog box is
closed.
When you enter a value in this option greater than 0, users are
given a chance to cancel the close or to edit the dialog box quickly
before it closes.
No Category
■
Show Closing Message
Displays the Closing Message before the window or dialog box is
closed.
No Category
■
Closing Message
The message you want displayed to users when the window or
dialog box is closed. When you click the [...] button, you can create
a detailed message.
No Category
■
Use CSS Style Sheet
Lets you select to use a CSS Style Sheet.
No Category
■
CSS Style Sheet
The CSS Style Sheet formatting codes for your message.
Settings
See “Settings tab in all components” on page 383.
TextBoxComponent
This component lets a user enter text data for submission through a Web form.
The data gets placed into a text variable. When you use this component, you
usually want to label it with the LabelComponent.
When you place this component on the form, a dialog box opens which displays
the minimum required options. You must first enter the Output Name, which is
the text variable. You can then choose which output paths are required or optional
for this component. At least one output path must be required for this component.
533
534
Component properties
Components
After you click OK, you can view other available options when you double-click
this component.
This component is available in a Forms project by using a form component that
utilizes the Web Form Editor (for example, See “Form Builder” on page 467.).
Tab name
Options with descriptions
Functionality
■
Output Data
A variable from within your project to hold the output data. When
you click the [...] button, the value source selector opens.
If you do not have a variable already declared, enter the name you
want for the variable. A variable of this name is created when the
project is created.
Functionality
■
Default Value
A default value for your text box. When you click the [...] button,
the value source selector opens. The default value is placed in the
text box until the user enters a value, even if the Output Data
variable contains data before this component starts.
Functionality
■
Always Use Default Value
Lets you select if you always want a default value to appear in this
text box. If no default value is entered, No Value Set becomes the
default value.
This lets you remove the data in the text box if your process loops
to it and you want to remove the data every time it is accessed.
Functionality
■
Output Paths
Lets you select how you want this component to be used by each
output path on the Web form.
Required - This component is required for this output path.
Optional - This component is optional for this output path.
Ignored - This component is ignored for this output path.
Functionality
■
Custom Events
A list of customized events you want this component to respond
to.
You can add an event handler when you click Add and scroll to
the event name. Then, in the Edit Object dialog box, you can select
the behavior configuration for the event handler you chose.
Functionality
■
Specify Control ID
Specifies your own control ID. If this option is not selected, an
automatically created control ID is specified for this component.
Component properties
Components
Tab name
Options with descriptions
Functionality
■
Control ID
A unique identifier for this component. This identifies this
component to the Web browser.
Functionality
■
Post Form On Value Change
Lets you select to post the value in this text box to the Output Data
variable as soon as a user clicks out of this component.
If this is not selected, as soon as a user clicks out of this component,
the value in this text box is placed in a temporary variable. When
the user takes a path out of the form, the value from the temporary
variable is placed in the Output Data variable.
Functionality
■
Tab Index
The tab order for this component on the page.
When a user presses the tab key, the curser moves to the
component with the next consecutive numbered Tab Index on the
form.
Functionality
■
Tab Stop
Allows this component to be a tab stop. If this is cleared, a user
cannot get to this component by using the tab key.
Functionality
■
Tool Tip
A tool tip for this component. Tool tips are displayed when the
user hovers the cursor over the component.
Functionality
■
Visible
Lets you select whether or not you want this component to be
visible.
If you use a variable for this, your workflow can change the variable
so that this component only appears on the form in certain
instances; for example, only on Tuesday.
Functionality
■
Required Error Message
An error message to display if you set this component to Required
(it is required for the successful completion of your form) but the
user failed to select a value.
Functionality
■
Use Custom Validation
Lets you select to use a custom validation system for this
component. A custom validation lets you check whether or not a
user’s input is valid. For example, you may want to check to see if
the user provided a valid address.
535
536
Component properties
Components
Tab name
Options with descriptions
Functionality
■
Custom Validation Model
Lets you create a validation model. Validation models are sets of
components, arranged in a logical line which checks if the user’s
input is valid. The model works by saving the user’s entry in a
variable called CustomValidationInput. This variable can be used
elsewhere in your project by selecting it under the OptionalData
classification in the Select Variable window.
In this model, we recommend that you use the form data variables.
These variables only exist in the form.
Appearance
■
Component Size
The size you want for the component.
You can also adjust the component size when you click on it and
drag on the box.
Appearance
■
Overflow Behavior
Lets you select the behavior if a user types in text that is wider
than the component.
Overflow - The component expands as the user types.
Clip - Does not show the words that go past the edge of the
component.
Scroll - Places a scroll bar on the component, which lets the user
scroll to see all the text.
Appearance
■
Text Box Mode
Lets you select the mode you want for your component.
SingleLine - Displays a single line only.
MultiLine - Displays multiple lines.
Password - Replaces all characters entered with an asterisk.
Appearance
■
Maximum Length
The maximum amount of characters a user can enter in the
component.
Look And Feel
■
Style
The style information you want for this component. Style
information includes font name, font face, font color, background
color, and so forth.
Look And Feel
■
Theme Style
The theme style for this component.
Theme styles are only available when a theme is added to the form.
Settings
See “Settings tab in all components” on page 383.
Component properties
Components
True False Rule
This rule evaluates a boolean value that is entered to see if it is set to true or false.
Table 25-69
Output Paths
Option
Description
True
If the boolean value is true, the workflow follows this output path.
False
If the boolean value is false, the workflow follows this output path.
Tab name
Options with descriptions
Configuration
■
Settings
See “Settings tab in all components” on page 383.
Value
The value you want to evaluate. When you click the [...] button, the
value source selector opens. You can choose a constant or variable
value.
The value is checked to see if it is true or false.
A variable array value can be selected when you drill into the array
and select a value.
Update Computer
This component updates a computer in Active Directory.
See “Active Directory components” on page 392.
Table 25-70
Output Paths
Option
Description
Updated
This path is followed if the computer was updated in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Name
The name of the computer to update.
Input
■
Computer Description
The description of the computer to update.
537
538
Component properties
Components
Tab name
Options with descriptions
Input
■
DNS Name
The DNS name of the computer to update.
Input
■
Operating System Name
The name of the operating system on the computer to update.
Input
■
Operating System Version
The version of the operating system on the computer to update.
Input
■
Operating System Service Pack
The service pack number of the operating system on the computer
to update.
Input
■
Managed By
The name of the manager of the computer to update.
Input
■
Is Disabled
If checked, the computer to update is disabled.
Input
■
Additional Attributes
The additional attributes of the computer to update.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Update Group
This component updates a group in Active Directory.
See “Active Directory components” on page 392.
Table 25-71
Output Paths
Option
Description
Updated
This path is followed if the group was updated in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Component properties
Components
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Group Name
The name of the group to update.
Input
■
SAM Account Name
The SAM Account name of the group to update.
Input
■
Group Description
The description of the group to update.
Input
■
Email Address
The email address of the group to update.
Input
■
Group Scope
The scope of the group to update.
Input
■
Is Security Group
If checked, the group to update is a security group.
Input
■
Notes
The notes about the group to update.
Input
■
Managed By
The name of the manager of the group to update.
Input
■
Additional Attributes
The additional attributes of the group to update.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Update Organization Unit
This component updates an organization unit in Active Directory.
See “Active Directory components” on page 392.
539
540
Component properties
Components
Table 25-72
Output Paths
Option
Description
Updated
This path is followed if the organization unit was updated in Active
Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Organization Unit Name
The name of the organization unit to update.
Input
■
OUDescription
The description of the organization unit to update.
Input
■
Street
The street address of the organization unit to update.
Input
■
City
The city of the organization unit to update.
Input
■
State
The state of the organization unit to update.
Input
■
Postal Code
The postal code of the organization unit to update.
Input
■
Country
The country of the organization unit to update.
Input
■
Additional Attributes
The additional attributes of the organization unit to update.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Component properties
Components
Update Shared Folder
This component updates a shared folder in Active Directory.
See “Active Directory components” on page 392.
Table 25-73
Output Paths
Option
Description
Updated
This path is followed if the shared folder was updated in Active
Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
Shared Folder Name
The name of the shared folder to update.
Input
■
Description
The description of the shared folder to update.
Input
■
UNC Name
The UNC name of the shared folder to update.
Input
■
Additional Attributes
The additional attributes of the shared folder to update.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Update User
This component updates a user in Active Directory. This component is commonly
used in connection with the Get User List component. Use the Get User List
component to retrieve the user whose information you want to update (the data
is placed in the Found Users variable). Then use a Single Value Mapping component
to change the data in the Found Users variable. Then use this component to update
the user information.
541
542
Component properties
Components
See “Active Directory components” on page 392.
See “Get User List” on page 489.
See “Single Value Mapping” on page 530.
Table 25-74
Output Paths
Option
Description
Updated
This path is followed if the user was updated in Active Directory.
Error
This path is followed if Active Directory returned an error. The error
is placed in the Error Message Name variable.
Tab name
Options with descriptions
Context
See “Context tab in Active Directory components” on page 385.
Input
■
User Name
The name of the user to update.
Input
■
User Info Source
You can specify the source from which to retrieve the information
that is used to update the user.
From Editor: Updates the user from information in the editor.
Then enter the user information in the User Information Editor
in the User Info option.
From Variable: Updates the user from information from a variable.
Then enter the user information in the User Info option.
Input
■
User Info
If From Editor is clicked, you can enter the user information in
the User Information Editor by clicking the […] button. If From
Variable is clicked, you can enter the user information by clicking
the […] button.
Output
■
Error Message Name
The name of the error message variable. This variable gets
populated with the error message, if one was received during the
retrieval process. This error message is the only exception handling
available for this component.
Settings
See “Settings tab in all components” on page 383.
Component properties
Components
Wait For All Workflow Components (Merge)
This component waits for all workflow components (found in Workflow
Components component toolbox path) to complete in any model in this workflow.
You should never use more than one of these in a single project.
Component Toolbox Paths - Workflow Components > Merge
This is only available in a Workflow project.
Table 25-75
Output Paths
Option
Description
done
When all workflow components in any model in this workflow have
completed, the workflow follows this output path.
Tab name
Options with descriptions
Message Listeners See “Message Listeners tab in some components” on page 387.
Passive Merging
■
Check Passive Completion
Checks for the termination of workflow components in any model
in this workflow. Only turn this off if you have all paths terminating
into this component.
Passive Merging
■
Check Time Span
Sets the time to wait between checks. The system checks repeatedly
to see if all workflow components have completed execution. The
system waits a certain amount of time (Check Time Span) between
checks.
Settings
See “Settings tab in all components” on page 383.
Wait For Job Completion
This component waits for a job to complete before you continue with the workflow.
It uses the provided computer ID and job ID to periodically check the status of a
job on Deployment Server.
This is a deployment component.
See “Create DS Connection Profile” on page 421.
Component Toolbox Path - Symantec > Deployment Solution
543
544
Component properties
Components
Tab name
Options with descriptions
Input
■
Computer Id
The computer ID.
If From Picker is selected, this option lets you click the [...] button,
enter a group name or criteria, and choose the computer. The
Computer ID option gets populated with the ID of the computer
you want to check the status of a job on.
If From Variable is selected, this option lets you click the [...] button
and enter a computer ID.
Input
■
Job Id
The job ID.
If From Picker is selected, this option lets you click the [...] button,
enter a folder name (for example, Workflow), and choose the job.
The Job ID option gets populated with the ID of the job whose status
you want to check.
If From Variable is selected, this option lets you click the [...] button
and enter a job ID.
Output
■
Job Data Variable Name
The name of the output variable that contains the job status.
Deployment
Server
See “Deployment Server tab in deployment components” on page 385.
Settings
See “Settings tab in all components” on page 383.
Inputs
■
Time Between Checks
The amount of time that the component waits before it checks the
status of the job.
Inputs
■
Timeout Time Span
The amount of time that the component waits before it times out.
This should be set to the maximum time you want to wait for the
job to run before the workflow continues anyway.
Message Listeners See “Message Listeners tab in some components” on page 387.
Wait For Ticket Change
This component pauses the workflow until the given Help Desk ticket matches
the target change criterion. The criterion can be a specific ticket status change,
that the priority is equal to ASAP, or that the ticket is overdue.
Component Toolbox Path - Symantec > Help Desk > Tickets
Component properties
Components
Table 25-76
Output Paths
Option
Description
Change
If the target change criterion is reached by the ticket, this path is
followed.
Timeout
If the time in the Timeout Time Span option is reached, this path is
followed.
Tab name
Options with descriptions
Configuration
■
Trigger Event
The event trigger for restarting the workflow.
Configuration
■
Expected Status
If the Trigger Event is StatusChange, this option lets you select
the status to trigger the restart when you click the [...] button.
Configuration
■
Incident Number
Lets you select a variable or enter the ticket number to monitor.
When you click the [...] button, the value source selector opens.
Configuration
■
Time Between Checks
Lets you select the frequency to check for the ticket event trigger.
When you click the [...] button, the value source selector opens.
Configuration
■
Timeout Time Span
Lets you select the amount of time to pass before this component
times out. When you click the [...] button, the value source selector
opens.
Notification Server See “Notification Server tab in Symantec components” on page 386.
Settings
See “Settings tab in all components” on page 383.
Message Listeners See “Message Listeners tab in some components” on page 387.
Wait On External Event
This component lets you pause the execution of your project until an external
model completes execution (an external event occurs).
For example, you want to wait until an email is sent to a user or until a system
has completed writing a file. This component lets you wait until one of these
events complete before your project continues.
545
546
Component properties
Components
Table 25-77
Output Paths
Option
Description
External Event
Complete
When the external event completes (an End component in the Wait
Process model maps to True), this path is followed.
Tab name
Options with descriptions
General
■
Start Process
The model for the start process. When you click the [...] button,
the value source selector opens.
If a start process is defined, it gets executed first when this
component starts.
For example, the start process could send an email to a user that
informs them that the process has started, but is waiting for the
external event.
General
■
Time Between Checks
The amount of time to wait between checking for the external
event. When you click the [...] button, the value source selector
opens.
General
■
Timeout Path Name
The name of the timeout path.
General
■
Timeout Type
The timeout type.
General
■
Timeout Time Span
The amount of time to pass before this component times out (the
system becomes unresponsive). When you click the [...] button, the
value source selector opens. This option appears when Time Span
is selected in the Timeout Type option.
General
■
Timeout Date
The date variable. When you click the [...] button, the value source
selector opens. This variable must contain the amount of time to
pass before this component times out (the system becomes
unresponsive). This option appears when Date is selected in the
Timeout Type option.
Component properties
Components
Tab name
Options with descriptions
General
■
Wait Process
The model for the wait process. When you click the [...] button, the
value source selector opens.
The End component in this model needs to have a boolean mapping.
You use this model to create the rules or conditions that monitor
the external event. When the external event occurs, the output
path for that event should be connected to the End component
that is mapped to True.
Message Listeners See “Message Listeners tab in some components” on page 387.
Settings
See “Settings tab in all components” on page 383.
547
548
Component properties
Components
Appendix
A
Project Global Properties
This appendix includes the following topics:
■
Resources tab
■
Libraries tab
■
Models tab
■
Publishing tab
■
Properties tab
■
Storage Preferences tab
■
Reporting tab
■
Global Data tab
■
Application Properties
Resources tab
Each project requires external libraries, or resources, in order to run. Resource
files provide projects with additional information, functionality, or option
definitions. Resources may include Dynamic Linked Libraries (called libraries),
and .CONFIG files, which contain configuration options.
See “Workflow Designer tool” on page 60.
Click Add to add resources to the project.
Table Properties
■
Resource Type
550
Project Global Properties
Resources tab
This box contains a description of the type of resource listed. Some resources
may have their type edited. To edit a resource type, edit a new resource type
in the resource's corresponding Resource Type box.
■
ResourceName
This box contains the logical name of the resource.
■
Resource Name
This box contains the name of the resource. The name of the resource is the
location of the resource file.
■
Description
This box holds a description of the resource. You can edit the description of
the resource by entering a description in the resource's Description cell.
■
Original Resource Location
This box contains the directory for the original resource file. The original
resource file is both referenced and left in place (if Copy Local is not selected),
or is copied to the Workflow Designer project directory (if Copy Local is
selected).
■
Debug Only
Select this if the resource should only be used when debugging your application.
It is assumed the file or resource will be available on the Workflow Server.
■
Invocation Target
If selected, the resource is invoked upon project execution. Invoking a resource
means it must be loaded or executed before the project is loaded. Libraries
required by the project initially must be invoked before the project can be
executed.
■
Last Modify Date
This is a non-editable box that displays the date of the last resource
modification.
■
Copy Local
Select if you want to create a local copy of a resource. Local copies are placed
in the project directory. For example, if a resource originally is located at
C:\Resources, selecting Copy Local places a copy of the resource on the
C:\LogicBaseProjects\MaestroProject1\ directory.
■
Publish With Project
Select if you want your resource files to be published with the project. When
the project is published, some common resources may be available on the
Workflow Server or the computer system you are publishing your project to.
Those resources do not require publishing. Customized libraries, which are
rare on other systems, should be deployed so they are available to all users.
Project Global Properties
Libraries tab
Libraries tab
This tab lets you manage libraries (in .DLL format) used by your project. Libraries
added and used on this tab are local to the project. Upon installation, Workflow
Designer core libraries are already uploaded for use on a project. Libraries can be
added or removed from a project and can be additional Workflow Designer libraries,
external libraries, or custom libraries created by a Integration generator.
See “Workflow Designer tool” on page 60.
Click Add to add libraries to the project.
Table Properties
■
Name
This box contains the name of the library. This is also the location of the library
file.
■
Description
This box contains a description of the library, which can be edited by entering
a description in the resource's Description box.
■
Debug Only
Select this if the library should only be used when debugging your application.
■
Copy Local
Select this if you want to create a local copy of a resource. Local copies are
placed in the project directory, which is located at
C:\LogicBaseProjects\ProjectName\.
■
Publish
Select this to require that the library be published with the project.
■
Last Modify Date
This is a non-editable box that displays the date of the last library modification.
■
Original Path
Select [...] to change the original path of the library.
Models tab
This tab provides a list of the models in your project. The Primary model is created
upon project creation. It contains all the main components and project
functionality. In order to cut down on the component clutter in the primary model,
you can create sub-models, which perform specific tasks and are executed by the
primary model.
See “Workflow Designer tool” on page 60.
551
552
Project Global Properties
Publishing tab
Table Properties
■
Name
This box contains the name of the models included in your project. If you want
to rename a model, edit the model's name in this box.
■
File Name
This is a non-editable box that holds the name of the .MODEL file associated
with your project's models. Each model in a project has an accompanying
.MODEL file (stored in your project's folder) which holds model information
and data.
■
Execution Method
This box contains the execution method of the model.
■
Return Type
Some models manipulate data and return a value upon completion of the
model. For example, a model may ask for the user's name as input and return
it to the primary model as a return variable. If a model returns a value, it must
return a value of a certain datatype. The first name of a user, for example,
would be of type String, because names are stored as text. To edit the return
type for a model, enter a datatype in this box.
■
Primary
Select this if the model is the primary model. One model must be the primary
model in a project. The primary model is executed first in a project, and acts
as the base for all other models.
■
Invocation Target
Select this if the model must be invoked prior to project execution. Invoking
a model loads it and sets any relevant properties. For example, if a project
needs a user's name to run, and the model acquires the user's name, it may
need to be invoked prior to project execution so that the user's name is available
when the primary model executes.
Publishing tab
This tab lets you set basic options regarding your project, which appears to users
and developers after the project is published and running.
See “Workflow Designer tool” on page 60.
The following describe the fields in the Publishing tab.
General
■
Name Space
Project Global Properties
Publishing tab
Enter the namespace of a project. This is a unique text identifier used to
differentiate your project from others. This namespace also serves to identify
the components involved in your project.
■
URL
Enter the URL of your organization's home page. This URL can be viewed by
users and is useful in streamlining technical support or feedback.
Primary Service
■
Service Name
Enter a name for your Webservice, if wanted. The Webservice is launched as
[servicename].aspx on the Workflow Server. Users then connect to your .ASPX
file in order to utilize the functions of your Webservice.
■
Method Name
In order to operate your projects after they are deployed as Webservices, users
must invoke methods. The primary method, which acts to execute your primary
model, must be given a name, so it can be identified by users. Enter into this
box the name you want to give your primary method. The default is Execute,
which indicates you are executing the functions of your project.
■
Service Return Class Name
Data returned from your Webservice is placed in a special class, so it may be
handled easily by users. Classes are bundles of data organized in a particular
way. The class which is used to return data from your Webservice must be
given a name. Enter a name for your return class in this box.
Business Time Span Config
■
Business Time Span Config
Select [...] to override the business hours for your project. The Time Span
settings that occur in components take precedence over the project's Time
Span settings. Time Span settings that occur in this project take precedence
over global Time Span settings.
Workflow Type
Sets the ways that a project can run.
See “About publishing a project” on page 105.
■
Webservice
Starts when a user makes a request (for example, through a Smart task in
Helpdesk or a resource Item Action).
■
Auto Start
The Workflow Server monitors an event and when that event happens, the
workflow runs. For example, when an e-mail appears in a mailbox, a particular
workflow runs.
553
554
Project Global Properties
Publishing tab
■
Form Start
Starts with a dialog workflow form that requires user input (for example, salary
advance requests or vacation requests). When a Form Start workflow starts,
the workflow is processed until it gets to a Dialog Workflow component. The
first workflow component you have must be a Dialog Workflow component.
Dialog Settings
These settings are for how you want Web forms in Dialog workflow components
to end. These are default project level settings. Component level settings take
precedence over these.
■
Use LogicBase End Page
Select to show the Workflow Designer end page (this page states that the
process has ended when a user clicks out of the Web form).
■
Redirect To Page At End
Enter the URL redirect for the end page.
■
Redirect To Page At End Parameter
Enter the URL parameter redirect for the end page.
■
View State Preference
Select how you want to keep the view state restrained: to the page or to the
session. This is an IIS setting.
■
Center Forms On Page
Select to center all Web forms on the page.
■
Default Theme
Select the default theme you want to use for all Web forms.
■
Form Dialog Type
Select the form dialog type you want to use for all Web forms.
Auto Start Settings
These settings appear when Auto Start is selected in the Workflow Type section.
■
Start With Primary Model
Select if you want this project to auto start with the primary model instead of
another model.
■
Run Auto Start Until Does Not Start
Select if you want to keep running the Auto Start component until it no longer
has data to process.
For example, suppose the Auto Start component is monitoring a database and
processes a row at a time. If the auto start schedule is set to monitor the
component daily and there are 500 new rows in the database, if this checkbox
Project Global Properties
Publishing tab
is selected, auto start continues to run until there are no longer any rows to
process. Auto Start then waits until the next scheduled time to run.
If, in the previous example, this checkbox is not selected, only one row is
processed each time Auto Start runs according to the schedule.
■
Schedule
Select the schedule for the Auto Start component to run by clicking the [...]
button.
Data To Expose
■
Properties To Expose
Lets you add project data to be exposed externally. This lets you provide
methods on your workflow service that lets users inspect or set your properties.
Workflow Runtime Settings
■
Allow External Workflow Tracking IDs
Select to provide an external tracking ID for the process. If this is selected,
when a request is made to start the workflow, a process tracking ID needs to
be provided. The tracking ID that is provided must be unique.
■
Allow Workflow Abortions
Select to let administrators stop an unfinished task in a workflow.
■
Checkpoint Policy
Select the checkpoint policy you want for your project. You can roll back
workflows to a previous checkpoint if you select to in this box.
■
Never
Never allow the set of a checkpoint.
■
Manual
Allow the manual set of a checkpoint.
■
AfterWorkflowComponent
Set a checkpoint after every Workflow component.
■
AfterEveryComponent
Set a checkpoint after every component.
■
Data Cleanup Policy
Select the cleanup policy you want for your project. If you select to cleanup
data, all file system data gets removed on either a model or project exit.
■
Generate Hook For Auto Run
Select to allow the Workflow Server to periodically try to run this project.
When you publish this project to a Workflow Server, this project registers
555
556
Project Global Properties
Publishing tab
itself as being able to run automatically. If this is not selected, the project
timeouts and escalations, reminders, and autostarts may not work correctly.
■
Work Queue Service Name
Select the location you want for the project tasks. A work queue holds all
serialized data about each task.
■
■
WSWorkQueue
The data is placed in a Webservice. This uses the Process Manager Web
portal for storing your work queues.
■
LogicBaseExchangeWorkQueue
The data is placed in Exchange. This is the default choice because it is the
most flexible, high performance, and reliable option. Exchange settings
are made in the Properties tab.
■
FileSystemWorkQueue
The data is placed in a file system. For small workflows, this can let you
quickly access data.
■
InMemoryWorkQueue
The data is placed in the memory. This is primarily used for testing. It is
very fast, but has no persistence capability.
■
SQLServerWorkQueue
The data is placed in SQL server. This gives you audit ability and control.
Work Status Service Name
Select the location you want for the project work status.
■
WSWorkQueue
The data is placed in a Webservice. This uses the Process Manager Web
portal for storing your work status.
■
LogicBaseExchangeWorkQueue
The data is placed in a Exchange. This is the default choice because it is
the most flexible, high performance, and reliable option. Exchange settings
are made in the Properties tab.
■
FileSystemWorkQueue
The data is placed in a file system. For small workflows, this can let you
quickly access data.
■
InMemoryWorkQueue
The data is placed in the memory. This is primarily used for testing. It is
very fast, but has no persistence capability.
■
SQLServerWorkQueue
Project Global Properties
Properties tab
The data is placed in SQL server. This gives you audit ability and control.
Properties tab
Projects require data, taken as input, in order to run. This input data, can be set
in this tab. Properties may include varying pieces of information, ranging from
a user's name to a URL. Properties are available as variables in your projects.
You may edit your properties, remove properties you no longer need, or add new
ones using the Editing Buttons.
See “Workflow Designer tool” on page 60.
Editing Buttons
■
Add Property
Click this button to add a new property to your property list. When clicked, a
new entry is added to the property list. You may then edit your new property
by editing the values to its Property Name and Property Value fields.
■
Add Password Property
Click this button to add a password property. After adding, a row is entered to
edit the property name and password value. Select [...] to set the default
password.
■
Convert To Password Property
To convert an existing property to a password property, select a row in the
properties table and click Convert to Password Property. Select [...] to set the
default password.
■
Remove Property
Click this button to remove a selected property. Properties are selected if there
is an arrow located to the property's left.
Table Properties
■
Name
Enter a name for your property. The default property, BaseURLToProject,
holds a reference to your project's URL. The property names are displayed in
your projects as variables.
■
Category
Enter a category for your property.
■
Value
Enter a value for your property. This value is entered into your project
whenever you make reference to your property.
■
Description
557
558
Project Global Properties
Storage Preferences tab
Enter a description for your property.
Storage Preferences tab
This tab lets you set preferences for storage of datatypes.
See “Workflow Designer tool” on page 60.
Reporting tab
This tab lets you set up project reporting with Process Manager. This is for use
with Process Manager that comes with Workflow 7.0.
See “Workflow Designer tool” on page 60.
Add Process Component
Adds the component to your project that enables reporting
(Global Logging Capture).
See “Global Logging Capture” on page 490.
Process Prefix
The prefix that appears in front of the reporting numbers.
Pad Char
The character that gets placed at the beginning of the
reporting numbers.
Pad Length
The length you want for the reporting numbers.
Global Data tab
This tab contains variables that are available to any process (including embedded
and linked processes as well as through Webservice calls).
See “Workflow Designer tool” on page 60.
Application Properties
This tab is for future functionality.
See “Workflow Designer tool” on page 60.
Appendix
B
Edit Tool Preferences
This appendix includes the following topics:
■
Studio Configuration page
■
Designer page
■
Debugging page
■
Deployment page
■
Process Manager page
■
Repository page
Studio Configuration page
Tool Setup
Always Ask for Save
Select for the user to be asked to save the project before
closing the project.
Correct Caps Automatically
Select if Workflow Designer should automatically detect
caps lock and remove it if it appears the user is unaware it
is set. For example, if a user types "hELLO", it can be
assumed that the user is unaware that caps lock is enabled,
and was attempting to type "Hello".
560
Edit Tool Preferences
Studio Configuration page
Show Version Upgrade Info
If a user opens a project in a newer version of Workflow
Designer than the version used to design it, Workflow
Designer can upgrade the project. Select from the Show
Version Upgrade Info drop-down box if you wish to display
the upgrade information to the user.
Passive
Display changes to the user and perform the changes
without confirmation
■ Confirm
Display changes to the user and ask for confirmation
before performing changes
■ Never
Perform the upgrades automatically, but do not inform
the user.
■
Tool Web Pages
This is the tab to the main tool page. You can add more pages
as wanted.
Warn About Trusted Zones
If an administrator deploys a project to a foreign (remote)
server, it is important the project is secured from outside
interference. If this option is selected, the project
administrator will be notified if a non-trusted entity
attempts to interfere with or contact the project illegally.
Project Config
Primary Model Node Color
This feature is currently disabled.
Normal Model Node Color
This feature is currently disabled.
Invocation Target Model
Node Color
This feature is currently disabled.
Ask to Add Projects In Base
Directory
Select to be prompted to add a project to the main project
list when it is being opened, but it is not yet displayed on
the main project list.
Base Project Directory
Enter into this box the directory Workflow Designer should
use to store your project's files.
Default Deploy Directory
Enter into this box the directory Workflow Designer should
use when publishing projects.
Edit Tool Preferences
Studio Configuration page
Default Library Directory
Set in this box the directory Workflow Designer should use
to search for libraries. When a user chooses to install custom
libraries or select custom libraries from the Import Libraries
window, Workflow Designer creates its available libraries
list by surveying this directory.
Default Project Type
Select from this box the default project type you wish
Workflow Designer to select when a user chooses to create
a new project.
Default Unpackage Directory When a user chooses to import a packaged project, Workflow
Designer must unpack it. Enter into this box the directory
you wish Workflow Designer to automatically unpack
imported packaged projects into.
Default XML Name Space
Enter the default namespace Workflow Designer should use
for all components which utilize XML.
Enable Localization Support Select if the project should have localization support,
meaning that each user has the power to select their display
language and language settings.
Project Templates
This lists the templates for the project types you can use in
Workflow Designer. Click [...] to add more template
packages.
Search Paths
Sets the default search path on the Search Path Libraries
tab in Import Components.
Set Default Project Type to
Last Used
Select if Workflow Designer should automatically select the
last type of created project as the default project type.
Show Model Documentation Select if the project should display all the model
documentation associated with it.
Show Project Documentation Select if the project should display all the documentation
associated with it.
Sort Models Alphabetically
Select if you want to sort models and sub-models
alphabetically when they are displayed in the project
browser.
Template Directory
Enter the directory where project templates are saved.
Feedback Setup
561
562
Edit Tool Preferences
Studio Configuration page
Submit Feedback to
Transparent Logic
Select if Workflow 7.0 should send feedback submitted by
project users to Symantec. If there are any problems
regarding the use of the Workflow 7.0 development
environment, the comments will be sent to Symantec. If
this is cleared, you can set an alternate support service URL.
Show Submit Feedback
Confirmation
Select if the user should get confirmation on whether their
feedback was submitted successfully to Symantec.
Store Feedback If No
Connection Available
Select if feedback should be stored for submission later, in
the absence of an internet connection.
Save Settings
Save Diagram Window
Appearances
Select if Workflow Designer should save window settings
set by users when the user closes Workflow Designer. When
the user re-opens Workflow Designer, all of the
previously-set options will be saved and re-loaded.
Save Main List Appearances Select if Workflow Designer should save project list settings
between instances of Workflow Designer. A user can save
his or her settings between executions of Workflow
Designer.
Save Windows Position and
Size
Select if Workflow Designer should save the position and
size of the Windows position.
Backup
Backup Directory
Enter a directory Workflow Designer should use when
backing up project files.
Do Backups
Select to force Workflow Designer to backup projects
regularly, thus preventing against data loss.
Splash Screen
Suppress Splash Screen
Select to prevent Workflow Designer from displaying its
splash screen when loading or booting.
Reports
Generate Reports
Specify when reports will be created: When Application
Closes, On Every Save, Manual or Prompt Alt Exit.
Zip Reports
Select to put the zip the generated reports.
Edit Tool Preferences
Designer page
Designer page
Component Help
Override Library
Customization Settings
Select to change the location of the component help files.
Show Assembly Name In
Help
Select if Workflow Designer should show the name of a
component's corresponding assembly (or library) file in the
component's help file.
Component Library
Max Number of Components Enter into this box a maximum number of components
to Save
Workflow Designer should allow to be saved in the user's
component library.
Link Config
Link 01-10 Color
Set in these boxes the colors Workflow Designer should use
for various component links. Multiple colors may be set and
will be available to users when designing Workflow Designer
projects.
Link Selected Color
Set in this box the color Workflow Designer should use to
display a selected link. Links are simply the lines used to
connect components in the designer. A link is selected when
the user clicks on and highlights the link.
Orthogonal
Select if Workflow Designer should automatically create
right angles out of links in the Designer. If this is not
selected, links will take the shortest path (commonly
diagonal lines).
Scale Style
Select to change the look of the lines that link the
components together.
Stroke Curviness
Enter into this box a value Workflow Designer should use
to curve bending links. A curviness of 1 is "ultimate
curviness" and will turn links into circular or semicircular
lines.
Stroke Style
Select a style Workflow Designer should use to draw links
from this drop-down box. You may have
RoundedLineWithJumpOvers, which will create jump
symbols if two links pass over one another, Line,
RoundedLine, and Bezier (which curve the lines).
563
564
Edit Tool Preferences
Designer page
Designer Tooltips
tooltips
The tool tip for a component is displayed when you rest the
cursor over the component. Tool tips can include multiple
pieces of information to help you identify or choose
components within a project. The ToolTip options are a set
of check-boxes that let you dictate which pieces of
information should be displayed in a component's tool tip.
To display information, select the corresponding check-box.
Designer Config
Append Class To Component Select if Workflow Designer should name components based
Name
on their classes. For example, a Send Email component may
be in the EmailTools class. With this option checked, the
Send Email component would be named Send
Email-EmailTools.
Auto Close Wait Windows
Select if Workflow Designer should automatically close
certain windows (wait windows) after a certain number of
seconds. An example of a wait window is the Session
Feedback window, executed after a project is debugged.
Default Variable Not Found
Text
Select to set the text that displays in a process if a variable
value is not found.
Designer Embedded Property Select to display the component property in bottom left
Grid
when clicked on in model.
Open To
Select from this box the model Workflow Designer should
automatically open when the user launches the designer.
By default, Workflow Designer opens the Primary Model of
the project.
Pre Populate Connection
Strings on Generated
Components
Select this to have the connection string set in the generator
displayed to the user by default. If this is not selected, the
connection string box in generated components is blank by
default.
Small Nodes
Select if Workflow Designer should display the nodes of
project components as small. If this is not selected, the small
nodes on project components are displayed as larger grey
boxes.
Text Editor Behavior
Edit Tool Preferences
Designer page
Default HTML Font
Select the default HTML font you want when using HTML
in your project.
Default HTML Font Size
Select the default HTML font size you want when using
HTML in your project.
Show HTML Form Controls
in Merge
Select if Workflow Designer should allow users to add HTML
form controls when using the Merge Data option of
component editing.
Show Text Merge Editor
Warning
Select to warn user that user should know what they are
doing before using the tab on the HTML page.
Form Designer
Auto Component Order on
Every Close
Select to auto order components on a form. The component
order is an option on the bottom left of the model pane.
Auto Tab Order on Every
Close
Select to change the tab order to match the component
order.
Composer Controls Text
Logically
Select to display the variable name on text box while in
designer mode.
Prompt for Basic Form Data Select if Workflow Designer should, when designing forms
in the form designer, prompt the user for basic (default)
form data.
Cache
Cache Timeout In Min
Enter the minutes to cache form.
Component Editor
Allow Component Name Sync Select to allow the changing of the name in the Settings tab
of configurator to also change the name on the component
label.
Hide Component Class Name Select if Workflow Designer should hide (make invisible)
Property
the Component Class Name property in the Edit Component
window. This property is unchangeable, and can cause
confusion if the user does not know what it means.
Hide Description Property
Select if Workflow Designer should hide (make invisible)
the Description property in the Edit Component window. It
is optional for users to specify a description to their
components.
565
566
Edit Tool Preferences
Designer page
Hide Location Property
Select if Workflow Designer should hide (make invisible)
the Location property in the Edit Component window. The
location property can be set automatically by clicking,
dragging, and placing components in the designer window.
You do not need to display the coordinates of a component's
location to a user.
Hide Name Property
Select if Workflow Designer should hide (make invisible)
the Name property in the Edit Component window. It is
optional for a user to specify a customized name for a
component.
Hide Override Background
Color Property
Select if Workflow Designer should hide (make invisible)
the Override Background Color property in the Edit
Component window. It is optional for a user to set a
background color, and therefore is not critical for it to
appear.
Business Model
Show Business Model
Select to add a business model to new projects as the default.
Add Business Model to New
Projects
Selecting adds a business model node under the Project Tree
automatically.
Business Model Errors Are
Warnings
Select to show a warning on the business model components
if the component has not been completed. This will not stop
you from running a project.
Add Default Swim Lane
Select to add a default swim lane upon business model
creation.
Component Palette
Maximum Displayed Search Enter the maximum number of components to be displayed
Results
from a component search.
Maximum Recently Used
Components
Enter the maximum number of recently used components
to be displayed.
Show Alpha Components
Select if Workflow Designer should display automatically
alpha components, which are components in their alpha
stage of development and testing (the components are not
fully publishable).
Edit Tool Preferences
Debugging page
Show Beta Components
Select if Workflow Designer should display automatically
beta components, which are components in their beta stage
of development and testing (the components are not fully
publishable).
Variable Selection
Default to Include
Convertible Types
Select if Workflow Designer should include, when selecting
variables for a component box, convertible types.
Convertible type variables are variables whose datatypes
are dynamic, and can therefore be molded to fit many types
of data.
Default to Include Optional
Variables
Select if Workflow Designer should show optional data in
the variable editors.
Data Configuration
Display Data Type
When allowing a user to select a variable datatype, the
datatypes must be displayed in a list. They can be displayed
one of three ways: FriendlyName (which displays a common
name like "Text"), FullTypeName (which displays the full,
technical name for a datatype) and ShortTypeName (which
displays an abbreviated, short version of the datatype).
Image Library
Image Library Paths
Lets you manage the default library paths and add and
remove new library paths.
Virtuoso Libraries
Open Source With External
Program
Select to name a programming tool to use when opening
source from an Integration generated project.
Debugging page
Debugging
Debugging IP Address
If the computer Workflow Designer should use for debugging
has a static IP address (it does not use DHCP to discover its
address), enter its IP address in this box. The IP address is
used to communicate with the test project.
567
568
Edit Tool Preferences
Deployment page
Debugging Port
Enter the port Workflow Designer should use to
communicate with a project being tested or debugged.
Warn on Debugger Close
Select if Workflow Designer should warn a user who is
closing the debugger window, and give the user an option
to cancel the close operation and keep the debugger window
open.
Debugging Grid
Debug Log Row Color
Select the row color for debug logs in the debugging grid.
Error Log Row Color
Select the row color for error logs in the debugging grid.
Fatal Log Row Color
Select the row color for fatal logs in the debugging grid.
Info Log Row Color
Select the row color for information logs in the debugging
grid.
Warning Log Row Color
Select the row color for warning logs in the debugging grid.
Debugging Browser
Non Default Browser EXE
File
Many computers have multiple Web browsers. If Workflow
Designer’s development computer has multiple Web
browsers, enter the full path to the non-default browser in
the Non Default Browser EXE File box. This non-default
browser will only be used if the Use Default Browser
check-box (see below) is cleared.
Use Default Browser
Select if Workflow Designer should use Window's default
browser to open any project-related Web pages or Web sites.
Use Shell Execute
If a project needs to launch an external application, it can
do so using either shell execute (opening using a DOS
prompt or shell), or attempting to run the program within
Windows. Select this if Workflow Designer should (by
default) attempt to open external files and applications
using a DOS prompt or shell.
Deployment page
Deployment
Edit Tool Preferences
Deployment page
Seconds Till Cleanup On
Deploy
Enter into this box the number of seconds Workflow
Designer should wait after publishing a project before
cleaning up the deployment files (temporary files created
when publishing a project).
Deployment: Local
Debugging Web Server
Select to use the internal Web server packaged with
Workflow Designer or to use IIS.
Dynamically Determine
Internal Web Service
IPAddress
Select to find the correct IP address to use for internal Web
server in the case where localhost is not the computer
default.
Determine Web Root
Dynamically
To access a project, users must locate it using a browser.
The Web root is the first part of the URL used to locate
projects deployed locally. By default, it is http://localhost//.
If your development computer has a specific Web root, select
this to determine the Web root from Windows properties,
or enter it in the Web Root textbox (see below).
Web Root
If Workflow Designer is not set up to dynamically discover
the Web root of a server, the Web root must be entered here.
IIS Root
Enter into this box the root directory for all your Window's
IIS services. The default is sufficient for most
commonly-setup computer systems.
Deployment App Name
Enter into this box a name Workflow Designer should use
for projects deployed locally. The default is debug, because
applications deployed locally to the development computer
are commonly deployed for debugging purposes.
Include Custom Libs
Select to include custom libraries in the directory with the
publishing package. If not selected, they are excluded.
Local Deployment Root
All deployed projects have files which are required for
proper project function. When a project is deployed, these
files are moved to a special location. Enter the directory
Workflow Designer should use to house these project files
in this textbox.
Remove Deploy Directory
Itself
Select to remove the entire deployment directory and
recreate it on deployment. If not selected, the content of
the directory is replaced.
Sticky Debug URLs
Select to use the defined URL inside of dynamically changing
debug URLs.
569
570
Edit Tool Preferences
Process Manager page
Deployment: Remote
Deployment Servers
Select Add to add Workflow Servers that this Workflow
Designer can send projects to.
IPFor Remoting Deployment Enter the location in the network of the process which
Service
deploys your project. In most cases, the Remoting
Deployment Service is located on the same computer you
developed your project on. Therefore, this box can be left
as localhost.
Port For Remoting
Deployment Service
Enter the port used by the process which deploys your
project. The default is standard for most projects, and thus
can be left as 11434.
Skip Pick Deployment Host
Select to skip the picker, when publishing, where you pick
from the list of Package Servers for deployment.
Deployment: Installer
Default Install Dir
Enter the default directory for creating deployment
installers for projects.
Process Manager page
This is only available in Workflow 7.0 for use with integrating Process Manager.
Process Manager
Enable Security
Select to use the users, groups, and organizations
permissions that are set up in Process Manager to govern
access to Workflow Designer. This lets you set up the same
types of permissions in both Process Manager and Workflow
Designer.
Use Integrated Session ID
When Publishing
Select to use the integrated session ID when publishing a
workflow project to Process Manager.
Workflow Person
Assignment Screen.
Select whether you want the Workflow person assignment
screen to display a checklist or let the user search for and
select the assignment.
Repository page
This is only available in Workflow 7.0 for use with integrating Process Manager.
Edit Tool Preferences
Repository page
Repository
Enable Project Repository
Selected if project repository is enabled.
Repository Project Close
Action
Select the action to perform when the project repository is
closed.
571
572
Edit Tool Preferences
Repository page
Appendix
C
Symantec Component
Datatypes
This appendix includes the following topics:
■
Symantec component datatypes
Symantec component datatypes
This section lists the datatypes that are available for Symantec components.
Table C-1
Symantec Incident Status
Field Name
Datatype
ID
Text
Value
Text
Table C-2
Item Details
Field Name
Datatype
Applied to Collections
Text
Attributes
Text
Enabled
Text
GUID
GUID Format
Is Scheduled Item
Boolean
Long Type Name
Text
574
Symantec Component Datatypes
Symantec component datatypes
Table C-2
Item Details (continued)
Field Name
Datatype
Name
Text
Parent Folder GUID
GUID Format
Parent Folder Name
Text
Schedule Enabled
Boolean
Schedule XML
Text
Shared Schedule GUID
GUID Format
Type GUID
GUID Format
Type Name
Text
Table C-3
Power Management Command (Drop Down)
Field Name
Datatype
WOL
Text Value
Get Client Config
Text Value
Send Basic Inventory
Text Value
Table C-4
Help Desk Asset
Field Name
Datatype
Department
Text
ID
ID
Location
Text
Name
Text
Resource GUID
GUID Format
Type_Lookup_Value
?
Table C-5
Help Desk Contact
Field Name
Datatype
Contact Email
Text
Symantec Component Datatypes
Symantec component datatypes
Table C-5
Help Desk Contact (continued)
Field Name
Datatype
Contact ID
ID
Contact Name
Text
Contact Resource GUID
GUID Format
Table C-6
Task Details
Field Name
Datatype
Description
Text
GUID
GUID Format
Input parameters
Complex Set
Description
Text
Display Name
Text
Internal Name
Text
Required
Boolean
Type
Text
Value
Text
Name
Text
Output Properties
Complex Set
Description
Text
Display Name
Text
Internal Name
Text
Required
Boolean
Type
Text
Value
Text
Type
Text
575
576
Symantec Component Datatypes
Symantec component datatypes
Table C-7
Ticket Category
Field Name
Datatype
Is Default
Text
Name
Text
Ordinal
Text
Status
Text
Ticket Category ID
ID
Index
A
account management 280
account management settings 187
Active Directory 131
components 392
integrating with 131
Active Directory components 392
ActiveDirectoryTaskSource 99
add and configure a component
scenario 349
Add Computer To Organization Unit 394
Add Group To Group 395
Add Group To Organization Unit 396
Add Group To Share 396
Add Items To Collection 398
Add New Data Element 398
Add Organization Unit To Organization Unit 400
add page page 201
Add Ticket Comment 400
Add User To Group 401
Add User To Organization Unit 402
Add User To Share 402
Add Values 404
adding 257
adding a server
task tray 106
adding components to library 68
adding documents 249
application management settings 187
Approval Workflow 404
article
adding 256
adding a new entry 260
articles
working with 259
articles settings 188
AsciiMergeLabelComponent 411
asdk generator 126
Assign Manager To Computer 412
Assign Manager To Group 413
Assign Manager To Shared Folder 414
Assign Manager To User 415
automation policies
Symantec Management Console 174
B
bulletin board 257
C
categories
managing 255
working with 274
check in 245
check out 245
Compare Numbers Rule 416
component
datatypes 383, 573
end 68, 457
help 69
start 68, 532
Component editor 383, 385
component editor 383
component generators 119, 127
about 125
component toolbox 76
components 66
adding to a project 65
connecting 66
copy properties 67
generate 126
importing 68, 138
setting credentials 143, 149
workflow 62
Configurable Auto Start 416
configure and add a component
scenario 349
connections
managing 139
Context tab 385
copy components to model 66
copy properties 67
copy to model 66
578
Index
create a new project
scenario 348
create a workflow project
scenario 364
Create Anonymous Access Token 417
Create Basic Authentication Token 418
Create Collection 419
Create Computer 420
Create Default Access Token 421
Create DS Connection Profile 421
Create Group 423
create integration library 126
Create Kerberos Authentication Token 424
Create Notification Server Credentials 424
Create Organization Unit 427
Create Resource 429
Create Shared Folder 430
Create Ticket 431
Create User 436
creating a project model 77
credentials 140, 146
creating Deployment Server 148
creating NS 142
setting component 143, 149
customization
Process Manager page lists 212
Process Manager pages 205
customization settings 189
D
data
document 245
workflow designer 78
data management 269
datatypes
component 383, 573
Date Greater Than 437
Date Range Rule 440
DatePickerComponent 438
debugging configuration 567
Decision Path Component 441
Decision-Only-type project 56
DefaultTaskSource 87
Delete Computer 443
Delete Group 444
Delete Organization Unit 445
Delete Shared Folder 445
Delete User 446
Delivering a task
in an email 102
in Process Manager 102
deployment configuration 568
Deployment Server
connection settings 146
creating credential 148
Deployment Server credentials 146
Deployment Server tab 385
design time credentials 140, 146
Designer 60
designer
preferences 55
designer configuration 559, 563
designer loader screen 54
Dialog Workflow 83–85, 447
ActiveDirectoryTaskSource 99
DefaultTaskSource 87
delivering a task in an email 102
delivering a task in Process Manager 102
ProcessManagerTaskSource 90, 93
SharePointTaskSource 97
task assignment 86
Dialog Workflow task source 93
discussion
adding 261
adding a new thread 262
discussions 254
working with 261
Display Content 454
distributing
workflow components 173
document
add 240
add advanced 241
add categories 247
add version 246
adding a category 233
adding a sub category 234
adding simple 240
adding using components 249
category and sub category 234
check in and check out 245
creating expected messages 239
delete 249
deleting a category 236
displaying category history 237
displaying viewer 238
download 243
Index
document (continued)
download zip files 243
editing a category 233
email 248
promote version 246
searching 232
set permissions 247
setting category permissions 238
view 244
view history 245
view versions 244
document category types
working with 271
document management settings 190
document sharing 230
document types
working with 270
documentation 75
documents
page 231
Folder Watch Start 464
For Each Element in Collection 465
Form Builder 467
forms project type 57
G
edit create Symantec Management Console
credentials
scenario 348
edit tool preferences 55, 113, 559
Editor 383
Editor tabs 383
email
sending 295
email settings 190
Embedded Merge 455
end component 68, 457
Ensemble
publishing 112
example
conference room booking 361
new employee help 347
Exception Component 458
Exception Trigger 459
Exception Trigger By Component 460
Exception Trigger By Components 461
Exception Trigger By Exception Type 462
Gain Approval 469
generate components 126
generate reports 80
generator
asdk 126
report 126
resource 126
task 126
generators
about 125
component 119
rebuilding 127
Symantec Management Platform 136
Get All Children For Parent Ticket 474
Get All Users And Groups 474
Get Computer 475
Get Computer List 476
Get Current Date 477
Get Folder Permission List 477
Get Group List 479
Get Groups For User 479
Get Help Desk Assets For Contact 484
Get Help Desk Contact Manager 485
Get Job 480
Get Number From String 481
Get Organization Units List 482
Get Scheduled Job 483
Get Share Permission List 486
Get Shared Folders List 487
Get Task Definition from Task 487
Get Ticket Status 488
Get User List 489
Get Users in Group 490
global data tab 71, 558
Global Logging Capture 490
groups
managing a userbsxd5 s 296
F
H
FAQ
Hanging Path Trigger 491
Hanging Path Trigger By Path 492
E
adding 258
Find Help Desk Contact 463
579
580
Index
help 27
component 69
Help Desk asset datatype 574
Help Desk contact datatype 575
HTMLMERGECOMPONENT 493
I
import model 78
importing components 68
importing Symantec components 138
incident status datatype 573
Initialize Data 494
installing 32
Integrating 131, 133
integrating
process manager with active directory 340
process manager with workflow designer 339
Integrating a workflow process with Active
Directory 131
Integrating a workflow process with SharePoint 133
Integration 131, 133
integration 127
process manager 339
workflow task with workflow designer 226
integration method
Process Manager 226
integration project
creating 138
Integration-type project 59
item details datatype 574
M
Manage users and groups
scenario 362
master settings 184–185
Matches Rule 499
Message listeners tab 387
metadata
project 70
model 76
creating 77
importing 78
models 76
models tab 71, 551
monitoring project type 59
Move Object To Container 500
N
naming
logicbase 33
New File Auto Start 501
new model 77
new project
creating 54
not logged-in users settings 191
Notification Server tab 386
notifications settings 192
NS
creating credential 142
managing connections to 139
Number Range Rule 502
K
O
knowledge base 254
adding an article 256
optimization settings 194
organizations
managing 301
managing a userbsxd5 s 297
L
libraries tab 71, 551
library
adding components 68
List Computers 497
List Jobs In Folder 498
List Schedules For Job 499
loading window
workflow designer 53
logicbase
project types 33
P
package project 115
pages
managing 196
Password String Generator 503
permissions
document 245
managing 300
managing a userbsxd5 s 296
plug-ins
uploading 219
Index
portal
process manager 183
power management command datatype 574
preferences
edit designer 55
process
viewing 225
Process Manager 29, 102
adding Process Manager pages 199
customizing pages 203
integration method 226
publishing 112
publishing to 375
symbols 182
workflow management 221
process manager
about 179
changing settings 184
portal 183
security 280
settings 185, 193
process manager configuration 570
process manager integration 339
Process Manager page
about 196
adding Web parts 208
customizing 205
editing Web parts 209
sharing 210
Process Manager page list
customization options 212
customizing 212
report, changing 214
Process Manager pages
add page 201
add page page 201
adding 199
customizing 203
deleting 211
modifying 211
Process Manager portal
pages. See Process Manager page
Process Manager task list
using in SharePoint 134
Process View page 225–226, 339
setting up users to view 226
Process View pages
about 214
default sections 216
ProcessManagerTaskSource 90
added features 93
profile settings 194
project
creating 54
creating integration 138
packaging 115
reloading 117
reports 80
testing 116
view in Process Manager 376
project data 71
project data tabs 71
project global properties 549
project metadata
workflow designer 70
project model
creating 77
validate 77
project models 76
project name 549
project start types 107
project tree
workflow designer 69
project type
decision only 56
forms 57
integration 59
monitoring 59
workflow 57
project types
workflow designer 55
Project workspace 75
properties
project 549
properties tab 557
publish
to multiple Symantec Management Platform
servers 113
publish application to server 105
publish workflows to Symantec Management Console
granting a user permission 172
publishing 111
as a right-click action in the Symantec
Management Console 152
formats 109
to the Symantec Management Console 170
publishing a project 111
publishing a workflow 105
581
582
Index
publishing formats 109
Publishing projects
Publishing projects to Symantec Management
Console 7.0 149
publishing tab 71, 552
publishing to Ensemble 112
publishing to Process Manager 112, 375
Q
Quick Link Dialog Workflow 504
R
rebuilding 127
relationship types
adding 271
reload project 117
Remove Computer from Organization Units 511
Remove Group from Group 512
Remove Group from Organization Units 513
Remove Group from Share 513
Remove Manager from Computer 515
Remove Manager from Group 515
Remove Manager from Shared Folder 516
Remove Manager from User 517
Remove Organization Unit out of Organization
Unit 517
Remove User from Group 518
Remove User from Organization Units 519
Remove User from Share 520
report generator 126
reports
generating project 80
reports settings 194
Reset User Password 521
resource generator 126
resource tab 71
resources tab 549
right-click action
Symantec Management Console 152
use case example 153
right-click actions
viewing in the Symantec Management
Console 153
Run Job On Computer 522
run project 116
run time credentials 140, 146
S
scenario
conference room booking 361
new employee help 347
schedule
adding 264
Schedule Job On Computer 523
schedules
working with 266
scheduling
task workflow 172
scheduling a task 172
Symantec Management Console 174
security
process manager 280
Send Complete Workflow Message 524
Send Email 527
server 39
server extensions configurator 43–44
service catalog 273
service right-click action 153
Set Ticket Status 530
settings
changing process manager 184
process manager 185
Settings tab 383
Setup Process 529
Share Page 210
SharePoint 133
integrating with 133
SharePointTaskSource 97
Single Value Mapping 530
Site Actions 206
site aggregator page
creating 202
start component 68, 532
start type 107
start types 107
status tracking 114
storage preferences tab 558
storage tab 71
studio configuration 559
sub-page
adding 203
Subtract Days 532
Symantec Deployment Server credentials 148
Symantec Management Console 34, 149
creating a workflow task 171
defining automation policies 174
Index
Symantec Management Console (continued)
granting a user permission to publish
workflows 172
link from workflow server 43
publishing a workflow as a task 170
publishing to 170
right-click action 152
right-click actions 153
scheduling a task 174
Symantec Management Console credentials 140
creating 142
Symantec Management Console permission 172
Symantec Management Platform
Workflow 7.0 135
Symantec Management Platform generators 136
Symantec ns credentials 142
symbols
Process Manager 182
T
tab
Deployment Server 385
Message listeners 387
Notification Server 386
tabs
global data 558
libraries 551
models 551
properties 557
publishing 552
resources 549
storage preferences 558
task 83
adding 223
delegating 222
publishing to the Symantec Management
Console 170
Task assignment 86
task details datatype 575
task generator 126
task integration 83–84
workflow 226
task source 83, 85, 87, 90, 93, 97, 99
task tray application
adding a server 106
task workflow
scheduling 172
tasks 83
working with 224
Terminate Window and Close Dialog 532
testing a project 116
scenario 357
TextBoxComponent 533
ticket category datatype 576
toolbox
component 76
track status 114
tree
workflow designer project 69
True False Rule 537
types
workflow 145
U
Update Computer 537
Update Group 538
Update Organization Unit 539
Update Shared Folder 541
Update User 541
use case example
right-click action 153
user
adding 290
granting permission to publish workflows to the
Symantec Management Console 172
user relationship types
adding 271
users
managing 295
working with 297
user’s groups
managing 296
user’s organizations
managing 297
user’s permissions
managing 296
using tasks 83
V
validate
project model 77
version
document 245
W
Wait For All Workflow Components (Merge) 543
Wait For Job Completion 543
583
584
Index
Wait For Ticket Change 544
Wait On External Event 545
web form
adding 275
web form settings 276
Web part
adding to Process Manager page 208
editing on Process Manager page 209
web part catalogs
adding 219
working with 219
web server
viewing 42
webservice
adding 276
webservice settings 278
wiki
adding 258
workflow
project type 57
publishing 105
running on NS 145
status tracking 114
types 145
Workflow 7.0 34
configuring 32
installing 32
installing and configuring 32
project types 33
where to get more information 27
workflow components
about 62
distributing 173
Workflow Designer 29
tool 60
using 135
workflow designer 54, 75
about 51
data 78
documentation 75
loading window 53
preferences 55
project tree 69
project types 55
Workflow Designer tool 60
workflow model
importing 78
workflow project
packaging 115
workflow project (continued)
reloading 117
reports 80
Workflow Server 29
workflow server 39
viewing projects 42
workflow settings 196
workflow task 83
creating in the Symantec Management
Console 171
workflow task integration 226
workflow tasks 83
Workspace 75
Was this manual useful for you? yes no
Thank you for your participation!

* Your assessment is very important for improving the work of artificial intelligence, which forms the content of this project

Download PDF

advertisement