Você está na página 1de 576

AdminStudio Workflow

Manager 5.0
User Guide
Version 5.0
Legal Information
Book Name: AdminStudio Workflow Manager 5.0 User Guide
Part Number: WFM-050-UG02
Product Release Date: 11/23/2009

Copyright Notice
Copyright © 2001-2009 Flexera Software, Inc. and/or InstallShield Co. Inc. All Rights Reserved.
This product contains proprietary and confidential technology, information and creative works owned by Flexera Software, Inc. and/or
InstallShield Co. Inc. and their respective licensors, if any. Any use, copying, publication, distribution, display, modification, or transmission of
such technology in whole or in part in any form or by any means without the prior express written permission of Flexera Software, Inc. and/or
InstallShield Co. Inc. is strictly prohibited. Except where expressly provided by Flexera Software, Inc. and/or InstallShield Co. Inc. in writing,
possession of this technology shall not be construed to confer any license or rights under any Flexera Software, Inc. and/or InstallShield Co. Inc.
intellectual property rights, whether by estoppel, implication, or otherwise.
All copies of the technology and related information, if allowed by Flexera Software, Inc. and/or InstallShield Co. Inc., must display this notice of
copyright and ownership in full.

Trademarks
Flexera Software, AdminStudio, FLEXenabled, FLEXlm, FLEXnet, FLEXcertified, FLEXnet Connect, FLEXnet Connector, FLEXnet Manager,
FLEXnet Publisher, InstallShield, InstallShield Developer, InstallShield DevStudio, InstallShield Professional, and Package For The Web are
registered trademarks or trademarks of Flexera Software, Inc. and/or InstallShield Co. Inc. in the United States of America and/or other countries.
All other brand and product names mentioned herein are the trademarks and registered trademarks of their respective owners.

Restricted Rights Legend


The software and documentation are “commercial items,” as that term is defined at 48 C.F.R. §2.101, consisting of “commercial computer
software” and “commercial computer software documentation,” as such terms are used in 48 C.F.R. §12.212 or 48 C.F.R. §227.2702, as
applicable. Consistent with 48 C.F.R. §12.212 or 48 C.F.R. §227.2702-1 through 227.7202-4, as applicable, the commercial computer software
and commercial computer software documentation are being licensed to U.S. government end users (A) only as commercial items and (B) with
only those rights as are granted to all other end users pursuant to the terms and conditions set forth in the Flexera Software, Inc. standard
commercial agreement for this software. Unpublished rights reserved under the copyright laws of the United States of America.
Contents

1 AdminStudio Enterprise Server 9.5 Help Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15


Activating AdminStudio Enterprise Server and Workflow Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .18
Using List Features . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Permanently Modifying a List View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Grouping Lists. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Sorting Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .25
Removing and Restoring the Display of List Columns. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .26
Persisting Changes to Individual Reports on the Report View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .27
Temporarily Modifying a List View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
Filtering a List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .28
Changing Column Order . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .30
Resizing List Columns . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
Resizing a List’s Width or Height . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .31
Toggling the Display of the Group By Box and the Filter Bar . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .33
Exporting Data From Any List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .35
Using Help . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
Opening the Help Library . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
Help Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .36
Contacting Us. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .38

2 Managing Roles and Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39


AdminStudio and Workflow Manager Roles and Permissions. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .39
Role Permission Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
AdminStudio Client Tools Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .40
AdminStudio Enterprise Server Tools Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .43
Workflow Manager Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .45
System Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48
Superuser Role: AMSSuper . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .48

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 3


Contents

Default System Roles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .49


Default System Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .50
Creating a New Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
Editing an Existing User Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .51
Copying an Existing Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
Deleting a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .52
Roles Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
Role Administration Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .53
Copy Role View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .54
Role Details View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .55

3 Managing Users, Directory Services, and User Logins. . . . . . . . . . . . . . . . . . . . . . . . . . . 57


Managing Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .57
Creating a New User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
Importing Directory Services Users and Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .58
Disabling a User or Group Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .59
Deleting a User Account. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .60
Managing Directory Services Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61
Managing Directory Services Connections . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61
Adding a Directory Service Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .61
Editing an Existing Directory Service Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .64
Deleting a Directory Service Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65
Managing Directory Services Attributes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .65
Managing User Logins. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .66
Login Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .67
IIS Authentication Methods Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .68
Using AdminStudio Enterprise Server Account Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
Using Domain Account Login. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .69
Using Single Sign-On Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .70
Using Guest Account Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71
Setting Up a Guest Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .71
Logging in as a Guest. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .72
Setting the Session Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .73
Users/Groups and Directory Services Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74
User Administration Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .74
User Details View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .76
Directory Services User/Group Add View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .77
Directory Services Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78
Directory Services List Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .78
Add Directory Service Connection View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .79
Directory Services Attributes Administration Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .81
Add Directory Service Attributes View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .82

4 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Contents

4 Generating and Viewing Reports in Report Center . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83


Generating and Viewing AdminStudio Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85
About the Package Report Tab of the Report Center . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .86
Generating a Package Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89
Viewing Package Reports. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89
Searching for a Package on the Select Package Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .89
Information Included in Package Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .93
Package Summary Information View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .94
Files View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95
Registry View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .96
Shortcuts View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .97
ODBC Drivers View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .98
ODBC DS View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .99
Extended Attributes View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .100
Validation View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .101
Conflicts View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .102
History View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .103
Dependencies View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .104
Navigating Through a Package Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105
Archiving a Package Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .107
Exporting a Package Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .109
Generating a Custom SQL Query Report for AdminStudio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .110
Generating and Viewing Workflow Manager Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112
Creating Custom Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .112
Creating a Custom Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .113
Creating an Activity Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .114
Generating a Custom SQL Query Report. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .119
Wildcard Support in Report Center SQL Queries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .120
Generating System Reports: Projects Report and Application Requests Summary Report. . . . . . . . . . . . . . . . . . . . . .120
Generating an Application Requests Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .123
Generating a Projects Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .124
Exporting Report Data from the Report View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .125
Exporting Data From Any List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .126
Report Center Reference. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127
All Reports Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .127
Projects Report Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128
Projects Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .128
Application Requests Summary Report Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .129
Application Requests Summary Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .131
Report View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .132
Select Package Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .133
Package Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .138
Reports Wizard . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143
Select Report Type Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 5


Contents

Select Report Objects Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .143


Select Report Fields Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144
Set Filters Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .144
Select Template Data Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .145
Enter SQL Query Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .146
General Information Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
Summary Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .147
AdminStudio and Workflow Manager Tables. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148
AdminStudio Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148
cstblPackage . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .148
cstblGroups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
cstblGroupPackages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .150
AsJob . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151
AsJobQueue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .151
AsJobStep. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .152
Workflow Manager Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .153
Workflow Manager Database Table Schema Diagram . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .154
AMS_Application Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .156
AMS_ApplicationItem Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157
AMS_Person Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .158
AMS_ApplicationStatus Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159
AMS_RelatedApplications Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159
AMS_Issues Table. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .159
AMS_AuditTrail Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .161
AMS_Contracts Table . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .164

5 Automating Tasks Using Job Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167


About Job Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .168
Job Steps: Tasks You Can Automate . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .169
Template Jobs vs. Custom Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .170
Selecting Contextual Packages in a Custom Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171
Dynamic Group Content Identification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .171
Conflict Resolution and the Software Repository. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .172
User Permissions and Job Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173
Directory Monitoring and Job Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .173
Managing Jobs. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .174
Creating a New Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .174
Creating a New Job Based on a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .174
Creating a New Custom Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .175
Editing an Existing Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .180
Rescheduling a Job . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .181
Setting Email Alerts. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .182
Viewing Job Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .183
Deleting a Job. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .184

6 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Contents

Managing Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .185


Source and Target Packages in Template Jobs vs. Custom Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .185
Creating a New Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .186
Editing an Existing Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .188
Deleting a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .189
Setting Job Manager Conflict Detection Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .189
Managing Jobs Using Job Manager Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .191
About Job Manager Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .191
Opening the Job Manager Engine User Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .192
Adding an Application Catalog. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .192
Deleting a Connection to an Application Catalog . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .192
Executing Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193
Pausing, Shutting Down, and Restarting Application Catalog Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .193
Viewing Job Manager Engine Status in Job Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .194
Setting Configuration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .195
Job Manager Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .197
Jobs Queue Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .198
Add Job Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .199
Edit Job Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .202
Delete Job/Template Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204
Schedule Job Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .204
Job Alerts Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .205
Job Status Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .205
Job Template List Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .206
Add Template Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .206
Edit Template Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .208
Conflict Detection Options Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .209
Job Manager Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .210
Manage Application Catalogs View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .210
Conflict Detection Configuration View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .212
Validation Configuration View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .213
E-mail Alerts View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .213

6 Distributing Packages Using Configuration Manager Web Console . . . . . . . . . . . . . . . 215


About Microsoft System Center Configuration Manager and Configuration Manager Web Console . . . . . . .216
Distributing Software Through Configuration Manager Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .217
Configuration Manager Web Console Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .219
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .220
Distributing Packages Using the Configuration Manager Web Console. . . . . . . . . . . . . . . . . . . . . . . . . . . . . .220
Configuring Distribution Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .221
Distributing a New Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .221
Selecting a Package for Distribution . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .222
Setting Package Configuration Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .223

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 7


Contents

Setting Package Settings Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .224


Setting Access Accounts Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .228
Setting Distribution Points Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .229
Setting Programs Options. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .230
Setting Advertisements Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .237
Saving the Package on the Configuration Manager Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240
Viewing the Status of a Distributed Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240
Modifying the Distribution Settings of a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .240
Deleting Packages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .241
Configuration Manager Web Console Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .243
Microsoft System Center Configuration Manager Web Console Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .244
Connect to Configuration Manager Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .244
Distribute Package Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .245
PDF Selection Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .245
Configuration Manager Package Configuration Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .246
Package Settings View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .247
Access Accounts View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .250
Distribution Points View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .251
Programs View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .252
Advertisements View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .259
Package Summary Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .262
Select a Configuration Manager Collection Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .262
Distribution Settings Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .262
Package Administration Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .263
Package Status Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .263
Confirm Delete Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .266
Distribute New Package Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .267

7 Using Workflow Manager to Manage Enterprise Software Packaging . . . . . . . . . . . . . 269


About AdminStudio Workflow Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .270
Workflow Manager and the Application Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .271
Workflow Manager Concepts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .273
Workflow Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .274
Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .275
Application Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .276
Customers, Servicers, and Companies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .276
Application Families . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .277
Deployment Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .277
How Dates and Times are Displayed in Workflow Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .277
Getting Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .278
How To Get Started . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .278
Identify Login for Service Company Administrator Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .279
Initialize Workflow Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .279
Review the Lifecycle of an Application Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .280

8 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Contents

Customizing Workflow Manager for Your Organization. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .281


Changing the Login Screen Graphic . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .282
Changing the Home Page Logo. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .284
Displaying a Custom Web Page on the Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .284
Changing the Page Header . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .285
Customizing Workflow Manager Terminology . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .286
Changing the Step Completion Dialog Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .287
Customizing Email Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .288
Location of Email Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .288
Using Replaceable Parameters in Email Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .289
Searching User/Group Listings in Workflow Manager. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .291
Submitting and Monitoring Application Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .296
Submitting an Application Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .296
Submitting an Application Request (Customer). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .296
Submitting an Application Request (Servicer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .298
Copying an Existing Application Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .299
Copying an Existing Application Request (Customer). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .299
Copying an Existing Application Request (Servicer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .300
Deleting an Application Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .300
Monitoring the Progress of an Application Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .301
Searching for Application Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .301
Opening an Application Request’s Application Progress Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .303
Viewing an Application Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .304
Viewing All Application Requests for Your Company (Customer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .304
Viewing the Project List. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .304
Tracking an Application Request’s SLA Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .305
Calculating an Application Request’s SLA Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .305
Stopping and Restarting the SLA Clock. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .306
Generating SLA Status Reports . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .307
Completing Application Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .308
Initiating Work on an Application Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .308
Accepting an Application Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .308
Assigning Users to Application Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .310
Viewing Application Request Assignments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .311
Updating an Application Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .312
Completing a Workflow Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .312
Rolling Back to a Previous Workflow Step . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .314
Editing Data By Performing a Rollback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .315
Editing Data Without Performing a Rollback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .316
Editing Data Collected During Initial Workflow Step. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .318
Editing Data Collected During Subsequent Workflow Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .319
Editing Time Spent Information for Normal Workflow Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .319
Editing Update History Workflow Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .321
Editing Work Assignment Workflow Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .321

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 9


Contents

Editing Script Execution and Custom Web Page Workflow Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .322
Sending Email and Comments at Update, Edit, or Rollback . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .323
Viewing an Application Request’s Uploaded Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .324
Linking Related Application Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .324
Working With Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .324
Creating a New Issue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .325
Responding to or Closing an Issue . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .326
Viewing All Issues . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .327
Performing Administrative Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .327
Managing Companies . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .328
Creating a Customer Company . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .328
Deleting a Customer Company . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .329
Creating a Service Company . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .329
Deleting a Service Company . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .330
Managing Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .330
Creating or Editing a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .330
Defining Project Permissions and Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .332
Defining Project Permissions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .332
Setting Project Email Notification Defaults . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .333
Deleting a Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .334
Uploading and Viewing Project Policy Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .334
Uploading Policy Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .334
Viewing a Project's Policy Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .335
Managing Workflow Templates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .335
About Workflow Templates. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .336
Creating a New Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .337
Initiating the Template. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .337
Creating Data Groups . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .338
Creating the First Workflow Phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .345
Creating Subsequent Workflow Phases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .348
Creating Templates That Use Conditions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .352
Setting Up Conditional Branching of Workflow Phases . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .352
Setting Up Conditional Display of Data Groups, Data Elements, or Workflow Steps . . . . . . . . . . . . . . . . . . . . . . .354
Defining Specialized Data Elements, Workflow Phases, and Workflow Steps . . . . . . . . . . . . . . . . . . . . . . . . . . . . .356
Defining a Database-Driven Data Element . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .356
Defining Automated Import, Validation, and Conflict Analysis Workflow Steps . . . . . . . . . . . . . . . . . . . . . . . . . . .357
Defining a Custom Web Page Workflow Step. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .360
Configuring a Custom Web Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .360
Defining a Workflow Phase with a Phase Type of AdminStudio Workflow . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .365
Including a Customer Acceptance Phase or Last Phase . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .365
Specifying Email Templates for Workflow Steps. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .365
File Upload Considerations in Application Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .366
Editing a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .367
Previewing and Testing a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .370

10 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Contents

Copying a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .370


Copying an Existing Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .371
Copying an Existing Template to Another Workflow Manager Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .371
Deleting a Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .373
Managing Email Notifications. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .373
Email Notification Events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .374
Setting Email Notification Defaults for Projects and Application Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .376
Setting Email Notification Defaults for New Projects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .376
Setting Email Notification Defaults for Application Requests . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .377
Overriding Email Notification Defaults for an Application Request . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .380
Adding Users, Groups, and External Email Addresses to an Email Notification List . . . . . . . . . . . . . . . . . . . . . . . .383
Adding Users or Groups to an Email Notification List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .383
Adding an External Email Address to an Email Notification List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .386
Deleting a User, Group, or External Email Address from a Notification List . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .387
Manually Adding Email Notifications at Workflow Step Completion, Edit, or Rollback Event . . . . . . . . . . . . . . . . .388
Managing My Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .394
Managing SLA Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .396
Modifying Default SLA Calendar Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .396
Modifying Due/At Risk Period for an Application Request. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .398
Dynamically Updating an Application Request’s Application Due Period. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .398
Managing Deployment Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .401
Viewing Existing Deployment Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .402
Adding a New Deployment Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .403
Editing a Deployment Site . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .403
Setting Deployment Site Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .404
Managing Application Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .404
Creating a New Application Status. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .405
Editing an Application Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .405
Deleting an Application Status . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .406
Managing External Datasources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .406
About Using External Datasources. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .406
Creating a New External Datasource Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .409
Editing an Existing External Datasource Connection. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .410
Deleting an External Datasource Connection . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .411
Workflow Manager Configuration Tasks . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .411
Specifying Folders for Uploads and Downloads . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .411
Setting the System User Account. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .412
Integrating AdminStudio and Workflow Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .413
Connecting the AdminStudio Client Tools to the AdminStudio Enterprise Server Application Catalog. . . . . . . . . .414
Associating a Workflow Manager Application Request with a Package . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .415
Sharing AdminStudio Extended Attribute Data With Workflow Manager Workflows . . . . . . . . . . . . . . . . . . . . . . . .418
Default Extended Attribute Description File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .421
Defining a Workflow Manager Phase as an AdminStudio Workflow Project . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .423
Automatically Performing ConflictSolver Tasks from a Workflow Manager Workflow Step . . . . . . . . . . . . . . . . . . .425

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 11


Contents

8 Workflow Manager Reference . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 427


Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .428
Application Request Related Pages and Views. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .431
All Application(s)/Application Search Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .432
Application Search Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .434
All Projects Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .437
Assignments Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .438
Project Summary Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .439
View Policy Documents Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .441
Application Progress Page (Customer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .441
Data Entry Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .442
Copy an Application Request Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .442
Workflow Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .443
Application Progress Page (Servicer) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .444
Application Progress Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .445
Properties Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .446
Related Applications Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .448
Add Related Applications Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .449
Deployment Progress Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .449
Application Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .449
Application Progress Page (Shared) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .454
Issues Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .454
Uploaded Files Tab. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .458
Downloadable Files Tab . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .459
Application Request Notifications Override Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .459
Issues List Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .460
Submit Application Request Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .461
Copy an Application Request Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .462
Work Assignment Listing Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .463
Assignment Details Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .465
Working Queue View Page. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .466
My Notifications Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .467
Administration Pages and Views . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .472
Application Status Administration Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .473
New/Edit Application Status View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .474
Calendar Settings Administration Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .474
Company/Business Unit Administration Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .475
Company/Business Unit Details View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .476
Deployment Site Administration Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .477
Deployment Site Details View. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .478
Email Settings Administration Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .478
External Email Address Administration Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .480
Add External Email Address View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .480
Project Permission and Notification Settings View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .480

12 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Contents

Project Permissions Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .481


Project Email Notification Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .482
Project Administration Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .485
Project Details View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .485
Policy Documents Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .489
Policy Document Details View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .490
System Settings Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .490
Template Administration Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .491
Copy Template Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .493
Template Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .494
Template Details Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .496
Template Properties View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .500
Data Group Properties View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .503
Data Element Properties View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .507
Common Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .507
Data Element Data Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .508
Data Type-Specific Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .511
Data Element Condition Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .514
Workflow Phase Details View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .515
Workflow Step Details View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .519
Workflow Step Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .521
Workflow Step Condition Area . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .526
External Data Sources Administration Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .527
External Data Source Details View . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .528
Terminology Customization Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .529
Terminology Report . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .530
Dialog Boxes . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .531
Select External Email Address Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .531
Add User/Group Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .532
Create Application Family Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .533
Dynamic Pick List Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .533
File Upload Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .534
Select User Dialog Box. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .534
Edit Status Comment Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .536
Validate Template Dialog Box . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .536
Configuration File: web.config . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .537
Connection Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .537
Database Connection String for ASP.net Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .537
Database Connection String for ASP Pages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .539
Workflow Manager Web Services URL. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .540
AdminStudio Enterprise Platform . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .541
Web Service Bridge to AdminStudio . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .541
Timeout Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .542
HTTP Request Length and Execution Timeout . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .542

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 13


Contents

Login Page Timeout Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .543


System Session Mode Value . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .543
Set System Authentication to “Forms” . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .544
Application Request-Related Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .544
Auto-Acceptance of Submitted Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .544
Guest System Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .545
Setting the Default AdminStudio User Work Assignment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .546
Project Summary Page Workflow Percentage Display Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .546
Project Report Time Spent on Each Phase Display Setting . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .547
Root Folder for Uploading and Downloading Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .547
SLA Disable/Enable Flag . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .548
Email Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .548
Email Server URL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .548
SMTP Authentication Type . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .549
Send One Email to All Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .549
Send Email to Automatically Imported Members of a Directory Service Group . . . . . . . . . . . . . . . . . . . . . . . . . . . .550
Send Email as BCC . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .550
System Email Sender’s Email Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .551
System Email Subject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .551
Location of Email Template Folder and Template Files. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .552
System Support Email Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .553
Company Name for Email Notification . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .553
List Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .554
Default Number of Lines Displayed in Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .554
Default Font for Lists . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .554
Extending Workflow Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .555
Using the IPlugin Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .555
How to Use the IPlugin Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .556
IPlugin Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .557
AppBinariesSubmitted Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .557
AppRequestSubmitted Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .558
AppMetaDataChanged Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .558
AppRepackageApproved Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .559
AppWorkflowStepInitiated Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .559
AppWorkflowStepComplete Method . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .560
AsyncOperationCompleted Method. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .560
Data Passed in XML to IPlugin Methods . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .561
Setting Up IPlugin Automation in Workflow Manager . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .563
Workflow Manager Installation Issues. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .565

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 567

14 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


1
AdminStudio Enterprise Server 9.5
Help Library

Edition • AdminStudio Enterprise Server is included with AdminStudio Enterprise Edition. AdminStudio Workflow
Manager, which is integrated with AdminStudio Enterprise Server, is sold separately.

AdminStudio Enterprise Server is a security console and set of Web tools that are closely integrated with
AdminStudio. The configuration of Web tools that is included depends upon the software bundle that you
purchased:

Table 1-1 • AdminStudio Enterprise Server 9.5 Tool Bundles

Configuration
Security Report Job Manager Web Workflow
Bundle Purchased Console Center Manager Console Manager

AdminStudio Included Includes Included Included


Enterprise Edition AdminStudio
Component

Workflow Manager Included Includes Included Included


Workflow
Manager
Component

AdminStudio Included Includes Both Included Included Included


Enterprise Edition and Components
Workflow Manager

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 15


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library

The AdminStudio Enterprise Server and Workflow Manager user documentation is presented in the following
sections:

Table 1-2 • AdminStudio Enterprise Server 9.5 & Workflow Manager 5.0 Help Library

Topic Content

Using the AdminStudio Enterprise • Managing Roles and Permissions—Explains how to create
Server Security Console and edit roles to manage access to AdminStudio functionality.
• Managing Users, Directory Services, and User Logins—
Explains how to create an account for each person that you
want to have access to AdminStudio, and how to import users
or groups of users from a directory service. Also explains how
to set up the AdminStudio account, domain account, single
sign-on, and guest account login methods.

Using AdminStudio Enterprise • Generating and Viewing Reports in Report Center—


Server Tools Explains how to use the Report Center to generate reports on
packages stored in the Application Catalog, and on Workflow
Manager Projects and Application Requests. You can also use
SQL queries to generate custom reports on data stored in the
AdminStudio Enterprise Server Application Catalog.
• Automating Tasks Using Job Manager—Explains how to
use Job Manager to automate time consuming application
migration tasks, saving you time and enabling you to enforce
standardized business practices on the packaging process.
• Distributing Packages Using Configuration Manager
Web Console—Explains how to use Configuration Manager
Web Console, a Web-based application, to configure package
distribution options and distribute setup packages without
going to SMS Server.

16 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library

Table 1-2 • AdminStudio Enterprise Server 9.5 & Workflow Manager 5.0 Help Library (cont.)

Topic Content

Using Workflow Manager • About AdminStudio Workflow Manager—Introduces you


to Workflow Manager concepts, describes the steps you need
to take to start using Workflow Manager, and explains how to
customize Workflow Manager for your organization.
• Submitting and Monitoring Application Requests—
Includes procedures that are related to submitting,
monitoring, and reporting on Application Requests.
• Completing Application Requests—Includes procedures
that are related to performing Application Request tasks.
• Generating and Viewing Workflow Manager Reports—
Explains how to view existing reports or create custom
reports, and how to export report data.
• Performing Administrative Tasks—Includes administrative
procedures such as creating users and groups, defining roles
and permissions, directory services configuration, email
notification management, and creating Templates and
Projects.
• Workflow Manager Reference—Includes the same topics
that are displayed when you open help from the Workflow
Manager interface.

This section of the help library includes the following topics:

• Activating AdminStudio Enterprise Server and Workflow Manager

• Using List Features

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 17


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Activating AdminStudio Enterprise Server and Workflow Manager

Activating AdminStudio Enterprise Server and


Workflow Manager
AdminStudio Enterprise Server Tools and Workflow Manager are each activated by entering a valid serial number.
The number of tabs visible in AdminStudio Enterprise Server depend upon which serial numbers you enter.

• The Job Manager tab is only visible if you enter an AdminStudio Enterprise Edition serial number.

• The Workflow Manager tab is only visible if you enter a Workflow Manager serial number.

• The Report Center, Distribution, and Administration tabs are always visible.

You can enter serial numbers during product installation or at any time after that on the System Settings page of
the Administration tab.

• Entering Serial Numbers During Installation

• Entering Serial Numbers in the Product Interface

Entering Serial Numbers During Installation


You are prompted to enter an AdminStudio Enterprise Edition and Workflow Manager serial number on the Serial
Number panel of the AdminStudio Web Server installation. You are required to enter at least one serial number.

Figure 1-1: Serial Number Panel of the AdminStudio Web Server Installation

18 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Activating AdminStudio Enterprise Server and Workflow Manager

Entering Serial Numbers in the Product Interface


After installation, you can enter (or remove) serial numbers on the System Settings page of the Administration tab:

Figure 1-2: The Serial Number fields on the System Settings page

If you remove a serial number from this page and click Update, the product-specific functionality of that component
is no longer visible.

• The Job Manager tab is only visible if you enter an AdminStudio Enterprise Edition serial number.

• The Workflow Manager tab is only visible if you enter a Workflow Manager serial number.

• The Report Center, Distribution, and Administration tabs are always visible.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 19


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

Using List Features


Most of the lists used in AdminStudio Enterprise Server and Workflow Manager implement the same list features,
which allow you to group a list by any column, sort a list by any column, filter a list by specific criteria in one of the
columns, resize list columns, change which columns are displayed, and change column order.

Some of the modifications that you can make to a list are persisted on a per-user basis, while others are only
temporarily applied. This section contains the following topics:

• Permanently Modifying a List View

• Temporarily Modifying a List View

• Exporting Data From Any List

Permanently Modifying a List View


You can make the following modifications to a list view, and these modifications are persisted on a per-user basis.
These changes remain in effect even after you refresh a page, even when you exit a page and return to it later, and
even after you log out of the system and log back in later.

• Grouping Lists

• Sorting Lists

• Removing and Restoring the Display of List Columns

• Persisting Changes to Individual Reports on the Report View

Important • For most of the lists in AdminStudio Enterprise Server, when you make the modifications listed above,
these changes are persisted on a per-user basis. However, on the Report View, modifications are persisted on a
per-user, per-report basis, allowing you to customize the display of each report. See Persisting Changes to
Individual Reports on the Report View for more information.

Grouping Lists
This section explains how to group a list by a column, ungroup a list, and create subgroupings.

• Grouping an Ungrouped List

• Ungrouping a List or Changing a List's Group By Column

• Performing Subgrouping

Note • The Group By selections you make on a list are persisted on a per-user basis. Each time you alter a list’s
Group By settings, a cookie is saved on your computer, so that your Group By settings will be applied each time you
view that list on the same machine.

20 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

Grouping an Ungrouped List


If a list is not grouped by a column, the Group By Box is empty and displays the following message:

Drag a column header here to group by that column.

To group by a column, perform the following steps.

Task: To group a list by a column heading:

1. Click on the column header that you want to group by and drag it on top of the Drag a column here to
group by that column box (the Group By Box).

2. When you see a red arrow on the right side of the Group By Box, release the column header. In this example,
a list of users is being grouped by the Roles column:

Tip • Another way to do this is to click on the column header that you want to group by and select Group By
This Field from the context menu.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 21


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

When you group by a column header, the following occurs:

• The name of the column header that you have chosen now appears in the Group By Box.

• The name of the list you are viewing appears in a white box to the left of the Group By Box.

• The name of the column header that you selected and each of its values (in the format of Column Name:
Value) is now listed in a bar at the left of the list, with all records associated with that value of that column
grouped underneath that bar.

• One group (bar) appears for each of the values of the selected column. Click the plus sign to expand the
list.

Ungrouping a List or Changing a List's Group By Column


Perform the following steps to ungroup a list or to change the column that the list is grouped by.

Task: To ungroup a list or change a list's Group By column:

1. Click on the name of the column header in the Group By Box and drag it back to the header row in the list to
the location where you want the column to be inserted.

2. When you see a red arrow on the right side of the Group By Box, you can release the column header.

22 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

Tip • Another way to do this is to click on the column name in the Group By Box and select Ungroup By This
Field from the context menu.

The list is now ungrouped and the entries of the column that the list was previously grouped by now appear in
the regular list.

3. Now you can choose another column to use to group the list by following the steps listed above under
Grouping an Ungrouped List.

Performing Subgrouping
To further refine a list, you can create subgroups inside of a group.

Task: To perform subgrouping

1. Click on the column header that you want to use to perform a subgrouping and drag it on top of the name of
the column header that currently appears in the Group By Box.

2. When you see a red arrow on the right side of the Group By Box, you can release the column header.

Tip • Another way to do this is to click on the column header that you want to subgroup by and select Group
By This Field from the context menu.

A second column header is now listed to the right of the original Group By Box, and the grouped list is now
grouped by the second column:

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 23


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

Both the groupings and subgroupings that you apply are persisted on a per-user basis.

24 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

Sorting Lists
You can sort lists by any column by clicking on the column header of the column you want to sort by.

Note • The Sort Order selections you make on a list are persisted on a per-user basis. Each time you alter a list’s
Sort Order settings, a cookie is saved on your computer, so that these Sort Order settings will be applied each time
you view that list on the same machine.

Task: To sort a list by a column heading:

1. Click on the column heading to toggle through the three sort order states, which are identified by a visual
indicator

Indication Description

When the column is sorted in Ascending order, an up arrow is displayed in the header
row.

When the column is sorted in Descending order, a down arrow is displayed in the
header row.

When the column is not sorted (meaning that the list is either sorted by another column
or is just listed in the default order that the records appear in the database), no arrow is
displayed.

Tip • Another way to do this is to select the column header of the column you want to sort, and then select Sort
Ascending or Sort Descending from the context menu.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 25


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

Removing and Restoring the Display of List Columns


To improve readability or clarity, you can choose to remove a column from a list. When you remove a column from
a list, you are just turning off the display of that column, not deleting the data that was in that column. You can
restore a removed column to the list at any time.

Note • The changes that you make to the columns displayed in a list are persisted on a per-user basis. Each time
you alter the columns that are displayed in a list, a cookie is saved on your computer, so that your column display
settings will be applied each time you view that list on the same machine.

Removing a Column from a List


To remove a column from a list, perform the following steps.

Task: To remove a column from a list:

1. Point the cursor in the column header of the column you want to remove.

2. Select Remove This Column from the context menu.

The column is now hidden.

Note • You cannot remove all of a list’s columns. At least one column must remain visible.

Restoring a Column to a List


To restore the display of a hidden column to a list, perform the following steps.

Task: To restore the display of a deleted column to a list:

1. To restore the display of a deleted column to a list, point the cursor anywhere in the heading row.

2. Point to Select Columns in the context menu. A list of all of the available columns for this list is displayed.

26 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

3. Select the check box next to the name of the column that you want to restore to the list.

4. Click Apply Changes at the bottom of the context menu. The deleted column is now displayed in the list.

Note • When the deleted column is first restored to the list, it will be the last column on the right. However, after
the page is refreshed, it will return to its default location.

Persisting Changes to Individual Reports on the Report View


Reports that you create using the Report Wizard are displayed on the Report View. Because each report contains
different information, you would not want to customize them all the same way. You would want to make groupings,
choose a sort column, and display the columns that help you easily see the most important information in the
report.

Therefore, for the “persisted” modifications listed in this section, they are persisted on a per-user, per-report basis.
Each report you view on the Report View can have its own set of persisted modifications. These persisted
modifications include:

• Grouping Lists

• Sorting Lists

• Removing and Restoring the Display of List Columns

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 27


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

Temporarily Modifying a List View


You can make the following modifications to a list view to improve its readability or to find specific information, but
these modifications are not persisted when the screen is refreshed, or when you exit the page and return to it later.

• Filtering a List

• Changing Column Order

• Resizing List Columns

• Resizing a List’s Width or Height

• Toggling the Display of the Group By Box and the Filter Bar

Filtering a List
You can filter a list by specific criteria in one of the columns. The search fields are located in the row directly below
the column headers and are identified by the following icon:

Figure 1-3: List With Filter Row Displayed

Note • Any filters that you apply to a page are automatically cleared whenever the page is refreshed. Also, if you exit
a page containing a filtered list and open it again later, the filters will not be persisted.

Applying a Filter
To filter a list by criteria you specify, perform the following steps:

28 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

Task: To filter a list by user-entered criteria:

1. Click on the icon in the row below the column header and select one of the operators from the list:

The following operators are available:

Greater Than or Equal To


Greater Than
Equal To
Not Equal To
Less Than or Equal To
Less Than
Like
Not Like
Between
Not Between
Is Null
Not Is Null
Is Empty
Not Is Empty

2. For regular searches, enter the text you want to filter by in the row below the column header (next to the
icon) and press Enter. Only those items in the list that meet the specified criteria will be listed.

3. For searches using the Between operator, enter the search criteria in the row below the column header (next
to the icon) in the format of @number1 and @number2 and press Enter. Only those applications that meet the
specified criteria will be listed.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 29


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

Removing a Filter
To remove a filter from a list, perform the following steps:

Task: To remove a filter from a list:

1. Click on the icon in the row below the column header of the column containing the filter.

2. Select Clear This Filter from the list.

3. To delete filters from all columns, select Clear All Filters.

Changing Column Order


To help compare the values of columns, you can click and drag to change the order of columns in a list.

Note • A change in a list’s column order is not persisted between sessions. As soon as the page is refreshed, or if
you exit the page and open it again later, the columns will appear in their default order.

Task: To change column order:

1. Click on the column header of the column you wish to relocate.

2. While holding the mouse button down, drag the column header on top of the rule between two columns. When
moving the column header, it appears as a brighter blue “ghost” gradient box:

3. When the cursor changes into a double-headed arrow, release the mouse button to perform the move.

30 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

Resizing List Columns


To improve the readability of the values in a column of a list, you can click and drag to temporarily resize a column.
However, as soon as the page is refreshed, or if you exit the page and open it again later, the column widths will
return to the defaults.

Task: To resize a column:

1. Position your cursor at the right side of the column header of the column that you want to resize. When you are
pointing at the correct location, the cursor turns into a double-arrow icon:

2. Click once, and while holding the mouse button down, drag the edge of the column left or right until it is the
desired width.

Tip • If you want to increase the width of all of the columns of a list, you can enlarge the browser window, and then
click F5 or click the Refresh button in the browser’s toolbar to refresh the view. The list will expand to fit the new size
of the window. If you reduce the size of a browser window and then click F5, the list will be reduced in size to fit
within the smaller window. See Resizing a List’s Width or Height.

Resizing a List’s Width or Height


If you want to increase the size of a list to make it easier to read, you can enlarge the browser window, and then
click F5 or your browser’s Refresh button to refresh the view. The list will expand to fit the new size of the window.

If you reduce the size of a browser window and refresh the view, the list (and associated scroll bars) will be reduced
in size to fit within the smaller window.

Note • A change in width of the columns in a list is not persisted between sessions. As soon as the page is
refreshed, or if you exit the page and open it again later, the columns will appear in their default width.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 31


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

Task: To resize a list to match the new size of a browser window:

1. Open a page that contains a list. In the list below, four Application Requests are visible, and there is a scroll bar
on the right side of the list to use to view the rest of the items on the list.

2. Click and drag to resize the browser window to make it either larger or smaller than its current size. In the
following example, the browser window was made taller so that more rows could be displayed at once.

32 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

As you make the browser window bigger, the list expands to fill up the height of the page, making more
Application Requests visible. Notice that the list no longer has a scroll bar, since all Application Requests are
displayed.

Toggling the Display of the Group By Box and the Filter Bar
You can turn the display of the Group By Box and the Filter Bar for the current session by making a selection from
the context menu.

Note • As soon as the page is refreshed, or if you exit the page and open it again later, the hidden Group By Box or
Filter Bar will reappear.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 33


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

Turning Off the Display of the Group By Box


To turn off the display of the Group By Box, perform the following steps:

Task: To turn off the display of the Group By Box:

1. Click on a column header and select Group By Box from the context menu. The Group By Box is no longer
displayed.

2. To restore the Group By Box, click on a column header and select Group By Box again from the context
menu.

Turning Off the Display of the Filter Bar


To turn off the display of the Filter Bar, perform the following steps:

Task: To turn off the display of the Filter Bar:

1. Click on a column header and select Filter Bar from the context menu. The Filter Bar is no longer displayed.
In this example, both the Group By Box and the Filter Bar are hidden:

2. To restore the Filter Bar, click on a column header and select Filter Bar again from the context menu.

34 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using List Features

Exporting Data From Any List


You can export data in any list to Microsoft Excel, HTML, PDF, XML, TIFF, RTF, or Text format. When you export data
from a list, data from all of the pages of the list are exported, not just the data that is currently displayed. You can
export data from any list, including user generated reports that are displayed on the Report View.

Task: To export list data:

1. At the bottom right corner of the list, click the Export button. The Export Menu opens displaying three sets
of options: Data to Export, Export Format, and Page Orientation.

2. In the Export Format section of the menu, select the desired format.

3. In the Page Orientation section of the menu, select Portrait or Landscape.

4. Click Export now. The data from that listing is exported in the selected format, saved to a temporary location
on the Workflow Manager Server, and then that data file is opened in the appropriate application:

• Microsoft Internet Explorer (HTML/XML/TIFF)

• Adobe Reader (PDF)

• Microsoft Excel (Excel)

• Microsoft Word (RTF)

• Notepad (Text)

5. On the File menu of the application displaying the report, click Save As and save the report to a local drive.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 35


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using Help

Using Help
When you have questions about your product, first consult the online help library. The help library is the complete
user’s guide for using AdminStudio Enterprise Server and Workflow Manager tools.

• Opening the Help Library

• Help Conventions

Opening the Help Library


The AdminStudio Enterprise Server and Workflow Manager Help Library can be opened from within its interface by
clicking the Help button in the page banner:

Help Conventions
In this documentation, reader alert and style conventions are used to bring your attention to specific information or
help you identify information.

Reader Alert Conventions


Reader alerts are used throughout this documentation to notify you of both supplementary and essential
information. The following table explains the meaning of each alert.

Table 1-3 • Reader Alert Conventions

Image Alert Name Description

Note Notes are used to draw attention to pieces of information that should stand
out.

Important Note Important notes are used for information that is essential for users to read.

Caution Cautions indicate that this information is critical to the success of the
desired feature or product functionality.

Tip Tips are used to indicate helpful information that could assist you in better
utilizing the desired function or feature.

36 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Using Help

Table 1-3 • Reader Alert Conventions (cont.)

Image Alert Name Description

Best Practices Best Practices alerts instruct you on the best way to accomplish a task.

Edition-Specific Edition-specific notes indicate that the information applies to a specific


Note edition of a product (such as Standard, Professional, or Enterprise edition).

Windows Logo Windows Logo Guideline alerts accompany Microsoft logo compliance
Guideline requirements and recommendations.

Security Security alerts identify security issues.

Procedure The Procedure graphic indicates that procedural instructions follow.

Style Conventions
The following style conventions are used throughout this documentation.

Table 1-4 • Style Conventions

Style Example Description

User Interface On the File menu, click Open. User interface elements appear in
Elements bold when referenced in tasks.

Variables fileName Variables appear in italics.

Code #define HWND_BROADCAST 0xffff Code snippets appear in a


monospace typeface.

User Inputted Text Type $D(install). Text that is to be entered as a literal


value is displayed in a monospace
typeface, in bold, and in blue.

File Name and My files are located in the File names and directory paths are
Directory Paths C:\MyDocuments\SampleCode directory. presented in a monospace typeface.

.INI File Text Insert the line LimitedUI=Y into the file to display Text in .INI files is presented in a
only the Welcome dialog box when the monospace typeface.
Windows Installer package is run.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 37


Chapter 1: AdminStudio Enterprise Server 9.5 Help Library
Contacting Us

Table 1-4 • Style Conventions (cont.)

Style Example Description

Command-Line To run the installation silently, enter: Command-line statements and


Statements parameters are presented in a
Setup.exe /s /v/qn
monospace typeface.

Environment Set the value of the windir environment Environment variables are presented
Variables variable. in a monospace typeface.

Examples Create two groups, one called Admins and the Examples are presented in bold.
other called General.

Functions FeatureAddItem adds a new feature to a Functions are presented in


script-created feature set. presented in bold.

Properties In the Name property, enter a name for this Properties are presented in bold.
custom control that is unique among all of the
controls in your project.

Screen Output If you type an incorrect parameter, the message Screen output (from a log file or from
The system cannot find the path specified. the console) is displayed in a
is displayed. monospace typeface, and in blue.

Links Obtain the latest modules, white papers, project Links appear in blue.
samples, and more from:

http://www.mycompany.com

Contacting Us
You may contact us from anywhere in the world by visiting our Web site at:

http://www.flexerasoftware.com

38 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


2
Managing Roles and Permissions

All of the AdminStudio and Workflow Manager permissions are related to Roles. The amount of functionality that a
user has is directly related to what Roles they are assigned to.

This section contains information on the following tasks:

• AdminStudio and Workflow Manager Roles and Permissions

• Creating a New Role

• Editing an Existing User Role

• Copying an Existing Role

• Roles Reference

AdminStudio and Workflow Manager Roles


and Permissions
Permissions are assigned to Roles, and Roles are assigned to users. Therefore, all permissions in AdminStudio
and Workflow Manager are controlled by Roles.

This section includes the following topics:

• Role Permission Lists

• AdminStudio Client Tools Permissions

• AdminStudio Enterprise Server Tools Permissions

• Workflow Manager Permissions

• System Roles

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 39


Chapter 2: Managing Roles and Permissions
AdminStudio and Workflow Manager Roles and Permissions

Role Permission Lists


Permissions to perform all AdminStudio and Workflow Manager functions are assigned using Roles. A user has
permission to perform only those tasks that are explicitly selected in the Role(s) that the user is assigned to.

This section describes all of the AdminStudio and Workflow Manager permissions:

• AdminStudio Client Tools Permissions

• AdminStudio Enterprise Server Tools Permissions

• Workflow Manager Permissions

AdminStudio Client Tools Permissions


The AdminStudio client tools have the following permissions:

Table 2-1 • AdminStudio Client Tools Permissions

Category Permission

AdminStudio • Edit—Permits user to view and edit those Projects on the Projects tab that
are assigned to him.
Projects Tab
• Create—Permits user to create new Projects and assign them to users.
Users with the Create permission see a list of all users and their associated
Projects on the Projects tab. Users with only the Edit permission cannot
create new Projects and can only view and edit Projects that are assigned to
him.
• Delete—Permits user to delete a Project from the Projects tab.

AdminStudio • View—Permits user to view the Workflow tab and all of the existing
Workflows.
Workflow Templates Tab
• Edit—Permits user to edit existing Workflows on the Workflow tab.
• Create—Permits user to create a new Workflow on the Workflow tab.
• Delete—Permits user to delete a Workflow from the Workflow tab.

AdminStudio • Add—Permits user to add a new tool to the Tools tab.

Tools Tab • Edit—Permits user to edit the properties of an existing tool on the Tools tab.
• Delete—Permits user to delete an existing tool on the Tools tab.

40 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 2: Managing Roles and Permissions
AdminStudio and Workflow Manager Roles and Permissions

Table 2-1 • AdminStudio Client Tools Permissions (cont.)

Category Permission

AdminStudio • Modify Tools Options Dialog—Permits user to set options on the


Locations, Updates and Quality tabs of the AdminStudio Options dialog
General
box. Users without this permission can view the Options dialog box but
cannot make any changes.

If a user has only the Modify Tools Options Dialog permission but does
not also have the Change Default Application Catalog permission, that
user cannot edit the Shared AdminStudio Application Catalog field on
the Application Catalog tab of the Options dialog box.

• Change Default Application Catalog—Permits user to edit the Shared


AdminStudio Application Catalog field on the Application Catalog tab
of the Options dialog box (if that user also has the Modify Tools Options
dialog permission). This permission also permits user to edit the Make this
the default shared Application Catalog option on the Connect
Application Catalog dialog box

Application Manager / • Run Analysis—Permits user to perform conflict analysis on a package.


Conflict Solver • Resolve—Permits user to resolve any automatically resolvable conflicts
Conflicts found during conflict analysis on a package.
• Modify Rules—Permits user to open the Rules Viewer and create and edit
new Rules.
• Modify Data—Permits user to create new Groups, rename existing Groups,
and modify Group Properties.

Permits user to Cut and Paste a Group to a new location.

Permits user to Copy/Cut and Paste a package into a new Group.

Permits user to modify options on the Resolution Options dialog box.

Permits user to edit a package Description on the Products View.

Application Manager / • Delete—Permits user to delete a package from the Application Catalog.
Conflict Solver • Import—Permits user to import a package into the Application Catalog.
Package • Modify Extended Attributes—Permits user to modify a package’s
metadata on the Extended Attribute view.
• Delete History—Permits user to delete a package’s history log (which
contains a record of any operation that materially changes a software
package or the data associated with it).

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 41


Chapter 2: Managing Roles and Permissions
AdminStudio and Workflow Manager Roles and Permissions

Table 2-1 • AdminStudio Client Tools Permissions (cont.)

Category Permission

Application Manager / • Modify Tools Options Dialog—Permits user to open the Application
Conflict Solver Manager/ConflictSolver Options dialog box and set options.

Other • Change Application Catalog—Permits the user to connect to a different


Application Catalog by selecting Connect on the Catalog menu. Without
this permission, this selection is disabled.
• Run Merge Wizard—Permits user to use the Merge Wizard to merge the
application data of a specified Application Catalog into the currently open
Application Catalog.
• Run Validation—Permits user to use the Validation Wizard to validate a
Windows Installer package against custom actions written by Microsoft
which can be executed to determine if an installation package is built
according to Windows Installer standards.
• Scan for Dependencies—Permits user to generates a list of all of a
package’s files that have dependencies with files used by other products or
operating systems in the Application Catalog.
• Run Directory Monitoring—Permits user to use the Network Directory
option of Package Auto Import to monitor a directory location on the
network (or a local directory) and automatically import or re-import packages
in that directory at scheduled intervals.
• Run Best Practices—Permits user to use the Conflict Wizard or the
ConflictSolver Process Assistant to evaluate source packages to see if they
meet Windows Installer best practices rules.

Patch Impact Manager • Import Patch—Permits user to use OS Security Patch Wizard to import
Windows operating system patches into the Application Catalog.
• Run Analysis—Permits user to use the ConflictSolver Patch Impact
Analysis Wizard to analyze the impact of installing an OS Security patch on
user machines.

Software Repository • Overwrite—Permits user to import a duplicate package into the Software
Repository, overwriting the existing version.

42 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 2: Managing Roles and Permissions
AdminStudio and Workflow Manager Roles and Permissions

AdminStudio Enterprise Server Tools Permissions


The AdminStudio Enterprise Server tools have the following permissions:

Table 2-2 • AdminStudio Enterprise Server Tools Permissions

Category Permission

People • View—Permits user to see the Administration/Users & Groups tab.


• Add—Permits user to add new users and import a users list from Active
Directory.
• Edit—Permits user to modify existing users.
• Delete—Permits user to delete existing or newly created users.

Roles • View—Permits user to see the Administration/Roles tab.


• Add—Permits user to add new Roles.
• Copy—Permits user to copy an existing Role.
• Edit—Permits user to modify an existing Role.
• Email Notify Enabled—Not currently in use.

Directory Services • View—Permits user to see the Administration/Directory Services tab and
view the Directory Services page, the Directory Services List page, and the
Directory Services Attributes Administration page.
• Add—Permits user to add a new Directory Service.
• Edit—Permits user to edit an existing Directory Service.
• Delete—Permits user to delete existing or newly created Directory Services.

System Settings • View—Permits user to open the Administration/System Settings tab.


• Edit—Permits user to edit the fields on the Administration/System Settings
tab: AdminStudio Enterprise Server User Account and the Workflow Manager/
AdminStudio Enterprise Server Serial Numbers.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 43


Chapter 2: Managing Roles and Permissions
AdminStudio and Workflow Manager Roles and Permissions

Table 2-2 • AdminStudio Enterprise Server Tools Permissions (cont.)

Category Permission

Job Manager • View—Permits user to see the Job Manager tab only if that user also has at
least one of the following Job Manager permissions: Manage Jobs, Manage
Templates, or Configuration.

If you only have the Job Manager View permission (and none of the other Job
Manager permissions), you will not be able to view the Job Manager tab or any
of its subtabs.

• Manage Templates—Permits user to see the Job Manager/Manage


Templates tab, view the list of Templates on the Job Template List page, and
view the details of an existing Template on the Edit Template page.

Users with only the View and Manage Templates permission cannot create a
new Template or edit an existing Template.

When a Role is assigned the Manage Templates permission, the View


permission is automatically selected.

• Manage Jobs—Permits user to see the Job Manager/Manage Jobs tab,


view the list of Jobs on the Jobs Queue page, and view the details of a Job that
they created on the Edit Job page.

Users with only the View and Manage Jobs permission cannot create a new
Job or edit an existing Job.

When a Role is assigned this permission, the View permission is automatically


selected.

• Manage Jobs for All Owners—Adds the Show All Jobs check box option to
the Jobs Queue page, which enables this user to see a list of Jobs created by
all users. For users without this permission, only those Jobs that they created
are listed.
• Configuration—Permits the user to view the list of conflict detection rules that
are selected on the Conflict Detection Options page. However, if this user
does not also have the Edit permission, this user will not be able to make any
changes to this list.

When a Role is assigned this permission, the View permission is automatically


selected.

• Edit—If a user also has the Manage Templates and/or Manage Jobs
permissions, this permission allows the user to create new Templates and Jobs,
and also to edit existing Templates and Jobs. If this user has this permission and
also has the Configuration permission, this user can modify the selections on
the Conflict Detection Options page.

44 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 2: Managing Roles and Permissions
AdminStudio and Workflow Manager Roles and Permissions

Table 2-2 • AdminStudio Enterprise Server Tools Permissions (cont.)

Category Permission

Report Center / • Add—Permits user to click Add on the All Reports page and create a new
All Reports Custom Report using the Report Wizard.
• Edit—Permits user to edit an existing Custom Report.
• Delete—Permits user to delete an existing Custom Report.

Report Center / • View—Permits user to see the Package Reports tab and view Package
Package Reports Reports.

Software Distribution • Operate—Permits user to use Configuration Manager Web Console (the
Distribute tab of AdminStudio Enterprise Server) to configure package
distribution options and distribute setup packages without going to
Configuration Manager Server.

Workflow Manager Permissions


Workflow Manager has the following permissions:

Table 2-3 • Workflow Manager Permissions

Category Permission

Application Request • View—Permits user to view the Properties and Issues tabs on the
Application Progress page of existing Application Requests.
• Add—Permits user to create a new Application Request.
• Edit—Permits user to edit an existing Application Request.
• Copy—Permits user to copy an existing Application Request.
• Delete—Permits user to delete an existing Application Request.
• Monitor Application Progress—Permits user to see the Application
Progress, Uploaded Files, and Downloadable Files tabs of the
Application Progress page. Also permits user to complete Workflow Steps.
• View Related Applications—Permits user to view the Related Applications
tab of the Application Progress page.
• Add Related Applications—Permits user to link one Application Request to
another on the Related Applications tab.
• Delete Related Application Links—Permits user to delete Related
Application links.
• Edit Application Due Period—Permits user to edit the Application Due
Period field on the Properties tab of the Application Progress page.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 45


Chapter 2: Managing Roles and Permissions
AdminStudio and Workflow Manager Roles and Permissions

Table 2-3 • Workflow Manager Permissions (cont.)

Category Permission

Application Status • View—Permits user to view the Application Status Administration page and
Management to view (but not update) Application Status details on the Edit Application
Status view.
• Add—Permits user to add a new Application Status.
• Edit—Permits user to update Application Status details on the Edit
Application Status view.
• Delete—Permits user to delete an existing Application Status

Calendar Settings • View—Permits user to view the Calendar Settings Administration page.
• Edit—Permits user to edit the settings on the Calendar Settings
Administration page.

Issues • View—Permits user to view the Issues tab of the Application Progress page
and to view the issue details.
• Add—Permits user to create a new E-mail or Knowledge Base issue .
• Respond—Permits user to respond to an existing issue.
• Close—Permits user to close an E-mail or Knowledge Base issue.
• Add/Close Critical Issue—Permits user to create and close Critical issues.

My Notifications • View—Permits user to view the My Notifications pages: My Default Project


Notifications and My Application Notifications.
• Edit—Permits user to edit the settings on the My Notifications pages: My
Default Project Notifications and My Application Notifications.

Project Permissions • View—Permits user to view (but not edit) the permission and email settings on
the Project Permission and Notification Settings view.
• Edit—Permits user to edit the permission and email settings on the Project
Permission and Notification Settings view.

Projects • View—Permits user to view the Project Administration page and view (but
not update) Project details on the Project Details view.
• Add—Permits user to create a new Project.
• Edit—Permits user to edit the details of an existing Project.
• Delete—Permits user to delete a Project.

Requestor Company • View—Permits user to view a list of existing Requestor companies and view
Requestor company details.
• Add—Permits user to add new Requestor companies.
• Edit—Permits user to update Requestor company details.
• Delete—Permits user to delete an existing Requestor company.

46 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 2: Managing Roles and Permissions
AdminStudio and Workflow Manager Roles and Permissions

Table 2-3 • Workflow Manager Permissions (cont.)

Category Permission

Search • Simple Search—Permits user to enter keywords in the Application Search


box on the Workflow Manager Home page to search for an Application
Request by name.
• Advanced Search—Permits user to search for Application Requests by
multiple criteria on the Application Search page.

Servicer Company • View—Permits user to view a list of existing Servicer companies, view Servicer
company details, and update those details.
• Add—Permits user to create new Servicer companies.

Templates • View—Permits user to view the Template Administration page and view
Template details on the Template Details page. Also gives you permission to add
an external data source on the External Data Sources subtab of the
Administration tab.
• Add—Permits user to edit an existing Template and create a new Template.
• Copy—Permits user to copy an existing Template.

Terminology • View—Permits user to view and modify AdminStudio Enterprise Server system
terminology.

Work Assignment • View—Permits user to view the Working Queue View and Work Assignment
Listing pages to see a list of existing work assignments.
• Assign—Permits user to assign work on the Assignment Details page.

Global Email • View—Permits user to view the Email Settings Administration and External
Administration Email Address Administration pages.
• Edit—Permits user to edit the settings on the Email Settings Administration
and External Email Address Administration pages.

Deployment Sites • View—Permits user to see the Deployment Site Administration page.
• Add—Permits user to add a new Deployment Site.
• Edit—Permits user to edit an existing Deployment Site.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 47


Chapter 2: Managing Roles and Permissions
AdminStudio and Workflow Manager Roles and Permissions

System Roles
AdminStudio and Workflow Manager come with default System Roles which cannot be modified. These Roles
were created based upon the needs of typical AdminStudio and Workflow Manager users, providing each Role
with only the permissions a user would need to perform their required tasks. You can either assign these System
Roles to users, or you can copy System Roles and then modify them to customize them for your organization.

Copied System Roles or new Roles that you create have a Role Type of User (User Roles), while default Roles
created during installation have a Role Type of System (System Roles). A Role’s Role Type is listed on the Role
Administration page and cannot be changed.

Information about System Roles is organized in the following sections:

• Superuser Role: AMSSuper

• Default System Roles

• Default System Users

Superuser Role: AMSSuper


When AdminStudio Enterprise Server and Workflow Manager are installed, the following user is created and is
assigned the AMSSuper Role:

• User Name: suams

• Password: suams

A user assigned the AMSSuper Role can create Servicer companies and customize terminology. All other tasks
should be performed by a Service Company administrator or by accounts created by a Service Company
administrator.

Note • The AMSSuper Role is not listed on the Role Administration page unless you are logged on using the
suams account.

48 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 2: Managing Roles and Permissions
AdminStudio and Workflow Manager Roles and Permissions

Default System Roles


When AdminStudio Enterprise Server and Workflow Manager are installed, the following System Roles are created:

Figure 2-1: Default System Roles

Note • If you did not purchase Workflow Manager, the Roles associated with the Requester company are not listed:
Application User, Project Manager, and QA Tester.

Note • If you are connected to an Application Catalog that has been upgraded from AMS 2.5, all Roles will have a
Role Type of User.

The following table lists the default System Roles:

Table 2-4 • Default System Roles

Role Name Company Name Description

Project Manager Servicer Project Manager for Servicer Company

Repackager Servicer Application Repackager for Servicer Company

SCAdmin Servicer System Administrator for Servicer Company

Tech Lead Servicer Tech Lead for Servicer Company

Application User Requester (Workflow Manager only) Application User for Requester Company

Project Manager Requester (Workflow Manager only) Project Manager for Requester Company

UA Tester Requester (Workflow Manager only) User Acceptance Tester for Requester
Company

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 49


Chapter 2: Managing Roles and Permissions
AdminStudio and Workflow Manager Roles and Permissions

You can view the permissions of each of these Roles by selecting the Role on the Role Administration page, and
then expanding the Role Permissions list.

Default System Users


When AdminStudio Enterprise Server and Workflow Manager are installed, a User Account is created for each of
these System Roles:

Figure 2-2: Default System Users

To see what functionality is available for one of these default System users, you could log on as that user and then
observe what features are available. You could also select the System user’s associated Role on the Role
Administration page, and then expand the Role Permissions list.

Note • By default, the password for each of these default System Users is the same as the text prior to the @ sign
(such as techlead for techlead@servicer.com), except the password for pm@requester.com and
pm@servicer.com is projectmanager.

50 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 2: Managing Roles and Permissions
Creating a New Role

Creating a New Role


To create a new Role, perform the following steps.

Task: To create a new Role:

1. On the Administration tab, click Roles. The Role Administration page opens.

2. Click the Add button. The Role Details View opens.

3. Enter a name in the Role Name field to uniquely identify this Role.

4. From the Role Company list, select the name of the Company whose users can be assigned this Role.

5. In the Role Description text box, describe the purpose of this new Role.

6. In the Role Permissions list, select the permissions you want to assign to this Role. For a detailed list of the
available permissions, see Role Permission Lists.

7. Click the Update button. The new Role now appears in the list on the Role Administration page.

Editing an Existing User Role


You can edit all Roles with a Role Type of User, but System Roles cannot be modified.

Task: To edit an existing User Role:

1. On the Administration tab, click Roles. The Role Administration page opens.

2. Select the Role that you want to edit. The Role Details View opens.

3. Make edits to the Role Name and Role Description fields, if desired.

Note • It is not recommended that you change a Role’s Role Company.

4. In the Role Permissions List, edit the permissions assigned to this Role.

5. Click the Update button. You are returned to the Role Administration page.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 51


Chapter 2: Managing Roles and Permissions
Copying an Existing Role

Copying an Existing Role


You can make a copy of an existing User or System Role using a new Role Name. You can then modify it to
customize it for your organization. You cannot modify a System Role. You can also copy an existing Role from one
Company to another.

To copy an existing Role, perform the following steps.

Task: To copy an existing Role:

1. On the Administration tab, click Roles. The Role Administration page opens.

2. Click the Copy button. The Copy Role View opens.

3. From the Copy from Company list, select the name of the Company whose Role you want to copy.

4. From the Copy from Role list, select the Role that you want to copy.

5. From the Copy to Company list, select the Company that you are creating this new Role for.

6. Enter a name in the New Role Name field to uniquely identify this Role.

Note • You are not permitted to have two Roles in the same Company with the same name. You are permitted
to use the same Role name in more than one Company.

7. From the Role Company list, select the name of the Company whose users can be assigned this Role.

8. In the Role Description text box, enter a description for the Role.

9. In the Role Permissions List, edit the permissions that were previously assigned to this Role.

10. Click the Update button. The new Role now appears in the Role list on the Role Administration page.

Deleting a Role
You can delete all Roles with a Role Type of User, but System Roles cannot be deleted.

Task: To delete an existing User Role:

1. On the Administration tab, click Roles. The Role Administration page opens.

2. Select the user-defined Role that you want to delete. The Role Details View opens.

3. Click Delete. You are prompted to confirm the deletion.

4. Click OK. The Role Details View closes and the Role you deleted is no longer listed on the Role
Administration page.

52 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 2: Managing Roles and Permissions
Roles Reference

Roles Reference
Reference information for Roles is presented in the following sections:

• Role Administration Page

• Copy Role View

• Role Details View

Role Administration Page


The Role Administration page lists all defined Roles on the system. From this view, you can edit existing Roles or
add new ones. The following options are available:

Table 2-5 • Role Administration Page

Option Description

Select Click to access the Role Details View, where you can edit this Role.

Role Name Name of Role.

Role Company Name of company that this Role was defined for.

Role Description Description of the purpose of this Role.

Role Type Identifies this role as one of the following:

• System—Role was created during installation and cannot be deleted or modified.


However, it can be copied and modified to create a User Role.
• User—Role created by an administrator either by copying an existing System Role
or by creating a new Role.

For more information, see System Roles.

Add Click to access the Role Details View, where you can add a new Role.

Copy Click to access the Copy Role View, where you can copy an existing Role.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 53


Chapter 2: Managing Roles and Permissions
Roles Reference

Copy Role View


On the Copy Role view of the Role Administration page you can copy an existing System or User Role.

Table 2-6 • Role Administration Page / Copy Role View Options

Option Description

Copy from Select the name of the Company that has a Role that you want to copy.
Company

Copy from Role Select the name of the Role that you want to copy. You can copy either System or User
Roles.

Copy to Company Select the name of the Company that this new Role is being created for.

New Role Name Enter a name to identify this new Role.

Copy Click to create this new Role and close the Copy Role view.

Cancel Click to exit this view without creating a new Role.

54 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 2: Managing Roles and Permissions
Roles Reference

Role Details View


Permissions are assigned to Roles, and Roles are assigned to users. Therefore, all permissions in AdminStudio
and Workflow Manager are controlled by Roles.

On the Role Details view, you can enter or edit information to identify a Role and set the Role Permissions. You can
also delete a user-defined Role.

Table 2-7 • Role Administration Page / Role Details View Options

Option Description

Role Name Enter a name to uniquely identify this Role

Role Company Select the Company whose employees can be assigned the Role.

Role Description Enter text to identify the purpose of this Role.

Role Permissions Select the specific functionality permissions that you want to assign to this Role. For
List more information, see Role Permission Lists and System Roles.

Update Click to save your entries and close the Role Details view.

Delete Click to delete this user-defined Role.

Note • If you are editing a System Role, the Delete button will be disabled.

Cancel Click to exit this view without saving your entries.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 55


Chapter 2: Managing Roles and Permissions
Roles Reference

56 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


3
Managing Users, Directory Services,
and User Logins

You can create a user account for each person that you want to have access to AdminStudio Enterprise Server, or
you can import users or groups of users from a Windows Active Directory or Novell eDirectory Directory Service.

You can also configure various login methods to best suit your needs: AdminStudio account login, domain account
login, single sign-on login, and guest account login.

Information is presented in the following main sections:

• Managing Users and Groups

• Managing Directory Services Configurations

• Managing User Logins

Managing Users and Groups


There are several methods for creating new users in AdminStudio Enterprise Server:

• Create a user account—Create a user account for each person that you want to have access to
AdminStudio Enterprise Server. See Creating a New User Account.

• Import Directory Service users—Set up a Windows Active Directory or Novell eDirectory Directory Service
Connection and import users from that Directory Service. See Importing Directory Services Users and Groups.

• Import Directory Service group—Set up a Windows Active Directory or Novell eDirectory Directory Service
Connection and import a group from that Directory Service. This allows you to provide dynamic access to all
of the members of that group as the members of that group changes. For more information, see Importing
Directory Services Users and Groups.

Note • For more information on the methods for logging into AdminStudio Enterprise Server, and the how
authentication is performed, see Managing User Logins.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 57


Chapter 3: Managing Users, Directory Services, and User Logins
Managing Users and Groups

Creating a New User Account


To create a new user account, perform the following steps.

Task: To create a new user account:

1. Open AdminStudio Enterprise Server and open the Administration tab.

2. Open the Users & Groups tab. The User Administration page opens.

3. Click Add. The User Details view opens.

4. Select the new user’s Company from the list.

5. Enter a User Name and a Password, with the User Name in the format of:

username@companyname.com

6. Optionally, enter the user’s Email address.

7. Optionally, enter a geographic Location that you can use to group users together, such as New York Office
or Midwest Region, etc. Assigning a geographical location to a user enables you to display this information in
reports.

8. All of the Roles that have been defined for the selected Company are listed. Select the Roles that you want to
assign to this user.

Note • The Roles that a user is assigned to determine what portions of AdminStudio Enterprise Server and
Workflow Manager functionality they will have access to. Therefore, you must assign at least one Role to a user.

9. Click Update to save your entries and close the User Details view, or click Update and Add New to remain
in the User Details view so you can add another user.

Importing Directory Services Users and Groups


If you have defined a Directory Service, as described in Adding a Directory Service Connection, you can choose to
add Users or Groups from that Directory Service into AdminStudio Enterprise Server.

When a user is added from a Directory Service into AdminStudio Enterprise Server, only information that uniquely
identifies the user in the Directory Service is stored in AdminStudio Enterprise Server. Information such as
telephone number and email address will always be queried at run time, so that the most current information is
obtained.

AdminStudio Enterprise Server supports Windows Active Directory and Novell eDirectory directory services.

Note • For more information on AdminStudio Enterprise Server support for Directory Services, see Managing
Directory Services Connections and Managing User Logins.

58 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 3: Managing Users, Directory Services, and User Logins
Managing Users and Groups

Task: To import users or groups from a Directory Service into AdminStudio Enterprise Server:

1. Open AdminStudio Enterprise Server and open the Administration tab.

2. Open the Users & Groups tab. The User Administration page opens.

3. Click Directory Service User/Group Import. The Directory Services User/Group Add view opens.

4. From the Select a Directory Service list, select the Directory Service that you want to import users or groups
from.

5. Next to Select Group or User, select the User or Group option.

6. Next to Filter Directory Service list, select one of the following options:

• Show All—Select this option to include all Users or Groups in the list.

• Filter list by—Select this option, enter text in the box, and click Find to filter the list by the specified
criteria.

For example, to search for all of the users that start with the letter P, use the asterisk wildcard character (*) and
enter P* in the Filter list by box.

7. From the Select Group or User to Add list, select the group or user to import to AdminStudio Enterprise
Server. The User Details view opens, providing a read-only view of the imported user or group’s User Name
and Password.

If you import a User that is a member of a Group that was previously imported, that User inherits the Roles that
are assigned to that Group. You can then assign additional Roles to that User.

8. Click Update to save your entries and close the User Details view, or click Update and Add New to remain
in the User Details view so you can add another user.

Disabling a User or Group Account


User and Group accounts have a status of Active or Inactive. If a User or Group has the status of Inactive, that
User or a member of that Group:

• Cannot log into AdminStudio Enterprise Server.

• Cannot be assigned any work.

• Is not listed on the User Administration page.

• Does not get any email notifications.

• Cannot be selected as a Customer Contact or Servicer Contact.

• Cannot be viewed by Customers.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 59


Chapter 3: Managing Users, Directory Services, and User Logins
Managing Users and Groups

Deleting vs. Disabling a User Account


If a user is associated in any way with an open or completed Workflow Manager Application Request, you cannot
delete that user from the system. In that case, you would instead disable that account by setting its Status to
Inactive.

• If a user IS NOT associated with an Application Request, you can delete that user. This means that if
you create a user by mistake, before that user has interacted with the application, you can delete it by opening
that user on the User Details view and clicking Delete.

• If a user IS associated with an Application Request, However, since AdminStudio Enterprise Server
stores the IDs of users on actions and assignments for historical, tracking and reporting purposes, you cannot
delete a user that is associated with a Workflow Manager Application Request. In this case, you would set the
user’s Status to Inactive on the User Details view.

Task: To disable a user account:

1. Open AdminStudio Enterprise Server and open the Administration tab.

2. Open the Users & Groups tab. The User Administration page opens.

3. Select the User or Group that you want to disable to open its User Details view.

4. Select Inactive from the Status list and click Update.

Deleting a User Account


You can delete a User or Group account from the User Details view.

Task: To delete a user account:

1. Open AdminStudio Enterprise Server and open the Administration tab.

2. Open the Users & Groups tab. The User Administration page opens.

3. Select the User or Group that you want to delete to open its User Details view.

4. Click Delete. You are prompted to confirm the deletion.

5. Click OK. The deleted User or Group is no longer listed on the User Administration page.

60 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 3: Managing Users, Directory Services, and User Logins
Managing Directory Services Configurations

Managing Directory Services Configurations


AdminStudio Enterprise Server can be integrated with Windows Active Directory and Novell eDirectory. This
enables you to set up automatic login with AdminStudio Enterprise Server based upon Directory Services
authentication.

If you import a Group, all members of that group could then login to AdminStudio Enterprise Server without
requiring you to import the individual members of the Group. AdminStudio Enterprise Server can then retrieve user
attributes, such as email address or telephone number, from the Directory Service dynamically.

• Directory Service Connections—Rather than creating a user account for each person who will use
AdminStudio Enterprise Server, you can import users from Windows Active Directory or Novell eDirectory
directory services. For information on integrating AdminStudio Enterprise Server with Directory Service users
and groups, see Managing Directory Services Connections.

• Directory Service Attributes—When creating a Workflow Manager Template, you can set a Data Element’s
Data Type to Directory Service. This means that when a Directory Service authenticated user performs the
Workflow Step that requests that Data Element, information is pulled from the Directory Service to
automatically populate the field, such as that user’s name, email address, or location. For information on
enabling the use of Directory Service Attributes, see Managing Directory Services Attributes.

Note • For more information about Directory Services and Lightweight Directory Access Protocol (LDAP), see
Ldp Overview on the Microsoft TechNet Web site.

Managing Directory Services Connections


Rather than creating a user account for each person who will use AdminStudio Enterprise Server, you can import
users from Windows Active Directory or Novell eDirectory directory services. To integrate AdminStudio Enterprise
Server with a Directory Service users and group, you set up a Directory Service Connection.

This section includes the following topics:

• Adding a Directory Service Connection

• Editing an Existing Directory Service Connection

• Deleting a Directory Service Connection

Adding a Directory Service Connection


Directory Services Connections are used to import users and groups into AdminStudio Enterprise Server, and to
authenticate Active Directory or eDirectory users logging into AdminStudio Enterprise Server.

You can choose to have a Directory Service listed in the Domain list on the AdminStudio Enterprise Server login
page. This enables users in this Directory Service to login to AdminStudio Enterprise Server using their enterprise
network credentials.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 61


Chapter 3: Managing Users, Directory Services, and User Logins
Managing Directory Services Configurations

To add a Directory Service connection, perform the following steps:

Task: To add a Directory Service connection:

1. On the Administration tab, click Directory Services. The Directory Services page opens.

2. Click Manage Directory Services Connections. The Directory Services List page opens.

3. Click Add. The Add Directory Service Connection view opens.

4. Enter the following information:

Option Description

Use to Authenticate Select Yes to include this Directory Service in the Domain list on the
Users? AdminStudio Enterprise Server login page. This enables users to login to
AdminStudio Enterprise Server using their enterprise network credentials.

You can create many Directory Service connections, but only those connections
that have this field checked will be listed in the Domain list on the AdminStudio
Enterprise Server login page.

Note • In an enterprise, there is usually only one Directory Service that is responsible for
authenticating users. However, you can create additional Directory Service connections to
import users and groups.

Directory Service Enter a name to identify this Directory Service in the Domain list on the
Name AdminStudio Enterprise Server login page. It is recommended that the Directory
Service Name match the Domain Name.

Description Enter a description of this Directory Service.

Directory Service Identify the type of Directory Service that you are adding a connection to:
Type
• Active Directory
• Novell eDirectory

Directory Service Enter the name or IP address of the Server on which this Directory Service is
Host running.

Directory Service Enter the port number of the Server on which this Directory Service is running. By
Port default, AdminStudio Enterprise Server uses Port 389.

Important • The value for the Directory Service Port should be the port on the given server
to which AdminStudio Enterprise Server should connect to send LDAP queries.

62 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 3: Managing Users, Directory Services, and User Logins
Managing Directory Services Configurations

Option Description

Base Distinguished Enter the Base Distinguished Name (DN) to identify the root node of this Directory
Name Service.

For example, for MyCompany, the Base DN could be:

dc="MyCompany", dc="com"

Domain Name Enter the Domain Name of this Directory Service. This Domain Name is used to
create the right credentials, along with the Admin User Name. For example, you
would enter DomainName\AdminUserName to connect to the specified Directory
Service.

Note • To upgrade from AMS 2.5, enter the same Domain Name that was used in AMS 2.5.
AdminStudio Enterprise Server will read this Domain Name and then try to authenticate the
User using this Directory Service. For single sign-on to work on an upgrade scenario from
2.5 to 4.0, administrators have to configure at least one Directory Service.

Use Secure Socket Select Yes if this Directory Service is configured to use Secure Socket Layer
Layer (SSL)? (SSL).

Connect Select No if you do not want to permit anonymous connections.


Anonymously?
If you select Yes to permit anonymous connections, AdminStudio Enterprise
Server may not be able to authenticate Directory Service users and may not be
able to add Directory Service users/groups into AdminStudio Enterprise Server.

Admin Enter the Distinguished Name of a user who has permission to retrieve users/
Distinguished Name groups information and authenticate any user against this Directory Service.
Enter the Distinguished Name in the format of:

domainname\username

such as:

abcinc\jsmith

Password Enter the password for the Admin Distinguished Name.

Group Class Name Enter the object class names for groups for this Directory Service. Default values
are:

• Active Directory: group


• eDirectory: groupofnames

Group Name Enter an attribute used by this Directory Service to name groups. The default
Attribute value for both Active Directory and eDirectory is cn.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 63


Chapter 3: Managing Users, Directory Services, and User Logins
Managing Directory Services Configurations

Option Description

Group Member Enter an attribute used by this Directory Service to define member groups.
Attribute Default values are:

• Active Directory: member


• eDirectory: uniquemember

User Class Name Enter the object class name used by this Directory Service for users. Default
values are:

• Active Directory: user


• eDirectory: inetorgperson

User Name Attribute Enter the attribute used by this Directory Service to identify users. Default values
are:

• Active Directory: samaccountname


• eDirectory: uid

5. Click Test Connection test to see if the settings that you entered can be used to successfully connect to this
Directory Service.

6. Click Update to save your entries and return to the Directory Services List page or click Update and Import
(User/Group) to save your entries and open the Directory Services User/Group Add view.

Editing an Existing Directory Service Connection


To edit an existing Directory Service connection, perform the following steps:

Task: To edit an existing Directory Service connection:

1. On the Administration tab, click Directory Services. The Directory Services page opens.

2. Click Manage Directory Services Connections. The Directory Services List page opens.

3. Select the Directory Service connection that you want to edit. The Edit Directory Service Connection page
opens.

4. Edit these entries as described in Adding a Directory Service Connection.

64 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 3: Managing Users, Directory Services, and User Logins
Managing Directory Services Configurations

Deleting a Directory Service Connection


You can import a user/group into an AdminStudio Enterprise Server database using a Directory Service
Connection. This will create a reference to this Directory Service Connection in the database. You can then import
a Directory Service Attribute into the database.

In order to delete this Directory Service, user has to delete all the references to this Directory Service Connection. If
there are references left (like users from this directory service or attributes from this directory service) you cannot
delete this Directory Service Connection.

Managing Directory Services Attributes


When creating a Workflow Manager Template, you can assign a Data Element the Data Type of Directory
Service. This means that when a Directory Service authenticated user performs the Workflow Step that requests
that Data Element, information is pulled from the Directory Service to automatically populate the field, such as that
user’s name, email address, location, etc.

Figure 3-1: Example of Fields Populated With Directory Services Attributes

Note • If the user is not connected using Directory Service authentication, then the fields will be left blank and
enabled.

On the Directory Services Attributes Administration Page, which is accessed by clicking Manage Directory
Services Attributes on the Directory Services page, Administrators can map their customizations for the
directory service.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 65


Chapter 3: Managing Users, Directory Services, and User Logins
Managing User Logins

Creating Directory Services Attributes


To add a new Directory Services attribute from the directory server into the AdminStudio Enterprise Server
database, perform the following steps.

Task: To create a new Directory Services attribute:

1. On the Directory Services page, click Manage Directory Services Attributes. The Directory Services
Attributes Administration page opens.

2. Click Add. The Add Directory Service Attributes view opens.

3. Using the current user’s credentials, the Attribute Name list lists all of the Directory Services attributes from
the Directory Services server. Select the Directory Services attribute that you want to add to the AdminStudio
Enterprise Server database. A Directory Services attribute is used in Directory Services protocol to access
information directories, such as employeeNumber or documentAuthor.

4. In the Attribute Alias text box, enter the name that you want to use to identify the Directory Services attribute
in AdminStudio Enterprise Server, such as Employee ID or Author.

5. Click Add to add the defined Directory Services attribute. If AdminStudio Enterprise Server is unable to
connect to the server (and no attributes are retrieved), the Add button is disabled.

Deleting Directory Services Attributes


To delete a Directory Services Attribute, open the Directory Services Attributes Administration page and click
Delete next to the attribute that you want to delete.

Managing User Logins


This section explains the four methods of logging into AdminStudio Enterprise Server, and how to set the session
timeout value.

• Login Methods

• Using AdminStudio Enterprise Server Account Login

• Using Domain Account Login

• Using Single Sign-On Login

• Using Guest Account Login

• Setting the Session Timeout Value

66 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 3: Managing Users, Directory Services, and User Logins
Managing User Logins

Login Methods
There are four methods you can use to login to AdminStudio Enterprise Server:

Table 3-1 • AdminStudio Enterprise Server Login Methods

Method Description Related Topics

AdminStudio Users login to AdminStudio Enterprise Server using a User • Using AdminStudio
Enterprise Account (User Name and Password) that was created in Enterprise Server
Server AdminStudio Enterprise Server by clicking Add on the User Account Login
Account Administration page. • Creating a New User
Login Account

Domain Users login to AdminStudio Enterprise Server using their • Using Domain Account
Account Domain Account (User Name and Password), the same Login
Login account they use to login to their network. • Adding a Directory
To set this up, you import users or groups from a Directory Service Connection
Service: Active Directory or Novell eDirectory. • Importing Directory
Services Users and
Groups
Note • For domain account login, the Anonymous access option
on the IIS Authentication Methods Dialog Box must be selected.

Single Sign- You set up AdminStudio Enterprise Server so that if users • Using Single Sign-On
On Login are logged on to your network using their Domain Account Login
(User Name and Password), they are automatically logged • Adding a Directory
in to AdminStudio Enterprise Server. Service Connection
To set this up, you import users or groups from Active • Importing Directory
Directory Services Users and
Groups

Note • For Single Sign-On, IIS performs user authentication. For all
other login methods, AdminStudio Enterprise Server performs
authentication.

Note • Single Sign-on is not supported for Novell eDirectory users


and groups.

Note • For single sign-on login, the Anonymous access option


on the IIS Authentication Methods Dialog Box must not be selected.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 67


Chapter 3: Managing Users, Directory Services, and User Logins
Managing User Logins

Table 3-1 • AdminStudio Enterprise Server Login Methods (cont.)

Method Description Related Topics

Guest You set up a Guest account to permit users without • Using Guest Account
Account AdminStudio Enterprise Server login credentials to access Login
Login features – such as viewing Reports or searching for an • Setting Up a Guest
Application Request – without entering a User ID or Account
Password.
• Logging in as a Guest

IIS Authentication Methods Dialog Box


To set the Anonymous access option in IIS, perform the following steps.

Task: To open the IIS Authentication Methods dialog box:

1. Open Internet Information Services (IIS).

2. Select the AdminStudio Enterprise Server Web site in the tree view.

3. On the Action menu, select Properties. The Web Site Properties dialog box opens.

4. Open the Directory Security tab and click Edit in the Anonymous access and authentication control
area. The Authentication Methods dialog box opens.

Figure 3-2: Anonymous Access option on the IIS Authentication Methods Dialog Box

68 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 3: Managing Users, Directory Services, and User Logins
Managing User Logins

Using AdminStudio Enterprise Server Account Login


To Set Up
To set up AdminStudio Enterprise Server User Account login, create a user account (User Name and Password)
for each person that you want to have access to AdminStudio Enterprise Server. See Creating a New User
Account.

To Login
Users with AdminStudio Enterprise Server accounts enter their AdminStudio Enterprise Server-generated User
Name and Password on the AdminStudio Enterprise Server Login page. AdminStudio Enterprise Server performs
the authentication.

More Information
For more information, see Creating a New User Account

Using Domain Account Login


To Set Up
To set up Domain Account login, you do the following:

• Set up a Windows Active Directory or Novell eDirectory Directory Service Connection. See Adding a
Directory Service Connection.

• On your AdminStudio Enterprise Server IIS Server, open the IIS Authentication Methods Dialog Box and select
the Anonymous access option. This specifies that AdminStudio Enterprise Server is going to authenticate
the users.

• Import users or groups from that Directory Service. See Importing Directory Services Users and Groups.

To Login
Imported users or users belonging to the imported groups enter their Directory Service User Name and
Password on the AdminStudio Enterprise Server Login page.

AdminStudio Enterprise Server then connects with the Directory Service using the credentials provided on the Add
Directory Service Connection View, and then passes the login User Name and Password to the Directory Service
so that it can authenticate the user.

Note • When entering the User Name, it is not necessary to enter the Directory Service domain name.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 69


Chapter 3: Managing Users, Directory Services, and User Logins
Managing User Logins

More Information
For more information, see:

• Adding a Directory Service Connection

• Importing Directory Services Users and Groups

• IIS Authentication Methods Dialog Box

Using Single Sign-On Login


To Set Up
To set up Single Sign-on login, you do the following:

• Set up a Windows Active Directory Directory Service Connection. See Adding a Directory Service
Connection.

• On your AdminStudio Enterprise Server IIS Web Server, open the IIS Authentication Methods Dialog Box and
clear the Anonymous access option. This specifies that IIS is going to authenticate the users.

• Import users or groups from that Active Directory Directory Service. See Importing Directory Services Users
and Groups.

Note • Regarding Single Sign-On, note the following:

• For Single Sign-On, IIS performs user authentication . For all other login methods, AdminStudio Enterprise
Server performs authentication.
• Single Sign-on is not supported for Novell eDirectory users and groups.

To Login
When a user with single sign-on opens AdminStudio Enterprise Server, the IIS Web Server checks to see if the
user’s domain User Name and Password are valid in the Active Directory Domain Server, and then automatically
logs the user in to AdminStudio Enterprise Server. AdminStudio Enterprise Server does not need to connect to the
Active Directory Domain Server.

For More Information


For more information, see:

• Adding a Directory Service Connection

• Importing Directory Services Users and Groups

• IIS Authentication Methods Dialog Box

70 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 3: Managing Users, Directory Services, and User Logins
Managing User Logins

Using Guest Account Login


This section describes how to setup a Guest Account and how to login using a Guest Account:

• Setting Up a Guest Account

• Logging in as a Guest

Setting Up a Guest Account


When a Guest Account is set up, AdminStudio Enterprise Server users without a User Account are automatically
logged in using a Guest Account.

The AdminStudio Enterprise Server administrator can set up a Guest account to permit users without login
credentials to access features such as viewing a report or searching for an Application Request . By using a Guest
Account, Administrators do not have to add a new user account just to provide access for users who only need
very limited functionality.

AdminStudio Enterprise Server system administrators should configure a Guest Account as follows:

Task: To set up a Guest Account:

1. Create a new user account to use as the Guest Account, and add this user to the web.config file located in the
AdminStudio Enterprise Server Web Application wwwroot directory. Enter the user name in the following
location of the web.config file:

<!-- Guest System Access -->


<add key="GuestAccount" value="username@companyname.com" />

2. On the Administration tab, click Users & Groups. The User Administration page opens.

3. Assign the Guest Account user to Roles with limited permissions. See Managing Roles and Permissions for
more information.

Guest System Access Recommendations


When setting up Guest System Access, please follow these guidelines:

• The AdminStudio Enterprise Server Administrator should assign the Guest account user to Roles with limited
privileges. If the Guest account belongs to a Role with high privileges, then every user who logs on as a Guest
will have high privileges.

• If the GuestAccount key does not exist in the web.config file, then the Guest Access option does not appear
on the AdminStudio Enterprise Server Login page.

• If the GuestAccount key exists in the web.config file but the user name specified in the value is empty (such as
value=""), then the Guest Access option does not appear on the AdminStudio Enterprise Server Login page.

• If the GuestAccount key exists in the web.config file, but the user name specified in the value does not exist in
the AdminStudio Enterprise Server database, then AdminStudio Enterprise Server displays an error message
when a user tries to log on as a Guest User.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 71


Chapter 3: Managing Users, Directory Services, and User Logins
Managing User Logins

Configuring a Guest Account on a Workflow Manager Portal Site


Please note the following regarding configuring a Guest account on a Workflow Manager Portal site:

• If users are accessing Workflow Manager through a Workflow Manager portal, then the AdminStudio
Enterprise Server administrator should add the GuestAccount key to the web.config file of the Portal site. By
default, Workflow Manager will use the Guest account value configured at the portal site to log on the Guest
user. If the portal site does not have any GuestAccount value configured, then Workflow Manager uses the
GuestAccount value at the Workflow Manager Web Application site to log on the Guest account.

• If users are accessing the Workflow Manager site directly (not going through a portal), then Workflow Manager
uses the GuestAccount value configured in the web.config file located in the AdminStudio Enterprise Server
Web Application wwwroot directory to log on the Guest account.

Note • The web.config file installed by AdminStudio Enterprise Server should contain the GuestAccount key with
an empty value. It is the responsibility of the System Administrator to fill in that value in the web.config file of the
Portal site or the AdminStudio Enterprise Server Web Application site.

Logging in as a Guest
Before anyone can log on to AdminStudio Enterprise Server as a Guest User, the System Administrator must
configure a Guest Account, following the instructions in Setting Up a Guest Account. Then a user could log on to
your AdminStudio Enterprise Server site as a guest using the appropriate method:

• If Directory Service authentication is used at your site, and the user’s Directory Service user name does
not exist in the AdminStudio Enterprise Server database, AdminStudio Enterprise Server automatically logs
this user on using the Guest account.

• If Directory Service authentication is not used at your site, AdminStudio Enterprise Server opens the
AdminStudio Enterprise Server Login page by default. The user then selects the Guest Access option and
clicks Login.

72 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 3: Managing Users, Directory Services, and User Logins
Managing User Logins

The AdminStudio Enterprise Server Administrator assigns the Guest account to specific Roles, and the degree of
permissions that the Guest account has depends upon which Roles the account is assigned to.

• When a Role is created, the administrator must indicate whether that Role has permission to create a
Workflow Manager Application Request.

• When Reports are created, the administrator must indicate which Roles have permission to view them.
Guest Users can view all Reports that their assigned Roles have permission to access.

Setting the Session Timeout Value


When AdminStudio Enterprise Server is installed, the session timeout value is set to 20 minutes. This means that
after you login to the AdminStudio Enterprise Server, if your session remains idle for 20 minutes, you are prompted
to login again.

You can change the session timeout value by editing two values in the web.config file: sessionState timeout and
LoginPageTimeOut.

Task: To change the session timeout value:

1. Open the wwwroot directory of the AdminStudio Enterprise Server installation and open web.config in a text
editor.

2. Locate the line that contains sessionState timeout:

<sessionState timeout="20" mode="InProc" stateConnectionString= "tcpip=127.0.0.1:42424"


sqlConnectionString="data source=127.0.0.1; Trusted_Connection=yes" cookieless="false" />

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 73


Chapter 3: Managing Users, Directory Services, and User Logins
Users/Groups and Directory Services Reference

3. Change the value specified for sessionState timeout="nn" to the new timeout value.

4. Locate the following line that contains LoginPageTimeOut:

<add key="LoginPageTimeOut" value="19.5" />

5. Change this value to match the timeout value you specified for the sessionState.

Users/Groups and Directory Services


Reference
This section details the contents of the AdminStudio Enterprise Server pages that are used to manage users and
directory services:

Table 3-2 • Users/Groups and Directory Services Tabs Reference

Page Subpages

User Administration Page • User Details View


• Directory Services User/Group Add View

Directory Services Page • Directory Services List Page


• Add Directory Service Connection View
• Directory Services Attributes Administration Page
• Add Directory Service Attributes View

User Administration Page


This view lists all users defined in the system. From this view, you can add a new User, edit an existing User, or
import a Directory Service User or Group.

Table 3-3 • User Administration Page Options

Option Description

Add Click to access the User Details View, where you can add a new User.

Directory Service Click to access the Directory Services User/Group Add View, where you can import a
User/Group Import User or Group from an Directory Service.

Status To filter the list of users by Status, make a selection from this list: Active, Inactive or
All.

74 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 3: Managing Users, Directory Services, and User Logins
Users/Groups and Directory Services Reference

Table 3-3 • User Administration Page Options (cont.)

Option Description

User Name Name user uses to log onto AdminStudio Enterprise Server, in the format of:

username@companyname.com

If a Directory Services Group has been imported, the Group name is listed in this
column.

Roles Lists the roles that this User has been assigned to.

Company Name of user’s Company.

From the User Administration page, you can perform the following tasks:

• Create a AdminStudio Enterprise Server user account—Create a user account for each person that you
want to have access to AdminStudio Enterprise Server. See Creating a New User Account.

• Import Directory Service Users or Groups—Set up a Windows Active Directory or Novell eDirectory
Directory Service Connection and the click Directory Service User/Group Import on the User
Administration page to import Users or Groups from that Directory Service. See Importing Directory Services
Users and Groups. Importing a group allows you to provide dynamic access to all of the members of that
Group as the members of that Group changes.

• Edit a user account—To edit an existing account, click Select next to the User Name to open the User
Details view.

Note • For more information on the methods for logging into AdminStudio Enterprise Server and how authentication
is performed, see Managing User Logins.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 75


Chapter 3: Managing Users, Directory Services, and User Logins
Users/Groups and Directory Services Reference

User Details View


On this view, enter or edit user account and imported Directory Services account information. On this page, you
can also delete a user account.

Table 3-4 • User Details View Options

Option Description

Company Select the Company that this user or group belongs to.

User Name Perform one of the following:

• New—When creating a new user, enter the name the user will use to log onto
AdminStudio Enterprise Server in the format of: username@companyname.com.
• Importing—When importing a user group from a Directory Service, the name listed
here will be prepopulated and uneditable.

Password Enter the User’s password.

Note • This field is not shown when importing a Directory Service Group.

Status Select Active to make this user or group active in the AdminStudio Enterprise Server
system, or select Inactive to disable this account. See Disabling a User or Group
Account.

Email User’s email address.

Note • This field only appears when creating a new user account. For users imported from a Directory
Service, this information is retrieved dynamically from the Directory Service when needed.

Roles Listing of all of the defined Roles at the selected Company. Select the Roles appropriate
for this user or group.

Location Optionally, enter a geographic Location that you can use to group users together, such as
New York Office or Midwest Region, etc. Assigning a geographical location to a user
enables you to display this information in reports.

Update Click to save your entries and close the User Details view.

Update and Add Click to save your entries and remain in the User Details view, where you can enter
New another new user.

Delete Click to delete this user account.

Cancel Click to exit this view without saving your entries.

76 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 3: Managing Users, Directory Services, and User Logins
Users/Groups and Directory Services Reference

Directory Services User/Group Add View


This view is accessed by clicking Directory Service User/Group Import on the User Administration page.
The following options are included:

Table 3-5 • Directory Services User/Group Add View

Option Description

Select a Directory Select the defined Directory Service that you want to import a user or group from.
Service

Note • For information on defining a Directory Service Connection, see Adding a Directory
Service Connection.

Select Group or Specify whether you are importing a User or a Group.


User

Filter Directory Select Show All to include all Users or Groups in the list, or select Filter list by,
Service List enter text in the box, and click Find to filter the list by the specified criteria.

For example, to search for all of the users that start with the letter P, use the asterisk
wildcard character (*) and enter P* in the Filter list by box.

Select Group or From the Select Group or User to Add list, select the group or user to import.
User to Add

Note • If you import a User that is a member of a Group that was previously imported, that User
inherits the Roles that are assigned to that Group. You can then assign additional Roles to that
User.

Update Click to save your entries.

The selected user or group is then opened in the User Details View.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 77


Chapter 3: Managing Users, Directory Services, and User Logins
Users/Groups and Directory Services Reference

Directory Services Page


AdminStudio Enterprise Server can be integrated with Windows Active Directory and Novell eDirectory. This
integration enables you to integrate Directory Services Users and Groups and also to use Directory Services
attributes.

Table 3-6 • Directory Services Page Options

Option Description

Manage Directory Click to open the Directory Services List Page where you can set up connections
Service Connections to Active Directory and eDirectory Directory Services.

Manage Directory Click to open the Directory Services Attributes Administration Page where you
Service Attributes can map Directory Service attributes, which can be used when defining Data
Elements.

When a Data Element is defined as a Directory Service attribute, when this Data
Element appears during a data entry step in a Workflow, information about the
logged in user will be pulled from the Directory Service to populate those fields,
such as: Department, Location, Employee Number, etc.

Note • For more information about Directory Services and Lightweight Directory Access Protocol (LDAP), see
Ldp Overview on the Microsoft TechNet Web site.

Directory Services List Page


Directory Services Connections are used to import users and groups into AdminStudio Enterprise Server, and to
authenticate Active Directory or Novell eDirectory users logging into AdminStudio Enterprise Server.

You can choose to have a Directory Service listed in the Domain list on the AdminStudio Enterprise Server login
page. This enables users in this Directory Service to login to AdminStudio Enterprise Server using their enterprise
network credentials.

The information and options are included:

Table 3-7 • Directory Services List Page Options

Option Description

Directory Service Name The name that identifies this Directory Service in the Domain list on the
AdminStudio Enterprise Server login page.

Description A description of this Directory Service.

78 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 3: Managing Users, Directory Services, and User Logins
Users/Groups and Directory Services Reference

Table 3-7 • Directory Services List Page Options (cont.)

Option Description

Directory Service Type Identifies this Directory Service as either a Windows Active Directory or Novell
eDirectory type.

Directory Service Host The name or IP address of the Server on which this Directory Service is running.

Add Click to add a new Directory Service connection.

Add Directory Service Connection View


On the Add Directory Service Connection view, which is opened by clicking Add on the Directory Services List
Page, you enter the necessary settings to connect to an Active Directory or Novell eDirectory Directory Service.

Table 3-8 • Add Directory Service Connection View Options

Option Description

Use to Authenticate Select Yes to include this Directory Service in the Domain list on the AdminStudio
Users? Enterprise Server login page. This enables users to login to AdminStudio Enterprise
Server using their enterprise network credentials.

Note • For Single Sign-On, IIS performs user authentication. For all other login methods,
AdminStudio Enterprise Server performs authentication.

Directory Service Enter a name to identify this Directory Service in the Domain list on the AdminStudio
Name Enterprise Server login page. It is recommended that the Directory Service Name
match the Domain Name.

Description Enter a description of this Directory Service.

Directory Service Identify the type of Directory Service that you are adding a connection to:
Type
• Active Directory
• Novell eDirectory

Directory Service Enter the name or IP address of the Server on which this Directory Service is running.
Host

Directory Service Enter the port number of the Server on which this Directory Service is running. By
Port default, AdminStudio Enterprise Server uses Port 389.

Important • The value for the Directory Service Port should be the port on the given server to
which AdminStudio Enterprise Server should connect to send LDAP queries.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 79


Chapter 3: Managing Users, Directory Services, and User Logins
Users/Groups and Directory Services Reference

Table 3-8 • Add Directory Service Connection View Options (cont.)

Option Description

Base Distinguished Enter the Base Distinguished Name (DN) to identify the root node of this Directory
Name Service.

For example, for MyCompany, the Base DN could be:

dc="MyCompany", dc="com"

Domain Name Enter the Domain Name of this Directory Service. This Domain Name is used to create
the right credentials, along with the Admin User Name. For example, you would enter
DomainName\AdminUserName to connect to the specified Directory Service.

Note • To upgrade from AMS 2.5, enter the same Domain Name that was used in AMS 2.5.
AdminStudio Enterprise Server will read this Domain Name and then try to authenticate the User
using this Directory Service. For single sign-on to work on an upgrade scenario from 2.5 to 4.0,
administrators have to configure at least one Directory Service.

Use Secure Socket Select Yes if this Directory Service is configured to use Secure Socket Layer (SSL).
Layer (SSL)?

Connect Select No if you do not want to permit anonymous connections.


Anonymously?
If you select Yes to permit anonymous connections, AdminStudio Enterprise Server
may not be able to authenticate Directory Service users and may not be able to add
Directory Service users/groups into AdminStudio Enterprise Server.

Admin Enter the Distinguished Name of a user who has permission to retrieve users/groups
Distinguished Name information and authenticate any user against this Directory Service. Enter the
Distinguished Name in the format of:

domainname\username

such as:

abcinc\jsmith

Password Enter the password for the Admin Distinguished Name.

Group Class Name Enter the object class names for groups for this Directory Service. Default values are:

• Active Directory: group


• eDirectory: groupofnames

Group Name Enter an attribute used by this Directory Service to name groups. The default value for
Attribute both Active Directory and eDirectory is cn.

80 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 3: Managing Users, Directory Services, and User Logins
Users/Groups and Directory Services Reference

Table 3-8 • Add Directory Service Connection View Options (cont.)

Option Description

Group Member Enter an attribute used by this Directory Service to define member groups. Default
Attribute values are:

• Active Directory: member


• eDirectory: uniquemember

User Class Name Enter the object class name used by this Directory Service for users. Default values
are:

• Active Directory: user


• eDirectory: inetorgperson

User Name Attribute Enter the attribute used by this Directory Service to identify users. Default values are:

• Active Directory: samaccountname


• eDirectory: uid

Update Click to save your entries and return to the Directory Services List Page.

Update and Import Click to save your entries and open the Directory Services User/Group Add View.
(User/Group)

Test Connection Click to test to see if the settings that you entered can be used to successfully connect
to this Directory Service.

Directory Services Attributes Administration Page


On the Directory Services Attributes Administration page, which is accessed by clicking Manage Directory
Services Attributes on the Directory Services page, Administrators can map their customizations for the
directory services.

Directory Service attributes can be used when defining Data Elements. When a Data Element is defined as a
Directory Service attribute, when this Data Element appears during a data entry step in a Workflow, information
about the logged in user will be pulled from the Directory Service to populate those fields, such as: Department,
Location, Employee Number, etc.

The following information is listed:

Table 3-9 • Directory Services Attributes Administration Page Options

Option Description

Directory Name of the LDAP (Lightweight Directory Access Protocol) Directory Service attribute that
Service is used in Directory Services protocol to access information directories, such as
Attribute employeeNumber or documentAuthor.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 81


Chapter 3: Managing Users, Directory Services, and User Logins
Users/Groups and Directory Services Reference

Table 3-9 • Directory Services Attributes Administration Page Options (cont.)

Option Description

Attribute Alias Name that you want to use to identify the Directory Service attribute in AdminStudio
Enterprise Server, such as Employee ID or Author.

Delete Click to delete the listed attribute.

Add Directory Service Attributes View


When you click Add on the Directory Services Attributes Administration page to add a new Directory Service
attribute into the AdminStudio Enterprise Server database, the following fields are displayed:

Table 3-10 • Add Directory Service Attributes View Options

Option Description

Directory Select the Directory Service that contains the attribute that you want to add.
Service

Attribute Lists all the attributes from the selected Directory Service server, using the currently logged
Name user’s credentials.

Attribute Alias Enter the name that you want to use to identify the Directory Service attribute in
AdminStudio Enterprise Server.

Add Click to add the defined Directory Service attribute. If AdminStudio Enterprise Server is
unable to connect to the server (and no attributes are retrieved), the Add button is disabled.

When a Data Element is defined as a Directory Service attribute during Workflow Manager Template creation, when
this Data Element appears in the Workflow, information will be pulled from the Directory Service to populate those
fields, such as:

However, if the user is not connected using Directory Service authentication, then the fields will be left blank and
will be enabled.

82 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


4
Generating and Viewing Reports in
Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager.

Report Center provides reporting capability for both AdminStudio and Workflow Manager. You can use Report
Center to generate reports on packages stored in the Application Catalog, and on Workflow Manager Projects and
Application Requests. You can also use SQL queries to generate custom reports on data stored in the AdminStudio
Enterprise Server Application Catalog.

Table 4-1 • AdminStudio and Workflow Manager Reports in Report Center

Product Available Reports

AdminStudio Report Center provides a centralized view of all of the information regarding packages in
Reports your Application Catalog. See Generating and Viewing AdminStudio Reports

• Package Report—Includes consolidated package information including conflicts,


validation results, and extended attributes. See Viewing Package Reports.
• Custom SQL Query Report—A custom report defined by entering an SQL query in
the Report Wizard.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 83


Chapter 4: Generating and Viewing Reports in Report Center

Table 4-1 • AdminStudio and Workflow Manager Reports in Report Center (cont.)

Product Available Reports

Workflow You can view System Reports that include information on Projects and Application
Manager Requests. You can also define Custom Reports that include information about the status
Reports of Projects and Application Requests. See Generating and Viewing Workflow Manager
Reports.

• System Reports—Includes detailed summary information on a Company’s Projects


and Application Requests. See Generating System Reports: Projects Report and
Application Requests Summary Report.
• Custom Report—A report defined by using the Report Wizard. See Creating a
Custom Report.
• Custom Activity Report—Every time an activity or event occurs during the
completion of an Application Request, Workflow Manager records that activity. You
can view a listing of these activities in the Activity Report, a custom report which you
define using the Report Wizard. See Creating an Activity Report
• Custom SQL Query Report—A custom report defined by entering an SQL query in
the Report Wizard. See Generating a Custom SQL Query Report

84 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Generating and Viewing AdminStudio Reports


You can use Report Center to obtain a centralized view of all of the information regarding packages in your
AdminStudio Application Catalog. Because Report Center is a Web application, it can be easily accessed by a
geographically dispersed workforce without requiring any software installation or data transfer. Report Center
makes it easy to get the application data you need to diagnose and repair software problems and to manage
applications across your organization.

A catalog-level search tool enables you to generate detailed, customizable reports on packages with particular
characteristics. These reports are accessible anywhere via a Web interface and can be exported to PDF or Excel
format for sharing and archiving.

Information on generating and viewing AdminStudio reports in Report Center is presented in the following
sections:

Table 4-2 • Information About Generating AdminStudio Reports

Section Description

About the Package Report Explains the layout of the Select Package page on the Package Report
Tab of the Report Center tab, and the Package and Group summary information that can be viewed
on this page.

Generating a Package Report Explains how to generate a Package Report on a selected package. Also
explains how to filter the package tree by specified criteria in order to find a
specific package in the Application Catalog.

Information Included in Lists the contents of all of the sections of a Package Report.
Package Reports

Archiving a Package Report Explains how to create a PDF-snapshot of a Package Report at a particular
date and time and how to open an archived report.

Exporting a Package Report Explains how to export a Package Report to Excel or PDF format.

Generating a Custom SQL Explains how to enter an SQL query to specify the data to be displayed in a
Query Report for custom report.
AdminStudio

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 85


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

About the Package Report Tab of the Report Center


You generate most AdminStudio reports on the Select Package page on the Package Report tab in Report
Center.

Figure 4-1: Select Package Page of Report Center

86 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

The Select Package page is organized in the following sections:

Table 4-3 • Areas on the Select Package Page

Area Description

Package Tree On the left side of the interface, all of the groups and packages in the AdminStudio
Enterprise Server Application Catalog are displayed in a tree control.

If a search has been applied using the fields in the Search Packages area, only
those packages meeting that criteria are listed, and the Show All packages
button is enabled.

Package or Group In the top half of the right side of the interface, either a summary of group statistics
Summary Area (when a group is selected) or a summary of package statistics (when a package or
OS Snapshot is selected) is displayed. See Group Summary Information and
Package Summary Information.

When a Windows Installer .msi package is selected, you can click View Report to
view that package’s Package Report.

Search Packages Area In bottom half of the right side of the interface, the Search Packages area
includes fields allowing you to search for packages by attributes, content, or
associated Application Requests.

Group Summary Information


When a group in the package tree is selected, summary information about that group is listed.

Figure 4-2: Group Summary on the Select Package Page

The following information about the selected group is listed:

Table 4-4 • Group Summary Information

Item Description

Total Packages in Group Total number of packages that have been imported into the selected group. This
number is also broken down between number of Windows Installer packages
and the number of OS Snapshot packages.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 87


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Table 4-4 • Group Summary Information

Item Description

Packages With Conflicts Number of packages that have unresolved conflicts with other packages or OS
Snapshots in the Application Catalog.

Package Summary Information


When a package in the package tree is selected, summary information about that package is listed.

Figure 4-3: Package Summary on the Select Package Page

The following information about the selected package is listed:

Table 4-5 • Package Summary Information

Item Description

Product Version Version of package that is recorded in the package’s Windows Installer file.

Manufacturer Company that authored the package.

Import Date The date and time the package was imported into the Application Catalog.

In Software Repository Indicates whether or not this package and its associated files are managed by
the Software Repository.

Unresolved Conflicts The number of detected conflicts, generated during conflict analysis of this
package, which have not yet been resolved—either automatically or manually.

Associated Application If this package is associated with an Application Request, the Application
Request Request name is listed here. Click this link to open the Application Request’s
Application Report.

88 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Generating a Package Report


You generate a Package Report by selecting a package in the package tree and then clicking View Report. The
package tree can list either all of the packages in the Application Catalog or you can filter the list of packages by
specified criteria by using the fields in the Search Packages area.

• Searching for a Package on the Select Package Page

• Viewing Package Reports

Viewing Package Reports


You can view a Package Report by opening the Select Package page on the Report Center Package Reports
tab, selecting a package from the package tree, and then clicking View Report.

Task: To view a Package report:

1. Open the Package Report tab of the Report Center. The Select a Package page opens.

2. Select a package in the package tree. The Package Summary information is listed.

Note • To filter the package tree by specific criteria, perform a search as described in Searching for a Package
on the Select Package Page.

3. Click View Report. The Package Report for the selected package opens.

Note • You can archive this report by clicking the Archive Report link in the lower left of the Package Report.
See Archiving a Package Report. You can also export it in PDF or Excel format. See Exporting a Package
Report.

Searching for a Package on the Select Package Page


On the Select Package page, you can filter the list of packages displayed in the package tree to display only
those packages that meet specific search criteria, which are grouped into three categories:

• Package Attributes—Search by properties assigned to the Windows Installer package. See Package
Attributes.

• Package Content—Search by files, registry entries, .ini files, or shortcuts contained in the Windows Installer
package. See Package Content.

• Application Request Attributes—Search by information related to a package’s associated Application


Request. See Application Request Attributes.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 89


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

To filter the list of packages displayed in the package tree to display only those packages that meet specific search
criteria, perform the following steps.

Task: To search for a package on the Select Package page:

1. In the Search Packages area of the Select Package page, expand the criteria category that you want to use
by clicking the arrow. When all three categories are expanded, the following fields are available:

2. Enter values in the criteria fields that you want to search on. You can search for packages in the Application
Catalog based on metadata in three categories:

• Package Attributes—Search by properties assigned to the Windows Installer package. See Package
Attributes.

• Package Content—Search by files, registry entries, .ini files, or shortcuts contained in the Windows
Installer package. See Package Content.

• Application Request Attributes—Search by information related to a package’s associated Application


Request. See Application Request Attributes.

90 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

3. After you have entered the search criteria, click Search. The packages that meet the criteria are now listed in
the package tree in alphabetical order and are no longer grouped.

Package Attributes
You can search for packages in a catalog based on one or more of any of the following Package attribute
metadata:

Table 4-6 • Package Attribute Search Fields

Metadata Description

Product Name Enter a package name to search by.

Manufacturer Enter the name of the software vendor who authored the package.

Product Version Enter the value that was entered in the Windows Installer ProductVersion property for
this package.

Package Code Enter the GUID that identifies a particular Windows Installer .msi package. The Package
Code associates an .msi file with an application or product and is represented as a
string GUID—a text string that has a special format:

{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}

where each X character is a hex digit (0 through 9 or uppercase A through F).

Product Code Enter the GUID that uniquely identifies the particular product release of the package.
The ProductCode is a Windows Installer property and is represented as a string
GUID—a text string that has a special format:

{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}

where each X character is a hex digit (0 through 9 or uppercase A through F).

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 91


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Table 4-6 • Package Attribute Search Fields (cont.)

Metadata Description

Upgrade Code Enter the GUID that identifies the family of products that are in the same upgrade path.
The UpgradeCode is a Windows Installer property and is represented as a string
GUID—a text string that has a special format:

{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXsXXXXX}

where each X character is a hex digit (0 through 9 or uppercase A through F).

Note • Each stand-alone product usually has its own UpgradeCode GUID. Every version of XYZ
Product typically uses the same GUID for the UpgradeCode. In other words, Product A Version 1.0
has the same UpgradeCode as Product A Version 2.0, but has a different UpgradeCode than
Product B.

Setup File Name Name of the Windows Installer (.msi) file that was imported into the Application Catalog.

Comments Enter the text of any comments associated with the package.

Import Date Use this field to search for packages that were imported during a specific date range.
Select the greater than or equal (>=) or less than (<) operator from the list, and then
click on the box and select a date from the pop-up calendar.

Extended Enter the value of any of the Extended Attributes associated with the package.
Attributes

Package Content
You can search for packages in a catalog based on one or more of any of the following Package Content metadata

Table 4-7 • Package Content Search Fields

Metadata Description

File Enter the file name of one of the files in the Windows Installer package.

Registry Key Enter a registry key to search on.

Registry Value Enter a registry value to search on.

INI File Enter any changes to an .ini file that are made when the product is installed.

Shortcut Enter the name of a shortcut that is created when the product is installed.

92 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Application Request Attributes


You can search for packages in a catalog based on one or more of any of the following attributes of the package’s
associated Application Request:

Table 4-8 • Application Request Attributes Search Fields

Metadata Description

Name Enter the name of the package’s associated Application Request.

Upload Date Enter the date the Application Request was created.

Due Date Enter the date the Application Request is scheduled to be completed, based upon its
value for Application Due Period.

Risk Date Enter the date at which the Application Request’s status will change to At Risk, which
is based upon its value for Application At Risk Period.

Due Period Enter, in days, the length of time this Application Request needs to be completed in
order to meet its Project’s Service Level Agreement (SLA) requirements.

End Date Enter the date the Application Request was completed.

Information Included in Package Reports


A Package Report presents information in a tabbed interface. See Navigating Through a Package Report.

A Package Report includes the following major sections:

• Package Summary Information View

• Files View

• Registry View

• Shortcuts View

• ODBC Drivers View

• ODBC DS View

• Extended Attributes View

• Validation View

• Conflicts View

• History View

• Dependencies View

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 93


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Package Summary Information View


The initial view (Page 1) of a Package Report is the Package Summary Information view.

Figure 4-4: Package Report / Package Summary Information View

The Package Summary Information View lists the following information:

Table 4-9 • Package Report / Package Summary Information

Item Description

Product Name Name assigned to the package.

Manufacturer Company that authored the package.

Import Date The date and time the package was imported into the Application Catalog.

Unresolved The number of detected conflicts, generated during conflict analysis of this package,
Conflicts which have not yet been resolved—either automatically or manually.

Product Version Version of package that is recorded in the package’s Windows Installer file.

Product Language Decimal-based code identifying the language that this software package was
authored for. For example, English is 1033, German is 1031, and Japanese is 1041.

94 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Table 4-9 • Package Report / Package Summary Information (cont.)

Item Description

In Software Indicates whether or not this package and its associated files are managed by the
Repository Software Repository.

Files View
The Files view lists all of the files included in the selected package, and the location where these files will be
installed.

Figure 4-5: Package Report / Files View

For each file, the following information is listed:

Table 4-10 • Package Report / Files Information

Item Description

File Name of file included with this package.

Target Directory Name of directory where the file is installed.

Version Version number of the file.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 95


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Table 4-10 • Package Report / Files Information (cont.)

Item Description

File Size Size of the installed file.

Component Component that the file is associated with.

Registry View
The Registry view lists the registry entries that will be created when this package is installed.

Figure 4-6: Package Report / Registry View

For each registry entry, the following information is listed:

Table 4-11 • Package Report / Registry Information

Item Description

Root Identifies the predefined “root” key that contains the registry entry.

Key A registry key.

Name Name identifying the registry entry.

96 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Table 4-11 • Package Report / Registry Information (cont.)

Item Description

Value The string of data that defines the value of the key.

Component Package component that the registry entry is associated with.

Shortcuts View
The Shortcuts view lists all of the shortcuts that will be created when this package is installed.

Figure 4-7: Package Report / Shortcuts View

For each shortcut, the following information is listed:

Table 4-12 • Package Report / Shortcuts Information

Item Description

Name Name identifying the shortcut.

Target Directory Directory and executable that the shortcut invokes.

Component Component associated with the shortcut.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 97


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

ODBC Drivers View


The ODBC Drivers view lists all of the Open Database Connectivity (ODBC) drivers in the package.

ODBC Resources are ones that involve interaction with databases. ODBC drivers are libraries that implement
functions involving ODBC. Each database type has its own ODBC driver.

Figure 4-8: Package Report / ODBC Drivers View

For each ODBC driver, the following information is listed:

Table 4-13 • Package Report / ODBC Drivers Information

Item Description

Driver Name of an Open Database Connectivity (ODBC) driver in the package. Each database type
has its own ODBC driver.

Description Description of the ODBC driver identifying its associated database type.

File File associated with the ODBC driver.

Component Component associated with the ODBC driver.

98 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

ODBC DS View
The ODBC DS view lists all of the Open Database Connectivity (ODBC) data sources in the package. An ODBC
data source identifies the source database type and provides information on how to connect to that database.

Figure 4-9: Package Report / ODBC Data Sources View

For each ODBC DS, the following information is listed:

Table 4-14 • Package Report / ODBC DS Information

Item Description

Data Source Name of the ODBC data source, which identifies the source database type and provides
information on how to connect to that database.

Description Identifies the database type.

Driver Name of this ODBC data source’s associated ODBC driver.


Description

Component Component that this ODBC data source is affiliated with.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 99


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Extended Attributes View


The Extended Attributes view lists all of the extended attribute metadata that has been entered for this package.

Figure 4-10: Package Report / Extended Attributes View

For each Extended Attribute, the following information is listed:

Table 4-15 • Package Report / Extended Attributes Information

Item Description

Name Name identifying the attribute.

Value Content entered for the attribute.

100 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Validation View
The Validation view lists all of the ICE rule errors and warnings that were generated when the package was
validated against Microsoft ICEs (Internal Consistency Evaluators)—custom actions written by Microsoft which can
be executed to determine if an installation package is built according to Windows Installer standards.

Figure 4-11: Package Report / Validation View

For each error or warning, the following information is listed:

Table 4-16 • Package Report / Validation Information

Item Description

ICE Rule Name of ICE Rule that generated an error or warning message.

Description Error or warning message.

Error Level Indicates the severity of the message as either being a Warning or an Error.

• Errors—Package authoring that will cause incorrect behavior.


• Warnings—Package authoring that could possibly cause incorrect behavior.
Warnings can also report unexpected side-effects of package authoring.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 101


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Conflicts View
The Conflicts view lists all of the unresolved errors that were found when conflict analysis was performed on this
package.

Figure 4-12: Package Report / Conflicts View

For each error, the following information is listed:

Table 4-17 • Package Report / Conflicts Information

Item Description

ACE Rule Name of ACE Rule that generated the message.

Description Message generated during conflict analysis.

Target Package Package that conflicted with this package.

102 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

History View
The History view lists all of the actions that have been performed on this package since it was imported into the
Application Catalog.

Figure 4-13: Package Report / History View

For each action, the following information is listed:

Table 4-18 • Package Report / History Information

Item Description

Date Day and time the event occurred.

Action Identifies the event that occurred.

User Identifies the user who executed the event.

Description Description of the event that occurred.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 103


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Dependencies View
The Dependencies view lists all of a package's files that have dependencies with files used by other products or
operating systems in the Application Catalog.

Figure 4-14: Package Report / Dependencies View

For each dependency, the following information is listed:

Table 4-19 • Package Report / Dependencies Information

Item Description

Name Name of a file associated with this package that has dependencies with files used by other
products or operating systems in the Application Catalog.

Path Location where this dependent file is installed.

Size Size of the dependent file.

Version Version of the dependent file.

104 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Navigating Through a Package Report


The Package Report consists of the initial Package Summary View and 10 other multi-page views which are
accessed by clicking the links at the top of the report:

Figure 4-15: Navigation Links on the Package Report

Scrolling Through Pages of a View


Each of the Package Report views can be either a single page or multi-page, depending upon the content. The
Package Report window is not resizable, so you cannot enlarge the window to display more items. Instead, you
can use the Page Scrolling controls in the toolbar.

Figure 4-16: Page Scrolling Controls on Package Report

The total number of pages of the Package Report is listed in the toolbar, along with the number of the page that you
are currently viewing. To jump to a specific page, enter a number in the box and click Enter.

Page 1 of the Package Report is the Package Summary Information view. Following this view, the rest of the
views follow in the order in which they appear in the navigation links. The total number of pages in a Package
Report is determined by adding the number of pages of all of the different views together.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 105


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Using Zoom Capability to Modify the Report Size


You can make selections from the Zoom list in the Package Report tool bar to enlarge or decrease the size of the
report.

Figure 4-17: Zoom List on the Package Report

Note • When you use the Zoom list to change the size of a Package Report, the size of the font used in the text is
increased or decreased; however, the amount of information displayed on one page does not change.

Searching for Information in a Package Report


You can use the Find box in the Package Report tool bar to search for specific information in the Package Report.

Task: To search a Package Report:

1. In the Package Report toolbar, enter the text you want to search for in the Find box and click Find. The page
containing the first instance of that text is opened, and the text you searched for is highlighted.

106 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

2. Click Next in the tool bar to find the next instance of the text.

Archiving a Package Report


You can archive a Package Report to document a snapshot of a package’s information as of a specific date and
time.

Package Reports are saved in PDF format, and therefore can be easily distributed. An archived report looks very
similar to the original report, except that it is a multiple-page PDF:

Figure 4-18: Archived Package Report

Note • In an archived Package Report PDF, the navigation links at the top of the report (Files, Registry,
Shortcuts, etc.) are not active. To scroll through the PDF, use the standard Adobe Reader controls.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 107


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

To archive a Package Report, perform the following steps.

Task: To archive a Package Report:

1. Open a Package Report.

2. Click the Archive Report link in the lower left corner any of the Package Report pages. The report is archived
in PDF format and the following message is displayed:

The report has been archived.

3. Click the Report Center All Reports tab. The All Reports page opens, and the report that you just archived is
listed.

Note • Each user’s Archived Reports list only includes those reports that they archived. If you want others in
your organization to view an archived report, you need to distribute the PDF via email or other delivery method.

4. Click View next to the Package Report that you want to view. The report is opened in a PDF browser.

Deleting an Archived Package Report from the Archived Reports List


To delete an archived Package Report, perform the following steps.

Task: To delete an archived Package Report from the Archived Reports list:

1. In the Archived Reports list on the All Reports page, right-click on the archived report you want to delete, and
then click Delete. You are prompted to confirm the deletion.

2. Click OK. The archived report is deleted.

108 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Exporting a Package Report


You can export the contents of a Package Report to an Excel (.xls) or Acrobat (.pdf) file.

• Excel .xls file—When a Package Report is exported to Microsoft Excel format, each of the Package Report
views are displayed on a different worksheet.

• Acrobat .pdf file—An exported Package Report in PDF format is the same as the PDF created when a
Package Report is archived. See Archiving a Package Report.

To export a Package Report, perform the following steps.

Task: To export a Package Report:

1. In the Package Report tool bar, select Excel or Acrobat (PDF) file from the list.

2. Click Export. The File Download dialog box opens.

3. Click Save. The Save As dialog box opens.

4. Select a location for the exported file and click Save.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 109


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Generating a Custom SQL Query Report for AdminStudio


You can generate a Custom SQL Query Report to include data generated by both AdminStudio and Workflow
Manager. To generate a Custom SQL Query Report, perform the following steps.

Task: To generate a new Custom SQL Query report:

1. Open the Report Center tab. The All Reports page opens.

2. Click Add. The Select Report Type page opens.

3. Click Custom SQL Query Report. The Enter SQL Query Panel opens.

4. Enter an SQL Query to retrieve the data for this report. Click the Test Query button to verify the query syntax.

Tip • To assist you in writing queries to retrieve data, see AdminStudio Tables, for information on each table and
the columns it contains, and Wildcard Support in Report Center SQL Queries.

5. Click Next. The General Information Panel opens.

6. Enter a Report Name and Description to clearly identify the contents and purpose of this report. This name
and description will be listed on the All Reports page.

7. Select the Roles that you want to have permission to view this report.

8. Click Next. The Summary Panel opens, which displays all the information needed to create the report.

9. Click Finish. The report is generated in the Report View. This report is also saved and now appears in the list
on the All Reports page.

110 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing AdminStudio Reports

Wildcard Support in Report Center SQL Queries


In Report Center searches, the LIKE operator is always used. You can combine the LIKE operator with a wildcard
character, and the following rules apply:

Table 4-20 • Wildcard Support in Report Center Queries

Situation Rule

When no If you do not enter a wildcard character in the Search box, then Report Center performs
wildcards are a “LIKE” search, which searches for any occurrence of that text anywhere in the item
used that is being searched for.

For example, if you are searching for a file name that has the word test anywhere in the
file name, and you entered test in the Search box, it would be interpreted by Report
Center as:

*test*

And the following files would be found:

MyTestFile and TestFile

When wildcards You can specify a * wildcard in the Search box to narrow the search results.
are used
For example, if you are searching for a file name that includes the word test, but does
not begin with it, and you entered *test in the Search box, MyTest would be returned,
but not TestFile.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 111


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

Generating and Viewing Workflow Manager


Reports
AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

Both Servicers and Customers can generate reports. You can choose to include or exclude data, and you can filter
the data by Companies, Projects, Applications, Workflow Items, and other data, giving you maximum flexibility.

On the Report View, you can click Export to export a report to Microsoft Excel format.

Note • You can also export a report to Excel and other formats (PDF, HTML, TXT, XML, TIFF, RTF) using the Export
feature built-in to all lists. See Exporting Data From Any List.

This section includes topics on the following:

• Creating Custom Reports

• Generating System Reports: Projects Report and Application Requests Summary Report

• Exporting Report Data from the Report View

Note • You must be a Servicer with Administrative permissions to create a Report.

Creating Custom Reports


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

You can create three types of reports using the Reports Wizard:

• Custom Report—A custom report defined by using the Reports Wizard. See Creating a Custom Report.

• Activity Report—A custom report, which you define using the Report Wizard, that displays a listing of
activities that occur during the completion of an Application Request. See Creating an Activity Report.

• Custom SQL Query Report—A custom report defined by entering an SQL query in the Report Wizard. See
Generating a Custom SQL Query Report.

112 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

Creating a Custom Report


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

To create a Custom Report, perform the following steps.

Task: To create a new report:

1. Open the Report Center tab. The All Reports page opens.

2. Click Add. The Select Report Type page opens.

3. Click Custom Report. The Select Report Objects Panel opens.

4. Select the Objects that you would like to include in the Report—Companies, Packages, Applications
[Requests], Projects, Issues—and click Next. The Select Report Fields Panel opens, listing all of the
defined fields by Object type. Only the objects that you selected in the previous step will be listed.

5. Select the report fields that you would like to include in the Report and click Next. The Set Filters Panel
opens, where you can filter the data that you want to appear in the Report.

6. Click on a field in the Available Fields tree and set its filter on the right side using the drop-down boxes and
the text box, selecting appropriate logical conditions which are populated according to the selected field. Each
time you create a filter, click Add to add the filter to the current filter conditions.

Note • Even though you may not have included all of the available report fields in this report, you can still filter
the data using all of these report fields.

7. Click Test Query to test the created query for your report.

8. When you are satisfied with the filter conditions, click Next. The Select Template Data Panel opens, listing
all available Templates.

9. Expand the Templates in the Templates tree and select the data that you want to include in the report. All of
the Data Groups and Data Elements associated with the selected Template are listed.

To display only those Templates that are in use in the Available Templates list, select the Templates in use
only option.

10. Click Next. The General Information Panel opens.

11. Enter a Report Name and Description to clearly identify the contents and purpose of this report. This name
and description will be listed on the All Reports page.

12. Select the Servicer and Customer Roles that you want to have permission to view this report.

13. Click Next. The Summary Panel opens, which displays all the information needed to create the report.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 113


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

14. Click Finish. The report is generated in the Report View. This report is also saved and now appears in the list
on the All Reports page.

Creating an Activity Report


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

Every time an activity or event occurs during the completion of an Application Request, Workflow Manager records
that activity. You can view a listing of these activities in the Activity Report, a custom report which you define using
the Report Wizard.

• Activities Displayed in the Activity Report

• Information that Can Be Included in an Activity Report

• How to Create an Activity Report

Activities Displayed in the Activity Report


The Activity Report lists a record for each time one of the following activities occurs during the completion of an
Application Request:

Table 4-21 • Activities Listed in the Activity Report

Activity Description

Application Occurs when a user edits the Application Name field on the Properties tab of the
Request Name Application Progress page and clicks Update.
Change

Application Occurs when a user edits the Status of an Application Request on the Properties tab
Request Status of the Application Progress page and clicks Update.
Changed

Data Acceptance Occurs when a user clicks the Submit button after they have entered all of the initial
Begins data that is required for an Application Request (the Data Entry Step of the first
Workflow Phase).

Note • This event occurs simultaneously with the Data Submission Complete event.

114 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

Table 4-21 • Activities Listed in the Activity Report (cont.)

Activity Description

Data Acceptance Occurs when a Servicer clicks the Reject Data button to reject the data submitted
Cancel during an Application Request’s Data Entry Step.

Each time data is rejected, three activities are recorded:

• Data Acceptance Cancel


• Data Rejected
• Data Submission Begins

Data Acceptance Occurs when a Servicer clicks the Accept Data button after reviewing the data
Complete submitted during an Application Request’s Data Entry Step.

Data Changed Occurs when a user clicks Update after editing data that was submitted as part of an
Application Request.

Data Edit Occurs when a user clicks the name of a Data Entry Workflow Step, and then clicks the
Edit Data button.

Data Rejected Occurs when a Servicer clicks the Reject Data button to reject the data submitted
during an Application Request’s Data Entry Step.

Each time data is rejected, three activities are recorded:

• Data Acceptance Cancel


• Data Rejected
• Data Submission Begins

Data Submission Because the first Workflow Step of the first Workflow Phase of every Application
Begins Request is a Data Entry step, each time a Customer or Servicer submits a new
Application Request, this activity occurs when the Submit button is clicked.

Note • When Customers submit an Application Request, they are immediately prompted to enter
the required data. However, when Servicers submit an Application Request, they are not prompted
to enter the required data until they click on the first Workflow Step of the first Workflow Phase on
the Application Progress page.

Data Submission Occurs when a user clicks the Submit button after they have entered all of the initial
Complete data that is required for an Application Request (the Data Entry Step of the first
Workflow Phase).

Note • This event occurs simultaneously with the Data Acceptance Begins event.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 115


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

Table 4-21 • Activities Listed in the Activity Report (cont.)

Activity Description

SLA Start Occurs when a user clicks the Start Clock button on the Application Progress page to
restart monitoring of SLA time for the current Workflow Step.

SLA Stop Occurs when a user clicks the Stop Clock button on the Application Progress page to
stop monitoring of SLA time for the current Workflow Step.

Workflow Phase Occurs when the last Workflow Step in the previous Workflow Phase is completed.
Begins

Workflow Phase Occurs when all Workflow Steps in a Workflow Phase are rolled back.
Cancel

Workflow Phase Occurs when the last Workflow Step of a Workflow Phase is completed.
Complete

Workflow Step Occurs when the previous Workflow Step in a Workflow is completed.
Begins

Workflow Step Occurs when a Workflow is rolled back to previous Workflow Step, which cancels the
Cancel completion state of all of the Workflow Steps between the current step and the one that
is rolled back to.

Workflow Step Occurs when a Workflow Step is completed, one of the following events occurs
Complete (depending upon the Step Type):

• Data Entry/Edit—Occurs when a user clicks Submit after entering the required
data.
• Normal—Occurs when a user clicks OK after entering time information on the
Step Validation dialog box.
• Update History—Occurs when a user clicks OK after entering information on the
Update History dialog box to document a Workflow Step/Phase.
• Workflow Assignment—Occurs when a user clicks Apply on the Assignment
Details page after assigning a user to Roles associated with this Application
Request.
• Script Execution—Occurs when a user clicks this Workflow Step name on the
Application Progress page, which launches a user-specified executable file.
• Custom Web Page—Occurs when a user clicks this Workflow Step name on the
Application Progress page, which opens a user-specified URL address in a new
browser window.

Workflow Step Occurs when a user enters a reason for rollback and clicks the Rollback button on the
Rollback Rollback Workflow Item dialog box (which is opened by clicking the check mark
next to the name of a completed Workflow Step).

116 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

Information that Can Be Included in an Activity Report


Each time an activity occurs, the following information is recorded:

Table 4-22 • Available Activity Report Fields

Field Description

Activity Date Date and time that an activity occurred.

Activity Name Name of event that was recorded. See Activities Displayed in the Activity Report for a
complete list.

Activity Owner User who was “assigned” to the Workflow Step that was active when the activity
occurred; the user who performed the activity.

Application Name Name of the Application Request that the activity was associated with.

Data Major Name of the Data Group that contains a Data Element that was modified.

Data Minor Name of the Data Element that was modified.

New Value Modified value of the edited Data Element.

Old Value Previous value of the edited Data Element.

Project Name Name of Project that the Application Request associated with this Activity is associated
with.

Workflow Major Name of the Workflow Phase that contains the Workflow Step that was current when
the activity occurred.

Workflow Minor Name of the Workflow Step that was current when the activity occurred.

When defining an Activity Report, you choose which of these fields to include in the report. You can also choose to
include any data that was entered for an Application Request, and you can also filter the report based upon the
value of one of the available report fields.

How to Create an Activity Report


To create a Custom Activity Report, perform the following steps.

Task: To create an Activity Report:

1. Open the Report Center tab. The All Reports page opens.

2. Click Add. The Select Report Type page opens.

3. Click Activity Report. The Select Report Objects Panel opens.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 117


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

4. Leave Activities selected and click Next. The Select Report Fields Panel opens.

5. Select the report fields that you would like to include in the Activity Report and click Next. The Set Filters
Panel opens, where you can filter the data that you want to appear in the Report.

Note • For a listing of the report fields available in the Activity Report, see Information that Can Be Included in
an Activity Report.

6. Click on a field in the Available Fields tree and set its filter on the right side using the drop-down boxes and
the text box, selecting appropriate logical conditions which are populated according to the selected field. Each
time you create a filter, click Add to add the filter to the current filter conditions.

Note • Even though you may not have included all of the available report fields in this report, you can still filter
the data using all of these report fields.

7. Click Test Query to test the created query for your report.

8. When you are satisfied with the filter conditions, click Next. The Select Template Data Panel opens, listing
all available Templates.

9. Expand the Templates in the Templates tree and select the data that you want to include in the report. All of
the Data Groups and Data Elements associated with the selected Template are listed.

To display only those Templates that are in use in the Available Templates list, select the Templates in use
only option.

10. Click Next. The General Information Panel opens.

11. Enter a Report Name and Description to clearly identify the contents and purpose of this report. This name
and description will be listed on the All Reports page.

12. Select the Servicer and Customer Roles that you want to have permission to view this report.

13. Click Next. The Summary Panel opens, which displays all the information needed to create the report.

14. Click Finish. The report is generated in the Report View. This report is also saved and now appears in the list
on the All Reports page.

118 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

Generating a Custom SQL Query Report


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

To generate a Custom SQL Query Report, perform the following steps.

Task: To generate a new Custom SQL Query report:

1. Open the Report Center tab. The All Reports page opens.

2. Click Add. The Select Report Type page opens.

3. Click Custom SQL Query Report. The Enter SQL Query Panel opens.

4. Enter an SQL Query to retrieve the data for this report. Click the Test Query button to verify the query syntax.

To assist you in writing queries to retrieve data, see Enter SQL Query Panel, which provides information on
Workflow Manager tables.

5. Click Next. The General Information Panel opens.

6. Enter a Report Name and Description to clearly identify the contents and purpose of this report. This name
and description will be listed on the All Reports page.

7. Select the Servicer and Customer Roles that you want to have permission to view this report.

8. Click Next. The Summary Panel opens, which displays all the information needed to create the report.

9. Click Finish. The report is generated in the Report View. This report is also saved and now appears in the list
on the All Reports page.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 119


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

Wildcard Support in Report Center SQL Queries


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

In Report Center searches, the LIKE operator is always used. You can combine the LIKE operator with a wildcard
character, and the following rules apply:

Table 4-23 • Wildcard Support in Report Center Queries

Situation Rule

When no If you do not enter a wildcard character in the Search box, then Report Center performs
wildcards are a “LIKE” search, which searches for any occurrence of that text anywhere in the item
used that is being searched for.

For example, if you are searching for a file name that has the word test anywhere in the
file name, and you entered test in the Search box, it would be interpreted by Report
Center as:

*test*

And the following files would be found:

MyTestFile and TestFile

When wildcards You can specify a * wildcard in the Search box to narrow the search results.
are used
For example, if you are searching for a file name that includes the word test, but does
not begin with it, and you entered *test in the Search box, MyTest would be returned,
but not TestFile.

Generating System Reports: Projects Report and


Application Requests Summary Report
AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

From the Workflow Manager Home page and the All Reports page, you can open two System reports that give
you detailed summary information on a Company’s Projects and Application Requests: the Projects Report and
the Application Requests Summary Report.

120 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

Figure 4-19: System Reports on the All Reports Page

Figure 4-20: System Reports on the Workflow Manager Home Page

The following reports are available:

• Projects Report—A report that lists one or all of a Company’s Projects, including the SLA status and
Workflow progress of the Application Requests associated with a Project. You can choose to include
information on one Project or all of a Company’s Projects. See Projects Report Page.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 121


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

• Application Requests Summary Report—A report that lists all of a Company’s Application Requests,
including the SLA status and Workflow progress of those Application Requests. You can choose to include
information on one Application Request or all of a Company’s Application Requests. You can also filter the
report by SLA Status. See Application Requests Summary Report Page.

Opening a System Report


You can open a System Report from either the All Reports page or the Workflow Manager Home page.

Task: To open a System Report:

1. Do one of the following to open a System Report:

• On the All Reports page, click View next to Projects Report or Application Requests Summary
Report.

• On the Workflow Manager Home page, click Projects Report or Application Requests Summary
Report in the My Reports list.

The Projects Reports page or Application Requests Summary Report page opens.

2. Make selections on the Projects Reports page or Application Requests Summary Report page to
specify report parameters.

3. Click View Report.

Setting View Permissions for a System Report


You can specify which Roles at your company are able to view System Reports.

Task: To set view permissions for a System Report

1. On the All Reports page, click Edit next to Projects Report or Application Requests Summary Report.
The General Information page opens, listing all of the Roles for both the Customer and Servicer Company.

2. Select the Roles that you want to be able to view the selected report.

3. Click Update.

The following reports include detailed information on Project and Application Request progress and SLA status:

• Generating an Application Requests Summary Report

• Generating a Projects Report

122 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

Generating an Application Requests Summary Report


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

An Application Request Summary Report lists Application Request summary information by Company, including
progress status and Service Level Agreement (SLA) status.

You can choose to include information on one Application Request or all of a Company’s Application Requests.
You can also filter the report by SLA Status.

Task: To view an Application Requests Summary Report:

1. Click the Report Center tab to open the All Reports page.

2. Click View next to Application Requests Summary Report. The Applications Report page opens.

3. From the Company list, select the Company that you want to view a report on.

4. Select one of the following options to specify which Application Requests to include in this report:

• Single Application Request—Select this option and select an Application Request from the list to
include a report on just the selected Application Request.

• Multiple Application Requests by SLA Status—Select this option to filter the report by SLA Status,
and then select the statuses that you want to include: Completed On Time, Completed Late, On Time,
At Risk, or Late. To include all Application Requests associated with this Project, select all of the
statuses.

5. If you have selected to generate a report on a Single Application Request, you can also filter the report by
metadata by selecting the Additional Metadata Filter Conditions option. The Metadata filter fields appear.

6. To filter the report by metadata, perform the following steps:

a. Select the Data Element that you want to filter by from the Metadata Field list.

b. Enter a value for the selected Metadata Field in the Condition Value box or select a value from the
Values List (when available).

c. Select the appropriate Operator from the list (AND or OR).

d. Continue adding Metadata Fields, if desired. You can filter by up to four Metadata Fields.

7. Click View Report.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 123


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

Generating a Projects Report


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

A Projects Report lists Project summary information by Customer, including Application Request and Service Level
Agreement (SLA) status. You can choose to include information on one Project or all of a Customer’s Projects.

Task: To view a Projects Report:

1. Click the Report Center tab to open the All Reports page.

2. Click View next to Projects Report. The Projects Report page opens.

3. From the Company list, select the Company that you want to view a Projects Report on.

4. From the Projects list, select the Project that you want to view or to view all of the selected Company’s
Projects, select ** View for all **.

5. To filter this report by SLA Status, select only the statuses that you want to include in the report: Completed
On Time, Completed Late, On Time, At Risk, or Late. To include all Application Requests associated with
this Project, select all of the statuses.

6. Click View Report.

124 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

Exporting Report Data from the Report View


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

You can choose to export data from Custom Reports, Activity Reports, or Custom SQL Query Reports using either
of the following methods:

• Click Export on the Report View to export the data in Microsoft Excel format. See Exporting Report Data
Using the Export Button.

• Use the export feature that is built into all lists to export the data in HTML, PDF, XML, TIFF, RTF, or Text format.
See Exporting Data From Any List.

Exporting Report Data Using the Export Button


To export Report data to Microsoft Excel format, perform the following steps.

Task: To export a report to Microsoft Excel format:

1. Open a report in the Report View.

2. Click Export. The report is opened in Microsoft Excel.

3. To save the report in Microsoft Excel format, select Save As from the File menu to display the Save As dialog
box.

4. Enter a file name.

5. Select Microsoft Excel Workbook (*.xls) from the Save as type list.

6. Click Save.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 125


Chapter 4: Generating and Viewing Reports in Report Center
Generating and Viewing Workflow Manager Reports

Exporting Data From Any List


AdminStudio 9.5

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

You can export data in any list to Microsoft Excel, HTML, PDF, XML, TIFF, RTF, or Text format. When you export data
from a list, data from all of the pages of the list are exported, not just the data that is currently displayed. You can
export data from any list, including user generated reports that are displayed on the Report View.

Task: To export list data:

1. At the bottom right corner of the list, click the Export button. The Export Menu opens displaying three sets
of options: Data to Export, Export Format, and Page Orientation.

2. In the Export Format section of the menu, select the desired format.

3. In the Page Orientation section of the menu, select Portrait or Landscape.

4. Click Export now. The data from that listing is exported in the selected format, saved to a temporary location
on the Workflow Manager Server, and then that data file is opened in the appropriate application:

• Microsoft Internet Explorer (HTML/XML/TIFF)

• Adobe Reader (PDF)

• Microsoft Excel (Excel)

• Microsoft Word (RTF)

• Notepad (Text)

5. On the File menu of the application displaying the report, click Save As and save the report to a local drive.

126 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Report Center Reference


This section includes reference information on the following pages, views, and reports:

• All Reports Page

• Report View

• Select Package Page

• Package Report

• Reports Wizard

All Reports Page


The All Reports page provides access to the following reports:

• Workflow Manager—System Reports (Projects Report and Application Requests Summary Report), Custom
Report, Activity Report, and Custom SQL Query Report.

• AdminStudio—Archived Package Reports and Custom SQL Query Report.

The All Reports page includes the following options:

Table 4-24 • All Reports Page Options

Option Description

Report Name Name of a saved report.

Report Text describing the contents of the report.


Description

Add Click to design and generate a new report.

Available Reports
From the All Reports page, you can choose to create a new custom report, view a custom report that was already
created, or view the Projects Report Page or Application Requests Summary Report Page.

Viewing an Existing Custom Report from the All Reports Page


To view a report, click View to launch the Report View.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 127


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Projects Report Page


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

A Projects Report lists Project summary information by Customer, including Application Request and Service Level
Agreement (SLA) status. You can choose to include information on one Project or all of a Customer’s Projects.

To view a Projects Report, click View next to Projects Report on the All Reports page. The Projects Report
page opens.

Table 4-25 • Projects Report Page Options

Option Description

Company Select the Company that you want to view a Projects Report for.

Projects Select the Project that you want to view or to view all of the selected Company’s Projects,
select ** View for all **.

SLA Status To filter this report by SLA Status, select only the statuses that you want to include in the
report: Completed On Time, Completed Late, On Time, At Risk, or Late. To include all
Application Requests associated with this Project, select all of the statuses.

View Report Click to generate and display the Projects Report.

Projects Report
AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

A Projects Report lists Project summary information by Customer, including Application Request and Service Level
Agreement (SLA) status. You can choose to include information on one Project or all of a Customer’s Projects.

The following information is included in the Projects Report:

Table 4-26 • Projects Report Information

Item Description

Project Summary Listing of Project properties and SLA settings.

128 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-26 • Projects Report Information (cont.)

Item Description

Application Requests by Table listing the number of Application Requests associated with this project,
SLA Status grouped by SLA Status: Completed On Time, Completed Late, On Time, At
Risk, and Late.

Application Request The following pie charts are included:


Progress
• SLA Compliance Summary—Pie chart illustrating the quantity of
Overview Application Requests associated with this Project in each SLA Status.
• Current Phase Status—Pie chart illustrating the current phase of the
Application Requests that are in progress.

Application Request Listing of the quantity of in-progress Application Requests in each Workflow
Progress Phase, grouped by SLA Status.

In-Progress Application
Requests By Current Workflow
Phase

View Application Requests Click to open the Application Requests Summary Report Page for this Project.
Summary Report

Application Requests Summary Report Page


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

An Application Request Summary Report lists Application Request summary information by Company, including
progress status and Service Level Agreement (SLA) status.

You can choose to include information on one Application Request or all of a Company’s Application Requests.
You can also filter the report by SLA Status.

To view a Application Requests Summary Report, click View next to Applications Report on the All Reports
page. The Application Requests Summary Report page opens.

Table 4-27 • Applications Report Page Options

Option Description

Company Select the Company that you want to view an Application Requests Summary Report for.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 129


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-27 • Applications Report Page Options

Option Description

Include Select one of the following options to specify which Application Requests to include in this
report:

• Single Application Request—Select this option and select an Application Request


from the list to include a report on just the selected Application Request.
• Multiple Application Requests by SLA Status—Select this option to filter the report
by SLA Status, and then select the statuses that you want to include: Completed On
Time, Completed Late, On Time, At Risk, or Late. To include all Application
Requests associated with this Project, select all of the statuses.

Additional If you have selected to generate a report on a Single Application Request, you can also
Metadata filter the report by metadata by selecting this option. The following Metadata filter fields
Filter appear.
Conditions
• Metadata Field—Select the Data Element that you want to filter by from the list.
• Conditional Value & Values List—Enter a value for the selected Metadata Field in
the Condition Value box or select a value from the Values List (when available).
• Operator—Select the appropriate Operator from the list (AND or OR).

You can filter by up to four Metadata Fields.

View Report Click to generate and display the Application Requests Summary Report.

130 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Application Requests Summary Report


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager

An Application Request Summary Report lists Application Request summary information by Company, including
progress status and Service Level Agreement (SLA) status.

You can choose to include information on one Application Request or all of a Company’s Application Requests.
You can also filter the report by SLA Status.

The following information is included in an Application Requests Summary Report:

Table 4-28 • Application Requests Summary Report Information

Item Description

Service Company Identifies the Service Company that these Application Requests are associated with.

Selected Listing of the SLA Statuses included in this report.


Application
Requests

Application Listing of the following information for each Application Request associated with this
Requests Service Company:

• Application—Application Request name. Click the link to open the Application


Progress page for that Application Request.
• Start Date—Date Application Request was submitted.
• Due Date—Date Application Request should be completed to meet SLA
requirements
• End Date—Actual date Application Request was completed.
• Progress Status—Lists the Phase Type of this Application Request’s current
Workflow Phase.
• SLA Status—The Application Request’s SLA Status: On Time, At Risk, Late,
Completed Late, or Completed On Time.
• Elapsed Time—Elapsed time since the Application Request was submitted,
minus any time the SLA clock was stopped.
• SLA Time—Elapsed time since the Application Request was submitted, minus
any time the SLA clock was stopped, and any time that was spent performing a
Workflow Step that was not tracked.
• Company—Name of Customer Company.
• Project—Application Request’s associated Project. Click the link to open the
Projects Report for that Project.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 131


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Report View
The Report View, which is opened by clicking View next to an existing Custom Report on the All Reports page,
displays the contents of a saved report.

Table 4-29 • Report View

Option Description

Report Name Name of this report.

Description Text describing the contents of the report.

Default Filter Name of filter, if any, applied to this report.

Export Click to export this report to Microsoft Excel format.

Note • You can also export a report to Microsoft Excel and other formats (PDF, HTML, TXT, XML, TIFF,
RTF) using the Export feature that is built into all lists. See Exporting Data From Any List.

Show Filters If you have defined any filters for this report, click Show Filters to alter the filter settings. Show
Filter changes to Hide Filters and the following fields appear:

• Select a filter—Select any of the filters that have been saved to apply to this report.
• Select a value for this filter—All of the values of the field used in the selected filter are
listed. Select the one that you want to apply.
• or alternatively type in a value for this filter—If you want to apply a value that does
not appear in the list, type the value in this text box.
• Apply filter—Click to apply the new filter to the report.
• Reset filter—Click to reset the filter back to what its original state.

If there are no filters defined for this report, No filters available on this report appears
instead of the Show Filter link.

Change (Read Only for Customers) Select Published or Not Published from this list to set the status of
status of this a report. Non-published reports can be viewed by Servicers with Administrative permissions,
report but are not available to Servicers without Administrative permissions or Customers.
Published reports are available to all Servicers, Customers, and Guests.

132 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Select Package Page


From the Select Package page, you can select or search for a specific package, and then generate a detailed
Package Report. Information about the Select Package page is presented in the following sections:

• Areas of the Select Package Page

• Group Summary Information

• Package Summary Information

• Search Package Area

Areas of the Select Package Page


The Select Package page is organized in the following areas:

Table 4-30 • Areas on the Select Package Page

Area Description

Package Tree On the left side of the interface, all of the groups and packages in the AdminStudio
Enterprise Server Application Catalog are displayed in a tree control.

If a search has been applied using the fields in the Search Packages area, only
those packages meeting that criteria are listed, and the Show All packages
button is enabled.

Package or Group In the top half of the right side of the interface, either a summary of group statistics
Summary Area (when a group is selected) or a summary of package statistics (when a package or
OS Snapshot is selected) is displayed. See Group Summary Information and
Package Summary Information.

When a package is selected, you can click View Report to view that package’s
Package Report.

Search Packages Area In bottom half of the right side of the interface, the Search Packages area
includes fields allowing you to search for packages by attributes, content, or
associated Application Requests.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 133


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Group Summary Information


When a group in the package tree is selected, summary information about that group is listed.

Figure 4-21: Group Summary on the Select Package Page

The following information about the selected group is listed:

Table 4-31 • Group Summary Information

Item Description

Total Packages in Group Total number of packages that have been imported into the selected group. This
number is also broken down between number of Windows Installer packages
and the number of OS Snapshot packages.

Packages With Conflicts Number of packages that have unresolved conflicts with other packages or OS
Snapshots in the Application Catalog.

Package Summary Information


When a package in the package tree is selected, summary information about that package is listed.

Figure 4-22: Package Summary on the Select Package Page

134 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

The following information about the selected group is listed:

Table 4-32 • Package Summary Information

Item Description

Product Version Version of package that is recorded in the package’s Windows Installer file.

Manufacturer Company that authored the package.

Import Date The date and time the package was imported into the Application Catalog.

In Software Repository Indicates whether or not this package and its associated files are managed by
the Software Repository.

Unresolved Conflicts The number of detected conflicts, generated during conflict analysis of this
package, which have not yet been resolved—either automatically or manually.

Associated Application If this package is associated with an Application Request, the Application
Request Request name is listed here. Click this link to open the Application Request’s
Application Report.

Search Package Area


In the Search Package area of the Select Package page, you can filter the list of packages displayed in the
package tree to display only those packages that meet specific search criteria, which are grouped into three
categories:

• Package Attributes—Search by properties assigned to the Windows Installer package. See Package
Attributes.

• Package Content—Search by files, registry entries, .ini files, or shortcuts contained in the Windows Installer
package. See Package Content.

• Application Request Attributes—Search by information related to a package’s associated Application


Request. See Application Request Attributes.

To filter the list of packages displayed in the package tree to display only those packages that meet specific search
criteria, enter values in the criteria fields that you want to search on, and click Search. The packages that meet any
of the criteria are then listed in the package tree in alphabetical order and are no longer grouped.

Package Attributes
You can search for packages in a catalog based on one or more of any of the following Package attribute
metadata:

Table 4-33 • Package Attribute Search Fields

Metadata Description

Product Name Enter a package name to search by.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 135


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-33 • Package Attribute Search Fields (cont.)

Metadata Description

Manufacturer Enter the name of the software vendor who authored the package.

Product Version Enter the value that was entered in the Windows Installer ProductVersion property for
this package.

Package Code Enter the GUID that identifies a particular Windows Installer .msi package. The Package
Code associates an .msi file with an application or product and is represented as a
string GUID—a text string that has a special format:

{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}

where each X character is a hex digit (0 through 9 or uppercase A through F).

Product Code Enter the GUID that uniquely identifies the particular product release of the package.
The ProductCode is a Windows Installer property and is represented as a string
GUID—a text string that has a special format:

{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX}

where each X character is a hex digit (0 through 9 or uppercase A through F).

Upgrade Code Enter the GUID that identifies the family of products that are in the same upgrade path.
The UpgradeCode is a Windows Installer property and is represented as a string
GUID—a text string that has a special format:

{XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXsXXXXX}

where each X character is a hex digit (0 through 9 or uppercase A through F).

Note • Each stand-alone product usually has its own UpgradeCode GUID. Every version of XYZ
Product typically uses the same GUID for the UpgradeCode. In other words, Product A Version 1.0
has the same UpgradeCode as Product A Version 2.0, but has a different UpgradeCode than
Product B.

Setup File Name Name of the Windows Installer (.msi) file that was imported into the Application Catalog.

Comments Enter the text of any comments associated with the package.

Import Date Use this field to search for packages that were imported during a specific date range.
Select the greater than or equal (>=) or less than (<) operator from the list, and then
click on the box and select a date from the pop-up calendar.

Extended Enter the value of any of the Extended Attributes associated with the package.
Attributes

136 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Package Content
You can search for packages in a catalog based on one or more of any of the following Package Content metadata

Table 4-34 • Package Content Search Fields

Metadata Description

File Enter the file name of one of the files in the Windows Installer package.

Registry Key Enter a registry key to search on.

Registry Value Enter a registry value to search on.

INI File Enter any changes to an .ini file that are made when the product is
installed.

Shortcut Enter any shortcuts that are created when the product is installed.

Application Request Attributes


You can search for packages in a catalog based on one or more of any of the following attributes of the package’s
associated Application Request:

Table 4-35 • Application Request Attributes Search Fields

Metadata Description

Name Enter the name of the package’s associated Application Request.

Upload Date Date the Application Request was submitted.

Due Date Enter the date the Application Request is scheduled to be completed, based upon its
value for Application Due Period.

Risk Date Enter the date at which the Application Request’s status will change to At Risk, which is
based upon its value for Application At Risk Period.

Due Period Enter, in days, the length of time this Application Request needs to be completed in
order to meet its Project’s Service Level Agreement (SLA) requirements.

End Date Enter the date the Application Request was completed.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 137


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Package Report
This topic lists the data that is displayed in each section of a Package Report.

• Package Summary Information View

• Files View

• Registry View

• Shortcuts View

• ODBC Drivers View

• ODBC DS View

• Extended Attributes View

• Validation View

• Conflicts View

• History View

• Dependencies View

Note • See also see Information Included in Package Reports.

Package Summary Information View


The initial view (Page 1) of a Package Report is the Package Summary Information view, and it lists the following
information:

Table 4-36 • Package Report / Package Summary Information

Item Description

Product Name Name assigned to the package.

Manufacturer Company that authored the package.

Import Date The date and time the package was imported into the Application Catalog.

Unresolved The number of detected conflicts, generated during conflict analysis of this package,
Conflicts which have not yet been resolved—either automatically or manually.

Product Version Version of package that is recorded in the package’s Windows Installer file.

Product Language Decimal-based code identifying the language that this software package was
authored for. For example, English is 1033, German is 1031, and Japanese is 1041.

138 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-36 • Package Report / Package Summary Information (cont.)

Item Description

In Software Indicates whether or not this package and its associated files are managed by the
Repository Software Repository.

Files View
The Files view lists the all of the files included in the selected package, and the location where these files will be
installed. For each file, the following information is listed:

Table 4-37 • Package Report / Files Information

Item Description

File Name of file included with this package.

Target Directory Name of directory where the file is installed.

Version Version number of the file.

File Size Size of the installed file.

Component Component that the file is associated with.

Registry View
The Registry view lists the registry entries that will be created when this package is installed. For each registry
entry, the following information is listed:

Table 4-38 • Package Report / Registry Information

Item Description

Root Identifies the predefined “root” key that contains the registry entry.

Key A registry key.

Name Name identifying the registry entry.

Value The string of data that defines the value of the key.

Component Package component that the registry entry is associated with.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 139


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Shortcuts View
The Shortcuts view lists all of the shortcuts that will be created when this package is installed. For each shortcut,
the following information is listed:

Table 4-39 • Package Report / Shortcuts Information

Item Description

Name Name identifying the shortcut.

Target Directory Directory and executable that the shortcut invokes.

Component Component associated with the shortcut.

ODBC Drivers View


The ODBC Drivers view lists all of the Open Database Connectivity (ODBC) drivers in the package.

ODBC Resources are ones that involve interaction with databases. ODBC drivers are libraries that implement
functions involving ODBC. Each database type has its own ODBC driver. For each ODBC driver, the following
information is listed:

Table 4-40 • Package Report / ODBC Drivers Information

Item Description

Driver Name of an Open Database Connectivity (ODBC) driver in the package. Each database type
has its own ODBC driver.

Description Description of the ODBC driver identifying its associated database type.

File File associated with the ODBC driver.

Component Component associated with the ODBC driver.

ODBC DS View
The ODBC DS view lists all of the Open Database Connectivity (ODBC) data sources in the package. An ODBC
data source identifies the source database type and provides information on how to connect to that database. For
each ODBC DS, the following information is listed:

Table 4-41 • Package Report / ODBC DS Information

Item Description

Data Source Name of the ODBC data source, which identifies the source database type and provides
information on how to connect to that database.

Description Identifies the database type.

140 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-41 • Package Report / ODBC DS Information (cont.)

Item Description

Driver Name of this ODBC data source’s associated ODBC driver.


Description

Component Component that this ODBC data source is affiliated with.

Extended Attributes View


The Extended Attributes view lists all of the extended attribute metadata that has been entered for this package.
For each Extended Attribute, the following information is listed:

Table 4-42 • Package Report / Extended Attributes Information

Item Description

Name Name identifying the attribute.

Value Content entered for the attribute.

Validation View
The Validation view lists all of the ICE rule errors and warnings that were generated when the package was
validated against Microsoft ICEs (Internal Consistency Evaluators)—custom actions written by Microsoft which can
be executed to determine if an installation package is built according to Windows Installer standards.

For each error or warning, the following information is listed:

Table 4-43 • Package Report / Validation Information

Item Description

ICE Rule Name of ICE Rule that generated an error or warning message.

Description Error or warning message.

Error Level Indicates the severity of the message as either being a Warning or an Error.

• Errors—Package authoring that will cause incorrect behavior.


• Warnings—Package authoring that could possibly cause incorrect behavior.
Warnings can also report unexpected side-effects of package authoring.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 141


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Conflicts View
The Conflicts view lists all of the unresolved errors that were found when conflict analysis was performed on this
package. For each error, the following information is listed:

Table 4-44 • Package Report / Conflicts Information

Item Description

ACE Rule Name of ACE Rule that generated the message.

Description Message generated during conflict analysis.

Target Package Package that conflicted with this package.

History View
The History view lists all of the actions that have been performed on this package since it was imported into the
Application Catalog. For each action, the following information is listed:

Table 4-45 • Package Report / History Information

Item Description

Date Day and time the event occurred.

Action Identifies the event that occurred.

User Identifies the user who executed the event.

Description Description of the event that occurred.

Dependencies View
The Dependencies view lists all of a package's files that have dependencies with files used by other products or
operating systems in the Application Catalog. For each dependency, the following information is listed:

Table 4-46 • Package Report / Dependencies Information

Item Description

Name Name of a file associated with this package that has dependencies with files used by other
products or operating systems in the Application Catalog.

Path Location where this dependent file is installed.

Size Size of the dependent file.

Version Version of the dependent file.

142 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Reports Wizard
Using the Reports Wizard, you can generate reports of Workflow Manager deployment at any Customer site. You
can choose to include or exclude data, regardless of the specific Customer implementation. You can filter the data
by Companies, Projects, Applications, Workflow Items, and other data, giving you maximum flexibility.

Using the Reports Wizard, you can generate Custom and Activity Reports and Custom SQL Query Reports. See
Creating a Custom Report, Creating an Activity Report, and Generating a Custom SQL Query Report.

Note • You can also export a report to Excel and other formats (PDF, HTML, TXT, XML, TIFF, RTF) using the Export
feature built into all lists. See Exporting Data From Any List.

Note • Only Servicers with appropriate Role permissions can create a report. Customers cannot create reports.

Select Report Type Panel


On the Select Report Type Panel of the Reports Wizard, select one of the following options:

Table 4-47 • Select Report Type Panel Options

Option Description

Custom SQL Query Select to create a custom report defined by entering an SQL query in the Report
Report Wizard.

Select Report Objects Panel


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager.

On the Select Report Objects Panel of the Reports Wizard, select the objects you want to include in the report:

• For a Custom Report, you can select Applications, Companies, Projects, and Issues.

• For an Activity Report, the only selection is Activities.

Click Next to continue with the Reports Wizard.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 143


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Select Report Fields Panel


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager.

On the Select Report Fields Panel of the Reports Wizard, select the fields you want to include in the report. All of
the available fields are listed by object.

• For a Custom Report, the Applications, Companies, Projects, and Issues objects could be listed.

• For an Activity Report, only the Activities object is listed.

Click Next to continue with the Reports Wizard.

Set Filters Panel


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager.

On the Set Filters Panel of the Reports Wizard, enter a filter to define the data that you want to include in this
report.

Table 4-48 • Set Filters Panel of the Reports Wizard

Option Description

Available Fields Select a field from this tree to use to create a filter. When you click on a field to select it,
all of its values populate the Select a value for this filter list.

144 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-48 • Set Filters Panel of the Reports Wizard (cont.)

Option Description

Set Filter Area Use the following fields to create a filter to apply to this report:

• Select a value for this filter—All of the values of the selected field are listed.
Select the one that you want to use to create this filter.
• or alternatively type in a value for this filter—If you want to use a value that
does not appear in the list, type the value in this text box.
• Operator list box—Select an operator from this list box to specify how you want
the value in the selected field of each record to be selected, such as Equal, Greater
Than, Less Than, etc.
• Add—After you have set a filter, click Add to add the filter to the current filter
conditions. It will be added to the Test Query box below, and a query is
automatically run to determine if this filter generates any records.
• Conjunction Express List (AND, OR)—After you have set one filter, and want to
add another, select a conjunction from this box before you click Add to specify
whether the record must meet both filter conditions (AND) or only one filter
condition (OR).
• Test Query—Click to run the specified query to determine if the filter combination
generates any records. If no records are found, you are prompted to change the
filters.
• Reset All—Click to remove all filter conditions.

When you have finished defining filters, click Next to continue with the Reports Wizard.

Select Template Data Panel


AdminStudio 9.5 | Report Center

Edition • Report Center is included with AdminStudio Enterprise Edition and with Workflow Manager.

On the Select Template Data Panel of the Reports Wizard, you specify the Template data fields that you want to
include in this report.

In the Available Templates list, click the plus sign next to a Template name to expand the listing to show all data
fields associated with that Template, and select the data fields that you would like to include in the report.

Select the Templates in use only option if you want only Templates that are associated with active Projects and
Application Requests to be listed.

Click Next to continue with the Reports Wizard.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 145


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Enter SQL Query Panel


On the Enter SQL Query Panel of the Custom SQL Query Reports Wizard, enter an SQL query to retrieve the
data for this report. Click the Test Query button to verify the query syntax, and click Next to proceed.

Wildcard Support in Report Center SQL Queries


In Report Center searches, the LIKE operator is always used. You can combine the LIKE operator with a wildcard
character, and the following rules apply:

Table 4-49 • Wildcard Support in Report Center Queries

Situation Rule

When no If you do not enter a wildcard character in the Search box, then Report Center performs
wildcards are a “LIKE” search, which searches for any occurrence of that text anywhere in the item
used that is being searched for.

For example, if you are searching for a file name that has the word test anywhere in the
file name, and you entered test in the Search box, it would be interpreted by Report
Center as:

*test*

And the following files would be found:

MyTestFile and TestFile

When wildcards You can specify a * wildcard in the Search box to narrow the search results.
are used
For example, if you are searching for a file name that includes the word test, but does
not begin with it, and you entered *test in the Search box, MyTest would be returned,
but not TestFile.

Tip • To assist you in writing queries to retrieve data, see AdminStudio and Workflow Manager Tables for information
on each table and the columns it contains.

146 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

General Information Panel


On the General Information Panel of the Reports Wizard, enter a Report Name and Description to clearly
identify the contents and purpose of this report. This name and description will be listed on the All Reports page.

Next, select the Roles that you want to have permission to view this report.

Click Next to continue with the Reports Wizard.

Note • You can change the selected Roles at any time after this report is created by clicking Edit next to the Report
Name on the All Reports page.

Summary Panel
On the Summary Panel of the Reports Wizard, the following information is listed:

Table 4-50 • Summary Panel of the Reports Wizard

Option Description

Report Name Name of report.

Report Fields List of fields that you selected to be included in this report.

Template Data A list of the Template data you selected to be in this report.

Filters A list of filters applied to this report.

Click Finish to generate the Report. The report is generated in the Report View. This report is also saved and now
appears in the list on the All Reports page.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 147


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

AdminStudio and Workflow Manager Tables


To assist you in writing queries for Custom SQL Query reports, information on AdminStudio and Workflow Manager
tables is provided.

• AdminStudio Tables

• Workflow Manager Tables

AdminStudio Tables
To assist you in writing queries to retrieve AdminStudio data, information on the following AdminStudio tables is
provided.

• cstblPackage

• cstblGroups

• cstblGroupPackages

• AsJob

• AsJobQueue

• AsJobStep

cstblPackage

The cstblPackage table is the core table that contains information about imported packages. This table contains a
unique Package ID (the RowID column) that is referenced by all other data tables. This table contains the following
columns:

Table 4-51 • cstblPackage Columns

Column Type Key Nullable Description

RowID int Y N The Primary Key—used to uniquely identify a


record.

PackageCode text N The value of the equivalent MSI


PackageCode. Code can be up to 100
characters long.

ProductCode text N The value of the equivalent MSI


ProductCode. Code can be up to 100
characters long.

ProductVersion text N The value of the equivalent MSI


ProductVersion. Version can be up to 100
characters long.

148 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-51 • cstblPackage Columns

Column Type Key Nullable Description

UpgradeCode text N The value of the equivalent MSI


UpgradeCode. Code can be up to 100
characters long.

ProductName text N The value of the equivalent MSI


ProductName. Name can be up to 255
characters long.

Manufacturer text N The value of the equivalent MSI


Manufacturer. Name can be up to 255
characters long.

ProductLanguage int N The value of the equivalent MSI


ProductLanguage.

FileName text N UNC path to the MSI package. Name can be


up to 255 characters long.

Comments text N User description of the package. Comments


can be up to 4000 characters long.

ImportDate datetime N Date package was imported.

FileModifiedDate datetime N Derived from the file system, this is the date
that the package (MSI) file was last modified.

Flags int N Used internally.

DisplayedProductName text N Name of package that is displayed in the


Application Manager and ConflictSolver
Products View. Name can be up to 255
characters long.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 149


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

cstblGroups

Application Manager allows categorizing related packages using Groups. The cstblGroups table is used to store
the information about Application Manager groups. Application Manager ships with one row in this table that
defines the root node in the Groups tree. A group may contain imported packages or other sub-groups; these
parent-child relationship details are stored in the cstblGroupPackages table. This table contains the following
columns:

Table 4-52 • cstblGroups Columns

Column Type Key Nullable Description

RowID int Y N The Primary Key—used to uniquely identify a


record.

GroupName text N Name of group. Name can be up to 72 characters


long.

Description text N Description of group. Description can be up to 128


characters long.

Comments text N Comments associated with group. Comments can


be up to 255 characters long.

Properties int N Used internally.

CreatedDate datetime N Date group was created.

ModifiedDate datetime N Date group was last modified.

cstblGroupPackages

This table defines the relationship between packages and groups. This table contains the following columns:

Table 4-53 • cstblGroupPackages Columns

Column Type Key Nullable Description

RowID int Y N The Primary Key—used to uniquely identify a


record.

ParentGroupCode int N Foreign Key identifier into the cstblGroup table.


Parent group containing either the package or the
group entry (Group Row ID).

PkgRowID_ int N Foreign Key identifier into the cstblPackage table.


If this is a group, the value in this column is 0.
Otherwise, it contains the PackageRowID.

150 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-53 • cstblGroupPackages Columns

Column Type Key Nullable Description

MemberGroupCode int N Foreign Key identifier into the cstblGroup table. If


this is a package, the value in this column is -1.
Otherwise, it contains the GroupRowID.

AsJob

This table identifies all jobs within the Enterprise Server.

Table 4-54 • AsJob Columns

Column Type Key Nullable Description

JobId Int Y N The primary key to uniquely identify a job.

JobName Varchar(32) N N The user provided name for the job.

UserName Varchar(255) N N The user name that created this job and derived as
part of the Enterprise Server login process.

JobType Varchar(5) N N A string identifying the two job types of Custom


(cust) and Template (temp) jobs.

Created Datetime N N The time when the job was created. Generated
automatically.

Deleted_Flag Char(1) N N Not currently used.

Deleted Datetime N Y Not currently used.

Description Varchar(400) N Y An extended description used to elaborate the


purpose of a (Template) job.

AsJobQueue

This table is the active queue for all job instances which are available to run, or which have run

Table 4-55 • AsJobQueue Columns

Column Type Key Nullable Description

JobQueueId Int Y N The primary key to uniquely identify a job


queue entry.

QueueName Varchar(32) N Y The name of the job queue entry.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 151


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-55 • AsJobQueue Columns (cont.)

Column Type Key Nullable Description

LastAction Varchar(200) N Y The last status message generated by the job


execution. Initially empty until the job actually
runs.

Priority Int N Y Relative priority value giving preference to


jobs scheduled for immediate execution

CompletionTime DateTime N Y The time that the last run of the job
completed.

RequestTime DateTime N N The time after which the job will be set as
available to run.

JobId_ Int N N Foreign key into the AsJob table – JobId


column. This value identifies which job is
associated with this job queue entry.

UserName Varchar(255) N N The name of the user who added this job to
the job queue and derived as part of the
Enterprise Server login process.

MetaData Varchar(4096) N N Job specific XML data used by Template jobs.

StatusId_ Int N N Foreign key into the AsQueueStatus table –


StatusId column. This value identifies the
status of this particular job queue entry.

AsJobStep

This table identifies the individual job steps for all jobs within the Enterprise Server.

Table 4-56 • AsJobStep Table Columns

Column Type Key Nullable Description

JobStepId Int Y N The primary key to uniquely identify a job.

JobStepName Varchar(32) N N The name of the job step.

UserName Varchar(255) N N The user name that created this job step and
derived as part of the Enterprise Server login
process.

MetaData Varchar(4096) N N Job step specific XML data

152 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-56 • AsJobStep Table Columns (cont.)

Column Type Key Nullable Description

Created Datetime N N The time when the job step was created.
Generated automatically.

Deleted_Flag Char(1) N N Not currently used.

Deleted Datetime N Y Not currently used.

Description Varchar(400) N N An extended description of the purpose of the


job step.

JobId_ Int N N Foreign key into the ASJob table indicating too
which job this job step is associated.

JobIOrder Int N N The ordinal number in which the job step is


executed when the job itself is executed.

StepId_ Int N N Foreign key into the AsJobStepMaster table


which identifies the type of job.

Workflow Manager Tables


Information on Workflow Manager tables is provided in this section to assist you in writing queries to retrieve
Workflow Manager data. This section includes a Workflow Manager database table schema diagram, as well as
column information on each table.

Table 4-57 • Workflow Manager Tables

Table Name Description

Workflow Manager Database Diagram that illustrates the relationship between the Workflow Manager
Table Schema Diagram tables.

AMS_Application Table Stores information about Application Requests.

AMS_ApplicationItem Table Stores information about each Data Group, Data Element, Workflow
Phase and step that make an Application Request.

AMS_Person Table Stores information about the Users who can access Workflow Manager.

AMS_ApplicationStatus Table Stores information about the Application Request Statuses in Workflow
Manager.

AMS_RelatedApplications Table Stores information about related applications.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 153


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-57 • Workflow Manager Tables

Table Name Description

AMS_Issues Table Stores all the issues and their properties.

AMS_AuditTrail Table Stores audit information of Application Requests.

AMS_Contracts Table Stores Project related information.

Workflow Manager Database Table Schema Diagram

The following diagram illustrates the relationship between Workflow Manager tables:

154 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Figure 4-23: Workflow Manager Database Table Schema Diagram

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 155


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

AMS_Application Table

This table stores the information about the Application Requests created in Workflow Manager. Some of the
columns that can help you retrieve information are listed in the following table.

Table 4-58 • AMS_Application Table Column Information

Column Description

ApplicationID Primary Key of this table.

ApplicationLName This column stores the name of the Application Request created by Customer or
Servicer.

ContractID Each Application is tied with a Project. This column stores the Project ID of the
Project with which this application is tied with. More Information about this
Project can be found from AMS_Contracts table using this Project ID.

UploadDate This column stores the date and time when this Application Request was
created.

UploadBy This column stores the Person ID of the user who created this Application
Request. More information about this user can be found from AMS_Person
table using this Person ID.

DueDate This column stores the Date & Time by which this application should be
completed.

StatusSummary This column show the status of this Application Request. Following table show
the status of the application based on the value in this column.

• 0—Data Entry Phase


• 10—Workflow Phase
• 20—Acceptance Phase
• 30—Final Phase
• 90—Completed
• 40—AdminStudio Step
• 1010—Merge Workflow Step (used internally)

CurrentWFMajorItemID The value in this column indicates which Workflow Phase is currently being
executed for this Application Request. User can find further information about
this Workflow Phase from ams_wfmajorItemtpl table.

CurrentWFMinorItemID The value in this column indicates which Workflow Step is being executed for
this Application Request. User can find further information about this Workflow
Step from ams_wfminorItemTpl table.

156 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-58 • AMS_Application Table Column Information (cont.)

Column Description

TemplateID This column stores the Template ID of the Template that used to create the
Workflow of this Application Request. More Information about this Template can
be found from AMS_Templates table using this Template ID.

ApplicationEndDate This column stores the actual Date and Time when this Application Request was
completed.

AppStatusID This column is a foreign key from AMS_ApplicationStatus table and reflects
the status of the Application. Status of the Application can be Active or Inactive
by default and user can create additional statuses.

AMS_ApplicationItem Table

This table stores the information about each Data Group, Data Element, Workflow Phase and step that make an
Application Request. Information like who completed a Workflow Step, when was it completed, is the data has
been accepted by the Servicer, Total time spent on a step can be found in this table.

Table 4-59 • AMS_ApplicationItem Table Column Information

Column Description

ApplicationItemID Primary key of this table

ApplicationID This value in this column indicates the Application that this Item belongs to. User
can find further information about this application from AMS_Application table.

MajorMinorType The value in this table indicates if the Item is a Workflow Phase (Major) or Workflow
Step (Minor). Value of 1 in this column indicates Workflow Phase and value of 2 in
this column indicates Workflow Step. In both the cases value in DataWFType will
remain 2.

DataWFType The value of 1 in this column indicates that this Application Item is either a Data
Group or Data Element. If a value of 1 also exists in the MajorMinorType column,
then the Application Item is a Data Group. If a value of 2 exists in the
MajorMinorType column, then this Application Item is a Data Element.

CreateDate This column indicates the Date and Time when this Application Item was created.

UpdatedBySubmit This column contains the Person ID of the user who submitted a given Data Group
or data Element.

LastUpdateSubmit This column contains the Date & Time of when a Data Group or Data Element was
submitted.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 157


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-59 • AMS_ApplicationItem Table Column Information (cont.)

Column Description

UpdatedByAccept This column contains the Person ID of the user who accepts the data submitted by
the Customer.

LastUpdateAccept This column contains the Date & Time of when the Data Submitted by the Customer
was accepted by the Servicer.

AMS_Person Table

This table stores information about the Users who can access Workflow Manager. This table can store Workflow
Manager database users and Directory Services Users/Groups.

Table 4-60 • AMS_Person Table Column Information

Column Description

PersonID Primary key of this table

CompanyID This column stores the ID of the company where this user belongs. More information
about the Company can be found from AMS_Company table.

FName This column contains the First Name of the User

LName This column contains the Last Name of the User

UserName The value in this column is used to login into Workflow Manager. For LDAP users, this
value is LDAP User Names (such as NT User name for Active Directory) and for
Workflow Manager database Users the username is in email format.

Email This column stores the email address of the user. This email address is used for
sending notifications. If this column is empty then no emails are sent to this user.

Disabled The value in this column indicates if the user is enabled or disabled. If the value is 1
then user is disabled. A user who is disabled cannot login into Workflow Manager.

DistinguishedName This column is empty for non LDAP users. For users added through LDAP this is a
unique value that can help identify the user in LDAP server quickly.

158 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

AMS_ApplicationStatus Table

By default, Workflow Manager comes with two default Application statuses: Active and Inactive. However, you
can create additional statuses such as Closed, Canceled, and so on. The AMS_ApplicationStatus table stores
the information about the Application Statuses in Workflow Manager. This status is then used by Application
Requests in Workflow Manager.

Table 4-61 • AMS_ApplicationStatus Table Column Information

Column Description

StatusID Primary Key of this table

Status_Text Name of the Status (such as Completed)

IsActive If the value of this column is 1 then any application with this status is considered as Active
and will be displayed in Workflow Manager UI. If the value of this column is 0 then Workflow
Manager will not display this Application Request in Workflow Manager UI.

AMS_RelatedApplications Table

One Application can be related to one or more Applications. These applications might be duplicate or might
accomplish the same goal. Workflow Manager stores the information of the related applications in
AMS_RelatedApplications table.

Table 4-62 • AMS_RelatedApplications Table Column Information

Column Information

ApplicationID This column stores the ID of the Application that maybe related with one or more
Applications.

Related_ApplicationID This column stores the ID of Related Application. More information about
Application can be found from AMS_Application table.

AMS_Issues Table

This table stores all the issues and their properties.

Table 4-63 • AMS_Issues Table Column Information

Column Description

IssueID This Column stores the primary key for the Issue Table and each issue can be uniquely
identified by this number.

IssueAbstract This stores the Inline description/Abstract of the issue.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 159


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-63 • AMS_Issues Table Column Information (cont.)

Column Description

IssueText This stores the detail information about the issue.

IssueType This is an integer value which stores the type of the issue. An issue can be of various
types as follows:

User Created Issues

• 1—Issue is only shared between Service Company users.


• 2—General type of issue for Customers.
• 3—General type of issue for Servicers.
• 7—When user responds to any issue, a new issue is created of this issue type.
• 8—Critical Issue: This will block the Workflow progress and requires special
permission to create or close it.

System Generated Issues

There are also some system generated issues. They are as follows:

• 4—When Update History step is completed in Workflow.


• 5—When Data submitted is rejected by the Service Company user.
• 6—When any Workflow Step is rolled back.

Status This column stores the status of the issue as integer values , they are as follows:

• 0—New Created Issue which are not read.


• 1—Issue is already read.
• 2—Issue is already responded.
• 3—Issue is closed.

ApplicationID This column stores the ID of the Application for which the issue is created. This ID can be
used as join in AMS_Application table which will give information about the Application
for the issue.

CreatedBy This column stores the ID for the User who has created the issue. This ID is
AMS_Person table primary key; hence this ID can be used as join in AMS_Person
table to get more information about the user who created the issue.

CreateDate This column stores the date and time (format: MM/DD/YYYY HH:MM:SS AM/PM) when
the issue was created.

ReadBy This column stores the ID for the User who has read the issue last (most current). This ID
is AMS_Person table primary key; hence this ID can be used as join in AMS_Person
table to get more information about the user who read the issue.

160 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-63 • AMS_Issues Table Column Information (cont.)

Column Description

ReadDate This column stores the date and time (format: MM/DD/YYYY HH:MM:SS AM/PM) when
the issue was last read.

ClosedBy This column stores the ID for the User who has closed the issue. This ID is
AMS_Person table primary key; hence this ID can be used as join in AMS_Person
table to get more information about the user who closed the issue.

CloseDate This column stores the date and time when the issue was closed, using the following
format:

MM/DD/YYYY HH:MM:SS AM/PM

OriginalIssueID This column stores the IssueID (primary identifier for an issue) for the original issue of a
responded issue.

WFMajorItemId This column stores the ID of the Workflow Phase (major Workflow item) that the issue
was created for. This ID is the AMS_WFMajorItemTpl table primary key; hence this ID
can be used as join in AMS_WFMajorItemTpl table to get more information about this
Workflow Phase.

WFMinorItemId This column stores the ID of the Workflow Step that the issue was created for. This ID is
the AMS_WFMinorItemTpl table primary key; hence this ID can be used as join in
AMS_WFMinorItemTpl table to get more information about this Workflow Step.

AMS_AuditTrail Table

This table stores the audit information of an active Application Request and its data.

Table 4-64 • AMS_AuditTrail Table Column Information

Column Description

AuditTrailID Each new entry made in this table stores a unique GUID in this column. This is the primary
key for the AMS_AuditTrail Table.

AuditTypeCode This column contains values that indicate the events which generate an entry to the
AuditTrail table. For a list of all of these values, see AuditTypeCode Column Values in the
AMS_AuditTrail_Table

AuditTable Stores the name of the Workflow Manager table that was audited.

AuditField Stores the name of the column in the table that was audited.

AuditTablePK Stores the primary key information of the table that was audited.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 161


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-64 • AMS_AuditTrail Table Column Information (cont.)

Column Description

ApplicationID This column stores the ID of the Application for which the Audit information was created.
This ID can be used as join in AMS_Application table which will give information about
the Application for the issue.

IssueID This column stores the ID of the Issue for which the Audit information was created, if any
related issue was also created for the same audit. This ID can be used as join in
AMS_Issues table which will give information about the issue.

ChangedDate This column stores the date and time (format: MM/DD/YYYY HH:MM:SS AM/PM) when the
audit was created.

ChangedBy This column stores the ID for the User whose actions created the audit. This ID is
AMS_Person table primary key; hence this ID can be used as join in AMS_Person table
to get more information about the user.

OldValue This column stores the old data information of a data item of the active application
Workflow, whose value is changed.

NewValue This column stores the new data information of a data item of the active application
Workflow, whose value is changed.

IterationCount This gives the number of iteration an active application Workflow has been through. The
value starts from 1 and increases with each rollback of the active application.

Comment This column stores any comments for the audit (either system generated or entered by
user).

162 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

AuditTypeCode Column Values in the AMS_AuditTrail_Table


This column contains the following values:

Table 4-65 • AuditTypeCode Values in the AMS_AuditTrail Table

Code Description

100 / WFStep_Complete When Workflow Step is completed for an active Application Request.

101 / WFStepRollback_User When a Workflow Step is rolled back by a user.

102 / WFStepRollback_System When a Workflow Step is rolled back by the system.

110 / WFStep_Cancel When a Workflow Step is cancelled before completion.

201 / EmailIssue When an email issue (general issue type) is created by user.

202 / EmailWFRollback When email is sent to user for Workflow Step rollback.

203 / EmailDataUnlockOrReject When email is sent to user for Data reject in Workflow Data Entry Step.

204 / EmailWFAdvance When email is sent to user for Workflow Step advancement.

205 / EmailIssueRespond When any issue is responded.

291 / DataSubmit_Begin User opens data submission screen and begins entering data.

292 / DataAccept_Begin User clicks Submit to submit requested data.

300 / DataChange When data change is done in Data Entry step in Workflow.

301 / DataSubmit_Complete When data submit is done any step in Workflow.

302 / DataAccept_Complete When data acceptance is done in Data Entry step in Workflow.

303 / DataUnlock When data unlock is done in data entry step in Workflow. (This error
code only used in versions previous to AMS 2.5.)

304 / DataReject When data rejection is done in Data Entry step in Workflow.

305 / AppNameChange When Application Request name change is done.

306 / DataEdit When an active Application Request Workflow Step is edited.

312 / DataAccept_Cancel When a Data Acceptance step is cancelled before completion.

400 / SLA_Start Indicates the start of an Application Request’s recorded SLA period.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 163


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-65 • AuditTypeCode Values in the AMS_AuditTrail Table (cont.)

Code Description

401 / SLA_Stop Marks the completion of an Application Request, indicating the end of
its recorded SLA period. Using codes 401 and 402, you can determine
an Application Request’s elapsed SLA time.

500 / WFPhase_Begin When a Workflow Phase is started.

501 / WFPhase_Complete When the last step of a Workflow Phase has been completed.

502 / WFPhase_Cancel When a user cancels a Workflow Phase.

600 / UserManagement When user management activity occurs.

700 / WorkAssignment When a work assignment is made.

AMS_Contracts Table

This table stores the audit information of the live Application and its data.

Table 4-66 • AMS_Contracts Table Column Information

Column Description

ContractID This column stores the primary key value for this table which can identify each
contract (project) uniquely.

ContractName This column stores the name of the contract (project).

StartDate This Date is start day for the project.

EndDate This column stores the end date for the project/contract.

Disabled This column stores the status of the project:

0—Active

1—Inactive.

IncludeWeekends This column stores the default value for all the Application created from this
project , whether weekends will be included in calculation of due date.

DefaultDuePeriod This column stores the default due period value for all the Application created
from this project.

DefaultRiskPeriod This column stores the default Risk period value for all the Application created
from this project.

164 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

Table 4-66 • AMS_Contracts Table Column Information (cont.)

Column Description

RequestPrefix This column stores the Request Prefix value for all the Application created from
this project.

CompanyID CompanyID column stores the ID of the company for the project. More
information about the Company can be found from AMS_Company table.

TemplateID This column stores the Template ID of the Template that used to create the
Workflow for the Application Request created from this project. More
Information about this Template can be found from AMS_Templates table
using this Template ID.

DeploymentTemplateID This column stores the Template ID of the Deployment Template that used to
create the Deployment Workflow for the Application Request created from this
project. More Information about this Template can be found from
AMS_Templates table using this Template ID.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 165


Chapter 4: Generating and Viewing Reports in Report Center
Report Center Reference

166 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


5
Automating Tasks Using
Job Manager

Edition • Job Manager is included with AdminStudio Enterprise Edition.

You can use Job Manager to automate time consuming tasks such as package import, validation, conflict analysis,
and conflict resolution. With Job Manager, you can schedule these tasks to run automatically at scheduled times,
perhaps when system availability is highest. This enables your organization to increase the efficiency of your
packaging process and to enforce standardized business practices.

Table 5-1 • Job Manager User Documentation

Section Description

About Job Manager Describes the purpose of Job Manager, and the types of tasks that you can
automate.

Directory Monitoring Describes how the Directory Monitoring Job Step can be included in both
and Job Manager Template Jobs and Custom Jobs to examine a specified directory for new or
modified packages and then to automatically import or reimport those packages
into the Application Catalog.

Managing Jobs Explains how to create a new job, reschedule a job, set email alerts for a job, and
view job status.

Managing Templates Explains how to create and edit Job Templates.

Setting Job Manager Explains how to set import, validation, and detection options.
Conflict Detection
Options

Managing Jobs Using Explains how to use Job Manager Engine to manage jobs from multiple
Job Manager Engine Application Catalogs.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 167


Chapter 5: Automating Tasks Using Job Manager
About Job Manager

Table 5-1 • Job Manager User Documentation (cont.)

Section Description

Job Manager Reference Provides detailed information on all of the Job Manager pages.

About Job Manager


You can use Job Manager to automate time consuming tasks such as package import, validation, conflict analysis,
and conflict resolution. Job Manager provides:

• Increased efficiency—With Job Manager, you can schedule common tasks—such as package import,
conflict analysis, and conflict resolution—to run automatically at scheduled times (such as when system
availability is highest), and no human intervention is required.

• Enforcement of consistent business practices—Job Manager enables organizations to enforce


consistent business practices in the deployment preparation process. It allows you to perform the exact same
series of steps on any package before it is deployed in your enterprise, such as checking against specific ICE
or ACE rules, and against a specific operating system.

• Dynamic group content identification—You can create a Job that will perform actions on whatever
packages are in a selected group at the time the Job is executed. You can schedule a reoccurring Job to
automatically perform actions on the exact contents of a group without ever having to select any packages or
create any new Jobs. This allows you to enforce consistent business practices on a group’s contents even as
the content changes.

This section includes the following topics:

• Job Steps: Tasks You Can Automate

• Template Jobs vs. Custom Jobs

• Selecting Contextual Packages in a Custom Job

• Dynamic Group Content Identification

• Conflict Resolution and the Software Repository

• User Permissions and Job Manager

168 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
About Job Manager

Job Steps: Tasks You Can Automate


Jobs are comprised of one or more Job Steps. The following Job Step Types are available:

Table 5-2 • Job Manager Step Types

Task Description

Scan for The Scan for Dependencies Job Step analyzes a Windows Installer package for
Dependencie dependent files. This information is used primarily to enhance the quality of any future Patch
s Impact Analysis operation that may be performed on this package.

Directory You can use the Directory Monitoring Job Step to establish a consistent, repeatable
Monitoring process in which a directory and, optionally, its subdirectories are monitored for any new or
modified Windows Installer package files, and if changes are detected, those new or
modified files are then either imported or reimported into the Application Catalog. See About
Automatically Importing Packages from a Network Directory for more information.

Validation The Validation Job Step verifies the internal data integrity of a Windows installer package.

Conflict The Conflict Detection Job Step performs conflict detection against selected packages.
Detection

Import The Import Job Step imports a specified package (of any package type except Merge
Modules) into the Application Catalog. An Import Job Step can only be included in a
Custom Job, not a Job based on a Template.

Best Practice The Best Practice ACEs Job Step operates against a single package to enforce Microsoft
Detection Windows Installer standards.

Resolution The Resolution Job Step performs automatic conflict resolution on one Windows Installer
package or a set of packages. To configure the Resolution Job Step, you first select the
packages to perform conflict resolution on, and then you select at least one resolution.

About Automatically Importing Packages from a Network Directory


In AdminStudio Application Manager, you can use the Network Directory option of Package Auto Import to
monitor a directory location on a network (or a local directory) and automatically import or re-import packages in
that directory at scheduled intervals.

You can use this Network Directory option in combination with the Directory Monitoring Job Step to establish
a consistent, repeatable process in which a directory and, optionally, its subdirectories are monitored for any new
or modified Windows Installer package files. If changes are detected, those new or modified files can then be either
imported or reimported into the Application Catalog.

Note • For more information, see Automatically Importing Packages from a Network Directory.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 169


Chapter 5: Automating Tasks Using Job Manager
About Job Manager

Template Jobs vs. Custom Jobs


When you create a new Job, you can either base it on an existing Template that has pre-defined Job Steps, or build
a Custom Job by choosing which Job Steps you want to perform and in what order. Each type of Job serves a
particular purpose and provides certain benefits.

Template Jobs
Creating Jobs based on pre-defined Templates enables an organization to enforce consistent business practices.
System Administrators can create a Template to define a series of Job Steps that they always want performed on a
certain type of package before it is deployed. Then, when a package that falls into that category needs to be
prepared for deployment, a Job based on that Template can be created and run.

For example, if all users of a specific department of an organization use the same disk image (Operating System
and set of applications), all packages that are distributed in that department would need to have conflict analysis
performed against that OS Snapshot and those target applications. The System Administrator could create a
Template that uses those specific target applications, and could include very specific ICE and ACE rules in the
conflict analysis, based upon requirements specific to that target environment.

In Template Jobs:

• Target packages are selected when a Template is created.

• Source packages are selected when a Job based on a Template is created.

• An Import Job Step cannot be included.

• A Directory Monitoring Job Step can be included to examine the specified directory for new or modified
packages and then automatically import or reimport those packages into the Application Catalog. This is
equivalent to using the Application Manager Package Auto Import Wizard to automatically import packages
from a network directory. However, subsequent Job Steps cannot perform any actions on packages imported
or reimported as part of a Directory Monitoring Job Step.

Note • See About Automatically Importing Packages from a Network Directory for more information.

Custom Jobs
When creating a new Custom Job, you can include only the Job Steps that you want to perform, in the order you
want to perform them, using the source and target packages that you select when you create the Job. In Custom
Jobs:

• Both Source and Target packages are selected when the Custom Job is created.

• An Import or Directory Monitoring Job Step can be included, and you can use packages imported as
part of those steps as Source packages in subsequent Job Steps.

Because you can insert an Import or Directory Monitoring Job Step, a Custom Job is well-suited to automate a
bulk import process.

170 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
About Job Manager

Selecting Contextual Packages in a Custom Job


When defining a Custom Job, the packages that you import in prior Import or Directory Monitoring Job Steps
are available for selection as source or target packages when defining operations in subsequent Job Steps.

The packages that will be imported in an Import or Directory Monitoring Job Step are selected when the Job is
executed, not when the Job Step is defined, so the names of those packages are unknown.

Therefore to make these imported packages available for selection when defining subsequent Job Steps, they are
listed in the Contextual Packages group in the package tree and are referred to in context of their associated
import step, such as Job Step n, where n is the number of the Job Step that performed the import.

Figure 5-1: Contextual Packages Group

Dynamic Group Content Identification


You can create a Custom or Template Job that will perform actions on whatever packages are in a selected group
at the time the Job is executed.

Therefore, you can schedule a reoccurring Job to automatically perform actions on the exact contents of a group
without ever having to select any packages or create any new Jobs. This allows you to enforce consistent business
practices on a group’s contents even as the content changes.

For example, your organization could have a policy of importing all new packages into a specific group, such as a
New Products Group. You could then choose to schedule a Job to run each night that would automatically perform
conflict analysis and resolution using the packages in the New Products Group as the source packages and using
selected packages in the Application Catalog as the target packages. In the morning, you could quickly see the
current state of each package and continue the evaluation process.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 171


Chapter 5: Automating Tasks Using Job Manager
About Job Manager

Conflict Resolution and the Software Repository


If you include a Conflict Detection Job Step in a Job to identify conflicts, you can also include a Resolution Job
Step to automatically resolve the conflicts that have associated Conflict Application Resolution Definitions
(CARDs), and then reimport the modified package into the Application Catalog.

Resolution Behaviors
Because conflict resolution requires that the package be modified, if a package is stored in the Software
Repository and is currently checked-out by another user, it cannot be modified, and therefore cannot be resolved.
This resolution behavior is detailed in the following table.

Table 5-3 • Job Manager Resolution Behavior Regarding the Software Repository

Package State Resolution Behavior

Package in Software Job Manager ignores the resolution process for these packages. The packages
Repository / Checked are already being edited by someone else.
Out

Package in Software The package will be checked out by the virtual user Job Manager Engine prior
Repository / Not to the normal operation of the resolution process.
Checked Out

If the resolution process results in a no-operation or the user does not elect to re-
import the package, then the check-out operation will be cancelled.

Package Not in The resolution process will operate normally.


Software Repository

Re-Import Behaviors
When defining a Resolution Job Step, you have to indicate the reimport option for resolved packages. When
defining a Resolution Job Step, you have the choice of three re-import options for resolved packages: re-import
as a new version, re-import by overwriting the existing version, or do not re-import.

172 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Directory Monitoring and Job Manager

The choice you make depends upon whether the package is stored in the Software Repository:

Table 5-4 • Resolved Package Re-Import Options

Resolved Packages Re- Package Not in Software


import options Package in Software Repository Repository

As a new version Package will be re-imported and N/A


checked-in as a new version.
Package cannot be imported as a new
version unless it is in the Software
Repository.

By overwriting existing Package will be re-imported and Package will be re-imported, replacing
version checked-in, replacing the existing the original package.
version.

Do not import the Package will not be re-imported. Package will not be re-imported.
resolved packages

User Permissions and Job Manager


The list of Job Step types that are available for you to select when creating a Job is controlled by the permissions
of the Roles you are assigned to. For example, if you are not assigned to a Role that includes conflict resolution
permission, the Resolution Job Step will not be available for your selection.

You can obtain access to the complete list of Job Step types by being assigned to additional Roles or having the
Roles that you are assigned to modified to provide additional permissions.

Directory Monitoring and Job Manager


A Directory Monitoring Job Step can be included in both Template Jobs and Custom Jobs to examine a
specified directory for new or modified packages and then to automatically import or reimport those packages into
the Application Catalog. This is equivalent to using the Application Manager Package Auto Import Wizard to
automatically import packages from a network directory.

Note • See About Automatically Importing Packages from a Network Directory for more information.

However, the use of these imported packages varies between Template Jobs and Custom Jobs:

• Template Jobs can include a Directory Monitoring Job Step to import packages, but subsequent Job
Steps in that Job cannot perform any actions on any packages that are imported/reimported as part of that
Directory Monitoring Job Step.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 173


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs

• Custom Jobs can include a Directory Monitoring Job Step, and you can use packages imported as part of
that Directory Monitoring Job Step as source packages in subsequent Job Steps. See Selecting Contextual
Packages in a Custom Job.

Managing Jobs
This section explains how to create and submit Jobs for execution. Topics include how to create and edit Template
and Custom Jobs, reschedule a Job, set email alerts for a Job, and view Job status. The following topics are
included:

• Creating a New Job

• Editing an Existing Job

• Rescheduling a Job

• Setting Email Alerts

• Viewing Job Status

• Deleting a Job

Creating a New Job


When creating a new Job to execute, you have the choice of either creating a Job based on a Template or a new
Custom Job:

• Template Job—A Job based on a Template consists of a series of pre-defined Job Steps. See Creating a
New Job Based on a Template.

• Custom Job—Allows you to include only the Job Steps that you want to perform, in the order you want to
perform them, and using the source and target packages that you select. Custom Jobs can include the
Import Job Step, while Template Jobs cannot. See Creating a New Custom Job.

Creating a New Job Based on a Template


A Template Job consists of a series of pre-defined Job Steps that are performed on the package(s) or group(s) you
select from the Application Catalog.

To create a job based on a Template, perform the following steps.

Task: To create a Job based on a Template:

1. Login to AdminStudio Enterprise Server.

2. Click the Job Manager tab. The Jobs Queue page opens.

3. Click the Add button. The Add Job page opens with the Template option selected.

174 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs

4. From the Template list, select the appropriate Template.

5. In the Name field, enter a name for this job.

6. In the Package List tree, select the package(s) or group(s) that this Job will perform actions on. For example,
if you chose a Job Template named Scan_Dependencies_Template, select the packages that you want to
scan.

If you choose a group, this Job’s actions will be performed on all the packages in that group at the time the
Job is run. With this dynamic group content identification feature, you can schedule a reoccurring Job to
automatically perform actions on the exact contents of a group without ever having to select any packages or
create any new Jobs.

7. Schedule this Job by selecting one of the following options from the Execution list:

• Immediate—Execute this Job immediately.

• Scheduled—Execute this Job at the Date and Time selected.

Note • You can also choose to set this job to reoccur at a specified interval. See Rescheduling a Job

8. Click Save. The new Job is now listed on the Jobs Queue page and will be run at its scheduled time.

Creating a New Custom Job


When you create a Custom Job, you can include only the Job Steps that you want to perform, in the order you
want to perform them, and using the source and target packages that you select. Custom Jobs can include the
Import Job Step, while Template Jobs cannot.

To create a Custom Job, perform the following steps.

Task: To create a new Custom Job:

1. Login to AdminStudio Enterprise Server.

2. Click the Job Manager tab. The Jobs Queue page opens.

3. Click the Add button. The Add Job page opens with the Template option selected.

4. Enter a Name for this new job.

5. Clear the Template option. An empty Define Job Steps area opens.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 175


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs

6. Select one of the listed tasks from the Step Type list:

• Scan for Dependencies—Analyze a Windows Installer package for dependent files.

• Directory Monitoring—Use to establish a consistent, repeatable process in which a directory and,


optionally, its subdirectories are monitored for any new or modified Windows Installer package files, and if
any changes are detected, those new or modified files are then either imported or re-imported into the
Application Catalog.

• Validation—Verifies the internal data integrity of a Windows Installer package.

• Conflict Detection—Performs conflict detection on selected packages using Conflict ACE Rules

• Import—Import a selected package into the Application Catalog.

• Best Practice Detection—Performs conflict detection on a single package using Best Practice ACE
Rules to enforce Windows Installer standards.

• Resolution—Performs automatic conflict resolution on selected packages.

Each time you select a Step Type, you are prompted to specify additional information:

Step Type Required Selections

Scan for 1. Click Next. The Step 2 of 2 View opens.


Dependencies
2. Select the packages or groups of packages that you want to scan, and then
click Finish to save this Job Step.

176 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs

Step Type Required Selections

Directory Monitoring 1. Click Next. The Step 2 of 2 View opens.

2. In the Directory Name box, enter the UNC path of the directory that you
want to monitor.

3. Choose whether to Include subdirectories in the ‘Directory


Monitoring’ process.

4. Click Finish to save this Job Step.

Validation 1. Click Next. The Step 2 of 2 View opens.

2. Select the packages or groups of packages that you want to validate.

3. Click Finish to save this Job Step.

Conflict Detection 1. Click Next. The Step 2 of 4 vew opens.

2. Select the source packages or groups of packages that you want to include
in the conflict detection process, and then click Next. The Step 3 of 4 View
opens.

3. Select the target packages or groups of packages that you want to use in
the conflict detection process and click Next. The Step 4 of 4 View opens.

4. Select the set of Conflict ACE Rules that you want to include in the conflict
detection process and click Finish to save this Job Step.

Import 1. Click Next. The Step 2 of 4 View opens.

2. Select a package to import.

3. Specify whether to include the package in the Software Repository

4. Click Next. The Step 3 of 4 View opens.

5. Select any transform (.mst) or patch (.msp) files to import.

6. Click Next. The Step 4 of 4 View opens.

7. Select one or more destination groups into which the package will be
imported.

8. Click Finish to save this Job Step.

Best Practice 1. Click Next. The Step 2 of 2 View opens.


Detection
2. Select the packages or groups of packages that you want to perform Best
Practice conflict detection on.

3. Click Finish to save this Job Step.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 177


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs

Step Type Required Selections

Resolution 1. Click Next. The Step 2 of 3 View opens.

2. Select the packages or groups of packages that you want to perform


conflict resolution on, and then click Next. The Step 3 of 3 View opens.

3. Select the Conflict ACE Rules that you want to resolve automatically.

4. Select a Resolved packages re-import option. See Re-Import


Behaviors.

5. Click Finish to save this Job Step.

7. Each time you click Finish, the new Job Step is saved and you are prompted to add another Job Step.

8. Continue adding desired Job Steps by clicking Insert New Step.

9. If your Job includes Import or Directory Monitoring Job Steps, you can perform actions on those imported
or reimported packages in subsequent Job Steps. For example, if you add a Validation Job Step after an
Import or Directory Monitoring Job Step, you can choose to validate the newly imported/reimported
package or packages from the previous Steps.

To make these packages available for selection when defining subsequent Job Steps, they are listed in the
Contextual Packages group in the package tree and are referred to in context of their associated step, such
as Job Step n, where n is the number of the Job Step that performed the import.

178 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs

Note • During a Directory Monitoring Job Step, one or more packages in the monitored directory may be
imported or reimported into the Application Catalog. Therefore, if you select a Directory Monitoring Job Step
as a Source for a subsequent Job Step, that Step’s action will be performed on all of the newly imported or
reimported packages.

10. Schedule this Job by selecting one of the following options from the Execution list:

• Immediate—Execute this Job immediately.

• Scheduled—Execute this Job at the Date and Time selected.

Note • You can also choose to set this job to reoccur at a specified interval. See Rescheduling a Job

11. Click Save. The new Job is now listed on the Jobs Queue page and will be run at its scheduled time.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 179


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs

Editing an Existing Job


You can edit an existing Job by selecting the Job on the Jobs Queue page to open the Edit Job page. The
following information can be edited:

Table 5-5 • Editable Items in an Existing Job

Job Step Type Editable Items

General • Job Name


• Execution options
• Step Type

Scan for Dependencies Job • Selected packages and groups


Step

Directory Monitoring Job • Directory to monitor


Step • Option to monitor subdirectories

Validation Job Step • Selected packages and groups

Conflict Detection Job Step • Selected source packages and groups


• Selected target packages and groups
• Set of conflict detection rules to use during the conflict detection
process

Import Job Step • Package to import


• Software Repository option
• Transform (.mst) and Patch (.msp) files to include during import
• Destination group for imported package

Best Practice Detection Job • Selected packages and groups


Step

Resolution Job Step • Selected packages and groups


• Conflicts to resolve
• Resolved package re-import options

To edit an existing Job, perform the following steps:

Task: To edit an existing Job:

1. Login to AdminStudio Enterprise Server.

2. Click the Job Manager tab. The Jobs Queue page opens.

180 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs

3. Select the Job that you want to edit. The Edit Job page opens.

• Only one Job can be edited at a time.

• You cannot edit a Job with a Status of Running or Pending.

• You cannot change a Custom Job to a Template Job or vice versa.

4. Edit the Job following the instructions in Creating a New Job Based on a Template or Creating a New Custom
Job.

5. When you have finished editing the Job, click Save.

Rescheduling a Job
You can reschedule a completed Job so that it is run again. You can also reschedule Jobs that failed, were
cancelled, or are scheduled to be run in the future.

If a Job is in Scheduled, Complete, Failed, or Cancelled Status, open the Jobs Queue page and click the link
in the Schedule column for that Job. The Schedule Job page opens.

Task: To reschedule a job:

1. On the Jobs Queue page, click the date and time listed in the Schedule column for the Job you want to
reschedule. The Schedule Job page opens.

2. Select either For Immediate Execution or For Scheduled Execution.

• If you selected For Immediate Execution, click Save and your Job will be executed immediately.

• If you selected For Scheduled Execution, continue with step 4.

3. Click the calendar icon next to the Select Date field and select the date when you want the Job to be run.

4. In the Enter Time fields, select an hour of the day from the first list, select the minutes after the hour from the
second list, and select AM or PM from the third list.

5. If you want this Job to reoccur at a specified interval, set the Recurrence Interval option to Daily, Weekly, or
Monthly, and perform the following steps:

a. If you want this Job to reoccur a specific number of times, select the Number of Times option, and enter
a number in the box.

b. If you want this Job to reoccur until a specified expiration date, select the Expiration Date option, click
the calendar icon, and select a date from the calendar.

6. Click Save.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 181


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs

Setting Email Alerts


You can choose to send an email Alert when a Job is completed and when it fails. To do this, open the Jobs
Queue page, and click Add in the Alerts column for the Job that you want to set an alert for. You then can create
an email message on the Job Alerts page.

Tip • You can choose to send a Job alert upon both Job failure and Job success.

When composing the Subject line and the Message, you can also insert System Variables to instruct Job
Manager to automatically insert the variable data regarding that Job at runtime.

Task: To set email alerts:

1. On the Jobs Queue page, click Add in the Alerts column for the Job that you want to set an alert for. The
Job Alerts page opens.

2. From the Send the following e-mail alert when the job list, select fails or succeeds.

3. In the To field, enter the email addresses that you want to be notified when a Job is completed or when it fails.
Separate multiple email addresses with a semicolon (;).

4. In the Subject box, enter text to describe the purpose of the email. You can select System Variables from the
list so that the value of the variable for this Job is inserted when the email is sent.

5. In the Message box, enter the text of the message. You can select System Variables from the list so that the
value of the variable for this Job is inserted when the email is sent.

6. Click Save.

System Variables
The following system variables are available to use in email alerts:

Table 5-6 • System Variables Available to Use in Email Alerts

Variable Description

QueueName Name of Job.

LastAction The last Job Step that was completed for this Job. If a Job’s status is Running,
this is the Job Step that is currently being executed. If a Job’s status is
Complete, this is the last Job Step of the Job. If a Job Failed, this is the Job Step
that was running when the failure occurred.

CompletionTime Time job was completed.

UserName Person who submitted the Job.

182 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs

Table 5-6 • System Variables Available to Use in Email Alerts

Variable Description

JobName Name of Template.

JobType Number of Job Steps defined in the Template.

Description Description that was entered to identify the Template.

ProductVersion MSI specific property from package.

ProductName MSI specific property from package.

Manufacturer MSI specific property from package.

ProductLanguage MSI specific property from package.

FileName Base file path (either “Managed from the Software Repository” or appropriate
path).

Comments Product comments.

ImportDate Date package was imported into the Application Catalog.

DisplayedProductName Product name as displayed in Application Manager/ConflictSolver.

OriginalMsiFileName Name of .msi file that was imported into the Application Catalog.

OriginalPackageLocation Location of the original .msi file at the time it was imported into the Application
Catalog.

Viewing Job Status


On the Jobs Queue page, a Job’s current status is listed as a hyperlink in the Status column. If you click on this
hyperlink, the Job Status page opens, displaying the Job Name, the Job Status, and the status of each of the Job
Steps in that job.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 183


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs

The possible statuses are:

• Scheduled—Job is scheduled to be executed at a future date and time.

• Running—Job is currently being run. Only one job per Application Catalog connection will ever be running at
one time.

• Pending—Job is available to run but is waiting for the running job to complete. A job set for immediate
execution will be automatically assigned a Pending job status.

• Complete—Job has been executed.

• Canceled—Job was canceled before it was executed or before its execution was complete.

• Failed—Job was unable to run either because of a software error, a network communication problem, a
hardware failure, or any other reason.

Deleting a Job
You can delete a Job by opening the Jobs Queue page and clicking Delete in the Action column of the Job you
want to delete.

Note • Deleting a Template Job in no way effects the Job Template that it was based on.

Task: To delete a Job:

1. Login to AdminStudio Enterprise Server.

2. Click the Job Manager tab. The Jobs Queue page opens.

3. Click Delete in the Action column of the Job that you want to delete. The Delete Job page opens and you
are prompted to confirm the deletion.

Note • You cannot delete a Job with a Status of Running.

184 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Managing Templates

4. Click Delete. The Job is no longer listed on the Jobs Queue page.

Managing Templates
Creating Jobs based on pre-defined Templates enables an organization to enforce consistent business practices.
System Administrators can create a Template to define a series of Job Steps that they always want performed on a
certain type of package before it is deployed. Then, when a package that falls into that category needs to be
prepared for deployment, a Job based on that Template can be created and run.

For example, if all users of a specific department of an organization use the same disk image (Operating System
and set of applications), all packages that are distributed in that department would need to have conflict analysis
performed against that OS Snapshot and those target applications. The System Administrator could create a
Template that uses those specific target applications, and could include very specific ICE and ACE rules in the
conflict analysis, based upon requirements specific to that target environment.

This section includes the following topics:

• Source and Target Packages in Template Jobs vs. Custom Jobs

• Creating a New Template

• Editing an Existing Template

• Deleting a Template

Source and Target Packages in Template Jobs vs.


Custom Jobs
The selection of source and target packages in a Template Job differs from how source and target packages are
selected in Custom Jobs.

For Template Jobs:

• Target packages are selected when a Template is created.

• Source packages are selected when a Job based on a Template is created.

• An Import Job Step cannot be included. All actions must be performed on packages that have already
been imported into the Application Catalog.

For Custom Jobs:

• Both Source and Target packages are selected when the Custom Job is created.

• An Import Job Step can be included, and you can use newly imported packages as Source packages in
subsequent Job Steps.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 185


Chapter 5: Automating Tasks Using Job Manager
Managing Templates

Creating a New Template


You create a Template much like the steps described in Creating a New Custom Job, except:

• You do not Schedule a Template

• You do not set Alerts for a Template

• You cannot include an Import Job Step in a Template.

You create Templates on the Manage Templates tab. The Job Template List page lists all defined Templates.
From this page, you can Add a new Template, Edit an existing Template, or Delete a Template.

Task: To create a new Template:

1. Login to AdminStudio Enterprise Server.

2. Click the Job Manager tab. The Jobs Queue page opens.

3. Click the Manage Templates subtab. The Job Template List page opens.

4. Click the Add button. The Add Template page opens, displaying an empty Define Job Steps area.

5. Enter a Name for this new Template.

6. Enter a Description to define the purpose of this new Template.

7. Select one of the listed tasks from the Step Type list:

186 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Managing Templates

• Scan for Dependencies—Analyze a Windows Installer package for dependent files.

• Directory Monitoring—Use to establish a consistent, repeatable process in which a directory and,


optionally, its subdirectories are monitored for any new or modified Windows Installer package files, and if
any changes are detected, those new or modified files are then either imported or re-imported into the
Application Catalog.

• Validation—Verifies the internal data integrity of a Windows Installer package.

• Conflict Detection—Performs conflict detection on selected packages using Conflict ACE Rules

• Best Practice Detection—Performs conflict detection on a single package using Best Practice ACE
Rules to enforce Windows Installer standards.

• Resolution—Performs automatic conflict resolution on selected packages.

After you select a Step Type, you may be prompted to specify additional information. Make the required
selections, as listed in the following table, and click Finish to save the Step.

Step Type Required Selections

Scan for Click Next to save this Job Step. (Source packages will be selected when a Job
Dependencies based on this Template is created.)

Directory Monitoring 1. Click Next. The Step 2 of 2 view opens.

2. In the Directory Name box, enter the UNC path of the directory that you
want to monitor.

3. Choose whether to Include subdirectories in the ‘Directory


Monitoring’ process.

4. Click Finish to save this Job Step.

Validation Click Next to save this Job Step. (Source packages will be selected when a Job
based on this Template is created.)

Conflict Detection 1. Click Next. The Step 2 of 3 view opens.

2. Select the target packages or groups of packages that you want to use in
the conflict detection process and click Next. The Step 3 of 3 view opens.

3. Select the set of Conflict ACE Rules that you want to include in the conflict
detection process and click Finish to save this Job Step.

Best Practice Click Next to save this Job Step. (Source packages will be selected when a Job
Detection based on this Template is created.)

Resolution 1. Click Next. The Step 2 of 2 view opens.

2. Select the Conflict ACE Rules that you want to resolve automatically.

3. Select a Resolved packages re-import option. See Re-Import Behaviors.

4. Click Finish to save this Job Step.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 187


Chapter 5: Automating Tasks Using Job Manager
Managing Templates

8. Each time you click Finish, the new Job Step is saved and you are prompted to add another Job Step.

9. Continue adding desired Job Steps.

10. When you have finished adding Job Steps, click Save. The Template is now listed on the Job Template List
page and in the Template list on the Add Job page.

Editing an Existing Template


You can edit an existing Template by selecting the Template on the Job Template List page to open the Edit
Template page.

Task: To edit an existing Template:

1. Login to AdminStudio Enterprise Server.

2. Click the Job Manager tab. The Jobs Queue page opens.

3. Click the Manage Templates tab. The

4. Select the Template you want to edit. The Edit Template page opens.

Note • Only one Template can be edited at a time.

5. Edit the Template following the instructions in Creating a New Template.

6. When you have finished editing the Template, click Save.

188 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Setting Job Manager Conflict Detection Options

Deleting a Template
You can delete a Template by opening the Job Template List page and clicking Delete in the Action column of
the Template you want to delete.

Only Templates which are not in use are allowed to be deleted.

• A Template is considered in use as long as a Template Job associated with the Template exists.

• If a Template Job associated with this Template is scheduled to be run in the future or if it is already completed,
you will not be permitted to delete the Template.

Task: To delete a Template:

1. Login to AdminStudio Enterprise Server.

2. Click the Job Manager tab. The Jobs Queue page opens.

3. Click the Manage Templates tab. The Job Template List page opens.

4. Click Delete in the Action column of the Template that you want to delete. The Delete Template page
opens, prompting you to confirm the deletion.

5. Click Delete. The Template is no longer listed on the Job Template List page.

Setting Job Manager Conflict Detection


Options
You select the rules that you want Job Manager to use by default during conflict detection on the Conflict
Detection Options page of the Configuration tab.

Note • By setting these Conflict Detection options, you are only setting the defaults for the Conflict Detection Job
Step in a Job. When you are defining the Conflict Detection Job Step, you can change these selections.

Task: To set Detection options:

1. Login to AdminStudio Enterprise Server.

2. Click the Job Manager tab. The Jobs Queue page opens.

3. Click the Configuration subtab. The Conflict Detection Options page opens.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 189


Chapter 5: Automating Tasks Using Job Manager
Setting Job Manager Conflict Detection Options

4. In the Conflict Types tree, select the check box for ACE rules that you want to be performed during conflict
identification. Conflict rules (ACEs) associated with unselected boxes will not be performed during conflict
identification. The following rules are available:

Category ACEs

Components • ACE30—A check for KeyPath conflicts across components.


• ACE02—Check destination directories for identical components.
• ACE09—Check for different merge module versions.

File Extensions • ACE17—Confirm that file extensions exist in only one component.

Files • ACE23—Identifies file duplication between source and target packages.


• ACE12—Checks for components that contain files that can be replaced by one
of the merge modules that you have imported into the Application Catalog
database.
• ACE08—identifies components with identical ComponentIds, and checks those
components to see if the versions of the files in each component match.
• ACE07—Checks for the existence of the same file in components with different
ComponentIds.
• ACE03—Checks to see if components in different packages that have matching
ComponentIds also contain the same files.

INI Files • ACE22—Checks file name/target directory pairs in the File table to see if they
conflict with similar entries in the IniFile table.
• ACE21—Checks entries in the IniFile table to see if they conflict with similar
entries in the File table.
• ACE14—Checks for the existence of components with different ComponentIds
that modify the same INI file entry, such as the [File Name/Section/Key/Value]
entry.

NT Services • ACE16—Checks for the existence of identical NT Services in components with


different ComponentIds.

ODBC Resources • ACE15—Checks for the existence of identical ODBC entries in components
with different ComponentIds.

Product • ACE20—Checks the Upgrade Code to see if it is unique.


Properties • ACE19—Checks the Product Code to see if it is unique.
• ACE18—Checks the Package Code to see if it is unique.

Registry • ACE24—Checks to see if registry entries with the same registry hive, key, and
value name have the same data type and value.
• ACE10—Checks for the existence of identical Root/Key/Name registry
combinations in components with different ComponentIds.

190 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs Using Job Manager Engine

Category ACEs

Shortcuts • ACE13—Checks for the existence of the same shortcut within different
packages in components with different ComponentIds.

Windows • WST01—Checks to see if the ALLUSERS property is defined.


Terminal Server • WST02—Checks for any registry entries installed to per-user specific locations.
Validation
• WST03—Checks for any file entries installed to per-user specific locations.
• WST04—Checks for any ODBC data source entries installed to per-user
specific locations.
• WST05—Checks for any environment strings installed to per-user specific
locations.

5. Click Save.

Managing Jobs Using Job Manager Engine


Job Manager Engine executes the Jobs created with Job Manager. Job Manager Engine can connect to any of the
Application Catalogs in your network and allow you to configure how the engine operates and manage the state of
any particular Application Catalog.

This section includes the following topics:

• About Job Manager Engine

• Opening the Job Manager Engine User Interface

• Adding an Application Catalog

• Deleting a Connection to an Application Catalog

• Executing Jobs

• Pausing, Shutting Down, and Restarting Application Catalog Jobs

• Setting Configuration Options

About Job Manager Engine


The Job Manager Engine’s Manage Application Catalogs View lists the Catalog Name of each of the
Application Catalogs that it is connected to, the Status (Running, Pending, Paused) of each Application Catalog,
and the # of Jobs from that Application Catalog that are currently running or waiting to run.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 191


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs Using Job Manager Engine

Opening the Job Manager Engine User Interface


In order to execute jobs, Job Manager Engine needs to be running somewhere in the network. Because Jobs are
often scheduled to be run overnight, Job Manager Engine usually needs to be running continuously. There are two
ways to launch Job Manager Engine:

• Launch at startup—The first time that Job Manager Engine launches, you are prompted to select whether
you want to automatically launch Job Manager Engine at startup. If you choose this option, Job Manager
Engine launches, but then is automatically minimized, and its icon is shown in the Windows system tray.

• Select shortcut on Start menu—You can open Job Manager Engine by selecting it from the AdminStudio
9.5 Tools subfolder on the Start menu. However, when it is launched, it is still automatically minimized, and its
icon is shown in the Windows system tray.

If you want to view the Job Manager Engine interface, click on the Job Manager Engine system tray icon. The
Manage Application Catalogs View of the Job Manager Engine opens.

For more information on the Job Manager Engine interface, see Job Manager Engine.

Note • While everyone who installs AdminStudio Enterprise Server gets the Job Manager Engine, only one Job
Manager Engine can be connected at any one time to any one Application Catalog.

Adding an Application Catalog


To add an Application Catalog to Job Manager Engine, perform the following steps.

Task: To add an Application Catalog to Job Manager Engine:

1. Open Job Manager Engine.

2. On the Manage Application Catalogs View, click the Add button. The Select Application Catalog dialog box
opens.

Deleting a Connection to an Application Catalog


When you delete an Application Catalog from Job Manager Engine, it will first shut down the Application Catalog,
allowing any currently executing Job Steps to complete. Therefore, this operation may take some time to
complete.

192 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs Using Job Manager Engine

Task: To delete the connection of Job Manager Engine to an Application Catalog

1. Open Job Manager Engine.

2. On the Manage Application Catalogs View, select the Application Catalog that you want to delete and click the
Delete button. You are prompted to confirm the deletion.

3. Click Yes. The Application Catalog is no longer listed.

Executing Jobs
When Job Manager Engine opens, it automatically identifies all of the Jobs that are in Pending status. Then, as the
scheduled time interval of each Pending Job is reached, Job Manager Engine executes it.

Job Manager Engine can be connected to multiple Application Catalogs at once, and multiple Job Manager
Engines may run on the network. However an Application Catalog can only be connected to one Job Manager
Engine at a time.

Pausing, Shutting Down, and Restarting Application


Catalog Jobs
From the Manage Application Catalogs View of Job Manager Engine, you can Pause, Shutdown, and Restart Jobs
in an Application Catalog:

Table 5-7 • Pausing, Shutting Down, and Restarting Application Catalog Jobs

Button Action That is Taken by Job Manager Engine

Pause Click to pause the execution of the Jobs in the selected Application Catalog.

Clicking the Pause button tells Job Manager Engine not to start the execution of any new
Jobs in the selected Application Catalog, but allow all currently executing jobs to complete
normally.

Job Manager Engine remains fully aware of the Application Catalog, but does not use any
CPU resources to run any Jobs. Therefore, the Pause operation could be used by someone
to temporarily give another Application Catalog better access to system resources so that it
could complete its jobs faster.

When you select a Paused Application Catalog and click Run/Restart, its Pending Jobs
begin executing immediately.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 193


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs Using Job Manager Engine

Table 5-7 • Pausing, Shutting Down, and Restarting Application Catalog Jobs

Button Action That is Taken by Job Manager Engine

Shutdown Click to stop all Jobs on the selected Application Catalog. Any currently running Job Step is
allowed to finish, but no additional Jobs will execute.

Clicking Shutdown tells Job Manager Engine to fail any currently running Jobs and to unload
itself from memory. All resources used by Job Manager Engine for this Application Catalog
are freed.

When you select a Shutdown Application Catalog and click Run/Restart, the restart
operation will need to relaunch and initiate the background thread for the Application Catalog,
and therefore a Shutdown Application Catalog takes longer to restart than a Paused
Application Catalog.

Run/Restart Click to initiate execution of Jobs from a selected Application Catalog that was Paused or
Shutdown.

When you select an Application Catalog, an icon is displayed to indicate its status:

Table 5-8 • Job Manager Engine Status Icons

Icon Status

All Pending Jobs and any future Jobs sent from this Application Catalog will be executed.

The Pending Jobs from this Application Catalog will not be executed until the connection is restarted
by clicking the Run/Start button.

No Jobs from this Application Catalog will be executed until the Application Catalog is restarted by
clicking the Run/Start button.

All Jobs from this Application Catalog that were in Pending status when it was shutdown were Failed
and must be resubmitted to execute.

Viewing Job Manager Engine Status in Job Manager


The status (Active or Not Active) of the Job Manager Engine associated with an installation of Job Manager is
displayed in the Job Manager Engine Status area of the left pane of all of the Job Manager pages:

194 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs Using Job Manager Engine

Figure 5-2: Job Manager Engine Status Displayed in the Job Manager User Interface

Setting Configuration Options


Usually the Job Manager Engine is installed on the same Server as the AdminStudio client tools, and the Job
Manager Configuration options are set on the Rules tab and Validate tab of the ConflictSolver Options dialog
box.

However, if you choose to install Job Manager Engine on a different server, you can set the following configuration
options from the Job Manager Engine interface:

• Conflict Detection Configuration

• Validation Configuration

• Email Alerts Configuration

Conflict Detection Configuration


On the Conflict Detection Configuration View, you can set the following configuration options:

Table 5-9 • Conflict Detection View Options

Option Description

ACE File File containing the pre-defined ACE rule information for all ConflictSolver Conflict and Best
Practice ACEs. It is installed in the following location on the machine where AdminStudio is
installed:

AdminStudio Installation Directory \ConflictSolver\Support

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 195


Chapter 5: Automating Tasks Using Job Manager
Managing Jobs Using Job Manager Engine

Table 5-9 • Conflict Detection View Options

Option Description

Custom You use user-defined custom ACEs to extend the functionality of pre-defined ACEs with
ACE File company-specific functionality. By selecting different user-defined ACE files, you can organize
rules appropriate for individual users in your organization.

The user-defined ACE file specified here is run after the pre-defined ACE rules are run. The
selection of this user-defined ACE file will affect the default Conflict Types displayed on the Job
Manager interface when you are creating Job Steps.

By default, an empty user-defined ACE file is installed in the following location on the machine
where AdminStudio is installed.

C:\AdminStudio Shared\ConflictSolver\ CustomConflictFile.ace

Only one user-defined ACE file can be active at one time.

Validation Configuration
On the Validation Configuration View, you can set the following configuration options:

Table 5-10 • Validation View Options

Option Description

CUB File Validation involves comparing a Windows Installer package against a known criteria to identify
deviations from those rules. By default, ConflictSolver compares packages against the Full MSI
Validation Suite. This suite contains a comprehensive set of Internal Consistency Evaluators
(ICEs)—guidelines created by Microsoft to ensure an installation package works correctly with
the Windows Installer engine.

The file specified in this field is file containing Internal Consistency Evaluators (ICEs) used for
validation.

The CUB file is configured as a part of the Job Server Engine installation, so normally you do not
need to modify this entry.

Email Alerts Configuration


On the E-mail Alerts View, you can enter configuration settings so that email alerts can be sent out to report the
status of a completed or failed job.

Table 5-11 • E-mail Alerts View Options

Option Description

SMTP Mail Server Enter the SMTP mail server the Job Manager Server should use when sending
Name messages. Enter the MTP Mail Server in the format of:

mail.mycompany.com

196 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Table 5-11 • E-mail Alerts View Options

Option Description

Senders E-mail Enter the E-mail Address of the person who you want to be displayed as the email
Address sender.

SMTP Server Port When someone sends a mail message to your SMTP Server, the mail will attempt to
come in to your server on Port 25. This is the standard SMTP (Simple Mail Transport
protocol) port.

Port 2525 is an alternate port used by forward services. This is a non-standard port, but
useful if the standard SMTP port is blocked

Job Manager Reference


Job Manager Reference includes the same topics displayed when you select help from the Job Manager or Job
Manager Engine interface. Reference information for Job Manager is organized into the following areas:

Table 5-12 • Job Manager Reference Organization

Page Views

Jobs Queue Page • Add Job Page


• Edit Job Page
• Delete Job/Template Page
• Schedule Job Page
• Job Alerts Page
• Job Status Page

Job Template List Page • Add Template Page


• Edit Template Page

Conflict Detection Options


Page

Job Manager Engine • Manage Application Catalogs View


• Conflict Detection Configuration View
• Validation Configuration View
• E-mail Alerts View

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 197


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Jobs Queue Page


The Jobs Queue page lists all defined Jobs. From this page you can choose to add a new Job, edit an existing
Job, delete a Job, schedule a job, or define the email alerts that will be sent out when this job is executed.

The following information and options are available:

Table 5-13 • Jobs Queue Page Options

Option Description

Add Button Click to open the Add Job Page where you can create a new Job.

Name Name of Job

Status Current status of the Job in the Job Execution process:

• Scheduled—Job is scheduled to be executed at a future date and time.


• Running—Job is currently being run. Only one job per Application Catalog
connection will ever be running at one time.
• Pending—Job is available to run but is waiting for the running job to complete. A
job set for immediate execution will be automatically assigned a Pending job
status.
• Complete—Job has been executed.
• Canceled—Job was canceled before it was executed or before its execution
was complete.
• Failed—Job was unable to run either because of a software error, a network
communication problem, a hardware failure, or any other reason.

The values in the Status column are also hyperlinks. Click on a status value to open
the Job Status Page that lists the current status of each Job Step in this Job.

Schedule Lists the scheduled date and time for this job. Click this link to open the Schedule Job
Page where you can specify when to run this job and also configure the selected Job
to reoccur over a specified interval.

Requestor User who created this Job.

Template Template that was used to create the Job. If no Template is listed, it is a Custom Job.

Alerts Click the link in this column to open the Job Alerts Page where you can add or edit an
email to send when the selected Job is completed and when it fails.

Action Click Delete in this column for a Job you want to delete.

198 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Add Job Page


The Add Job page includes the Template View and the Custom Job View.

Template View
On the Job Template View, you create a new Job based on a pre-existing Job Template. The Job Template View
contains the following options:

Table 5-14 • Add Job Page / Job Template View Options

Option Description

Job Name Enter a name to identify the Job.

Template Select this option and select a Template from the list to create a Template Job. .

Package List Select the package(s) or group(s) to be used by the Job Template. If you select a group, the
Job will perform actions on whatever packages are in the selected group at the time the Job is
executed.

Execution Use the following options to schedule this Job:

• Immediate—Select to execute this Job immediately.


• Scheduled—Select to execute this Job at the Date and Time you select.

Custom Job View


The Custom Job View contains the following options:

Table 5-15 • Add Job Page / Custom Job View Options

Option Description

Name Enter a name to identify the Job.

Template To create a Custom Job, clear this selection. When this option is not selected, the Define
Job Steps area opens.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 199


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Table 5-15 • Add Job Page / Custom Job View Options (cont.)

Option Description

Define Job You create Job Steps using this area. To create the first Job Step, make a selection from the
Steps Step Type list and click Next. To create all subsequent Job Steps, click Insert New Step.

The following Job Step Types are available:

• Import—Import a selected package into the Application Catalog.


• Scan for Dependencies—Analyze a Windows Installer package for dependent files.
• Directory Monitoring—Use to establish a consistent, repeatable process in which a
directory and, optionally, its subdirectories are monitored for any new or modified
Windows Installer package files, and if any changes are detected, those new or modified
files are then either imported or re-imported into the Application Catalog. See About
Automatically Importing Packages from a Network Directory for more information.
• Validation—Verifies the internal data integrity of a Windows Installer package.
• Conflict Detection—Performs conflict detection on selected packages using Conflict
ACE Rules
• Best Practice Detection—Performs conflict detection on a single package using Best
Practice ACE Rules to enforce Windows Installer standards.
• Resolution—Performs automatic conflict resolution on selected packages.

For each type of Job Step, you are prompted to specify additional information. See
Information Requested When Defining Job Steps in a Custom Job.

Use the Up and Down arrows to rearrange the order of the Job Steps, and use the Delete
button to delete a Job Step.

Click Finish to save each Step and click Save to save the Job.

Schedule Job Use the following options to schedule this Job:

• Execute—Select to execute this job Immediately or at a Scheduled time.


• Select Date—If you chose to execute this job at a Scheduled time, click the calendar
icon and select a date.
• Enter Time—If you chose to execute this job at a Scheduled time, enter the time in
hours and minutes.

200 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Information Requested When Defining Job Steps in a Custom Job


Each time you select a Step Type, you are prompted to specify additional information:

Table 5-16 • Information Requested When Defining a Job Step in a Custom Job

Step Type Required Selections

Scan for 1. Click Next. The Step 2 of 2 View opens.


Dependencies
2. Select the packages or groups of packages that you want to scan, and then
click Finish to save this Job Step.

Directory Monitoring 1. Click Next. The Step 2 of 2 View opens.

2. In the Directory Name box, enter the UNC path of the directory that you
want to monitor.

3. Choose whether to Include subdirectories in the ‘Directory


Monitoring’ process.

4. Click Finish to save this Job Step.

Validation 1. Click Next. The Step 2 of 2 View opens.

2. Select the packages or groups of packages that you want to validate.

3. Click Finish to save this Job Step.

Conflict Detection 1. Click Next. The Step 2 of 4 View opens.

2. Select the source packages or groups of packages that you want to include
in the conflict detection process, and then click Next. The Step 3 of 4 View
opens.

3. Select the target packages or groups of packages that you want to use in
the conflict detection process and click Next. The Step 4 of 4 View opens.

4. Select the set of Conflict ACE Rules that you want to include in the conflict
detection process and click Finish to save this Job Step.

Import 1. Click Next. the Step 2 of 4 View opens.

2. Select a package to import.

3. Specify whether to include the package in the Software Repository

4. Click Next. The Step 3 of 4 View opens.

5. Select any transform (.mst) or patch (.msp) files to import.

6. Click Next. The Step 4 of 4 View opens.

7. Select one or more destination groups into which the package will be
imported.

8. Click Finish to save this Job Step.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 201


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Table 5-16 • Information Requested When Defining a Job Step in a Custom Job (cont.)

Step Type Required Selections

Best Practice 1. Click Next. The Step 2 of 2 View opens.


Detection
2. Select the packages or groups of packages that you want to perform Best
Practice conflict detection on.

3. Click Finish to save this Job Step.

Resolution 1. Click Next. The Step 2 of 3 View opens.

2. Select the packages or groups of packages that you want to perform


conflict resolution on, and then click Next. The Step 3 of 3 View opens.

3. Select the Conflict ACE Rules that you want to resolve automatically.

4. Select a Resolved packages re-import option. See Re-Import


Behaviors.

5. Click Finish to save this Job Step.

Edit Job Page


You can edit an existing Job by selecting the Job on the Jobs Queue page to open the Edit Job page.

Note • When editing Jobs note that:

• Only one Job can be edited at a time.


• You cannot edit a Job with a Status of Running.
• You cannot change a Custom Job to a Template Job or vice versa.

You edit a Job following the instructions in Creating a New Job Based on a Template or Creating a New Custom
Job. When you have finished editing the Job, click Save.

202 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Editable Items in an Existing Job


The following information can be edited:

Table 5-17 • Editable Items in an Existing Job

Custom Jobs Template Jobs

General General

• Job Name • Job Name


• Execution options • Execution options
• Step Type
General
Scan for Dependencies Job Step • Selected packages and groups
• Selected packages and groups

Directory Monitoring Job Step

• Directory to monitor
• Option to monitor subdirectories

Validation Job Step

• Selected packages and groups

Conflict Detection Job Step

• Selected source packages and groups


• Selected target packages and groups
• Set of conflict detection rules to use during the
conflict detection process

Import Job Step

• Package to import
• Software Repository option
• Transform (.mst) and Patch (.msp) files to include
during import
• Destination group for imported package

Best Practice Detection Job Step

• Selected packages and groups

Resolution Job Step

• Selected packages and groups


• Conflicts to resolve
• Resolved package re-import options

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 203


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Delete Job/Template Page


The Delete Job/Template page opens when you attempt to delete a Job or Template and prompts you to confirm
the deletion. To delete a Job or Template:

• Deleting a Job—Open the Jobs Queue page and click Delete in the Action column of a Job that you want
to delete.

• Deleting a Template—Open the Job Template List page and click Delete in the Action column of a
Template that you want to delete.

To confirm the deletion, click Delete. To return to the Jobs Queue or Job Template List page without making the
deletion, click Cancel.

Schedule Job Page


You can reschedule a completed Job so that it is run again. You can also reschedule Jobs that failed, were
cancelled, or are scheduled to be run in the future.

To reschedule a Job, open the Jobs Queue page and click the date and time listed in the Schedule column for
the Job you want to reschedule. The Schedule Job page opens.

The Schedule Job page includes the following options:

Table 5-18 • Schedule Job Page Options

Option Description

Execute Select For Immediate Execution or For Scheduled Execution.

Select Date If you selected For Scheduled Execution, click the calendar icon and select the date when
you want this Job to run.

Enter Time If you selected For Scheduled Execution, identify the time of day that you want this Job to
run by selecting an hour of the day from the first list, selecting the minutes after the hour from
the second list, and selecting AM or PM from the third list.

Recurrence If you want this Job to reoccur at a specified interval, select Weekly, Daily, or Monthly from
Interval this list, and perform the following steps:

• If you want this Job to reoccur a specific number of times, select the Number of Times
option, and enter a number in the box.
• If you want this Job to reoccur until a specified expiration date, select the Expiration
Date option, click the calendar icon, and select a date from the calendar.

Save Click to save this Job schedule.

204 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Job Alerts Page


You can choose to send an email when a Job is completed and when it fails. To do this, open the Jobs Queue
page and click Add in the Alerts column of the Job that you want to set an alert for. You then can create an email
message on the Job Alerts page.

When composing the Subject line and the Message, you can insert system variables to instruct Job Manager to
automatically insert the variable data regarding that Job at runtime.

The Job Alerts page includes the following options:

Table 5-19 • Job Alerts Page Options

Options Description

To Enter the email addresses that you want to be notified when a Job is completed or when it
fails. Separate multiple email addresses with a semicolon (;).

Subject Enter text to describe the purpose of the email.

Message Enter the text of the email message. You can select System Variables from the list so that the
value of the variable for this Job is inserted when the email is sent.

Conditional Select one of the following options:


Forward
• Failed—Send an email when this Job fails.
• Complete—Send an email when this Job is completed.

Save Click to save your entries.

Job Status Page


On the Jobs Queue page, a Job’s current status is listed as a hyperlink in the Status column. If you click on this
hyperlink, the Job Status page opens, displaying the Job Name and Job Status, and the status of each of the
Job Steps in that job.

Figure 5-3: Job Status Page

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 205


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

The possible statuses are:

• Scheduled—Job is scheduled to be executed at a future date and time.

• Running—Job is currently being run. Only one job per Application Catalog connection will ever be running at
one time.

• Pending—Job is available to run but is waiting for the running job to complete. A job set for immediate
execution will be automatically assigned a Pending job status.

• Complete—Job has been executed.

• Canceled—Job was canceled before it was executed or before its execution was complete.

• Failed—Job was unable to run either because of a software error, a network communication problem, a
hardware failure, or any other reason.

Click Back to return to the Jobs Queue page.

Job Template List Page


The Job Template List page lists all defined Templates. From this page you can choose to add a new Template,
edit an existing Template, or delete a Template.

The following information and options are available:

Table 5-20 • Job Template List Page Options

Option Description

Add Click to open the Add Template page where you can create a new Template.

Template Name Name of Template

# of Steps Number of Job Steps defined in the Template.

Description Description that was entered to identify the Template.

Action Click Delete in this column to delete a listed Template.

Add Template Page


The Add Template page contains the following options:

Table 5-21 • Add Template Page Options

Option Description

Name Enter a name to identify the new Template.

206 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Table 5-21 • Add Template Page Options (cont.)

Option Description

Description Enter a description to identify the purpose of this Template.

Define Job Steps You create Job Steps using this area. Each time you want to create a Job Step, select
one of the listed tasks from the Step Type list:

• Scan for Dependencies—Analyze a Windows Installer package for dependent


files.
• Directory Monitoring—Use to establish a consistent, repeatable process in which
a directory and, optionally, its subdirectories are monitored for any new or modified
Windows Installer package files, and if any changes are detected, those new or
modified files are then either imported or re-imported into the Application Catalog.
See About Automatically Importing Packages from a Network Directory for more
information.
• Validation—Verifies the internal data integrity of a Windows Installer package.
• Conflict Detection—Performs conflict detection on selected packages using
Conflict ACE Rules
• Best Practice Detection—Performs conflict detection on a single package using
Best Practice ACE Rules to enforce Windows Installer standards.
• Resolution—Performs automatic conflict resolution on selected packages.

For each type of Job Step, you are prompted to specify additional information. See
Information Requested When Defining Job Steps in a Template.

Use the Up and Down arrows to rearrange the order of the Job Steps, and use the
Delete button to delete a Job Step.

Click Finish to save each Step and click Save to save the Job.

Information Requested When Defining Job Steps in a Template


Each time you select a Step Type, you are prompted to specify additional information:

Table 5-22 • Information Requested When Defining a Job Step in a Template

Step Type Required Selections

Scan for Click Next to save this Job Step. (Source packages will be selected when a Job
Dependencies based on this Template is created.)

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 207


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Table 5-22 • Information Requested When Defining a Job Step in a Template (cont.)

Step Type Required Selections

Directory Monitoring 1. Click Next. The Step 2 of 2 view opens.

2. In the Directory Name box, enter the UNC path of the directory that you want to
monitor.

3. Choose whether to Include subdirectories in the ‘Directory Monitoring’


process.

4. Click Finish to save this Job Step.

Validation Click Next to save this Job Step. (Source packages will be selected when a Job
based on this Template is created.)

Conflict Detection 1. Click Next. The Step 2 of 3 view opens.

2. Select the target packages or groups of packages that you want to use in the
conflict detection process and click Next. The Step 3 of 3 view opens.

3. Select the set of Conflict ACE Rules that you want to include in the conflict
detection process and click Finish to save this Job Step.

Best Practice Click Next to save this Job Step. (Source packages will be selected when a Job
Detection based on this Template is created.)

Resolution 1. Click Next. The Step 2 of 2 view opens.

2. Select the Conflict ACE Rules that you want to resolve automatically.

3. Select a Resolved packages re-import option. See Re-Import Behaviors.

4. Click Finish to save this Job Step.

Edit Template Page


You can edit an existing Template by selecting that Template on the Job Template List page to open the Edit
Template page.

Edit the Template following the instructions in Creating a New Template. When you have finished editing the
Template, click Save.

208 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Conflict Detection Options Page


On the Conflict Detection Options page, you select the rules that you want Job Manager to use by default
during conflict detection. The following rules are available.

Table 5-23 • Conflict Detection Options

Category ACEs

Components • ACE30—A check for KeyPath conflicts across components.


• ACE02—Check destination directories for identical components.
• ACE09—Check for different merge module versions.

File Extensions • ACE17—Confirm that file extensions exist in only one component.

Files • ACE23—Identifies file duplication between source and target packages.


• ACE12—Checks for components that contain files that can be replaced by one of
the merge modules that you have imported into the Application Catalog database.
• ACE08—identifies components with identical ComponentIds, and checks those
components to see if the versions of the files in each component match.
• ACE07—Checks for the existence of the same file in components with different
ComponentIds.
• ACE03—Checks to see if components in different packages that have matching
ComponentIds also contain the same files.

INI Files • ACE22—Checks file name/target directory pairs in the File table to see if they
conflict with similar entries in the IniFile table.
• ACE21—Checks entries in the IniFile table to see if they conflict with similar entries
in the File table.
• ACE14—Checks for the existence of components with different ComponentIds that
modify the same INI file entry, such as the [File Name/Section/Key/Value] entry.

NT Services • ACE16—Checks for the existence of identical NT Services in components with


different ComponentIds.

ODBC Resources • ACE15—Checks for the existence of identical ODBC entries in components with
different ComponentIds.

Product • ACE20—Checks the Upgrade Code to see if it is unique.


Properties • ACE19—Checks the Product Code to see if it is unique.
• ACE18—Checks the Package Code to see if it is unique.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 209


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Table 5-23 • Conflict Detection Options (cont.)

Category ACEs

Registry • ACE24—Checks to see if registry entries with the same registry hive, key, and value
name have the same data type and value.
• ACE10—Checks for the existence of identical Root/Key/Name registry combinations
in components with different ComponentIds.

Shortcuts • ACE13—Checks for the existence of the same shortcut within different packages in
components with different ComponentIds.

Windows • WST01—Checks to see if the ALLUSERS property is defined.


Terminal Server • WST02—Checks for any registry entries installed to per-user specific locations.
Validation
• WST03—Checks for any file entries installed to per-user specific locations.
• WST04—Checks for any ODBC data source entries installed to per-user specific
locations.
• WST05—Checks for any environment strings installed to per-user specific locations.

Job Manager Engine


Job Manager Engine executes the Jobs created with Job Manager. Job Manager Engine can connect to any of the
Application Catalogs in your network and allow you to configure how the engine operates and manage the state of
any particular Application Catalog.

Job Manager Engine has the following Views:

• Manage Application Catalogs View

• Conflict Detection Configuration View

• Validation Configuration View

• E-mail Alerts View

Manage Application Catalogs View


Application Catalogs that are connected to the Job Manager Engine are listed on the Manage Application Catalogs
View. For each Application Catalog, the following information is listed:

Table 5-24 • Connected Application Catalog Information

Item Description

Catalog Name of the connected Application Catalog database.


Name

Status Identifies whether the Job is Running, Pending, or Shutdown.

210 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Table 5-24 • Connected Application Catalog Information (cont.)

Item Description

# of Jobs Number of Jobs in that Application Catalog that have been submitted for execution.

When Job Manager Engine is open, it automatically identifies all of the Jobs in all of the Application Catalogs that it
is connected to that are in Pending status. Then, as the scheduled time interval of each Pending Job is reached,
Job Manager Engine will execute it.

On the Manage Application Catalogs View, the following functions can be performed:

Table 5-25 • Job Manager Engine / Manage Application Catalogs View Options

Option Description

Delete Click to delete the connection of Job Manager Engine to an Application Catalog.

Note • When you delete an Application Catalog from Job Manager Engine, it will first shut down the
Application Catalog, allowing any currently executing Job Steps to complete. Therefore, this operation
may take some time to complete.

Run/Restart Click to initiate execution of Jobs from a selected Application Catalog that was Paused or
Shutdown.

Pause Click to pause the execution of the Jobs in the selected Application Catalog.

Shutdown Click to stop all Jobs on the selected Application Catalog. Any currently running Job Step is
allowed to finish, but no additional Jobs would execute.

When you select an Application Catalog on Job Manager Engine Manage Application Catalogs View, an icon is
displayed to indicate its status:

Table 5-26 • Job Manager Engine Status Icons

Icon Status

All Pending Jobs and any future Jobs sent from this Application Catalog will be executed.

The Pending Jobs from this Application Catalog will not be executed until the connection is restarted
by clicking the Run/Start button.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 211


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Table 5-26 • Job Manager Engine Status Icons (cont.)

Icon Status

No Jobs from this Application Catalog will be executed until the Application Catalog is restarted by
clicking the Run/Start button.

All Jobs from this Application Catalog that were in Pending status when it was shutdown were Failed
and must be resubmitted to execute.

Conflict Detection Configuration View


On the Conflict Detection Configuration View, you can set the following configuration options:

Table 5-27 • Conflict Detection Configuration View Options

Option Description

ACE File File containing the pre-defined ACE rule information for all ConflictSolver Conflict and Best
Practice ACEs. It is installed in the following location on the machine where AdminStudio is
installed:

AdminStudio Installation Directory \ConflictSolver\Support

Custom You use user-defined custom ACEs to extend the functionality of pre-defined ACEs with
ACE File company-specific functionality. By selecting different user-defined ACE files, you can organize
rules appropriate for individual users in your organization.

The user-defined ACE file specified here is run after the pre-defined ACE rules are run. The
selection of this user-defined ACE file will affect the default Conflict Types displayed on the Job
Manager interface when you are creating Job Steps.

By default, an empty user-defined ACE file is installed in the following location on the machine
where AdminStudio is installed.

C:\AdminStudio Shared\ConflictSolver\ CustomConflictFile.ace

Only one user-defined ACE file can be active at one time.

212 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

Validation Configuration View


On the Validation Configuration View, you can set the following configuration options:

Table 5-28 • Validation Configuration View Options

Option Description

CUB File Validation involves comparing a Windows Installer package against a known criteria to identify
deviations from those rules. By default, ConflictSolver compares packages against the Full MSI
Validation Suite. This suite contains a comprehensive set of Internal Consistency Evaluators
(ICEs)—guidelines created by Microsoft to ensure an installation package works correctly with
the Windows Installer engine.

The file specified in this field is file containing Internal Consistency Evaluators (ICEs) used for
validation.

The CUB file is configured as a part of the Job Server Engine installation, so normally you do not
need to modify this entry.

E-mail Alerts View


On the E-mail Alerts View, you can enter configuration settings so that email alerts can be sent out to report the
status of a completed or failed job.

Table 5-29 • E-mail Alerts View Options

Option Description

SMTP Mail Server Enter the SMTP mail server the Job Manager Server should use when sending
Name messages. Enter the MTP Mail Server in the format of:

mail.mycompany.com

Senders E-mail Enter the E-mail Address of the person who you want to be displayed as the email
Address sender.

SMTP Server Port When someone sends a mail message to your SMTP Server, the mail will attempt to
come in to your server on Port 25. This is the standard SMTP (Simple Mail Transport
protocol) port.

Port 2525 is an alternate port used by forward services. This is a non-standard port, but
useful if the standard SMTP port is blocked

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 213


Chapter 5: Automating Tasks Using Job Manager
Job Manager Reference

214 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


6
Distributing Packages Using
Configuration Manager Web
Console

You can use Microsoft System Center Configuration Manager Web Console, a Web-based application, to configure
package distribution options and distribute setup packages without going to Configuration Manager Server. By
using the Configuration Manager Web Console, you can:

• Create and distribute packages to Configuration Manager Server from Configuration Manager Web Console.

• View the package deployment status from Configuration Manager Web Console after it is targeted to distribute
using Configuration Manager.

• Choose the target audience for deployment by browsing through the Configuration Manager collections.

• Configure program options for packages and target multiple distribution points for packages.

• Refresh source files on the distribution points if source files are changed.

• Create access accounts for setup packages to secure source files.

• Delete the packages.

Caution • Configuration Manager Web Console features cannot be installed on 64 bit machines because
Microsoft .NET Framework 2.0 does not support 64 bit machines.

Information on how to use the Configuration Manager Web Console is presented in the following sections:

Table 6-1 • Configuration Manager Web Console Help Library

Section Description

About Microsoft System Explains the concepts behind Microsoft System Center Configuration
Center Configuration Manager and Configuration Manager Web Console and how to get started
Manager and Configuration using Configuration Manager Web Console.
Manager Web Console

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 215


Chapter 6: Distributing Packages Using Configuration Manager Web Console
About Microsoft System Center Configuration Manager and Configuration Manager Web Console

Table 6-1 • Configuration Manager Web Console Help Library

Section Description

Distributing Packages Explains how to configure package distribution options and distribute setup
Using the Configuration packages using Configuration Manager Web Console.
Manager Web Console
• Configuring Distribution Settings
• Distributing a New Package
• Viewing the Status of a Distributed Package
• Modifying the Distribution Settings of a Package
• Deleting Packages

Configuration Manager Web Every view and dialog box available in Configuration Manager Web Console
Console Reference is discussed in this section.

For information on how to use the Configuration Manager Web Console, click on one the following topics:

• About Microsoft System Center Configuration Manager and Configuration Manager Web Console

• Distributing Packages Using the Configuration Manager Web Console

• Configuration Manager Web Console Reference

About Microsoft System Center Configuration


Manager and Configuration Manager Web
Console
AdminStudio is directly integrated with Microsoft System Center Configuration Manager via the Configuration
Manager Web Console, which enables enterprises using the Configuration Manager distribution system to cut
down software rollout times by greatly simplifying their distribution efforts enterprise-wide.

You can use Configuration Manager Web Console to prepare, publish, and distribute applications through your
Configuration Manager system without ever touching the Configuration Manager Server console, helping you
improve your application management efforts while simplifying your overall Configuration Manager management
requirements. You can use Configuration Manager Web Console to perform all of your Configuration Manager
administrative tasks, including publishing and advertising applications and retiring or deleting applications from
circulation. Configuration Manager Web Console also allows the use of existing Configuration Manager collections
to distribute your applications, which simplifies targeting.

Using the centrally managed Configuration Manager Web Console, you can better monitor any application's
Configuration Manager deployment success using a single interface, simplifying the process and saving you time.

216 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
About Microsoft System Center Configuration Manager and Configuration Manager Web Console

The following topics explain the concepts behind Microsoft Configuration Manager and Configuration Manager
Web Console and how to get started using Configuration Manager Web Console.

• Distributing Software Through Configuration Manager Server

• Configuration Manager Web Console Overview

• Getting Started

Distributing Software Through Configuration Manager


Server
Microsoft Configuration Manager is used by Systems Administrators to maintain and upgrade software for
organizations with distributed networks. Configuration Manager enables you to upgrade and configure each
computer from a central location or from multiple locations, and schedule software programs for distribution to
specific computers.

Software distribution with Configuration Manager includes the following tasks:

Table 6-2 • Software Distribution with Microsoft Configuration Manager Server

# Step Description

1 Install Client Install the Advertised Programs Client Agent on the Client computers to enable them
Agent Software to receive and run programs from Configuration Manager Server (advertised
on Client programs).
Computers

2 Prepare Site Prepare the following Site System Roles:


System Roles
• Client Access Points—A site system role that provides a communication
point between the site server and Legacy Client computers (computers using a
Windows operating system that is pre-Windows 2000). Computers contact
CAPs to install and update Configuration Manager Legacy Client software. After
Configuration Manager Legacy Client software has been installed on computers
in a site, they contact a CAP for updated information from the Configuration
Manager site server.
• Management Points—Management points are the primary point of contact
between Advanced Configuration Manager Clients and the Configuration
Manager site server.
• Distribution Points—Distribution points are site system roles that store
software package files so clients can access them during the software
distribution process. Clients contact distribution points to obtain source files
when they run programs that are advertised to them through a Client Access
point or a Management Point.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 217


Chapter 6: Distributing Packages Using Configuration Manager Web Console
About Microsoft System Center Configuration Manager and Configuration Manager Web Console

Table 6-2 • Software Distribution with Microsoft Configuration Manager Server

# Step Description

3 Prepare A collection is a customized management view of the resources in your organization.


Collections Collections serve as targets for performing software distribution on multiple
resources at one time. An example of a collection is All Windows NT Workstation 4.0
Systems. The clients that need to receive the program must be members of a
collection (referred to as the target collection).

4 Create Software Software Distribution Packages are applications packages that you are going to
Distribution distribute via Configuration Manager Server. Package properties include the software
Packages name and version, the location of the package source folder, and group permissions
for the distribution folder.

5 Specify Select the Distribution Points that will receive the software.
Distribution
Points

6 Create Create a program for the package that is going to be distributed. Program properties
Programs specify the command line that will run on the clients, and the types of clients on
which the program can run. A package can have multiple programs defined. For
example, you can define a Full Installation, a Custom Installation, and a Minimum
Installation for a single package.

7 Create Advertise the program that you want the clients to run. Advertising the program
Advertisements makes a program available to a specified target collection. The advertisement
contains the name of the program, the name of the target collection, and the
scheduling configuration (such as when to run the program or when will the program
expire).

218 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
About Microsoft System Center Configuration Manager and Configuration Manager Web Console

Configuration Manager Web Console Overview


Configuration Manager Web Console enables you to coordinate and manage the packaging, preparation, and
distribution of applications across your enterprise via your Configuration Manager system without ever touching
the Configuration Manager Server console. The following diagram explains the role that the Configuration Manager
Web Console plays in Configuration Manager software distribution:

Figure 6-1: Configuration Manager Web Console and Configuration Manager Server Integration

Setting Configuration Options


In the Package Configuration area of Configuration Manager Web Console, you specify distribution configuration
fields that the Configuration Manager Server utilizes in the distribution of the package. You can manually enter
package and distribution configuration information and settings, or you can choose to attach a Package Definition
File (.pdf) to a Windows Installer (.msi) package to pre-populate these fields. The following configuration
information is specified:

• Access Accounts—Specify which administrators are allowed to distribute this particular package.

• Distribution Points—Identify which servers may act as distribution points for this particular package.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 219


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

• Programs—Specify programs (that will run on the clients) to execute the distribution of the application, and
the types of clients on which the program can run (directories, operating system versions, etc.)

• Advertisements—Identify the collection of users to receive this package, and specify when the package will
be available for distribution and whether it is optional or mandatory.

See Setting Package Configuration Options for detailed information on setting these options.

Package Administration
The Package Administration area of Configuration Manager Web Console allows you to perform the following
tasks:

• Viewing the Status of a Distributed Package

• Modifying the Distribution Settings of a Package

• Deleting Packages

Getting Started
To start using the Configuration Manager Web Console to distribute packages to Configuration Manager Server,
you need to do the following:

• Learn About Configuration Manager Web Console—Review the About Microsoft System Center
Configuration Manager and Configuration Manager Web Console section to learn how Configuration Manager
Web Console is integrated with Configuration Manager Server.

• Configure Distribution Settings—Perform the steps in Configuring Distribution Settings to set the default
Configuration Manager Server values for any new package you target for distribution.

You would then be ready to perform the steps in Distributing a New Package.

Distributing Packages Using the Configuration


Manager Web Console
When you launch the Configuration Manager Web Console, the Microsoft System Center Configuration Manager
Web Console Home Page opens listing three options: Distribute a New Package, Package Administration,
and Distribution Settings. The following procedures explain how to use these options to configure package
distribution options and distribute packages without using the Configuration Manager Server Console:

• Configuring Distribution Settings

• Distributing a New Package

• Viewing the Status of a Distributed Package

• Modifying the Distribution Settings of a Package

• Deleting Packages

220 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Configuring Distribution Settings


You configure the Configuration Manager Server connection settings on the Distribution Settings Page.

Note • The values entered on the Distribution Settings page will be used as the default values for any new
package you target for distribution. However, you can change these values while configuring the package.

Task: To configure distribution settings:

1. Launch Configuration Manager Web Console. The Configuration Manager Web Console Home Page
opens.

2. Click Distribution Settings. The Distribution Settings page opens.

3. In the Site Server Name field, enter the machine name on which Configuration Manager Server is installed.
(This could be a local or remote machine.) When you make a selection in this field, the Site Code field is
populated with a list of sites available on the Configuration Manager Server.

4. In the Site Code field, select the Configuration Manager site you want to use for software distribution.

5. In the User Name field, enter the user name of a user who has access to the Configuration Manager Server.

6. Click Update to save your entries

7. Click the Home link to return to the Configuration Manager Web Console Home Page.

Distributing a New Package


You can use Configuration Manager Web Console to create packages, configure package distribution options, and
distribute setup packages without going to Configuration Manager Server. These package configuration settings
are saved with the application in the Application Catalog, enabling you to easily redistribute the package using the
same settings.

Distributing a package using Configuration Manager Web Console consists of the following tasks:

Table 6-3 • Configuration Manager Web Console Package Distribution Steps

# Step Description

1 Selecting a Package for Select the package in your Application Catalog that you want to distribute,
Distribution and choose whether you want to attach a Package Definition File (.pdf).
When you use a Package Definition File, appropriate fields on the
Configuration Manager Package Configuration Page are populated with the
information in the package definition file you selected.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 221


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Table 6-3 • Configuration Manager Web Console Package Distribution Steps

# Step Description

2 Setting Package In the Package Configuration area of Configuration Manager Web Console,
Configuration Options you specify the following distribution configuration fields that the
Configuration Manager Server utilizes in the distribution of the package.

• Setting Package Settings Options—General information about the


package, along with data source, data access, distribution settings,
and reporting information.
• Setting Access Accounts Options—Specify which administrators are
allowed to distribute this particular package.
• Setting Distribution Points Options—Specify which servers may act as
distribution points for this particular package. A Distribution Point is a
site system role that stores software package files so clients can
access them during the software distribution process.
• Setting Programs Options—Specify programs (that will run on clients)
to execute the distribution of the application, and the types of clients
on which the program can run (defined using directories, operating
system versions, etc.).
• Setting Advertisements Options—Identify the collection of users to
receive this package, and specify when the package will be available
for distribution and whether it is optional or mandatory.

3 Saving the Package on the Save the package on the Configuration Manager Server. You can then view
Configuration Manager the status of the package by following the instructions in Viewing the Status
Server of a Distributed Package.

Selecting a Package for Distribution


To select a package for distribution from Configuration Manager Web Console using Configuration Manager
Distribution, perform the following steps.

Task: To distribute a new package:

1. Launch Configuration Manager Web Console. The Configuration Manager Web Console Home Page
opens.

2. Click Distribute a New Package. The Distribute Package page opens, listing all of the Windows Installer
(.msi) packages in the open Application Catalog.

3. Click the radio button next to the Application Name of the package that you want to distribute. Only one
package can be selected at a time.

4. Click Distribute. The PDF Selection page opens.

222 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

5. In the Package Configuration area of Configuration Manager Web Console, you specify distribution
configuration fields that the Configuration Manager Server utilizes in the distribution of the package. You can
manually enter package and distribution configuration information and settings, or you can choose to attach a
Package Definition File (.pdf) to a Windows Installer (.msi) package to pre-populate these fields.

A Package Definition File (.pdf) is a text file that contains predefined programs and property settings for a
package and is used to automate package creation. When you use a package definition file, appropriate fields
on the Configuration Manager Package Configuration Page are populated with the information in the package
definition file you selected. A package definition file typically has an .sms file name extension (.pdf in previous
versions of Configuration Manager).

If you want to distribute this application using an existing Configuration Manager Package Definition File (.pdf
or .sms) (either one on the Configuration Manager Server or one on the machine where Configuration
Manager Web Console is installed), select a Package Definition File by performing the following steps:

a. Select the Distribute using Package Definition option if you want to distribute this application using an
existing Configuration Manager Package Definition File (.pdf or .sms). When you select this check box,
the Use Existing Package Definition option is automatically selected, and the existing Package
Definitions available on the Configuration Manager Server are listed.

b. Select the Use Existing Package Definition option to distribute this application using any Package
Definitions available on the Configuration Manager Server. When the Distribute using Package
Definition check box is selected, this option is automatically selected, and the existing Package
Definitions available on the Configuration Manager Server are listed. Select a Package Definition File from
the list.

c. Select the Use Package Definition from the following file option if you want to distribute this
application using a .pdf or .sms file located on the machine where Configuration Manager Console is
installed. When you select this option, all of the .pdf or .sms files in the following directory are listed:

<Configuration Manager Console Installation Directory>\SMS Web Console


Application\Distribution Providers\SMS\PDFs

6. Select a Package Definition File from the list.

7. Click Next. The Configuration Manager Package Configuration Page appears, listing the information in the
.pdf or .sms file (if one was selected).

8. Proceed with the steps in Setting Package Configuration Options to either enter or modify the package
configuration options.

Setting Package Configuration Options


On the Configuration Manager Package Configuration Page of Configuration Manager Web Console, you specify
distribution configuration fields that the Configuration Manager Server utilizes in the distribution of the package.
You can manually enter package and distribution configuration information and settings, or you can choose to
attach a Package Definition File (.pdf) to a Windows Installer package to pre-populate these fields.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 223


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Task: To set package configuration options:

1. Perform the steps described in Selecting a Package for Distribution.

2. Specify configuration options on each of the following Views of the Configuration Manager Package
Configuration Page:

a. Package Settings View—This View opens when a package name is selected in the tree. Specify
general information about the package, along with data source, data access, distribution settings, and
reporting information. See Setting Package Settings Options.

b. Access Accounts View—This View opens when Access Accounts is selected in the tree. Specify which
administrators are allowed to distribute this particular package. See Setting Access Accounts Options.

c. Distribution Points View—This View opens when Distribution Points is selected in the tree. Identify
which servers may act as distribution points for this particular package. See Setting Distribution Points
Options.

d. Programs View—This View opens when Programs is selected in the tree. Specify programs (that will run
on the clients) to execute the distribution of the application, and the types of clients on which the program
can run (directories, operating system versions, etc.). See Setting Programs Options.

e. Advertisements View—This View opens when Advertisements is selected in the tree. Identify the
collection of users to receive this package, and specify when the package will be available for distribution
and whether it is optional or mandatory. See Setting Advertisements Options.

Caution • Remember to click Update on each view to save your changes.

3. When you have finished specifying configuration options, click Next. The Package Summary page opens,
providing a summary of all of the options specified for the package.

4. Proceed with the steps in Saving the Package on the Configuration Manager Server.

Setting Package Settings Options

On the Package Settings View, you specify general information about the package, along with data source, data
access, distribution settings, and reporting information.

Task: To set Package Settings configuration options:

1. Perform the steps described in Selecting a Package for Distribution.

2. On the Configuration Manager Package Configuration Page, select the package name in the tree. The
Package Settings View opens, presenting information on five tabs: General, Data Source, Data Access,
Distribution Settings, and Reporting.

224 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

3. Enter the following information on the General tab.

Option Description

Icon To change the displayed icon, select a different icon from the list. This list is populated with
the files available from:

<Configuration Manager Web Console Installation Directory>\SMS Web Console


Application\Distribution Providers\SMS\Icons

Name The name of the package, up to 50 characters. This field is required.

Version The version number of the software package, up to 32 characters.

Publisher The name of the software publisher, up to 32 characters.

Language The language version of the software, up to 32 characters.

Comment Optional text about the package, such as a description. You can use up to 127 characters.

4. Click the Data Source tab and enter the following information:

Option Description

This Package This package has source files that are required to run its programs when they
contains source files are advertised to clients. By default, this check box is cleared. When this check
box is cleared, Configuration Manager does not use distribution points for the
package.

Source Directory The network path to the package source files.

Use a compressed Configuration Manager will create a compressed version of the source files on
copy of the source the site server. When you specify additional or refresh distribution points for the
directory package, the compressed version will be decompressed and copied to the
distribution points, rather than being copied directly from the original source
directory.

Use this option if the source files might be removed from the specified path (for
example, if the source files are on a compact disc). A compressed version of the
source directory is always created and used when the package is sent to
distribution points in child sites.

This field is available only when the This Package contains source files check
box is selected.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 225


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Option Description

Always obtain files from Configuration Manager will obtain package source files (the files needed to run
source directory the package programs, such as .exe and .dll files) from the path specified in the
Source directory box. Use this option if the source files are likely to remain at the
specified path, such as a share on a server.

This field is available only when the This package contains source files check
box is selected. By default, this option is selected.

Note • This option is unavailable if the package is a compressed version replicated from a
parent site.

5. Click the Data Access tab and enter the following information:

Property Description

Access distribution Users will access the package through the common Configuration Manager
folder through package share (SMSPKGx$, where x is the drive letter) on distribution points. By
common default, this option is selected.
Configuration
Manager package
share

Share Distribution The package will be created on distribution points with an administrator-specified
folder share (and path name) that is entered in the Share name text box.

Disconnect users Notifies users before disconnecting them from distribution points when
from distribution Configuration Manager updates package data. By default, this check box is
points cleared.

• Number of retries before disconnecting users—The number of times


that Configuration Manager tries to update the package source files before
starting to disconnect users who are connected to the distribution point. The
default setting is 2; you can specify 0 to 99, inclusive.
• User grace period—The number of minutes Configuration Manager should
wait after notifying users before disconnecting them from distribution points.
The default setting is 5 minutes; you can specify between 0 and 59 minutes,
inclusive.

226 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

6. Click the Distribution Settings tab and enter the following information:

Option Description

Sending priority The priority of this package when sent to distribution points in child sites. Packages
can be sent with High, Medium, or Low priority. The default setting is Medium
priority.

• If a package has High priority, it will be sent before packages with Medium or
Low priority.
• If a package has Low priority, it will be sent after packages with higher priority
settings.
• If packages have identical priorities, they will be sent in the order in which
they were created in the Configuration Manager Administrator console.

Sending priority for a package is carried over in packages sent from a parent site to
a child site.

Preferred sender The sender to be used to send this package to distribution points in other sites. You
can specify any sender configured for the site, or No Preference (which uses any
available sender). The default setting is No Preference.

Note • To use Courier Sender to distribute packages, you must select it as the preferred
sender.

7. Click the Reporting tab and enter the following information:

Property Description

Use package properties Configuration Manager will use the properties in the General tab for status
for status MIF matching MIF file matching. By default, this option is selected.

Use these fields for Configuration Manager will use the following values specified for status MIF
status MIF matching file matching:

• MIF file name—The name of the MIF file that contains the package
status, up to 50 characters.
• Name—The name of the package, up to 50 characters.
• Version—The version number of the package, up to 32 characters.
• Publisher—The software publisher of the package, up to 32 characters.

8. When you have finished entering the Package Settings options, proceed with entering the rest of the Package
Configuration options:

• Setting Access Accounts Options

• Setting Distribution Points Options

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 227


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

• Setting Programs Options

• Setting Advertisements Options

9. If you are finished entering Configuration Manager Package Configuration options, click Next to proceed to
the Package Summary page and perform the steps listed in Saving the Package on the Configuration
Manager Server.

Setting Access Accounts Options

On the Access Accounts View, you specify which administrators are allowed to distribute this particular package.

Task: To set Access Accounts configuration options:

1. Perform the steps described in Selecting a Package for Distribution.

2. On the Configuration Manager Package Configuration Page, select Access Accounts in the tree. The Access
Accounts View opens.

3. Use this view to create new users and groups. If you select a user’s icon under Access Accounts in the tree,
you can review (but not change) that user's permissions and can delete the user.

Option Description

Domain User List of all defined users, displaying the following:


Listing
• Name—User name using the syntax of Domain\User.
• Type—Identifies whether this is a user or a group, and identifies whether they
have Windows or Generic access.
• Permissions—Lists the user or group's permission.

Create New Access To create a new access account, select whether you want to create a Windows
Account User Access Account or a Generic Access Account, and perform the following
steps:

To create a Windows User Access Account:

1. Enter a User Name using the syntax of Domain\User.

2. Under Account Type, select User or Group.

3. Select this user's permission level from the Permissions list.

4. Click Create.

To create a Generic Access Account:

1. Under Account Type, select Users, Guests or Administrators.

2. Select this generic account's permission level from the Permissions list.

3. Click Create.

228 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

4. When you have finished entering the Access Accounts options, proceed with entering the rest of the Package
Configuration options:

• Setting Package Settings Options

• Setting Access Accounts Options

• Setting Distribution Points Options

• Setting Programs Options

• Setting Advertisements Options

5. If you are finished entering Configuration Manager Package Configuration options, click Next to proceed to
the Package Summary page and perform the steps listed in Saving the Package on the Configuration
Manager Server.

Setting Distribution Points Options

On the Distribution Points View, specify which servers may act as distribution points for this particular package.
A Distribution Point is a site system role that stores software package files so clients can access them during the
software distribution process. See Distributing Software Through Configuration Manager Server for more
information.

Task: To set Distribution Points options:

1. Perform the steps described in Selecting a Package for Distribution.

2. On the Configuration Manager Package Configuration Page, select Distribution Points in the tree. The
Distribution Points View opens, listing targeted distribution points and displaying the following information:

• Name—The name of the distribution point.

• Site—The name of the site where the distribution point is located (for example, NYC - New York City).

• Type—The type of distribution point (for example, Windows NT Server or NetWare Bindery).

3. To target a new distribution point(s), select a distribution point(s) from the Select New Distribution Point list
and click OK. The new distribution point will now be listed under Distribution Points in the tree.

4. When you have finished entering the Distribution Points options, proceed with entering the rest of the Package
Configuration options:

• Setting Package Settings Options

• Setting Access Accounts Options

• Setting Programs Options

• Setting Advertisements Options

5. If you are finished entering Configuration Manager Package Configuration options, click Next to proceed to
the Package Summary page and perform the steps listed in Saving the Package on the Configuration
Manager Server.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 229


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Setting Programs Options

On the Programs View, you specify programs (that will run on the clients) to execute the distribution of the
application, and the types of clients on which the program can run (directories, operating system versions, etc.).
The fields shown on the Programs View depends upon what is selected in the tree:

• To view a listing of existing programs and to create a new one, use the Main Programs View, which is
displayed when you select Programs in the tree.

• To edit an existing program, select the program icon under Programs in the tree to access the detailed tab
views.

Task: To set Program configuration options:

1. Perform the steps described in Selecting a Package for Distribution.

2. On the Configuration Manager Package Configuration Page, select Programs in the tree. The Programs View
opens.

3. To create a new program, select Programs in the tree, enter a name in the Name text box, and click Create.
The new program will now be listed under Programs in the tree. To edit the program settings on the detailed
tab view, select the program in the tree.

4. To edit an existing program, select the program icon under Programs in the tree to access the detailed tab
views (General, Requirements, Environment, and Advanced) where you can edit the program settings.

5. Click the General tab, and enter the following information:

Option Description

Icon To change the displayed icon, select a different icon from the list. This list is populated
with the files available from:

<Configuration Manager Web Console Installation Directory>\SMS Web Console


Application\Distribution Providers\SMS\Icons

Name The name of the program, up to 50 characters. This field is required and must be
unique within a package. This name is used when defining advertisements.

Comment Optional text about the program, such as a description. You can use up to 127
characters.

230 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Option Description

Command Line The command line for the program, up to 511 characters. This field is required. File
name extensions are strongly recommended.

Click Browse to navigate to the file. By default, the package source directory
appears, if it exists and is accessible. When the program is run on a client, the
command line file name will first be searched for within the package.

• If the file does not exist there, Configuration Manager searches the local Windows
directory.
• If Configuration Manager cannot find the file, the program fails.
• If the file name does not have a file name extension specified, Configuration
Manager tries .pif, .com, .exe, and .bat.
• If the file name has an extension but is not an executable, Configuration Manager
tries to apply a local association. For example, if the command line is readme.gif,
Configuration Manager will start the application specified on the client for
opening .gif files. For example:
setup.exe /a

command.com /c copy Jan98.dat c:\sales\Jan98.dat

Note • On 16-bit clients, batch files MUST specify the .bat file name extension, or the command
line will fail.

Start in The executable directory for the program, up to 127 characters. This directory can be
an absolute path on the client, or a path relative to the distribution point folder that
contains the package. This field is optional. For example:

c:\office97
i386

Run The program mode. By default, programs run in Normal mode. You can also run a
program in Minimized, Maximized, or Hidden mode.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 231


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Option Description

After Running The action that occurs after this program is completed successfully.

• No action required—No restart or logoff is required. This is the default value.


• Program restarts computer—The program requires a restart and performs the
restart automatically.
• Configuration Manager restarts computer—Configuration Manager restarts
the computer.
• Configuration Manager logs user off—Configuration Manager logs the
current user off the computer after the program is completed. Use this option if
the program requires that the user log off and then log on again before it can run.

Note • On 16-bit clients, only No action required is supported.

Caution • Both the Configuration Manager restarts computer and the Configuration Manager
logs user off actions are done forcefully after providing the user with a grace period. Applications
that are running on clients when this occurs will not have an opportunity to save their states or
data.

6. Click the Requirements tab and enter the following information:

Option Description

Estimated disk A whole number greater than or equal to zero that represents the amount of disk
space space the software will require when installed on the client. Also, specify the units
for the value.

Maximum allowed A whole number greater than zero that represents the time (in minutes) required
run time to run the program on the client.

Notify user if the Configuration Manager will monitor the run time of the program and warn the
program runs 15 user if the program is taking longer to run than the estimated time. By default, this
minutes longer than check box is cleared.
estimated

Note • This feature is not supported on 16-bit clients.

This program can The program can run on any platform. If this option is selected, Configuration
run on any platform Manager does not check the platform type when advertising the program to
clients. By default, this option is selected.

232 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Option Description

This program can The processors, operating systems, and service packs on which this program will
run only on run. When this option is selected, at least one platform must also be selected. By
specified client default, no platforms are selected. Configuration Manager uses this information
platforms when evaluating which clients in a collection are to receive the advertised
program.

Note • If you advertise this program to clients in Configuration Manager 1.2 sites,
Configuration Manager performs a less in-depth level of platform checking than it does for
Configuration Manager 2.0 clients. Platform checking for Configuration Manager 1.2 clients
is limited to Windows 3.1, Windows 95, x86 Windows NT, Alpha Windows NT, and Macintosh.

Additional Other information for clients, up to 127 characters. This field is optional. For
Requirements example, you can notify users that they should shut down all other applications
before running this program.

7. Click the Environment tab and enter the following information:

Option Description

Program can run Specify whether the program requires that a user be logged on to the client
computer to run:

• Only when a user is logged on—Prevents the program from running if no


user is logged on to the computer. This is the default setting. Use this option
for clients that do not run a Windows NT operating system.
• Only when no user is logged on— Prevents the program from running
until the user logs off the computer. This option is valid only for Windows NT
clients.

This option forces the program to run under the local Administrator account
on the client. If a user logs on while the installation is running, the program
continues to run.

• Whether or not a user is logged on—Enables the program to run with or


without user interaction. This option is valid only for Windows NT clients.

This option forces the program to run under the local Administrator account
on the client.

User input required Requires that the user interact with the program when it runs. This check box is
selected when Program can run is set to Only when a user is logged on. If the
program does not require user input, clear this check box.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 233


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Option Description

Run mode Select one of the following run modes:

• Run with user's rights


• Run with administrative rights

To specify that the program requires administrative privileges on the computer in


order to run, select Run with administrative rights. This option is available when
Program can run is set to Only when a user is logged on. By default, this check
box is cleared. This option is valid only for Windows NT clients.

The Run with administrative rights option forces the program to run under
the local Administrator account on the client.

Use software Run the program under an administrator-specified account (the Configuration
installation account Manager Windows NT Client Software Installation Account) on Windows NT
clients. This check box is available only when Program can run is set to Only
when no user is logged on or Whether or not a user is logged on. By default, this
check box is cleared.

This option should be used only when the program requires access to network
resources other than the package files on the distribution point.

Drive mode Select the drive mode used for network connections to the distribution points.

• Runs with UNC name—Enables the program to run with a universal


naming convention (UNC) name. This is the default setting.
• Requires drive letter—Indicates that the program requires a drive letter to
fully qualify its location, but Configuration Manager can use any available
drive letter on the client.
• Requires specific drive letter—Indicates that the program requires the
drive letter you specify (A to Z) to fully qualify its location (for example, H). If
the specified drive letter is already used on a client, the program will not run.

Reconnect to The computer will reconnect to the drive when the user logs on. By default, this
Distribution point at check box is cleared.
logon

Note • This feature is not supported on 16-bit clients.

234 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

8. Click the Advanced tab and enter the following information:

Option Description

Run another program This program requires another program (in another package that is targeted for
first distribution using Configuration Manager Web Console or in the current
package) to run before it. By default, this check box is cleared.

Note • This feature is not supported on 16-bit clients.

Note • The program you specify to run first does not need to be advertised separately.

Package The package that contains the program that must run before this program.

Program The program that must run first.

Note • If the depended-upon program fails on a client, the depending program will not
run. Also, if the program that runs first has been run successfully, Configuration Manager
will not automatically re-run it, even if the depending program is on a recurring schedule.

When this program is When Program can run (in the Environment tab) is set to Only when a user
assigned to a is logged on, you can specify how the program is assigned to users.
computer
• Run once for first user who logs on—The program should run only
once on the computer. This is the default setting. For example, a virus
checker only needs to run once on the client.
• Run once for every user who logs on—The program should run once
for each new user who logs on.

Note • On 16-bit clients, advertised programs will run only for the first user who logs on.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 235


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Option Description

Remove software Indicates that Configuration Manager will remove this program from client
when it is no longer computers when it is no longer advertised to those clients. This option is mainly
advertised useful for shared network applications and is available only to programs that
register with Add/Remove Programs in Control Panel.

To use this option, enter the name of the Uninstall Registry Key the program
creates in the following registry key:

HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\
CurrentVersion\Uninstall

After all advertisements for the program are revoked from the client,
Configuration Manager looks up the program's uninstall command line in the
UninstallString or QuietUninstallString property in this registry key. By
default, this check box is cleared.

An advertisement is considered revoked from a client when any of the following


are true:

• The client is no longer a member of the collection specified in the


advertisement.
• The advertisement is deleted.
• The advertisement expires.
• Uninstall registry key
• The registry key that contains the uninstall command for this program. You
can use up to 127 characters.

Note • This feature is not supported on 16-bit clients.

Disable this program Temporarily disables all advertisements that contain this program. The program
on computers where will be removed from the list available for users to run and will not be run via
it is advertised assignment until it is re-enabled. By default, this check box is cleared.

9. When you have finished entering the Programs options, proceed with entering the rest of the Package
Configuration options:

• Setting Package Settings Options

• Setting Access Accounts Options

• Setting Distribution Points Options

• Setting Advertisements Options

10. If you are finished entering Configuration Manager Package Configuration options, click Next to proceed to
the Package Summary page and perform the steps listed in Saving the Package on the Configuration
Manager Server.

236 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Setting Advertisements Options

On the Advertisements View, you identify the collection of users to receive this package, and specify when the
package will be available for distribution and whether it is optional or mandatory.

Task: To set Advertisements configuration options:

1. Perform the steps described in Selecting a Package for Distribution.

2. On the Configuration Manager Package Configuration Page, select Advertisements in the tree. The
Advertisements View opens, displaying a list of existing advertisements:

• Name—Name of the advertisement

• Program—The program to run on the client.

• Collection—The target collection of computers, users, or user groups that will receive the program.

• Available After—Date after which the advertisement will be available

• Expires After—Expiration date of advertisement

• Advertisement ID—Number uniquely identifying the advertisement

• Status—Advertisement’s status

3. To create a new advertisement, enter a name in the Name text box and click Create. The new advertisement
will now be listed under Advertisements in the tree.

4. To edit an existing advertisement, select it under Advertisements in the tree, and edit it on the detailed tab
view (General and Schedule).

5. On the General tab, enter the following information:

Option Description

Name The name of the advertisement, up to 50 characters. This field is required.

Comment Optional text about the advertisement, such as a description. You can use up to 127
characters.

Program The program (within the current package) to advertise to clients. This field is required.

Collection Select the existing collection that will receive the advertisement. Click Browse to open the
Select a Configuration Manager Collection Dialog Box, where you can select the
Configuration Manager collection that you want to use in this Advertisement definition.
This field is required.

Note • Configuration Manager will not advertise a program to 16-bit clients based on user groups or
user accounts, but this is supported for 32-bit clients.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 237


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Option Description

Include Specifies that the program also be advertised to clients and users in the specified
members of collection's subcollections. By default, this check box is selected.
subcollection
s

6. On the Schedule tab, enter the following information

Option Description

Advertisement The date and time when the program is advertised and available to run on clients.
start time By default, the current date and time is specified.

Greenwich Mean Time—Sets the time independent of time zones. That is, if you
set the time to 1:00 P.M. and select this option, the program will be advertised on
all clients simultaneously—1:00 P.M. for clients in the Greenwich mean time zone,
10:00 A.M. for clients in the Eastern time zone, and 7:00 A.M. for clients in the
Pacific time zone, and so on. This check box is cleared by default, which enables
you to specify a relative time for advertising the program. Configuration Manager
will treat the specified time as a local time. In this case, if the time is set to 1:00
P.M., the program will be advertised on clients at 1:00 P.M. in each time zone.

Mandatory If you want to ensure that the program runs on all clients (users cannot choose not
assignments to run the program), select:
(Assign
• As soon as possible
immediately after
this event) • Logon
• Logoff

Note • Recurring assignments are not supported on 16-bit clients. Programs advertised to
16-bit clients run only once on those clients.

Assignments are Suspends assignments for clients on a slow link. By default, this check box is
not mandatory over selected. (This option is available only if at least one assignment is defined.)
slow links

238 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Option Description

Allow users to run Enables users to run the program independent of when it is assigned. By default,
the program this check box is cleared. (This option is available only if at least one assignment is
independently of defined.)
assignments
Typically, only non-assigned programs are visible to users in the Configuration
Manager client interface. Use this option to display an assigned program in the
client interface. For example, to require users to upgrade their Microsoft Office
software, you specify an assignment in the advertisement properties. But if you
want to enable users to run the installation program before it is scheduled to run
automatically, select this option so that the assigned program appears in
Advertised Programs Wizard in the Control Panel on client computers.

Advertisement will Advertises the program to clients only for a limited time. By default, this option is
expire cleared. This feature is not supported on 16-bit clients; the program appears until
it runs on the client.

Note • When a program expires, it no longer appears in Advertised Programs Monitor or


Advertised Programs Wizard in Control Panel on client computers.To specify the cutoff date
and time, click the arrows next to the date and time. The default values are six months from
the current date and time.

Greenwich Mean Time—Set the time independent of time zones. That is, if you
set the time to 1:00 P.M. and select this option, the program will expire at all
computers simultaneously—1:00 P.M. for clients in the Greenwich mean time
zone, 10:00 A.M. for clients in the Eastern time zone, and 7:00 A.M. for clients in
the Pacific time zone, and so on. This check box is cleared by default, which
enables you to specify a relative time. Configuration Manager will treat the
specified time as a local time. In this case, if the time is set to 1:00 P.M., the
program will expire at 1:00 P.M. on clients in each time zone.

Priority The advertisement's priority when sent to child sites: High, Medium, or Low. The
default priority is Medium.

7. When you have finished entering the Advertisements options, proceed with entering the rest of the Package
Configuration options:

• Setting Package Settings Options

• Setting Access Accounts Options

• Setting Distribution Points Options

• Setting Programs Options

8. If you are finished entering Configuration Manager Package Configuration options, click Next to proceed to
the Package Summary page and perform the steps listed in Saving the Package on the Configuration
Manager Server.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 239


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Saving the Package on the Configuration Manager Server


To distribute an application from Configuration Manager Web Console using Configuration Manager Distribution,
perform the following steps.

Task: To save the package to the Configuration Manager Server:

1. Perform the steps described in Setting Package Configuration Options.

2. When the Package Summary page appears, review the summary of the all the options specified for the
package.

3. To save this package on the Configuration Manager Server, click Commit Changes to Configuration
Manager. A message will appear informing you that the package information was successfully saved to
Configuration Manager.

You could now view the status of the package by following the instructions in Viewing the Status of a
Distributed Package.

Viewing the Status of a Distributed Package


Click Package Administration on the Configuration Manager Web Console Home page to see the status of
a distributed package, delete a package, or modify a package's distribution settings.

Task: To view the status of a distributed package:

1. Launch Configuration Manager Web Console. The Configuration Manager Web Console Home Page
opens.

2. Click Package Administration. The Package Administration page appears, listing all packages which are
targeted for distribution.

3. Select a package and click View Status. The Connect to Configuration Manager page appears.

4. Enter a valid User Name and Password for the Configuration Manager Server you want to connect to, and
click Next. Configuration Manager Web Console retrieves the status of that package from the Configuration
Manager Server, and displays that information on the Package Status Page.

Modifying the Distribution Settings of a Package


Click Package Administration on the Configuration Manager Web Console Home Page to see the status of a
distributed package, delete a package, or modify a package’s distribution settings.

240 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Task: To modify the distribution settings of a package:

1. Launch Configuration Manager Web Console. The Configuration Manager Web Console Home Page
opens.

2. Click Package Administration. The Package Administration page appears, listing all packages which are
targeted for distribution.

3. Select a package and click Modify Settings. The Connect to Configuration Manager page appears.

If this package has not been distributed, you can change the Site Server and Site Code fields on the
Connect to Configuration Manager page. However, if the package has been distributed, you cannot
change these fields.

4. Enter a valid User Name and Password for the Configuration Manager Server you want to connect to, and
click Next. The General tab of the Package Settings View of the Configuration Manager Package
Configuration page opens.

5. Edit the package's distribution settings as described in Setting Package Configuration Options.

Deleting Packages
From the Configuration Manager Web Console, you can delete a package from the Application Catalog, from the
Configuration Manager Server, or both.

Caution • Deleting a distributed package from Configuration Manager will also delete its programs and any
advertisements of the programs. If the package has source files, they will be removed from distribution points. If
there are access accounts for this package, they will be deleted. Also, Configuration Manager Administrators'
security rights to the package will be deleted.

Caution • When you delete a package from the Application Catalog, all package configuration information is lost,
even if you do not delete it from Configuration Manager. If you delete a package from the Application Catalog but not
from Configuration Manager, the package would still be available on the Configuration Manager Server, but all
connection between the Application Catalog and Configuration Manager is lost. Should you want to distribute that
package again in the future, you would have to re-import the application into the Application Catalog, and then re-
enter package configuration information on the Configuration Manager Package Configuration Page.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 241


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Distributing Packages Using the Configuration Manager Web Console

Task: To delete a package:

1. Launch Configuration Manager Web Console. The Configuration Manager Web Console Home Page
opens.

2. Click Package Administration. The Package Administration page appears, listing all packages in your
Application Catalog. In the Status column, each package's status is either Distributed or Not Distributed.

3. Select a package and click Delete Distribution. The Connect to Configuration Manager page appears.

4. Enter a valid User Name and Password for the Configuration Manager Server you want to connect to, and
click Next. The Confirm Delete page appears prompting you to confirm that you want to delete this package
from the Application Catalog. If you are deleting a Distributed package, you are also prompted to confirm that
you want to delete this package from Configuration Manager.

5. Select Yes or No to indicate your deletion preferences:

Delete from Configuration


Package Status Delete from Catalog? Manager?

Not Distributed Choose Yes to confirm the deletion from N/A


the Application Catalog or choose No to
decline the deletion.

If you choose Yes, the package will be


deleted from the Application Catalog,
along with all of the package
configuration information that you
entered on the Configuration
Manager Package Configuration
page.

Distributed Choose Yes to confirm the deletion from Choose Yes to confirm the deletion from
the Application Catalog, or choose No Configuration Manager, or choose No to
to decline the deletion. decline the deletion.

If you delete a package from Unless you are certain that you will
Configuration Manager but do not delete never want to distribute this package
it from the Application Catalog, all of the again, it is recommended that if you
package configuration information that delete a package from Configuration
you entered on the Configuration Manager, you do not delete it from the
Manager Package Configuration Application Catalog.
page is saved, making it easy to
distribute this package again in the
future.

6. Click OK to confirm your selections.

242 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Configuration Manager Web Console


Reference
This section describes each of pages that you might encounter when using the Configuration Manager Web
Console. The following pages and views are documented:

• Configuration Manager Package Configuration Page

• Package Settings View

• Access Accounts View

• Distribution Points View

• Programs View

• Advertisements View

• Connect to Configuration Manager Page

• Confirm Delete Page

• Distribute New Package Page

• Distribute Package Page

• Microsoft System Center Configuration Manager Web Console Home Page

• Package Administration Page

• Package Status Page

• Package Summary Page

• PDF Selection Page

• Select a Configuration Manager Collection Dialog Box

• Distribution Settings Page

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 243


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Microsoft System Center Configuration Manager Web


Console Home Page
The Software Distribution page is the “home” page of Configuration Manager Web Console. From this page you
can choose to distribute a new package, perform package administration, and configure distribution settings.

The following selections are available:

Table 6-4 • Configuration Manager Web Console Home Page Options

Option Description

Distribute a New Click to access the Distribute Package Page where you can select a package to
Package distribute using distribution providers.

Package Click to access the Package Administration Page, where you can view the status of
Administration distributed applications, modify settings of distributed packages, and delete an
existing distribution.

Distribution Settings Click to access the Distribution Settings Page, where you can configure global
distribution settings or configure distribution provider settings.

Connect to Configuration Manager Page


This dialog appears when you are attempting to connect to a Configuration Manager Server.

All of the settings configured on this page only apply to the selected package. The default settings (specified on
the Distribution Settings Page) do not change.

Table 6-5 • Connect to Configuration Manager Page Options

Option Description

Site Server Enter the machine name on which Configuration Manager Server is installed. (This could
be a local or remote machine.) When you make a selection in this field, the Site Code
field is populated with a list of sites available on the Configuration Manager Server.

Site Code Select the Configuration Manager site you want to use for software distribution.

User Name Enter a valid user name for the Configuration Manager Server you want to connect to,
such as: Company\UserName.

Password Enter the appropriate password.

Next Click to proceed with the connection.

244 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Distribute Package Page


The Windows Installer .msi packages that you are preparing for distribution to Configuration Manager Server are
stored in the AdminStudio Enterprise Server Application Catalog. All of the Windows Installer packages in the open
Application Catalog are listed on the Distribute Package page, making them available for distribution. On this page,
select the package that you want to distribute to a Configuration Manager Server and click Distribute.

This page includes the following information and functionality.

Table 6-6 • Distribute Package Page Options

Option Description

Application Name Lists the names of all applications available for distribution. Click the radio button next
to the Application Name to select it for distribution. Only one application can be
selected at a time.

Company Name Lists the company affiliated with the listed application.

Distribute Click to initiate distribution of the selected application.

PDF Selection Page


A Package Definition File (.pdf) is a text file that contains predefined programs and property settings for a package
and is used to automate package creation. When you use a package definition file, appropriate fields on the
Configuration Manager Package Configuration Page are populated with the information in the package definition
file you selected. A package definition file typically has an .sms file name extension (.pdf in previous versions of
Configuration Manager).

This page contains the following fields:

Table 6-7 • PDF Selection Page Options

Option Description

Distribute Using Select this option if you want to distribute this application using an existing
Package Definition Configuration Manager Package Definition File (.pdf or .sms). When you select this
check box, the Use Existing Package Definition option is automatically selected,
and the list of existing Package Definitions available on the Configuration Manager
Server are shown on the following grid.

Use Existing Package Select this option to distribute this application using any Package Definitions
Definition available on the Configuration Manager Server. When the Distribute using
Package Definition check box is selected, this option is automatically selected,
and the list of existing Package Definitions available on the Configuration Manager
Server are shown on the following grid.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 245


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Table 6-7 • PDF Selection Page Options (cont.)

Option Description

Use Package Select this option if you want to distribute this application using a .pdf or .sms file
Definition from the located on the machine where Configuration Manager Console is installed. When
following file you select this option, the list below it is populated with a list of all of the .pdf or .sms
files in the following directory:

<Configuration Manager Web Console Installation Directory>\


SMS Web Console Application\Distribution Providers\SMS\PDFs

Next Click to proceed to the Configuration Manager Package Configuration Page where
appropriate fields are populated with the information in the Package Definition you
selected.

Configuration Manager Package Configuration Page


The Configuration Manager Package Configuration page, which you use to specify distribution configuration
fields that the Configuration Manager Server utilizes in the distribution of the package, consists of the following
views:

Table 6-8 • Configuration Manager Package Configuration Page Views

View Description

Package Settings View General information about the package, along with data source, data access,
distribution settings, and reporting information.

Access Accounts View Specify which administrators are allowed to distribute this particular package.

Distribution Points View Specify which servers may act as distribution points for this particular package. A
Distribution Point is a site system role that stores software package files so clients
can access them during the software distribution process.

Programs View Specify programs (that will run on clients) to execute the distribution of the
application, and the types of clients on which the program can run (defined using
directories, operating system versions, etc.).

Advertisements View Identify the collection of users to receive this package, and specify when the
package will be available for distribution and whether it is optional or mandatory.

246 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Package Settings View

Information on the Package Settings View is presented on the following tabs:

• General Tab

• Data Source Tab

• Data Access Tab

• Distribution Settings Tab

• Reporting Tab

Enter and edit information on these tabs and then click Update to save your changes.

General Tab
The General tab of the Package Settings View contains the following options:

Table 6-9 • Package Settings View — General Tab Options

Option Description

Icon To change the displayed icon, select a different icon from the list. This list is populated with the
files available from:

<Configuration Manager Web Console Installation Directory>\SMS Web Console


Application\Distribution Providers\SMS\Icons

Name The name of the package, up to 50 characters. This field is required.

Version The version number of the software package, up to 32 characters.

Publisher The name of the software publisher, up to 32 characters.

Language The language version of the software, up to 32 characters.

Comment Optional text about the package, such as a description. You can use up to 127 characters.

Data Source Tab


The Data Source tab of the Package Settings View contains the following options:

Table 6-10 • Package Settings View — Data Source Tab Options

Option Description

This Package This package has source files that are required to run its programs when they are
contains source files advertised to clients. By default, this check box is cleared. When this check box is
cleared, Configuration Manager does not use distribution points for the package.

Source Directory The network path to the package source files.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 247


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Table 6-10 • Package Settings View — Data Source Tab Options (cont.)

Option Description

Use a compressed Configuration Manager will create a compressed version of the source files on the
copy of the source site server. When you specify additional or refresh distribution points for the package,
directory the compressed version will be decompressed and copied to the distribution points,
rather than being copied directly from the original source directory.

Use this option if the source files might be removed from the specified path (for
example, if the source files are on a compact disc). A compressed version of the
source directory is always created and used when the package is sent to distribution
points in child sites.

This field is available only when the This Package contains source files check box is
selected.

Always obtain files Configuration Manager will obtain package source files (the files needed to run the
from source package programs, such as .exe and .dll files) from the path specified in the Source
directory directory box. Use this option if the source files are likely to remain at the specified
path, such as a share on a server.

This field is available only when the This package contains source files check box is
selected. By default, this option is selected.

Note • This option is unavailable if the package is a compressed version replicated from a
parent site.

Data Access Tab


The Data Access tab of the Package Settings View contains the following options:

Table 6-11 • Package Settings View — Data Access Tab Options

Property Description

Access distribution folder Users will access the package through the common Configuration Manager
through common package share (SMSPKGx$, where x is the drive letter) on distribution points.
Configuration Manager By default, this option is selected.
package share

Share Distribution folder The package will be created on distribution points with an administrator-
specified share (and path name) that is entered in the Share name text box.

248 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Table 6-11 • Package Settings View — Data Access Tab Options (cont.)

Property Description

Disconnect users from Notifies users before disconnecting them from distribution points when
distribution points Configuration Manager updates package data. By default, this check box is
cleared.

• Number of retries before disconnecting users—The number of


times that Configuration Manager tries to update the package source files
before starting to disconnect users who are connected to the distribution
point. The default setting is 2; you can specify 0 to 99, inclusive.
• User grace period—The number of minutes Configuration Manager
should wait after notifying users before disconnecting them from
distribution points. The default setting is 5 minutes; you can specify
between 0 and 59 minutes, inclusive.

Distribution Settings Tab


The Distribution Settings tab of the Package Settings View contains the following options:

Table 6-12 • Package Settings View — Distribution Settings Tab Options

Option Description

Sending priority The priority of this package when sent to distribution points in child sites. Packages can
be sent with High, Medium, or Low priority. The default setting is Medium priority.

• If a package has High priority, it will be sent before packages with Medium or Low
priority.
• If a package has Low priority, it will be sent after packages with higher priority
settings.
• If packages have identical priorities, they will be sent in the order in which they
were created in the Configuration Manager Administrator console.

Sending priority for a package is carried over in packages sent from a parent site to a
child site.

Preferred sender The sender to be used to send this package to distribution points in other sites. You can
specify any sender configured for the site, or No Preference (which uses any available
sender). The default setting is No Preference.

Note • To use Courier Sender to distribute packages, you must select it as the preferred sender.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 249


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Reporting Tab
The Reporting tab of the Package Settings View contains the following options:

Table 6-13 • Package Settings View — Reporting Tab Options

Property Description

Use package properties Configuration Manager will use the properties in the General tab for status MIF
for status MIF matching file matching. By default, this option is selected.

Use these fields for Configuration Manager will use the following values specified for status MIF file
status MIF matching matching:

• MIF file name—The name of the MIF file that contains the package status,
up to 50 characters.
• Name—The name of the package, up to 50 characters.
• Version—The version number of the package, up to 32 characters.
• Publisher—The software publisher of the package, up to 32 characters.

Access Accounts View

Use this view to create new users and groups. If you select a user's icon under Access Accounts in the tree, you
can review (but not change) that user's permissions and can delete the user.

Table 6-14 • Access Accounts View Options

Option Description

Domain User List of all defined users, displaying the following:


Listing
• Name—User name using the syntax of Domain\User.
• Type—Identifies whether this is a user or a group, and identifies whether they have
Windows or Generic access.
• Permissions—Lists the user or group's permission.

250 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Table 6-14 • Access Accounts View Options (cont.)

Option Description

Create New Access To create a new access account, select whether you want to create a Windows User
Account Access Account or a Generic Access Account, and perform the following steps:

To create a Windows User Access Account:

1. Enter a User Name using the syntax of Domain\User.

2. Under Account Type, select User or Group.

3. Select this user's permission level from the Permissions list.

4. Click Create.

To create a Generic Access Account:

1. Under Account Type, select Users, Guests or Administrators.

2. Select this generic account's permission level from the Permissions list.

3. Click Create.

Deleting a User or Group


To delete an individual user or group, select the user icon under Access Accounts in the tree and click Delete.

Distribution Points View

On the Distribution Points View, you can view a list of distribution points available on the Configuration Manager
Server and can target them for this package.

A Distribution Point is a site system role that stores software package files so clients can access them during the
software distribution process. See Distributing Software Through Configuration Manager Server for more
information.

Table 6-15 • Distribution Points View Options

Option Description

Distribution Point List of all defined distribution points, displaying the following:
Listing
• Name—The name of the distribution point.
• Site—The name of the site where the distribution point is located (for example,
NYC - New York City).
• Type—The type of distribution point (for example, Windows NT Server or
NetWare Bindery).

Select New To target a new distribution point(s), select a distribution point(s) from the list and
Distribution Point click OK. The new distribution point will now be listed under Distribution Points in
the tree.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 251


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Programs View

To view a listing of existing programs and to create a new one, use the main Programs View.

Table 6-16 • Programs View Options

Option Description

Program Listing List of all defined programs, displaying the program name, run time, disk space, and
any comments associated with the program.

Create New To create a new program, enter a name in the Name text box and click Create. The
Program new program will now be listed under Programs in the tree. To edit the program
settings on the detailed tab view, select the program in the tree.

To edit an existing program, select the program icon under Programs in the tree to access the detailed tab views
(General, Requirements, Environment, and Advanced) where you can edit the program settings.

General Tab
Make edits in these fields and then click Update to save your edits. To delete the program, click Delete.

Table 6-17 • Programs View — General Tab Options

Option Description

Icon To change the displayed icon, select a different icon from the list. This list is populated with the
files available from:

<Configuration Manager Web Console Installation Directory>\SMS Web Console


Application\Distribution Providers\SMS\Icons

Name The name of the program, up to 50 characters. This field is required and must be unique within
a package. This name is used when defining advertisements.

Comment Optional text about the program, such as a description. You can use up to 127 characters.

252 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Table 6-17 • Programs View — General Tab Options (cont.)

Option Description

Command The command line for the program, up to 511 characters. This field is required. File name
Line extensions are strongly recommended.

Click Browse to navigate to the file. By default, the package source directory appears, if it exists
and is accessible. When the program is run on a client, the command line file name will first be
searched for within the package.

• If the file does not exist there, Configuration Manager searches the local Windows directory.
• If Configuration Manager cannot find the file, the program fails.
• If the file name does not have a file name extension specified, Configuration Manager tries
.pif, .com, .exe, and .bat.
• If the file name has an extension but is not an executable, Configuration Manager tries to
apply a local association. For example, if the command line is readme.gif, Configuration
Manager will start the application specified on the client for opening .gif files. For example:
setup.exe /a

command.com /c copy Jan98.dat c:\sales\Jan98.dat

Note • On 16-bit clients, batch files MUST specify the .bat file name extension, or the command line will fail.

Start in The executable directory for the program, up to 127 characters. This directory can be an
absolute path on the client, or a path relative to the distribution point folder that contains the
package. This field is optional. For example:

c:\office97
i386

Run The program mode. By default, programs run in Normal mode. You can also run a program in
Minimized, Maximized, or Hidden mode.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 253


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Table 6-17 • Programs View — General Tab Options (cont.)

Option Description

After The action that occurs after this program is completed successfully.
Running
• No action required—No restart or logoff is required. This is the default value.
• Program restarts computer—The program requires a restart and performs the restart
automatically.
• Configuration Manager restarts computer—Configuration Manager restarts the
computer.
• Configuration Manager logs user off—Configuration Manager logs the current user off
the computer after the program is completed. Use this option if the program requires that
the user log off and then log on again before it can run.

Note • On 16-bit clients, only No action required is supported.

Caution • Both the Configuration Manager restarts computer and the Configuration Manager logs user off
actions are done forcefully after providing the user with a grace period. Applications that are running on
clients when this occurs will not have an opportunity to save their states or data.

Requirements Tab
Make edits in these fields and then click Update to save your edits. To delete the program, click Delete.

Table 6-18 • Programs View — Requirements Tab Options

Option Description

Estimated disk A whole number greater than or equal to zero that represents the amount of disk
space space the software will require when installed on the client. Also, specify the units for
the value.

Maximum allowed A whole number greater than zero that represents the time (in minutes) required to
run time run the program on the client.

Notify user if the Configuration Manager will monitor the run time of the program and warn the user if
program runs 15 the program is taking longer to run than the estimated time. By default, this check box
minutes longer than is cleared.
estimated

Note • This feature is not supported on 16-bit clients.

This program can The program can run on any platform. If this option is selected, Configuration
run on any platform Manager does not check the platform type when advertising the program to clients.
By default, this option is selected.

254 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Table 6-18 • Programs View — Requirements Tab Options (cont.)

Option Description

This program can The processors, operating systems, and service packs on which this program will run.
run only on When this option is selected, at least one platform must also be selected. By default,
specified client no platforms are selected. Configuration Manager uses this information when
platforms evaluating which clients in a collection are to receive the advertised program.

Note • If you advertise this program to clients in Configuration Manager 1.2 sites, Configuration
Manager performs a less in-depth level of platform checking than it does for Configuration
Manager 2.0 clients. Platform checking for Configuration Manager 1.2 clients is limited to
Windows 3.1, Windows 95, x86 Windows NT, Alpha Windows NT, and Macintosh.

Additional Other information for clients, up to 127 characters. This field is optional. For example,
Requirements you can notify users that they should shut down all other applications before running
this program.

Environment Tab
The Environment tab of the Programs View contains the following options:

Table 6-19 • Programs View — Environment Tab Options

Option Description

Program can run Specify whether the program requires that a user be logged on to the client computer
to run:

• Only when a user is logged on—Prevents the program from running if no user
is logged on to the computer. This is the default setting. Use this option for
clients that do not run a Windows NT operating system.
• Only when no user is logged on— Prevents the program from running until
the user logs off the computer. This option is valid only for Windows NT clients.

This option forces the program to run under the local Administrator account on
the client. If a user logs on while the installation is running, the program
continues to run.

• Whether or not a user is logged on—Enables the program to run with or


without user interaction. This option is valid only for Windows NT clients.

This option forces the program to run under the local Administrator account on
the client.

User input required Requires that the user interact with the program when it runs. This check box is
selected when Program can run is set to Only when a user is logged on. If the
program does not require user input, clear this check box.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 255


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Table 6-19 • Programs View — Environment Tab Options (cont.)

Option Description

Run mode Select one of the following run modes:

• Run with user's rights


• Run with administrative rights

To specify that the program requires administrative privileges on the computer in


order to run, select Run with administrative rights. This option is available when
Program can run is set to Only when a user is logged on. By default, this check box is
cleared. This option is valid only for Windows NT clients.

The Run with administrative rights option forces the program to run under the
local Administrator account on the client.

Use software Run the program under an administrator-specified account (the Configuration
installation account Manager Windows NT Client Software Installation Account) on Windows NT clients.
This check box is available only when Program can run is set to Only when no user is
logged on or Whether or not a user is logged on. By default, this check box is
cleared.

This option should be used only when the program requires access to network
resources other than the package files on the distribution point.

Drive mode Select the drive mode used for network connections to the distribution points.

• Runs with UNC name—Enables the program to run with a universal naming
convention (UNC) name. This is the default setting.
• Requires drive letter—Indicates that the program requires a drive letter to fully
qualify its location, but Configuration Manager can use any available drive letter
on the client.
• Requires specific drive letter—Indicates that the program requires the drive
letter you specify (A to Z) to fully qualify its location (for example, H). If the
specified drive letter is already used on a client, the program will not run.

Reconnect to The computer will reconnect to the drive when the user logs on. By default, this check
Distribution point at box is cleared.
logon

Note • This feature is not supported on 16-bit clients.

256 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Advanced Tab
The Advanced tab of the Programs View contains the following options:

Table 6-20 • Programs View — Advanced Tab Options

Option Description

Run another program This program requires another program (in another package that is targeted for
first distribution using Configuration Manager Web Console or in the current package) to
run before it. By default, this check box is cleared.

Note • This feature is not supported on 16-bit clients.

Note • The program you specify to run first does not need to be advertised separately.

Package The package that contains the program that must run before this program.

Program The program that must run first.

Note • If the depended-upon program fails on a client, the depending program will not run.
Also, if the program that runs first has been run successfully, Configuration Manager will not
automatically re-run it, even if the depending program is on a recurring schedule.

When this program is When Program can run (in the Environment tab) is set to Only when a user is
assigned to a logged on, you can specify how the program is assigned to users.
computer
• Run once for first user who logs on—The program should run only once on
the computer. This is the default setting. For example, a virus checker only
needs to run once on the client.
• Run once for every user who logs on—The program should run once for
each new user who logs on.

Note • On 16-bit clients, advertised programs will run only for the first user who logs on.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 257


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Table 6-20 • Programs View — Advanced Tab Options (cont.)

Option Description

Remove software Indicates that Configuration Manager will remove this program from client
when it is no longer computers when it is no longer advertised to those clients. This option is mainly
advertised useful for shared network applications and is available only to programs that register
with Add/Remove Programs in Control Panel.

To use this option, enter the name of the Uninstall Registry Key the program creates
in the following registry key:

HKEY_LOCAL_MACHINE\Software\Microsoft\Windows\ CurrentVersion\Uninstall

After all advertisements for the program are revoked from the client, Configuration
Manager looks up the program's uninstall command line in the UninstallString or
QuietUninstallString property in this registry key. By default, this check box is
cleared.

An advertisement is considered revoked from a client when any of the following are
true:

• The client is no longer a member of the collection specified in the


advertisement.
• The advertisement is deleted.
• The advertisement expires.
• Uninstall registry key
• The registry key that contains the uninstall command for this program. You can
use up to 127 characters.

Note • This feature is not supported on 16-bit clients.

Disable this program Temporarily disables all advertisements that contain this program. The program will
on computers where be removed from the list available for users to run and will not be run via assignment
it is advertised until it is re-enabled. By default, this check box is cleared.

258 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Advertisements View

On the Advertisements View, you identify the collection of users to receive this package, and specify when the
package will be available for distribution and whether it is optional or mandatory. You can view a list of existing
advertisements and create new advertisements.

Table 6-21 • Advertisements View Options

Option Description

Advertisement List of all existing advertisements, displaying the following:


Listing
• Name—Name of the advertisement
• Program—The program to run on the client.
• Collection—The target collection of computers, users, or user groups that will
receive the program.
• Available After—Date after which the advertisement will be available
• Expires After—Expiration date of advertisement
• Advertisement ID—Number uniquely identifying the advertisement
• Status—Advertisement's status

Create New To create a new advertisement, enter a name in the Name text box and click Create. The
Advertisement new advertisement will now be listed under Advertisements in the tree.

If you select an existing advertisement under Advertisements in the tree, you can edit it on the detailed tab view
(General and Schedule).

General Tab
To edit or delete an advertisement, select the advertisement icon under Advertisements in the tree. The General tab
appears. Make edits in these fields and then click Update to save your edits. To delete the advertisement, click
Delete.

Table 6-22 • Advertisements View — General Tab Options

Option Description

Name The name of the advertisement, up to 50 characters. This field is required.

Comment Optional text about the advertisement, such as a description. You can use up to 127
characters.

Program The program (within the current package) to advertise to clients. This field is required.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 259


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Table 6-22 • Advertisements View — General Tab Options (cont.)

Option Description

Collection Select the existing collection that will receive the advertisement. Click Browse to open the
Select a Configuration Manager Collection Dialog Box, where you can select the
Configuration Manager collection that you want to use in this Advertisement definition. This
field is required.

Note • Configuration Manager will not advertise a program to 16-bit clients based on user groups or user
accounts, but this is supported for 32-bit clients.

Include Specifies that the program also be advertised to clients and users in the specified collection's
members of subcollections. By default, this check box is selected.
subcollection
s

Schedule Tab
Make edits in these fields and then click Update to save your edits. To delete the advertisement, click Delete.

Table 6-23 • Advertisements View — Schedule Tab Options

Option Description

Advertisement The date and time when the program is advertised and available to run on clients. By
start time default, the current date and time is specified.

Greenwich Mean Time—Sets the time independent of time zones. That is, if you set
the time to 1:00 P.M. and select this option, the program will be advertised on all clients
simultaneously—1:00 P.M. for clients in the Greenwich mean time zone, 10:00 A.M. for
clients in the Eastern time zone, and 7:00 A.M. for clients in the Pacific time zone, and
so on. This check box is cleared by default, which enables you to specify a relative
time for advertising the program. Configuration Manager will treat the specified time as
a local time. In this case, if the time is set to 1:00 P.M., the program will be advertised
on clients at 1:00 P.M. in each time zone.

Mandatory If you want to ensure that the program runs on all clients (users cannot choose not to
assignments run the program), select:
(Assign
• As soon as possible
immediately after
this event) • Logon
• Logoff

Note • Recurring assignments are not supported on 16-bit clients. Programs advertised to 16-bit
clients run only once on those clients.

260 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Table 6-23 • Advertisements View — Schedule Tab Options (cont.)

Option Description

Assignments are Suspends assignments for clients on a slow link. By default, this check box is selected.
not mandatory over (This option is available only if at least one assignment is defined.)
slow links

Allow users to run Enables users to run the program independent of when it is assigned. By default, this
the program check box is cleared. (This option is available only if at least one assignment is
independently of defined.)
assignments
Typically, only non-assigned programs are visible to users in the Configuration
Manager client interface. Use this option to display an assigned program in the client
interface. For example, to require users to upgrade their Microsoft Office software, you
specify an assignment in the advertisement properties. But if you want to enable users
to run the installation program before it is scheduled to run automatically, select this
option so that the assigned program appears in Advertised Programs Wizard in the
Control Panel on client computers.

Advertisement will Advertises the program to clients only for a limited time. By default, this option is
expire cleared. This feature is not supported on 16-bit clients; the program appears until it
runs on the client.

Note • When a program expires, it no longer appears in Advertised Programs Monitor or


Advertised Programs Wizard in Control Panel on client computers.To specify the cutoff date and
time, click the arrows next to the date and time. The default values are six months from the current
date and time.

Greenwich Mean Time—Set the time independent of time zones. That is, if you set
the time to 1:00 P.M. and select this option, the program will expire at all computers
simultaneously—1:00 P.M. for clients in the Greenwich mean time zone, 10:00 A.M. for
clients in the Eastern time zone, and 7:00 A.M. for clients in the Pacific time zone, and
so on. This check box is cleared by default, which enables you to specify a relative
time. Configuration Manager will treat the specified time as a local time. In this case, if
the time is set to 1:00 P.M., the program will expire at 1:00 P.M. on clients in each time
zone.

Priority The advertisement's priority when sent to child sites: High, Medium, or Low. The
default priority is Medium.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 261


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Package Summary Page


This page, which lists a summary of the information in the .pdf file that you are using for Configuration Manager
distribution, appears after you have reviewed the .pdf file on the Configuration Manager Package Configuration
Page.

Click Commit Changes to Configuration Manager to save the package on the Configuration Manager Server.

A message will appear informing you that the package changes were successfully saved to Configuration
Manager.

Select a Configuration Manager Collection Dialog Box


This dialog box, which appears when you click Browse next to the Collection field on the General tab of the
Advertisements View of the Configuration Manager Package Configuration Page, lists all defined collections on the
Configuration Manager Server.

Select the collection that you want to use for the Advertisement definition, and click OK.

Distribution Settings Page


On the Distribution Settings page, which opens when you click Distribution Settings on the Configuration
Manager Web Console Home Page, you set the default Configuration Manager Server connection settings.

Table 6-24 • Distribution Settings Page Options

Option Description

Site Server Name Enter the machine name on which Configuration Manager Server is installed. (This
could be a local or remote machine.) When you make a selection in this field, the Site
Code field is populated with a list of sites available on the Configuration Manager
Server.

Site Code Select the Configuration Manager site you want to use for software distribution.

User Name Enter the user name appropriate for the Configuration Manager Site you want to
connect to.

Update Click to save your entries.

Note • The values on entered on this page will be used as the default values for any new package you target for
distribution. However, you can change these values while configuring the package.

262 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Package Administration Page


On this page you can view the status of distributed applications, modify settings of distributed packages, and
delete an existing distribution.

Table 6-25 • Package Administration Page Options

Option Description

Configuration Package ID assigned to this package by Configuration Manager.


Manager Package ID

Package Name Name of the package.

Version Version of the package.

Language Language that the package was written for.

Description Description of package.

Status Lists the distribution status of the package: Distributed or Not Distributed.

Application Name Name of application.

Company Name Manufacturer of application.

Modify Settings Click to modify the selected package's distribution settings. After you connect to the
appropriate Configuration Manager Server, the Configuration Manager Package
Configuration Page appears, where you can modify the distribution settings.

View Status Click to view the status of a distributed application. Configuration Manager Web
Console connects to the Configuration Manager Server, retrieves the status of that
application, and displays that status as a text message.

Delete Distribution Click to delete the selected application from Configuration Manager Web Console
and/or the Configuration Manager Server.

Package Status Page


The Package Status page opens when you select a Distribution Package on the Package Administration Page, and
click View Status.

A summary of this distributed package status is displayed in two main sections: Package Status and
Advertisement Status.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 263


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Package Status
The Package Status section includes the following information:

Table 6-26 • Package Status Page — Package Status Information

Option Description

Site Server location where package was distributed.

Distribution Point Distribution point where this package was distributed. A distribution point is a site
system role that stores software package files so clients can access them during the
software distribution process.

State Identifies the state of the source files on the distribution point. Values are:

• INSTALLED (0)
• INSTALL_PENDING (1)
• INSTALL_RETRYING (2)
• INSTALL_FAILED (3)
• REMOVAL_PENDING (4)
• REMOVAL_RETRYING (5)
• REMOVAL_FAILED (6)

Last Copied Date and time (GMT) when the package source files were last successfully copied to
the distribution point.

Source Version The number of times an administrator has updated the package source files and
requested an update to distribution points (specified on the Data Source tab of the
Package Properties dialog box).

Targeted The number of distribution points this package was sent to.

Installed The number of distribution points that received this package.

Retrying The number of distribution points that are having problems receiving the package, but
that Configuration Manager is still attempting to deliver to.

Failed The number of distribution points that failed to receive the package. Failure means
Configuration Manager tried to deliver the package several times, but could not do so
successfully.

Summary Date Date and time (GMT) when a change in package status for the sites was most recently
reported.

Path NAL path to the package's source files.

264 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Advertisement Status
The Advertisement Status section includes the following information

Table 6-27 • Package Status Page — Advertisement Status Information

Option Description

Advertisement Name Name of the advertisement.

Site Server location where package was distributed.

Target Collection Name of the collection to which this advertisement is advertised

Program Name of the program (related to PackageID) that this advertisement advertises.

Available After A program available to members of a collection after this time.

Expires After A program will no longer be available to members of a collection after this time.

Received Total number of users, user groups, or client computers that are reporting
successful receipt of the advertisement.

Failures Total number of users, user groups, or client computers that experienced an
error in processing the advertisement or its associated program, or that
attempted to run the advertised program but failed before the program could be
started.

Programs Started Total number of users, user groups, or client computers in the site that were able
to successfully start running the advertised program.

Program Errors Total number of users, user groups, or client computers that reported errors
while running the advertised program. A program is considered in error when it
produces either:

1. A non-zero exit code, or

2. An install-status MIF file with a failure-status attribute. This file, if present, will
override an exit code.

Program Success Total number of users, user groups, or client computers, or both, that are
reporting that the advertisement ran successfully. A program is considered
successful when it produces either:

1. A exit code of zero, or

2. An install-status MIF file with a success-status attribute. This file, if present,


will override an exit code.

Advertisement ID Unique identifier that Configuration Manager assigns to each advertisement.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 265


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Confirm Delete Page


The Confirm Delete page opens when you select a package on the Package Administration Page, and click
Delete Distribution.

The messages shown on this page depend upon the status of the selected package: Distributed or Not
Distributed:

• For both package status types, you are prompted to confirm that you want to delete the package from the
Application Catalog.

• If you are deleting a Distributed package, you are also prompted to confirm that you want to delete this
package from Configuration Manager.

Select Yes or No to indicate your deletion preferences:

Table 6-28 • Package Deletion Options

Package Status Delete from Catalog? Delete from Configuration Manager?

Not Distributed Choose Yes to confirm the deletion from N/A


the Application Catalog or choose No to
decline the deletion.

If you choose Yes, the package will be


deleted from the Application Catalog,
along with all of the package configuration
information that you entered on the
Configuration Manager Package
Configuration page.

Distributed Choose Yes to confirm the deletion from Choose Yes to confirm the deletion from
the Application Catalog, or choose No to Configuration Manager, or choose No to
decline the deletion. decline the deletion.

If you delete a package from Configuration Unless you are certain that you will never
Manager but do not delete it from the want to distribute this package again, it is
Application Catalog, all of the package recommended that if you delete a package
configuration information that you entered from Configuration Manager, you do not
on the Configuration Manager Package delete it from the Application Catalog.
Configuration page is saved, making it
easy to distribute this package again in the
future.

Click OK to confirm your selections.

266 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

Caution • Deleting a distributed package from Configuration Manager will also delete its programs and any
advertisements of the programs. If the package has source files, they will be removed from distribution points. If
there are access accounts for this package, they will be deleted. Also, Configuration Manager Administrators'
security rights to the package will be deleted.

Caution • When you delete a package from the Application Catalog, all package configuration information is lost,
even if you do not delete it from Configuration Manager. If you delete a package from the Application Catalog but not
from Configuration Manager, the package would still be available on the Configuration Manager Server, but all
connection between the Application Catalog and Configuration Manager is lost. Should you want to distribute that
package again in the future, you would have to re-import the application into the Application Catalog, and then re-
enter package configuration information on theConfiguration Manager Package Configuration Page.

Distribute New Package Page

Edition • This feature is included with AdminStudio Standard Edition only.

In the Application Name field, enter the name of the application that you want to distribute to a Configuration
Manager Server, and click Distribute to continue.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 267


Chapter 6: Distributing Packages Using Configuration Manager Web Console
Configuration Manager Web Console Reference

268 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


7
Using Workflow Manager to Manage
Enterprise Software Packaging

AdminStudio Workflow Manager is a Web-based application management system that gives you control over your
software package management process. Workflow Manager enables your organization to work together to quickly
prepare software for deployment while ensuring best practices are always followed.

The Workflow Manageruser documentation is presented in the following section

Table 7-1 • AdminStudio User Documentation

Topic Content

About AdminStudio Workflow Provides an overview of Workflow Manager and explains Workflow
Manager Manager concepts.

Getting Started Lists Workflow Manager System Requirements, describes the steps you
need to start using Workflow Manager, and explains how to customize
Workflow Manager for your organization.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 269


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
About AdminStudio Workflow Manager

Table 7-1 • AdminStudio User Documentation (cont.)

Topic Content

Using Workflow Manager to Includes how to perform the following tasks:


Manage Enterprise Software
• Submitting and Monitoring Application Requests—Includes
Packaging
procedures that are related to submitting, monitoring, and reporting
on Application Requests. See Submitting and Monitoring Application
Requests.
• Completing Application Requests—Includes procedures that are
related to performing Application Request tasks. See Completing
Application Requests.
• Generating and Viewing Workflow Manager Reports—Explains
how to view existing reports or create custom reports, and how to
export report data. See Generating and Viewing Workflow Manager
Reports.
• Performing Administrative Tasks—Includes administrative
procedures such as creating users and groups, defining roles and
permissions, directory services configuration, creating Templates and
projects. See Performing Administrative Tasks.

Workflow Manager Reference Includes the same topics that are displayed when you open help from the
Workflow Manager interface.

About AdminStudio Workflow Manager


AdminStudio Workflow Manager is a scalable Web-based data and workflow management system that lets you
monitor and control every aspect of the software packaging, deployment, and management process across your
entire enterprise. Workflow Manager ensures your IT department always follows a single efficient process when
preparing applications for deployment, enabling you to consistently achieve reliable deployment results that
translate into significantly lower IT costs.

With Workflow Manager, you can:

• Centrally track and manage the software packaging process across your enterprise.

• Give application owners an easy way to submit complete Application Requests.

• Enable IT Management to assign requests to the most available packager.

• Automatically route packages on to the next process step after tasks are completed.

• Generate reports from extensive application data captured by Workflow Manager.

270 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
About AdminStudio Workflow Manager

In this section, information about Workflow Manager is presented in the following topics:

Table 7-2 • About AdminStudio Workflow Manager Topics

Topic Description

Workflow Manager Presents a diagram that explains how Workflow Manager manages and coordinates
and the Application the major steps and people usually involved in an application lifecycle.
Lifecycle

Workflow Manager Familiarizes you with the following Workflow Manager concepts:
Concepts
• Workflow Templates
• Projects
• Application Requests
• Customers, Servicers, and Companies
• Application Families
• Deployment Sites

Workflow Manager and the Application Lifecycle


AdminStudio Workflow Manager is a scalable Web-based data and workflow management system that helps you
monitor and control the software packaging, deployment, and management process across your enterprise.
Workflow Manager enables your IT department to follow a single efficient process when preparing applications for
deployment.

The following diagram illustrates how Workflow Manager connects IT Management, software packagers, and
application owners to streamline the packaging process:

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 271


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
About AdminStudio Workflow Manager

Figure 7-1: Workflow Manager and the Application Lifecycle

Workflow Manager gives application owners an easy way to submit Application Requests to IT Management, who
can then approve and assign the Request to the most available software packager. Software packagers receiving
an Application Request see at a glance each process step and the tasks that they need to complete. As they
complete their tasks, Workflow Manager automatically routes the Application Request on to the next process step,
improving efficiency while ensuring steps are never overlooked.

This diagram is described in the following table:

Table 7-3 • Workflow Manager and the Application Lifecycle Diagram Description

# Step Description

1 End User Submits an An End User, defined as a Customer in the Workflow Manager system, could
Application Request be a person in your accounting department who wants a copy of Excel
installed, or a System Administrator at one of your client companies who
wants a copy of Photoshop repackaged and ready for distribution.

When submitting an Application Request, the user is prompted to enter data


required by the specified Workflow Template that was used to create this
Application Request.

2 IT Manager Reviews The IT Manager, defined as a Servicer Administrator in the Workflow


Application Request and Manager system, reviews the Application Request to see if all required
Assigns Tasks information has been entered. He then assigns the Application Request to
individual users or to a Role.

272 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
About AdminStudio Workflow Manager

Table 7-3 • Workflow Manager and the Application Lifecycle Diagram Description

# Step Description

3 Packagers Repackage Software Packagers at the Service Company perform the tasks detailed on
Application and Perform the Workflow. As they perform each step, the appropriate personnel at both
Testing the Customer Company and Service Company are informed.

4 End User is Notified that When all phases of the Workflow have been completed, the person who
Application is Ready for originally submitted the Application Request is informed that his application
Installation is ready for his use.

Using Workflow Manager to manage your application life cycles provides the following benefits:

• Enables Customer self-service through a web-based interface.

• Monitors progress through the migration life cycle and provides real-time status reporting.

• Tracks all steps involved in application lifecycle via workflows.

• Creates a centralized repository of critical package metadata.

• Keeps an audit trail of critical Customer and packager communications, both internal and external.

• Enforces packaging standards and processes.

• Enables you to advertise, distribute and track SMS packages.

Workflow Manager Concepts


This section familiarizes you with the following Workflow Manager concepts:

Table 7-4 • Workflow Manager Concepts

Concept Description

Workflow Templates A Workflow Manager Workflow is an ordered series of phases and steps that a Service
Company follows. The sequence of phases and steps is determined by a Template.

Projects Defined for a specific Customer Company with a specific Application Request and a
Deployment Template, which determine the steps that the Service Company carries
out in preparing the application for deployment to end users' computers and in
deploying the prepared application.

Application A record, associated with a Project, requesting that a Servicer perform a series of
Requests steps, typically, to prepare an application for deployment to end user computers or to
deploy the prepared application to end user computers.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 273


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
About AdminStudio Workflow Manager

Table 7-4 • Workflow Manager Concepts (cont.)

Concept Description

Customers, Describes the two types of Workflow Manager users: Customers—for whom
Servicers, and application work is done, and Servicers—who do application work.
Companies

Application Families User-defined categories, such as Manufacturer or type of software, that you can set
up to group Application Requests.

Deployment Sites User-defined groups of end users of the Customer Company, such as office locations
or departments, where software will be deployed.

Workflow Templates
A Workflow Template is an ordered series of steps that a Service Company follows to perform a task.

• A Workflow Template is comprised of a series of Workflow Phases, and each Workflow Phase contains
Workflow Steps.

• When a Project is created, it is associated with one Workflow Template.

• When an Application Request is created for that Project, it uses that Workflow Template, in effect putting that
Workflow Template into action.

There are two types of Workflows in Workflow Manager:

• An Application Workflow is the series of steps that a Service Company follows to prepare an application for
deployment.

• A Deployment Workflow is the series of steps that a Service Company follows to deploy the prepared
application.

274 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
About AdminStudio Workflow Manager

Workflow Template Example


A Workflow Template includes multiple Workflow Phases, and each Phase includes one or more Workflow Steps. In
the graphic below of an Application Request’s Application Progress page, there are five Workflow Phases:

Figure 7-2: Sample Workflow Template

The first Workflow Step in the first Phase is a data entry step, requiring the person who submits the Application
Request to enter some data. You can add another data collection Workflow Step later in the Workflow.

Template With Conditions and Conditional Branching


A Workflow Manager Template can employ conditional branching, meaning that the Workflow Phase that is
displayed next can depend on user input. You can also create a Template that conditionally hides or displays Data
Groups, Data Elements, or Workflow Steps based on user input. For more information, see Creating Templates
That Use Conditions.

Projects
A project specifies the terms under which the Service Company will perform one or more Application Requests for
the Customer. It includes Service Level Agreement (SLA) information to enforce Project and Application Request
deadlines.

A Project is associated with one Application Workflow Template and one Deployment Workflow Template. These
Templates determine the steps that the Service Company carries out when performing the Application Request and
deploying the prepared application.

On the Project Permission and Notification Settings View of the Project Administration page, you assign Role
Permissions and Email Notification Settings for each Phase / Workflow Step in a Project.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 275


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
About AdminStudio Workflow Manager

Application Requests
An Application Request is a record, associated with a Project, requesting that a Servicer perform a series of steps,
typically, to prepare an application for deployment to end user computers or to deploy the prepared application to
end user computers.

An end user, defined as a Customer in the Workflow Manager system, could be a person in your accounting
department who wants a copy of Microsoft Excel installed, or a System Administrator at one of your client
companies who wants a copy of Adobe Photoshop repackaged and ready for distribution.

To request that a set of tasks be performed to provide the requested software or service, a user submits an
Application Request. The user is prompted to enter data required by the specified Workflow Template that was
used to create this Application Request.

Then, the Application Manager, defined as a Servicer Administrator in the Workflow Manager system, reviews the
Application Request to see if all required information has been entered. He then assigns the Application Request to
individual technicians, defined as Servicers in the Workflow Manager system, or to a Servicer Role, to perform the
requested tasks.

Customers, Servicers, and Companies


There are two main categories of Workflow Manager users: Customers, for whom application work is done; and
Servicers, who do application work. A Servicer can do work for multiple Customers and multiple Customer
companies.

Tip • For some Workflow Manager users, “Customer Companies” may be departments within a single corporation,
and the “Service Company” may be the IT department of that corporation.

Customers use Workflow Manager to submit Application Requests and check the status of ongoing Application
Requests. Servicers use Workflow Manager to record the status of Application Requests and communicate with
Customers.

The status of an Application Request is measured against an Application Template and a Deployment Template,
which specify the phases and individual steps in the application and deployment processes.

When submitting an Application Request, the Customer specifies the Templates to be used by selecting an existing
Project that relates the Customer Company and a Service Company. The progress of an Application Request can
be viewed on the Application Progress page, where the steps of the Workflow Template are listed with visual
indicators of which ones are completed or not started yet, and which one is the current step.

Servicers also administer Workflow Manager in the following ways:

• add Customers, Companies, Servicers, and Service Companies

• assign Roles to Customers and Servicers for each Application Request

• assign permissions to Roles

• create Roles, Projects, and (optionally) Templates

276 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
About AdminStudio Workflow Manager

Roles & Permissions


A user’s assigned Roles determines how much functionality is available to that user. Permissions for all of Workflow
Manager’s functions are assigned to Roles, and Roles are assigned to Users. For more information, see Managing
Roles and Permissions.

Application Families
Workflow Manager supports organizing Application Requests into families. An Application Request is assigned to a
family by the person who submits the Application Request. You can filter by application family in searches and
various views.

Suppose that your organization was submitting Application Requests for three ABC Company products and two
XYZ Company products:

• ABC Company: IllustrateIt, BitMapIt, WebIt

• XYZ Company: AnimateIt, PublishIt

You could assign the ABC Company Application Requests to the ABC Company application family, and the XYZ
Company Application Requests to the XYZ Company application family.

The list of available application families can be added to when an Application Request is submitted. The ability to
add to the list of available application families rests with the Service Company and may also rest with the Customer
Company, depending on the choice made by the Servicer when the Service Company was created.

Deployment Sites
An application may need to be deployed to end users' computers differently for different groups of end users—for
example, user at different locations of the Customer Company. To accommodate this, Workflow Manager lets you
define multiple deployment sites.

Each deployment site that is associated with a particular Application Request has its own deployment Workflow,
which can be advanced or rolled back independently of the others.

Each Customer Company has its own list of deployment sites, which is administered by the Service Company; the
set of sites that are associated with a particular Application Request is determined by the person who submits the
Application Request.

How Dates and Times are Displayed in Workflow


Manager
Workflow Manager displays all dates per the time zone and language defined in the user's browser (not the time
zone and language of the Workflow Manager server).

Workflow Manager saves date time information in UTC format (Coordinated Universal Time) and converts it to the
local date time format—based on the user’s browser time zone setting—for display.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 277


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

Note • UTC format was formerly referred to as GMT or Greenwich Mean Time.

United States Example


The day and date for a United States customer would be displayed in MM/DD/YYYY format with a 12-hour clock and
an AM or PM designation:

10/23/2006 02:28:15 P.M.

Figure 7-3: Date and Time Displayed in United States Format

United Kingdom Example


The day and date for a United Kingdom customer would be displayed in DD/MM/YYYY format with a 24-hour clock
(no AM or PM designation):

23/10/2006 14:28:15

Figure 7-4: Date and Time Displayed in United Kingdom Format

Getting Started
When you first install Workflow Manager, there are specific Administrative tasks that you need to perform before
Workflow Manager is ready to use. Also, you have the option of changing the application graphics and text to
customize Workflow Manager for your organization. This section includes the following topics:

• How To Get Started

• Customizing Workflow Manager for Your Organization

How To Get Started


To get started using Workflow Manager, perform the following tasks:

• Identify Login for Service Company Administrator Account

• Initialize Workflow Manager

• Review the Lifecycle of an Application Request

278 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

Identify Login for Service Company Administrator Account


When Workflow Manager is installed, default Companies, Roles, and User accounts are created so that you can
immediately log in and start using Workflow Manager. One Service Company and one Customer Company are
created. To get started, you should log in using the default Service Company administrator account.

The Company Name of the default Service and Customer companies, as well as the User Name of the default
Service Company administrator account, vary depending upon whether you upgraded an existing database or
created a new one during Workflow Manager installation:

Table 7-5 • Default Company Names and Default Service Company Administrator Account

Service
Passwo Company Nam Customer
Situation User Name rd e Company Name

Created a New admin@servicer.com admin Servicer Requester


Database

Upgraded from a admin@serviceco.com admin ServiceCo CustomerCo


Previously Existing
AdminStudio (5.5 or
later) or AMS SQL
Server Database

Note • To see a list of all of the default Roles and User accounts that are created for the Service and Customer
companies, see System Roles.

Initialize Workflow Manager


Before Application Requests can be started, Workflow Manager must be initialized by performing the following
steps. Several steps are links to detailed instructions; after following each set of instructions, you can return to this
help topic by clicking the help window toolbar's Back button.

Task: To initialize Workflow Manager:

1. Log in to Workflow Manager using the Default Company Name and Default Service Company Administrator
Account, as described in Identify Login for Service Company Administrator Account.

Note • You could also login as any other Service Company user that is assigned the SCAdmin role. You could
also choose to create a new Service Company. See Creating a Service Company.

2. Create a Customer Company. See Creating a Customer Company.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 279


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

3. Create or customize Servicer and Customer Roles. See Creating a New Role

4. Create Servicer and Customer accounts. See Creating a New User Account.

5. Optionally, you can create a new Template; or you can use an existing system Template in the next step. See
Creating a New Template.

6. Create a Project. See Creating or Editing a Project.

Tip • For some Workflow Manager users, “Customer Companies” may be departments within a single corporation,
and the “Service Company” may be the IT department of that corporation.

Review the Lifecycle of an Application Request


Once Workflow Manager has been initialized, it is ready for use to create and perform Application Requests. The
following is a typical scenario:

Table 7-6 • Typical Lifecycle of Application Request

# Task Description

1 Customer A Customer creates a new Application Request, based upon a Project created for
Creates his company. Workflow Manager automatically sends an email to the Servicer. See
Application Submitting an Application Request (Customer).
Request

2 Servicer The Servicer reviews the application-related data that was submitted by the
Reviews Customer.
Application
• If the submitted data is satisfactory, the Servicer advances the Workflow
Request
and assigns people to act in the various Roles that have been defined. See
Updating an Application Request and Assigning Users to Application Requests.
• If the submitted data is not satisfactory, the Servicer unlocks the
submitted data. Workflow Manager automatically sends an email to the
Customer, who can then modify and resubmit the data. See Editing Data By
Performing a Rollback.

280 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

Table 7-6 • Typical Lifecycle of Application Request

# Task Description

3 Servicers Once the Application Request is underway, the assigned Servicers perform the
Perform Tasks steps defined by the Workflow and advance or roll back the Workflow as
appropriate.

While this is going on, the Customer can use Workflow Manager to check the
Workflow’s status. Customer and Servicers can communicate by adding or
responding to items on the Issues list. For more information, see the following
topics:

• Updating an Application Request


• Monitoring the Progress of an Application Request
• Creating a New Issue
• Responding to or Closing an Issue.

Tip • For some Workflow Manager users, “Customer Companies” may be departments within a single corporation,
and the “Service Company” may be the IT department of that corporation.

Customizing Workflow Manager for Your Organization


There are three ways that you can customize Workflow Manager to display your company's name and brand:

• Login Screen Graphic—On the Workflow Manager Login page, you can replace the default Workflow
Manager logo graphic with your company's logo. See Changing the Login Screen Graphic.

• Home Page Logo—You can change the logo that is displayed in the top left corner of the Workflow Manager
Home page. See Changing the Home Page Logo.

• Displaying a Custom Page on the Home Page—On the Home page, you can customize one of the
windows by specifying your own HTML page or Web address. See Displaying a Custom Web Page on the
Home Page.

• Workflow Manager Page Header—You can replace the Workflow Manager logo graphic, which is displayed
on the banner of all the Workflow Manager pages, with your company's logo. See Changing the Page Header.

• Terminology—You can make global changes to terminology used through Workflow Manager. See
Customizing Workflow Manager Terminology.

• Step Completion Dialog Boxes—You can display your company's logo on the completion dialog boxes that
appear when Workflow Steps are completed. See Changing the Step Completion Dialog Boxes.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 281


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

Note • Any modifications that you make to Workflow Manager files could be overwritten if you upgrade or reinstall
Workflow Manager. Make notes of any changes that you make so that you can customize Workflow Manager again if
necessary.

Changing the Login Screen Graphic


By default, the AdminStudio Enterprise Server Login screen displays the AdminStudio Enterprise Server logo:

Figure 7-5: AdminStudio Enterprise Server Login Screen

282 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

The large rectangular graphic in the upper left corner of the login screen is named topcorner01.jpg, is 320 x 245
pixels, and is stored in the wwwroot\images directory:

Figure 7-6: AdminStudio Enterprise Server Login Graphic

If you backup this file and replace it with your own graphic, you can immediately change the user’s first impression
of your AdminStudio Enterprise Server “front door”, as shown in the following graphic:

Figure 7-7: AdminStudio Enterprise Server Login Screen Customized With Company Logo

For optimum results, the logo should be either have a transparent background or a gradient blue background that
matches the one used on the page.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 283


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

Changing the Home Page Logo


You can change the logo that is displayed in the top left corner of the Workflow Manager Servicer and Customer
Home page.

Figure 7-8: Workflow Manager Logo on Servicer and Customer Home Pages

For optimum results, the logo should be either have a transparent background or a gradient blue background that
matches the one used on the page. It should also be of appropriate size (no larger than 200 px by 50 px).

Task: To change the logo displayed on the Home page:

1. On the Home page, click Companies on the Administration menu. The Company/Business Unit
Administration page opens.

2. Open the Company that you want to edit. The Company/Business Unit Details View opens, and the logo
currently being used is displayed under Customer Logo.

3. Click Browse next to the Upload Logo field and select the logo that you want to display.

4. Click Update.

Displaying a Custom Web Page on the Home Page


On the Customer and Servicer Home pages, you can customize one of the windows by specifying your own HTML
page or Web address.

By default, the Servicer Home page includes a My Page list of favorite links, and the Customer Home page
includes a brief description of how to submit an Application Request:

284 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

Figure 7-9: Default Custom Windows for Servicer and Customer Home Page

Task: To change the custom window displayed on the Home page:

1. On the Servicer Home page, click Companies on the Administration menu. The Company/Business Unit
Administration page opens.

2. Open the Company that you want to edit. The Company/Business Unit Details View opens.

3. In the My Page URL field, enter the address of the Web page that you want to display.

4. Click Update.

Changing the Page Header


The header bar at the top of every Workflow Manager screen can also be customized. By default, the AdminStudio
logo appears in the banner at the top of every page:

Figure 7-10: AdminStudio Logo in Page Header

The AdminStudio logo in this banner is named FLEX_as_140x43_trans.GIF (140 x 43 pixels):

To display your company's logo in the banner, simply update the file FLEX_as_140x43_trans.GIF, which is stored in
the wwwroot\images directory of the server where AdminStudio Enterprise Server is installed, with your own
graphic.

For optimum results, the logo should be either have a transparent background or a gradient blue background that
matches the one used in the header.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 285


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

Customizing Workflow Manager Terminology


From the Terminology Customization page, which is opened by clicking Terminology on the Administration
menu of the Servicer Home page, you can change the terminology used throughout Workflow Manager.

There are approximately 45 terms defined in Workflow Manager that are used throughout the system, such as:
Application Request, Customers, Servicers, Projects, Templates, Data Group, Data Element, etc.

If you feel that changing any of these words would be helpful to your Workflow Manager users, you can make edit
it on the Terminology Customization page, and the term would automatically be updated throughout Workflow
Manager.

Caution • Because making terminology changes make a global impact on Workflow Manager, changes are usually
made infrequently. In order to change system Terminology, you must be assigned to a Role that has the Terminology
View permission assigned.

Task: To customize Workflow Manager terminology:

1. On the Servicer Home page, click Terminology on the Administration menu to open the Terminology
Customization Page.

2. For each term that you want to customize on Workflow Manager pages, do the following:

a. Select the term from the list. Its name will appear in the Default System Term field.

b. In the Customized System Term edit box, type the customized term you want to display in place of the
selected default term.

c. Click the Update button.

Tip • To quickly recall what customizations you have made (for reading the help or communicating with technical
support), click the View Terminology Report link on the Terminology Customization Page to obtain a Terminology
Report listing the currently defined Workflow Manager terminology.

286 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

Changing the Step Completion Dialog Boxes


When you click on a step in the Workflow Manager Workflow, Workflow Manager will display a step completion
dialog box, similar to the following:

Figure 7-11: Customized Workflow Step Completion Dialog Box

In this case, the text in the upper window pane has been changed to display information that is specific to this
Workflow Template. The text comes from an HTML page that you are free to create and modify.

To insert your own custom text into a Workflow Step completion dialog box, perform the following steps:

Task: To customize a Workflow Step completion dialog box:

1. Create an HTML page with the text and formatting that you would like to display.

2. Using Windows Explorer, copy this HTML file to the directory that is specified in this template's Template
folder field of the Template Details page.

Note • Keep in mind that the folder in the Template Details page is specified relative to the wwwroot
subfolder of the folder in which AdminStudio Enterprise Server is installed.

3. Go to the Templates Administration page in Workflow Manager and open a Workflow Step to display the
Workflow Step Details area.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 287


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

4. Select your custom HTML page from the Popup HTML File list, as shown below:

5. Click Update.

Customizing Email Templates


You can customize the content and design of email notification messages that are sent out by Workflow Manager.
This information is presented in the following sections:

• Location of Email Templates

• Using Replaceable Parameters in Email Templates

Location of Email Templates

Outgoing email is based on customizable email templates. The email templates are stored as text files in the
following directory:

AdminStudioEnterprise\wwwroot\EmailTemplate

To change the location of email templates at your organization, you can update an entry in the Workflow Manager
Web site web.config file. When you select an email template to use when defining a Workflow Step or an issue, all
of the templates in this location will be included in the selection list. To add a new email template to the system,
copy the text file into this email templates folder.

288 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

Using Replaceable Parameters in Email Templates

Workflow Manager is installed with a set of standard email templates (text files) that will be used by default for
sending email. These email templates use replaceable parameters that are replaced with data before an email is
sent.

When creating email templates, you write up the email text using replaceable fields, and then store the templates in
a specific directory, making those templates available for use in Workflow Manager. To learn more about using
replaceable parameters in email templates, select the topics below:

• Replaceable Field Delimiters

• Pre-Defined Replaceable Values

• Using Data Items as Replaceable Values

• Legacy Standard Items

Replaceable Field Delimiters


Delineate replaceable fields with the characters %%# and #%%. Surround both pre-defined replaceable items and
data items from the template with these delimiters.

Pre-Defined Replaceable Values


The following items are pre-defined for use in email templates:

AMS_Application.ApplicationLName
AMS_Application.DueDate
AMS_Application.NewIssues
AMS_Application.TotalIssues
AMS_Application.UploadBy
AMS_Application.UploadDate

If you are creating a notification message which shows various information about the application, you can follow
the example text below:

<html>
<body>
<table>
<tr>
<td>
The application %%#AMS_Application.ApplicationLName#%%
has been submitted for repackaging by
%%#AMS_Application.UploadBy#%%. Please note that the due
date is %%#AMS_Application.DueDate#%%.
</td>
</tr>
</table>
</body>
</html>

More pre-defined values can be made available by populating the AMS_CViews_Fields table. In particular, the
chEmailField and chEmailQuery columns both need to be populated to enable a pre-defined value to work.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 289


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

Using Data Items as Replaceable Values


All of the data items that are defined in a template are available for use in email notification messages. For these
values, simply put the name of the data item between the delimiters %%# and #%%. The following example shows
how to use some of these data fields:

<html>
<body>
<table>
<tr>
<td>
Data Values for %%#AMS_Application.ApplicationLName#%%
<br>
Version Number: %%#Version (major.minor.patch)#%%
Description: %%#Description#%%
Application Type: %%#Application Type#%%
Application Size (megabytes): %%#Application Size
(megabytes)#%%
Is License Management required?: %%#Is License
Management required?#%%
Media Type: %%#Media Type#%%
Number of Users: %%#Number of Users#%%
</td>
</tr>
</table>
</body>
</html>

Legacy Standard Items


The following standard items are defined in Workflow Manager and may be used in an email template. Enclose
these item names in square brackets ( [ ] ) so that Workflow Manager will recognize them as standard data items
that will be replaced with actual values prior to the email being sent.

ApplicationName
Changed
Rejected
ApplicationDataItem
Destination
IssueText
Major
Minor
TimeSpent
RollbackText

290 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

Searching User/Group Listings in Workflow Manager


When performing some Workflow Manager tasks, you need to identify a user to either send notification emails,
assign an issue to, assign work to, designate as a company contact, etc. Often this means that you need to search
a large list of users to select the one you are looking for.

To assist you in performing these tasks, Workflow Manager provides search capability, allowing you to search a
comprehensive list that contains all AdminStudio Enterprise Server users as well as all of the Directory Services
users and groups (and subgroups) in all of the domains that have been registered with Workflow Manager. When
multiple results are found, a Search Results list is displayed:

Figure 7-12: Typical Workflow Manager Search Interface

Note • Database users and Directory Services users/groups in all domains registered with Workflow Manager are
searched.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 291


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

The user search method you will use depends upon your degree of knowledge of the exact user name you are
searching for:

Table 7-7 • Available Search Methods

Know this ... Do this ...

Know the exact user Enter the exact user name in the User Name field and click Check Names. That
name user will automatically be selected and will populate the User Name field. See
Performing a Search When You Know the User Name.

Know the beginning In this case, the uniqueness of the characters you entered determines whether a
characters of the user name is automatically selected or whether a Search Results list is displayed:
user name
• Generates only one result—If the characters that you entered match only one
user name, that user will automatically be selected and will populate the User
Name field.
• Generates multiple results—If the characters that you entered match more
than one user name, a Search Results list is displayed.

See Searching for a User Name.

Want to select a user To display a complete list of all users and groups, leave the User Name field empty
from a complete list and then click Check Names. The Search Results list will include all users and
of all users groups. See Selecting a User from a Complete List of Users.

Performing a Search When You Know the User Name


If you know the exact user name that you want to select, perform the following steps:

Task: To select a user by searching for exact user name:

1. Open the search area:

2. Enter the exact user name in the User Name box and click Check Names. Because you entered a complete
user name, that user is automatically selected and is listed in the User Name field.

3. Click Apply.

292 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

About Unimported Directory Services Users


When Workflow Manager performs a search, Directory Services users and groups (and subgroups) in all domains
registered with Workflow Manager are searched, even those that have not yet been imported into the Workflow
Manager database. If you select an unimported user, one of the following will occur:

• For email notification assignment—When an unimported user is selected for email notification
assignment, the user is selected as an external email address only. It is not imported into the Workflow
Manager database.

• All other types of Workflow Manager assignment—When an unimported user is selected for all other
types of Workflow Manager assignments (such as issue assignment, work assignment, Project contact), that
user is automatically imported into the Workflow Manager database.

Searching for a User Name


If you know the first few characters of the user name that you want to select, perform the following steps:

Task: To select a user by searching for a user name:

1. Open the search area.

2. Enter the first few letters of the user name in the User Name box and click Check Names. One of the
following happens:

• Only one match—If you have entered a complete user name or if there is only one match to the
characters you entered, that user is automatically selected and is listed in the User Name field.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 293


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

• Multiple matches—If you entered characters that match more than one user, a list of Search Results is
displayed, and you are prompted to make a selection by clicking the Select link. Also, you can further
refine the Search Results list by using the Search box.

Note • Database users and Directory Services users/groups in all domains are searched.

Caution • Database users that do not have an associated email address are listed in the Search Results
listing, but cannot be selected; the Select column for those users is empty.

3. Click Select next to the User Name you want to select. That user is now listed in the User Name field and
the Search Results list closes.

4. Click Apply.

294 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Getting Started

Selecting a User from a Complete List of Users


If you want to select a user by scrolling through a complete list of users, perform the following steps:

Task: To select a user from a complete list of users:

1. Open the search area.

2. Do not enter anything in the User Name box and click Check Names. A complete list of users and groups is
listed in the Search Results list.

3. You can refine the Search Results list by using the Search box.

4. When you have located the user you want to select, click Select next to the User Name. That user is now
listed in the User Name field and the Search Results list closes.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 295


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Submitting and Monitoring Application Requests

Caution • Database users that do not have an associated email address are listed in the Search Results
listing, but cannot be selected; the Select column for those users is empty.

5. Click Apply.

Submitting and Monitoring Application


Requests
This section explains how to Submit an Application Request, how to view Application Request data, and how to
track an Application Request’s SLA Status.

• Submitting an Application Request

• Copying an Existing Application Request

• Monitoring the Progress of an Application Request

• Tracking an Application Request’s SLA Status

Submitting an Application Request


The method of submitting an Application Request varies depending upon whether the user is a Customer or a
Servicer:

• Submitting an Application Request (Customer)

• Submitting an Application Request (Servicer)

Submitting an Application Request (Customer)


Customers submit Application Requests using the fields in the Submit a New Application Request area of the
Customer Home page or by clicking the Create a New Application Request link in the navigation bar of many
of the Workflow Manager pages.

Submitting an Application Request from the Home Page

Task: To create a new Application Request:

1. Login to Workflow Manager to open the Customer Home page.

2. In the Submit a New Application Request area, enter a name for this Application Request

3. From the Project list, select the name of the project that this Application Request will be associated with.

296 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Submitting and Monitoring Application Requests

Note • If your Company has only one associated Project, then the Project field will not be listed.

4. Click Submit Request. The Data Entry Tab of the Application Progress Page (Customer) for this new
Application Request opens, and you are prompted to enter some information.

• The information that is requested here is defined during Template creation and can include as many or as
few questions as the Servicer defined.

• If there is a help icon next to the data entry field, if you hover your cursor over the help icon, text will
appear to explain the purpose of the field:

• Questions preceded by a red dot are required, meaning that you must respond to the question or you will
be unable to proceed. Questions without a red dot are optional.

5. Answer the displayed questions, clicking Next to proceed to the next group of questions. When you get to the
last group of questions, there is a Submit button instead of a Next button.

6. When you have finished responding to questions, click Submit. You are returned to the Home page, and the
Application Request that you just submitted is now listed in your My Application Requests window.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 297


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Submitting and Monitoring Application Requests

Submitting an Application Request by Clicking the Create a New Application


Request Link
Customers can create a new Application Request by clicking Create a New Application Request on the All
Applications page.

Task: To create a new Application Request:

1. Login to Workflow Manager to open the Customer Home page.

2. Click the View Application Request List in the Actions menu. The All Applications page opens.

3. Click Create a New Application Request. The Submit Application Request page opens.

4. From the Project list, select the name of the project that this Application Request will be associated with.

5. Enter an Application Name to uniquely identify this Application Request.

6. Select the Application Family that this application will belong to, or click Create New to create a new
Application Family.

Note • If the Service Company associated with this Project was created with the Is an Application Family
Owner? option selected, the Create New button will only appear when a Servicer is submitting an Application
Request; if the option was not selected, this link will appear for both Servicers and Customers.

7. [For Projects associated with Deployment Templates only] From the Available Sites list, select the
deployment sites at your company where you want this application deployed. To select all deployment sites,
click Select All. To unselect all sites, click Clear All.

8. Click Create a New Application Request.

Submitting an Application Request (Servicer)


Servicers submit Application Requests by opening the Submit Application Request page.

Task: To create a new Application Request:

1. Login to Workflow Manager to open the Servicer Home page.

2. Click the Submit Application Request link in the Actions menu. The Submit Application Request page
opens.

Note • Servicers can also click the Submit an Application Request link in the Actions box on the Project
Summary page.

3. Enter an Application Name to uniquely identify this Application Request.

298 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Submitting and Monitoring Application Requests

4. From the Application Family list, select the application family that you want this new Application Request to
be associated with, or click Create New to create a new one.

Note • If the Service Company associated with this Project was created with the Is an Application Family
Owner? option selected, this link will only appear when a Servicer is submitting an Application Request; if the
option was not selected, this link will appear for both Servicers and Customers.

5. [Projects associated with Deployment Templates only] Select the Deployment Sites (if any have been defined)
at the Customer Company where you want this application deployed. To select all deployment sites, click
Select All. To unselect all sites, click Clear All.

6. Click the Submit button. The Project Summary page opens, which lists the new Application Request.

Copying an Existing Application Request


The method of copying an Application Request varies depending upon whether the user is a Customer or a
Servicer:

• Copying an Existing Application Request (Customer)

• Copying an Existing Application Request (Servicer)

Copying an Existing Application Request (Customer)


If you want to create a new Application Request that requires the submission of very similar data as an existing
Application Request, you can copy it and then modify it, rather than re-entering all of the requested data.

Task: To copy an existing Application Request:

1. On the Customer Home page, click View Application Request List in the Actions menu. The All
Applications(s) page opens.

2. Select the Application you want to copy to open its Application Progress Page (Customer).

3. Click the Copy an Application Request link in the Actions box. The Copy an Application Request Page
opens.

4. In the Application Name field, enter a name to uniquely identify this new Application Request.

5. Click Copy. The Application Progress page for the new Application Request opens and you are prompted
to submit the initial data.

Data that was entered, selections that were made, and files that were uploaded in the Application Request you
copied already populate the data fields.

6. Review the data fields, make any edits, and click Submit to submit this Application Request.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 299


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Submitting and Monitoring Application Requests

Copying an Existing Application Request (Servicer)


If you want to create a new Application Request that is very similar to an existing Application Request, you can
copy it and then modify it, rather than re-entering all of the requested data.

You can also choose whether you want to copy the Application Request's current Workflow state (the data items
and state of each Workflow Step), and whether you want to link the copy to the original Application Request.

The copy of the Application Request is automatically linked with the source Application Request and is listed on the
Related Applications Tab.

Task: To copy an existing Application Request:

1. On the Servicer Home page, click View Project List in the Actions menu. The All Projects Page opens.

2. Select a Project to open its Project Summary Page.

3. Select the Application Request you want to copy to open its Application Progress Page (Servicer).

4. Open the Properties Tab.

5. Click the Copy button. The Copy an Application Request Page opens.

6. In the Application Name field, enter a name to uniquely identify this new Application Request.

7. Specify whether you want to Copy the Workflow Progress State.

• If you select this option, the data items and state of each Workflow Step from the source Application
Request will be copied to the new Application Request.

• If you do not select this option, Workflow Manager only copies the initial data entry step, and the
Application Request is not automatically submitted.

8. If you want to link the copy to the original Application Request, select the Link with source Application
Request option. Linked Application Requests are listed on the Related Applications Tab.

9. Click Copy. Then, the following occurs depending upon the selection you made on the Copy the Workflow
Progress State option:

• If you selected this option, the Application Progress Page (Servicer) for the new Application Request
opens, and the data items and state of each Workflow Step from the source Application Request have
been copied to the new Application Request. Therefore, the progress displayed on this page is identical
to the progress of the source Application Request.

• If you did not select this option—The Application Progress Page (Servicer) for the new Application
Request opens and you are prompted to submit the initial data.

Deleting an Application Request


Only Servicers with Delete Application Request permission can delete an Application Request.

300 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Submitting and Monitoring Application Requests

Task: To delete an Application Request:

1. On the Servicer Home Page, click View Project List in the Actions menu. The All Projects Page opens.

2. Select the Project associated with the Application Request you want to delete. The Project Summary Page
opens.

3. Select the Application Request that you want to delete. The Application Progress Page (Servicer) for that
Application Request opens.

4. Open the Properties Tab and click Delete.

Monitoring the Progress of an Application Request


This section explains how to view an Application Request’s progress on its Application Progress page, how to
view an Application Report, and how to view lists of Application Requests and Projects.

• Searching for Application Requests

• Opening an Application Request’s Application Progress Page

• Viewing an Application Report

• Viewing All Application Requests for Your Company (Customer)

• Viewing the Project List

Searching for Application Requests


You can perform either a quick search, by entering text in the Application Search box on the Home Page, or an
advanced search, by opening the Search Criteria View and using more detailed search options.

Performing a Quick Search

Task: To perform a quick search for an Application Request:

1. Open the Home page.

2. In the Application Search text box, enter the Application Request name or part of the name of the
Application Request you are searching for.

3. Click Go.

The results of your search are listed on the Application Search Page (for Servicers) or the All Application(s)/
Application Search Page (for Customers).

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 301


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Submitting and Monitoring Application Requests

Performing an Advanced Search


To perform an advanced search for an Application Request, perform the following steps.

Task: To perform an advanced Application Request search:

1. On the Home page, click Search Application Requests in the Actions menu.

2. Enter the following search criteria:

Option Description

Application [Customers only] Select an Application Family to restrict your search to Application
Family Requests belonging to that Application Family.

Application Enter the name or part of the name of the Application Request you are searching for. If
Name you enter a word or part of a word, Workflow Manager will search for all Application
Requests that include that word or part of a word in the Application Name. If you enter
more than one word or word fragment, Workflow Manager will find only those
Application Requests that include that exact text in that order.

Metadata Text Enter the text you want to search for in the Data Elements (data entry fields) that were
entered either upon submission of an Application Request or as part of a Workflow
Phase. If you enter a word or part of a word, Workflow Manager will search for all
Application Requests that have data entries that include that word or part of a word. If
you enter more than one word or word fragment, Workflow Manager will find only
those Application Requests that have data entries that include that exact text in that
order.

Issue or Enter the text you want to search for in any of the Issues or Messages associated with
Message Text Application Requests. If you enter a word or part of a word, Workflow Manager will
search for all Application Requests that have Issues or Messages that include that
word or part of a word. If you enter more than one word or word fragment, Workflow
Manager will find only those Application Requests that have Issues or Messages that
include that exact text in that order.

AR Number Enter the numeric portion of the AR Number to restrict your search to the Application
Request matching that number. The Application Request Prefix is not included in the
search, and only exact numeric matches are found. For example, if you enter 12, only
one Application Request will be found: AR 12; Application Request with numbers of
AR 120 or AR 1235 are not found.

Note • Application Requests for one Service Company are assigned sequential numbers in the
order they were created. Creating a new Project that uses a different Application Request Prefix
does not reset the sequence number to zero, so entering just the numeric portion of the AR
Number will not return duplicate entries, such as AR 103 and HO 103. Only one Application
Request for that Service Company will have the AR Number of 103.

302 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Submitting and Monitoring Application Requests

Option Description

Created After Enter a date to restrict your search to Application Requests created after that date.

Created Before Enter a date to restrict your search to Application Requests created before that date.

Project Select a Project from the list to narrow your Application Request search to only that
Project.

Application Select to restrict your search to a specific Application Request Status, such as Active
Status or Inactive.

3. Click Search to initiate the search.

Opening an Application Request’s Application Progress Page


The progress of an Application Request is displayed on a tab of an Application Request’s Application Progress
page. The method of accessing this information is slightly different for Customers and Servicers.

Customers

Task: To open an Application Request’s Application Progress page:

1. On the Customer Home page, click View Application Request List in the Actions menu. The All
Application(s)/Application Search Page opens.

2. Select the Application you want to view. The Application Request’s Application Progress Page (Customer)
opens, with the Data Entry Tab selected.

3. Open the Workflow Tab.

Servicers

Task: To open an Application Request’s Application Progress page:

1. On the Servicer Home page, click View Project List in the Actions menu. The All Projects Page opens.

2. Select the Project associated with the Application Request you want to view. The Project Summary Page
opens.

3. Select the Application Request that you want to view. The Application Progress Page (Servicer) for that
Application Request opens, with the Application Progress Tab open.

4. For information on the deployment of a prepared application, open the Deployment Progress Tab and select
the desired deployment site.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 303


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Submitting and Monitoring Application Requests

Viewing an Application Report


Detailed information on an Application Request’s progress can be viewed on the Application Report.

Task: To open the Application Report

1. Open an Application Request’s Application Progress page, as described in Opening an Application


Request’s Application Progress Page.

2. Click the View Application Report link in the Actions box. The Application Report opens.

Note • For a description of the information included on the Application Report, see Application Report.

Viewing All Application Requests for Your Company (Customer)

Task: To view the status of all Application Requests for your company:

1. On the Customer Home page, click View Application Request List in the Actions menu. The All
Application(s) page opens, listing all of the Application Requests submitted by your Company.

Viewing the Project List


Servicers can view a list of Projects for all of their Customer Companies, and Customers can view a list of Projects
for their company.

Task: To view the Project List:

On the Home page, click View Project List in the Actions menu.

• For Customers, the All Projects Page opens, listing all of their Company’s Projects.

• For Servicers, the All Projects Page opens, listing all of the Application Requests submitted by all of their
Customer Companies.

304 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Submitting and Monitoring Application Requests

Tracking an Application Request’s SLA Status


You can track the SLA status of Application Requests so that you will know which Application Requests are on time
(per their Service Level Agreement), and which ones are late or at risk of being late.

• Calculating an Application Request’s SLA Status

• Stopping and Restarting the SLA Clock

• Generating SLA Status Reports

Note • See also Managing SLA Settings.

Calculating an Application Request’s SLA Status


SLA (Service Level Agreement) time tracking is used to report the status of an Application Request in relationship
to its SLA Due Date as either: On Time, At Risk, Late, Completed on Time, or Completed Late.

• Project SLA Settings and Application Request Due Date

• Example of an Application Request’s SLA Status Path

Project SLA Settings and Application Request Due Date


Each time a Project is created, the following SLA settings are defined:

• Application Due Period—Number of days after its submission date that an Application Request should be
completed (in order to be in SLA compliance).

• Application at Risk Period—Number of days prior to an Application Request’s due date that the Application
Request will be considered “at risk” of not meeting that date (SLA Status = At Risk).

• Length of a Work Day—Number of hours in a day that are considered work hours when monitoring elapsed
time for SLA calculations.

• Exclude Weekends?—Specifies whether to exclude weekend days when calculating an Application


Request’s SLA status.

• Holidays—Identify the holidays to exclude from SLA calculations.

An Application Request’s Due Date is automatically calculated by adding the number of business days in the
Application Due Period field to the date that the Application Request was submitted.

Note • The Application Due Period and Application at Risk Period values specified for a Project can be
overridden at the Application Request level on the Properties tab of the Application Progress page.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 305


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Submitting and Monitoring Application Requests

Example of an Application Request’s SLA Status Path


The following diagram illustrates the SLA status path of an Application Request with an Application Due Period
of 5 days and an Application at Risk Period of 2 days, with weekend days excluded from the calculations:

Figure 7-13: SLA Status Path of an Application Request (Example)

Stopping and Restarting the SLA Clock


You can click the Stop Clock button on the Application Progress page to stop the monitoring of SLA time for
the current Workflow Step.

Figure 7-14: Stop Clock button on the Application Progress Page

If work on an Application Request has been interrupted, you could stop the SLA clock to prevent that Application
Request from inaccurately being listed in SLA reports as At Risk or Late.

306 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Submitting and Monitoring Application Requests

When the Stop Clock button is clicked, its name changes to Start Clock, and the date and time that the clock
was stopped is listed. Click the Start Clock button to restart the monitoring of time

Figure 7-15: SLA Time Stopped on the Application Progress Page

Generating SLA Status Reports


You can view Application Request SLA status on the Projects Report and the Application Requests Summary
Report. See Generating a Projects Report and Generating an Application Requests Summary Report for more
information.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 307


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

Completing Application Requests


This section contains information on the following tasks:

• Initiating Work on an Application Request

• Updating an Application Request

Initiating Work on an Application Request


This section contains information on the following tasks:

• Accepting an Application Request

• Assigning Users to Application Requests

• Viewing Application Request Assignments

Accepting an Application Request


When an Application Request is submitted, the first Workflow Step of the first Phase is a data entry step, and that
data must be reviewed before work can begin on the Application Request. When the Application Request is viewed
on the Application Progress page, a red arrow indicates that the first Workflow Step is the current step.

A Servicer accepts an Application Request by viewing the submitted data and clicking Accept.

Task: To accept an Application Request:

1. Open an Application Request’s Application Progress page as described in Opening an Application


Request’s Application Progress Page. A red arrow appears next to the first Workflow Step in the first Workflow
Phase, indicating that it is the current step.

308 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

2. Click the red arrow. The data that was entered when the Application Request was submitted is listed, and you
are prompted to Accept Data or Reject Data.

3. Review the submitted data. If the data takes up more than one screen, click Next and Back to view all of the
data.

4. Click Accept Data. The Application Progress tab reopens, and the first Step of the first Phase is now
marked complete.

5. To initiate work on this Application Request, continue with Assigning Users to Application Requests.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 309


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

Note • If you had clicked Reject Data instead, a message dialog box opens, informing you that this action will
force the Customer to resubmit the data.

Assigning Users to Application Requests


To assign users to Application Request tasks, Servicers select one user for each Role that has permission to
perform tasks in the Application Request. This is done on the Assignment Details page, which is opened by
selecting an Application Request on the Work Assignment Listing page.

Note • You can assign a person to work on more than one Application Request at a time.

Task: To assign a person to an Application Request:

1. On the Home page, click the Assign Work link. The Work Assignment Listing page opens. On this page,
you can make a selection from the Filter Assignments List to filter this list by the following:

• Hide Completed Applications—List only those Application Requests that are still in progress.

• Data Entry Phase—List only those that are currently in the initial data collection step that is required
when submitting an Application Request.

• Work Phase—List only Application Requests that are in a standard work phase (a phase with no
restrictions).

• Customer Acceptance Phase—List only Application Requests that require Customer approval to be
completed.

• Last Phase—List only Application Requests that include administrative tasks after the Customer project
has been completed.

• Application Complete—List only those Application Requests that have been completed.

• AdminStudio Workflow—List only those Application Requests that are in a phase that is performed in
its entirety as an AdminStudio Project.

• Merging Workflow Steps—Lists only those Application Requests that are in a phase that implements
conditional branching.

2. Select the Application Request that you want to make assignments for. The Assignment Details page for
that Application Request opens.

3. Click the blue arrow to open the Current Assignments list, which contains the following information:

• Roles—Lists the Roles that have permission to perform tasks for this Application Request.

• Assigned To—Lists the name of the user that has been assigned to this Application Request for each
Role. If no assignment has been made, Not Assigned is displayed.

310 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

4. From the Role list, select the Role that you want to assign a user to.

5. Select a user from the User Name field by either entering a user name or by searching a comprehensive list
containing all Workflow Manager users as well as all of the Directory Services users that have been imported
as described in Searching User/Group Listings in Workflow Manager. When you perform a search and
generate a list of users, the number of current assignments each user has is included in the list.

6. After selecting a user, click Apply. The selected user name is then displayed on the Assignment Details
page in the Assigned To column of the Current Assignments list next to the name of the Role.

Viewing Application Request Assignments


To view a list of assignments by user, perform the following steps:

Task: To view a list of Application Request assignments:

1. On the Servicer Home page, click View Assignments by User in the Actions list. The Working Queue
View opens and lists all of the assignments that have been made for all Projects and all Application Requests
at your company.

Note • If you do not have permission to view assignments for all users, you will only see a list of Application
Requests assigned to you.

Note • Unassigned Application Requests are not listed on this page.

2. To more easily view assignments by user, right-click the User Name column header and then click Group By
This Field.

3. If you select an Application Request, its associated Assignment Details page will open.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 311


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

Updating an Application Request


You can update an Application Request’s progress or edit its data by doing the following:

Table 7-8 • Methods of Updating an Application Request

Task Description

Completing a Workflow The tasks that you perform to complete a Workflow Step vary depending upon
Step its type: Data Entry/Edit, Normal, Update History, Work Assignment, Script
Execution, Custom Web Page, Automated Import, Automated Validation, or
Automated Conflict Analysis.

You are either prompted to enter data, comments, or time spent on this step, or a
script or custom web page is launched.

Rolling Back to a To rollback to a previous Workflow Step that has already been completed so that
Previous Workflow Step that step and all subsequent steps must be repeated, open the Application
Progress page, and click the checked check box next to the completed
Workflow Step that you want to roll back to:

Editing Data By To edit data that was submitted during a Workflow Step that has already been
Performing a Rollback completed so that that step and all subsequent steps must be repeated, open
the Application Progress page, and click the selected check box next to the
name of the completed Workflow Step that contains data that you want to edit:

Editing Data Without Open the Application Progress page, and click the name of the completed
Performing a Rollback Workflow Step that contains data that you want to edit.

Completing a Workflow Step


When you have finished working on a Workflow Step and want to mark it complete, perform the following steps.

Task: To complete an Application Request Workflow Step:

1. If you are a Servicer, perform the following steps to open the Application Progress Page (Servicer):

a. On the Servicer Home page, click the View Project List link in the Actions menu. The All Projects
page opens, listing all projects for all customer companies.

b. Select the Project containing the Application Request you want to edit. The Project Summary page
opens.

c. Select an Application Request. The Application Progress page for that Application Request opens.

312 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

2. If you are a Customer, perform the following steps to open the Application Progress Page (Customer):

a. On the Customer Home page, click View Application Request List in the Actions menu.

b. Select an Application Request to open the Application Progress page.

c. Click the Workflow Tab.

3. To update the status of the preparation of the application for deployment, click the Application Progress
Tab; to update the status of the deployment of the prepared application, click the Deployment Progress Tab
and select the desired deployment site.

The Workflow Step that currently awaits completion is marked by a red arrow. If you have been assigned a
Role that has edit permission for that step, you can mark the step complete

4. Click the step name that is next to the red arrow. The action that happens next depends upon the Step Type
of this Workflow Step:

• Data Entry/Edit—You are prompted to submit data.

• Normal—You are prompted to enter the total time spent to complete this Workflow Step. If you do not
enter anything, 0 minutes will be recorded for this Workflow Step.

• Update History—You are prompted you to enter information to document this Workflow Phase.

• Workflow Assignment—The Assignment Details page opens, and you are prompted to assign a user
from your Service Company to Roles associated with this Application Request.

• Script Execution—A user-specified executable file is launched.

• Custom Web Page—A user-specified URL address is opened in a new browser window.

• Automated Import—A user-specified URL address is opened in a new browser window and Workflow
Manager runs a user-supplied IPlugin assembly that will programmatically import a package that was
uploaded in a previous Workflow Step into the Application Catalog. After the IPlugin assembly completes,
data will be sent back to Workflow Manager that will automatically mark this step complete and advance
the workflow.

• Automated Validation—A user-specified URL address is opened in a new browser window and
Workflow Manager runs a user-supplied IPlugin assembly that will programmatically validate a package

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 313


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

that was imported into the Application Catalog in a previous Workflow Step. After the IPlugin assembly
completes, data will be sent back to Workflow Manager that will automatically mark this step complete
and advance the workflow.

• Automated Conflict Analysis—A user-specified URL address is opened in a new browser window and
Workflow Manager runs a user-supplied IPlugin assembly that will programmatically perform conflict
analysis on a package that was imported into the Application Catalog in a previous Workflow Step. After
the IPlugin assembly completes, data will be sent back to Workflow Manager that will automatically mark
this step complete and advance the workflow.

After the appropriate steps have been taken, the Workflow Step is now displayed with a checked check box,
indicating that it is complete:

Rolling Back to a Previous Workflow Step

To roll back to a completed Workflow Step, click the checked check box next to the Workflow Step that you
want to roll back to.

Figure 7-16: Instructions for Rolling Back to a Workflow Step

Task: To update—that is, advance or roll back—an Application Request's progress:

1. If you are a Servicer, perform the following steps to open the Application Progress page:

a. On the Servicer Home page, click the View Project List link in the Actions menu. The All Projects page
opens, listing all projects for all Customer companies.

b. Select the Project containing the Application Request you want to edit. The Project Summary page
opens.

314 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

c. Select an Application Request. The Application Progress page for that Application Request opens.

2. If you are a Customer, perform the following steps to open the Application Progress page:

a. On the Customer Home page, click View Application Request List on the Actions menu.

b. Select an Application Request to open the Application Progress page.

c. Click the Workflow Tab.

3. Click the checked check box next to the completed Workflow Step that you want to roll back to. The
Rollback Workflow Item dialog box opens.

Note • If you perform a rollback, all of the data associated with the selected Workflow Step and all subsequent
steps is deleted and all of those steps must be repeated.

4. In the Rollback Workflow Step window, enter text explaining the reasons for the rollback, enter any
additional email addresses of people you would like informed of this rollback, and click the Rollback button.

Note • When performing a Normal Workflow Step multiple times due to Rollbacks, Workflow Manager keeps a
running total of the amount of Time Spent entered each time the Workflow Step was performed. If you are performing
a Workflow Step a second time, an additional text box, named Additional Time Spent, appears on the Step
Validation dialog box. In this text box, you can enter additional time that you spent on this Workflow Step. However,
you are not required to enter Time Spent.

Editing Data By Performing a Rollback


To perform a rollback to a previous Workflow Step so that you can edit the data in that step, perform the following
steps:

Task: To edit data by performing a rollback:

1. If you are a Servicer, perform the following steps to open the Application Progress page:

a. On the Servicer Home page, click the View Project List link in the Actions menu. The All Projects
page opens, listing all projects for all customer companies.

b. Select the Project containing the Application Request you want to edit. The Project Summary page
opens.

c. Select an Application Request. The Application Progress page for that Application Request opens.

2. If you are a Customer, perform the following steps to open the Application Progress page:

a. On the Customer Home page, click View Application Request List on the Actions menu.

b. Select an Application Request to open the Application Progress page.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 315


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

c. Click the Workflow Tab.

3. Click the name of the Data Entry Workflow Step that you want to edit.

Note • The first Workflow Step in the first Workflow Phase always has a Step Type of Data Entry/Edit.
However, other Workflow Steps can also collect data if a Data Group is created that is specified for use later in
the Workflow, and if that Data Group is selected on the Workflow Step Details View.

4. If you are editing data entering during the initial Application Request submission, the data entry view opens
with the data in read-only mode. Two buttons are displayed: Edit Data and Rollback.

a. Click Rollback. The Rollback Workflow Item dialog box opens prompting you to enter the reason for
the rollback.

b. Enter the reason for the rollback and click Rollback. The data entry fields are now editable.

c. Proceed through the data entry screens and click Submit.

5. If you are editing data entered in a Workflow Step later in the Workflow, the Rollback Workflow Item dialog
box opens prompting you to enter the reason for the rollback.

a. Enter the reason for the rollback and click Rollback. You are returned to the Application Progress

page and this Workflow Step is now the current step, marked with a red arrow.

b. Click on this Workflow Step name. A dialog box opens prompting you to enter the total time spent on
this Workflow Step and to re-enter the data that you wanted to edit.

Editing Data Without Performing a Rollback


If a Workflow Step has a Data Group associated with it, you submit the data when completing the step. You can, in
most instances, go back and edit this data even after this Workflow Step and those subsequent to it are
complete—without rolling back to that Workflow Step.

316 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

To edit data after a Workflow Step has been completed, you click the Workflow Step name hyperlink (instead of
clicking the check box, which is used to perform a rollback).

Figure 7-17: Instructions for Editing Workflow Step Data Without Rolling Back

Please note the following regarding editing previously submitted Workflow data:

• Can edit all submitted data throughout the Workflow—You can edit both data collected as part of the
initial Application Request submission and data collected as part of a subsequent Workflow Step. You can also
edit the data entered when completing a Normal step, such as the time period it took to complete the step.

• Cannot edit branching data—If a Workflow Step has a data item that affects branching, then that data item
is not editable. You would have to perform a Rollback to edit that Workflow data item.

• Data editing information is logged—Every time you edit a data item on a completed Workflow Step, the
information is logged in the Workflow Manager database and this information appears on the Application
Report, similar to Rollback information.

• Comments are required—You are required to enter comments after you edit the data items to indicate the
purpose of the edit.

• Triggers email notification—Editing this data triggers email notification to the users specified on the Project
Permission and Notification Settings View.

For instructions on how to edit a Workflow Step without performing a rollback, select the following topics:

• Editing Data Collected During Initial Workflow Step

• Editing Data Collected During Subsequent Workflow Steps

• Editing Time Spent Information for Normal Workflow Steps

• Editing Update History Workflow Steps

• Editing Work Assignment Workflow Steps [Servicer Only]

• Editing Script Execution and Custom Web Page Workflow Steps

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 317


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

Editing Data Collected During Initial Workflow Step

You can edit all of the data submitted during Application Request submission unless that data item is used in
branching.

Task: To edit data collected during initial Workflow Step:

1. If you are a Servicer, perform the following steps to open the Application Progress page:

a. On the Servicer Home page, click the View Project List link in the Actions menu. The All Projects
page opens, listing all projects for all customer companies.

b. Select the Project containing the Application Request you want to edit. The Project Summary page
opens.

c. Select an Application Request. The Application Progress page for that Application Request opens.

2. If you are a Customer, perform the following steps to open the Application Progress page:

a. On the Customer Home page, click View Application Request List on the Actions menu.

b. Select an Application Request to open the Application Progress page.

c. Click the Workflow Tab.

3. Click on the hyperlinked name of the initial Workflow Step. The first data submission screen opens containing
a read-only view of the data that was initially submitted and two buttons: Edit Data and Rollback:

4. Click Edit Data. A dialog box opens prompting you to enter the reason that you are editing the data in this
Workflow Step.

5. Enter the reason and any desired additional email recipients and comments, and then click Continue Edit to
close the dialog box and return to the Application Progress tab, where all of the data fields except those
used in branching are now editable.

318 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

Note • Data fields that are used for branching are read-only and labeled Rollback to edit this data item.

6. Proceed through all the data submission screens making any desired edits.

7. On the last data submission screen, click the Update button to save your edits.

8. Click Return to workflow to return to the Application Progress tab.

Editing Data Collected During Subsequent Workflow Steps

You can edit any data that was entered as part a subsequent Workflow Step (a Workflow Step that occurs after the
Application Request submission).

Task: To edit data collected during a subsequent Workflow Step:

1. If you are a Servicer, perform the following steps to open the Application Progress page:

a. On the Servicer Home page, click the View Project List link in the Actions menu The All Projects
page opens, listing all projects for all customer companies.

b. Select the Project containing the Application Request you want to edit. The Project Summary page
opens.

c. Select an Application Request. The Application Progress page for that Application Request opens.

2. If you are a Customer, perform the following steps to open the Application Progress page:

a. On the Customer Home page, click View Application Request List on the Actions menu.

b. Select an Application Request to open the Application Progress page.

c. Click the Workflow Tab.

3. Click on the name of the Workflow Step that contains data that you want to edit. The Step Validation dialog
box opens that includes the data entry fields and an Update and Rollback button.

4. Edit the data fields. You can also edit Total Time Spent fields.

5. Enter an explanation of the edits in the Edit Comments text box and click Update. You are returned to the
Application Progress page and the Workflow Step that you just edited is still marked complete.

Editing Time Spent Information for Normal Workflow Steps

You can edit the time that was entered in the Total Time Spent fields for a completed Workflow Step without
rolling back to that step.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 319


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

Task: To edit time spent information for normal Workflow Steps:

1. If you are a Servicer, perform the following steps to open the Application Progress page:

a. On the Servicer Home page, click the View Project List link in the Actions menu The All Projects
page opens, listing all projects for all customer companies.

b. Select the Project containing the Application Request you want to edit. The Project Summary page
opens.

c. Select an Application Request. The Application Progress page for that Application Request opens.

2. If you are a Customer, perform the following steps to open the Application Progress page:

a. On the Customer Home page, click View Application Request List on the Actions menu.

b. Select an Application Request to open the Application Progress page.

c. Click the Workflow Tab.

3. Click on the name of the Workflow Step that you want to edit. The Step Validation dialog box opens, which
includes an Edit Comments text box, and an Update and Rollback button. Also, there are now two Time
Spent fields: Initial Time Spent, which lists the amount of time you entered when you completed the
Workflow Step, and Additional Time Spent, where you can enter any additional time you have spent on this
Step.

4. Enter any Additional Time Spent.

320 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

Note • Workflow Manager keeps a running total of the amount of time entered initially, entered when editing a
Workflow Step’s data, and any time entered if this Workflow Step was performed a multiple times due to a
Rollback.

5. Enter an explanation of the edits in the Edit Comments text box and click Update. You are returned to the
Application Progress page and the Workflow Step that you just edited is still marked complete.

Editing Update History Workflow Steps

You can edit the comments that were entered on the Update History dialog box for Workflow Steps with a Step
Type of Update History without rolling back to that step.

Task: To edit comments on Update History Workflow Steps:

1. If you are a Servicer, perform the following steps to open the Application Progress page:

a. On the Servicer Home page, click the View Project List link in the Actions menu The All Projects
page opens, listing all projects for all customer companies.

b. Select the Project containing the Application Request you want to edit. The Project Summary page
opens.

c. Select an Application Request. The Application Progress page for that Application Request opens.

2. If you are a Customer, perform the following steps to open the Application Progress page:

a. On the Customer Home page, click View Application Request List on the Actions menu.

b. Select an Application Request to open the Application Progress page.

c. Click the Workflow Tab.

3. Click on the name of the Update History Workflow Step that you want to edit. The Update History dialog box
opens.

4. Edit the text in the Comments text box and click OK. You are returned to the Application Progress page
and the Workflow Step that you just edited is still marked complete.

Editing Work Assignment Workflow Steps

You can edit the Work Assignments that were made when performing a Workflow Step with a Step Type of Work
Assignment without rolling back to that step.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 321


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

Task: To edit comments on Work Assignment Workflow Steps:

1. On the Servicer Home page, click the View Project List link in the Actions menu The All Projects page
opens, listing all projects for all customer companies.

2. Select the Project containing the Application Request you want to edit. The Project Summary page opens.

3. Select an Application Request. The Application Progress page for that Application Request opens.

4. Click on the name of the Work Assignment Workflow Step that you want to edit. The Work Assignment
dialog box opens.

5. Edit the selections made in the Available Resources column.

6. Enter the reason for these edits in the Edit Comments text box and click OK. You are returned to the
Application Progress page and the Workflow Step that you just edited is still marked complete.

Editing Script Execution and Custom Web Page Workflow Steps

You can re-launch a script or a custom Web page, that are associated with Workflow Steps with a Step Type of
Script Execution or Custom Web Page without rolling back to that step.

Task: To edit comments on Work Assignment Workflow Steps:

1. If you are a Servicer, perform the following steps to open the Application Progress page:

a. On the Servicer Home page, click the View Project List link in the Actions menu The All Projects
page opens, listing all projects for all customer companies.

b. Select the Project containing the Application Request you want to edit. The Project Summary page
opens.

c. Select an Application Request. The Application Progress page for that Application Request opens.

2. If you are a Customer, perform the following steps to open the Application Progress page:

a. On the Customer Home page, click View Application Request List on the Actions menu.

b. Select an Application Request to open the Application Progress page.

c. Click the Workflow Tab.

3. Click on the name of the Script Execution or Custom Web Page Workflow Step that you want to re-launch.
The Step Validation dialog box opens.

4. Enter the reason for these edits in the Edit Comments text box and click OK. The Script or Custom Web
Page is launched, you are returned to the Application Progress page, and the Workflow Step that you just
edited is still marked complete.

322 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

Sending Email and Comments at Update, Edit, or Rollback


When you create a Template, you can use the Email templates to use field in the Workflow Step Details area
of the Workflow Phases View to select which email Template to use when each Workflow Step is edited,
completed, or rolled back. See Managing Email Notifications for more information.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 323


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

Viewing an Application Request’s Uploaded Files


To view files that were uploaded during the completion of a Workflow Step, perform the following steps:

Task: To view an Application Request's uploaded files:

1. Open the Application Progress page as described in Opening an Application Request’s Application Progress
Page.

2. Click Select next to the Application Name to open the Application Progress page.

3. Click the Uploaded Files tab to display links to any and all uploaded files for the Application Request.

Linking Related Application Requests


Servicers can use the Related Applications Tab of the Application Progress page to link Application Requests
together or to remove links. By linking related Application Requests to each other, you can track related
applications by easily navigating to the Application Progress page of these related applications, performing
searches, and producing reports that use this information.

Task: To link Application Requests:

1. Open the Application Progress page of the Application Request that you want to link other Application
Requests to.

2. Click the Related Applications tab. The Related Applications Tab opens.

3. Click Add Related Applications. The Add Related Applications page opens.

4. Select the Application Requests that you want to link to the current Application Request and click Add. The
selected Application Requests are then listed on the current Application Request's Related Applications tab.

Working With Issues


You can create three types of issues associated with an Application Request to help you communicate with the
Servicers and Customers:

• Knowledge Base—A Knowledge Base issue is used to share information between users in a discussion
board forum. You would create a Knowledge Base issue when you want to post an issue on the Issues tab
but do not want to notify anyone via email.

• Email—An Email issue is used for issues that you do not consider critical, but which require that people
associated with this Project be notified.

• Critical—A Critical issue is used to stop all work on an Application Request until the issue is resolved.

324 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

This section contains information on the following tasks:

• Creating a New Issue

• Responding to or Closing an Issue

Creating a New Issue


You create new issues on the Issues tab of an Application Request’s Application Progress page.

Task: To create a new Issue:

1. Open the Application Progress page as described in Opening an Application Request’s Application
Progress Page.

2. Open the Issues tab.

3. Click the New button. The Issue Details view opens.

4. In the Enter the issue abstract box, enter a short abstract of the issue to identify this issue in listings.

5. Enter the text of the issue.

6. Select an Issue Type from the list:

• Knowledge Base—Select if you want to post this issue on the Issues tab but do not want to notify
anyone of this issue. A Knowledge Base issue is used to share information between several users in a
discussion board forum.

• Email—Use if you want to send an email to all users with permission on this Project to notify them of this
issue. You use the Email type for issues that you do not consider critical, but which require that people
associated with this project be notified.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 325


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Completing Application Requests

• Critical—Use if you want to stop all work on this Application Request until the issue is resolved.
Whenever an Application Request has an open critical issue, its Workflow becomes read only until the
issue is resolved.

Note • For more information on these Issue Types, see Issue Types: Knowledge Base, Email, Critical.

7. Click the calendar icon to assign an Issue Due Date. This date will be listed on the Issues List page and
also on the Issues tab of the Application Progress page.

8. Assign a user to this Issue by clicking Assign User and selecting a user from the list.

When an issue is assigned to a user, that issue will be listed in the Issues list on the Workflow Manager
Home page when All Issues Assigned to Me is selected.

9. Click the Create button to create the Issue. It is now listed on the list on the Issues tab. Also:

• If you created a Knowledge Base issue, the issue is posted on the Issues tab, but no email is sent.
Other users must open the Issues tab to read it. Each time someone responds to an issue, their
response is listed below the original issue on the Issues tab.

• If you created an Email issue, an email is sent to the people assigned to the Roles selected on the Project
Permission and Notification Settings View.

• If you created a Critical issue, a note appears at the top of the Issues tab stating that Open Critical
issue present in Application, and a note stating The workflow is READ-ONLY because of Critical
issues appears on the Application Progress tab. Each time a person opens the Issues tab, the Issue
Details View of the critical issue is opened. Before any steps can be performed on this Application
Request, all critical issues must be closed.

Responding to or Closing an Issue


To respond to an Issue or close an Issue, perform the following steps:

Task: To respond to or close an item in the Issues list:

1. Open the Application Progress page as described in Opening an Application Request’s Application
Progress Page.

2. Click the Issues tab.

3. Click View/Respond to open the Issue Details area for that issue. A Respond and a Close button are
provided.

4. Do one of the following:

• To respond to an issue, click Respond, enter your response in the Response text box, and click
Submit.

• To close to an issue, click Close.

326 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Note • A Servicer cannot close an item that was created by a Customer.

Note • The Close button is not displayed for items that are responses. To close a response (or a response to a
response, or so on) you must close the original item; doing so closes all responses to that item (and responses
to the responses, and so on).

Viewing All Issues


A Servicer can view a list of all Issues submitted for all of the Customer Companies, while a Customer can view a
list of all Issues submitted by their Company.

Task: To view all issues:

On the Home page, click View Issues in the Actions menu to open the Issues List page.

Performing Administrative Tasks


When a Servicer that is assigned to the appropriate Roles logs in to Workflow Manager, the Servicer Home Page
opens and displays the Administration menu, providing links to the full functionality of Workflow Manager.
Administrative tasks are grouped into the following categories:

• Managing Companies

• Managing Projects

• Managing Workflow Templates

• Managing Email Notifications

• Managing SLA Settings

• Managing Deployment Sites

• Managing Application Status

• Managing External Datasources

• Workflow Manager Configuration Tasks

• Integrating AdminStudio and Workflow Manager

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 327


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Managing Companies
There are two main categories of Workflow Manager users:

• Customers, who submit Application Requests.

• Servicers, who perform tasks to complete Application Requests.

A Service Company can do work for multiple Customer companies. Each time a Service Company starts work for a
new Customer, a new Customer Company needs to be created.

User accounts are associated with one company, as are Templates, Projects, and Application Requests. A
Customer can only see information on Application Requests associated with their Company, but a Servicer can see
information on Application Requests submitted by all of their Customer companies.

This section includes the following topics:

• Creating a Customer Company

• Deleting a Customer Company

• Creating a Service Company

• Deleting a Service Company

Note • For some Workflow Manager users, “Customer Companies” may be departments within a single
corporation, and the “Service Company” may be the IT department of that corporation.

Creating a Customer Company

Task: To create a new Customer Company:

1. On the Workflow Manager Home page, click Companies on the Administration menu. The Company/
Business Unit Administration Page opens.

2. Click Add to display the Company/Business Unit Details View.

3. Enter a Company/Business Unit Name.

4. In the Company ID field, add any unique identifier used by your organization

5. By default, one of the windows on the Customer Home page includes a brief description of how to submit an
Application Request. If you want to change what is displayed in this Window, enter the URL of the page that
you want to display in the My Page URL field. See Displaying a Custom Web Page on the Home Page.

6. To customize the Customer Home page so that it displays this company’s logo, upload a graphic of that logo.
See Changing the Home Page Logo.

7. Click Update.

328 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Note • You can also change the logo displayed on the Workflow Manager Login page, the banner at the top of
all of the Workflow Manager pages, and you can customize the Step Completion dialog boxes. See Customizing
Workflow Manager for Your Organization for detailed instructions.

Deleting a Customer Company


To delete a Customer Company, perform the following steps.

Task: To delete Customer Company:

1. On the Servicer Home page, click the Companies link on the Administration menu to open the Company/
Business Unit Administration page.

2. Select the Customer Company that you would like to delete to open its Company/Business Unit Details
View.

3. Click Delete.

Creating a Service Company


To create a Service Company, perform the following steps.

Task: To create a new Service Company:

1. On the Servicer Home page, click the Companies link in the Administration menu to open the Company/
Business Unit Administration page.

2. Click the Add button to display the Company/Business Unit Details View.

3. Enter a Company/Business Unit Name and Company ID.

4. To allow only the Service Company to create application families, check the Is an Application Family
Owner? check box; to allow the Service Company and its Customers to create application families, clear the
box.

5. Click the Update button.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 329


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Deleting a Service Company

Caution • When you delete a Service Company, Workflow Manager deletes all the Customer Companies,
Templates, Users, Roles, Projects, and Application Requests associated with it.

Task: To delete a Service Company:

1. On the Servicer Home page, click the Companies link in the Administration menu to open the Company/
Business Unit Administration page.

2. Select the Service Company that you want to delete to open its Company/Business Unit Details View.

3. Click Delete.

Managing Projects
A Project specifies the terms under which a Service Company will perform one or more Application Requests for
the Customer. This section contains information on the following tasks:

• Creating or Editing a Project

• Defining Project Permissions and Notifications

• Deleting a Project

• Uploading and Viewing Project Policy Documents

Creating or Editing a Project

Task: To create or edit a project:

1. On the Administration menu on the Servicer Home page, click Projects. The Project Administration page
opens.

2. To create a new project, click Add. To edit an existing Project, select the Project. The Project Details View
opens.

Note • The Add button is disabled if no Templates that are specific to your company have been created,
meaning that the only Templates that are listed on the Template Administration page have the value Global in
the Library column.

3. In the Project Details View, specify the following General Information:

330 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

a. Project Name—Enter a name to identify this project.

b. Company/Business Unit—Select the company that this project will be associated with.

c. Applications—List of Application Requests associated with this Project. If you are creating a new
Project, this field will be empty

d. Project ID—This field can be any unique identifier used in your organization, such as an ID used by your
CRM software, or an internal project-tracking number.

e. Application Request Prefix—Enter a prefix to identify the Application Requests created for this Project.
This prefix will be pre-pended to the AR Number, the number that Workflow Manager generates to
uniquely identify an Application Request.

f. Status—Specify whether this Project is Active or Inactive.

4. Specify the requested Template Information:

a. Template—Select the Application Template that you want to associate with this Project.

b. Deployment Template—Select the Deployment Template that you want to associate with this Project. If
no deployment Templates exist, this field will be empty.

5. Specify the requested Service Level Agreement Properties:

a. Include Saturdays and Sundays—When calculating Application at Risk Period and Project Due Date,
indicate whether Saturdays and Sundays should be counted as business days by selecting Yes or No.

b. Application Due Period—Number of days in which an Application Request associated with this Project
should be completed. To calculate a Project’s End Date, the Application Due period value is added to date
the Application Request was submitted (Start Date).

c. Application at Risk Period—Number of days before Application Request is due that the Application
Request will be considered “at risk” of not being completed on time.

d. Send Emails at Application Risk—When “at risk” Application Requests are identified, select whether to
send out an email notification of this by selecting Yes or No.

6. Specify the requested Timing information:

a. Start Date—Date this Project was created.

b. End Date—End date specified for this project. (Currently, the information you enter in the End date field is
not used by Workflow Manager. This field is provided for future use.)

7. Specify the requested Contacts information:

a. Customer Contact—The user at the Customer Company selected as the contact for this Project.

b. Servicer Contact—The user at the Service Company selected as the contact for this Project.

8. Click the Update button. You are returned to the Project Administration page.

9. If you are creating a new Project, select the project to open the Project Details View, click the Set Project
Permissions & Notifications link, and continue with Defining Project Permissions and Notifications

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 331


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Defining Project Permissions and Notifications


On the Project Permission and Notification Settings view, you can assign Role permissions to either to
individual Data Elements/Workflow Steps or to an entire Data Group/Workflow Phase. Each Workflow Phase and
Data Group is listed in the tree control on the left. If you expand the listing, the all of the Data Elements/Workflow
Steps in each Workflow Phase/Data Group are also listed.

• Defining Project Permissions

• Setting Project Email Notification Defaults

Defining Project Permissions

On the Project Permission and Notification Settings view, you can set permissions for each Role that can be
assigned to employees of a Service Company or a Customer Company. You can set these permissions individually
for Data Group elements (questions asked on the Application Request form), or Workflow Steps, or set them for all
Data Group elements or Workflow Steps associated with a given Data Group (screens displayed by the Application
Request form) or Workflow Phase.

332 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Note • On the Project Permissions and Notification Settings view, you can also set default email notifications for
Application Requests submitted for this project. For more information. see Setting Email Notification Defaults for
New Projects.

To define Project permissions, perform the following steps.

Task: To define Project permissions:

1. On the Servicer Home page, click Project Permissions on the Administration menu. The Project
Permission and Notification Settings view opens.

2. To set permissions for all Data Elements/Workflow Steps associated with a given Data Group/
Workflow Phase, select the Data Group or Workflow Phase in the tree control on the left, then select View or
Edit permission for each of the listed Roles.

3. To set permissions for a Data Element/Workflow Step, select it in the tree control on the left, then select
View or Edit permission for each of the listed Roles.

4. To set a permission for a Data Element/Workflow Step that is different from the permission for the
associated Data Group/Workflow Phase, do the following:

a. Select the Data Element/Workflow Step in the tree control on the left.

b. On the right, click the lock icon next to the Role you want to set to unlock the check boxes.

c. Select View or Edit permission for each of the listed Roles.

5. Click Update.

Tip • You can use this feature to restrict what sort of work a person has permission to do. For example, to restrict
persons with the Role Quality Control to working on quality control related Workflow Steps, give that Role edit
permission for quality control related steps and no permission for any other steps.

Setting Project Email Notification Defaults

You can set email notification defaults for all new Projects on the Email Settings Administration page. You can
also set email notification defaults for all of a Project’s Application Requests on the Project Permissions and
Notification Settings page. The email settings defined on this page serve as the default email settings for all new
Application Requests submitted for that Project.

For detailed instructions, see Setting Email Notification Defaults for Projects and Application Requests.

Note • You have the ability to not only assign email notifications to Roles, but also to Workflow Manager users,
Directory Services users and groups in domains registered with Workflow Manager, and to external email
addresses.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 333


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Deleting a Project

Caution • When a Project is deleted, all of the Application Requests associated with that Project are also deleted.

Task: To delete project:

1. On the Servicer Home page, click the Projects link in the Administration menu to open the Project
Administration page.

2. Select the Project that you want to delete. The Project Details View opens.

3. Click the Delete button. If any Application Requests are associated with this Project, a warning message
opens.

4. Confirm the deletion.

Uploading and Viewing Project Policy Documents


This section contains information on the following tasks:

• Uploading Policy Documents

• Viewing a Project's Policy Documents

Uploading Policy Documents

A Policy Document is a file that you upload to associate it with a Project, making it centrally available to all people
involved, such as a contract, company procedures for packaging applications, software distribution procedures,
etc.

Task: To store Policy Documents for a project:

1. On the Servicer Home page, click the Projects link in the Administration menu to open the Project
Administration page.

2. Select a project to open its Project Details page.

3. Click Add/Edit Policy Documents for this Project in the Quick Links menu to open the Policy
Documents page.

4. Click the Add button to display the Policy Document Details View.

5. Specify the name and UNC path of the desired document.

6. Click the Update button. The document name is added to the Policy Documents page.

334 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Viewing a Project's Policy Documents

A Policy Document is a file that you upload to associate it with a Project, making it centrally available to all people
involved, such as a contract, company procedures for packaging applications, software distribution procedures,
etc.

Servicer

Task: To view a project's Policy Documents:

1. On the Home page, click the View Project List link to open the All Projects page.

2. Select the Project that you want to view. The Project Summary page opens, listing all applications in that
Project.

3. Click the View Policy Documents link to open the Policy Documents page, which has links to all Policy
Documents for the project.

Customer

Task: To view a project's Policy Documents:

1. On the Customer Home page, select View Project List in the Actions menu to open the All Projects page.

2. Select a Project to open the Project Summary page.

3. Click the Project Information tab, where all associated Policy Documents will be listed.

4. To view a Policy Document, click on it.

Managing Workflow Templates


This section explains how Servicers create and manage Workflow Templates:

• About Workflow Templates

• Creating a New Template

• Creating Templates That Use Conditions

• Defining Specialized Data Elements, Workflow Phases, and Workflow Steps

• Editing a Template

• Previewing and Testing a Template

• Copying a Template

• Deleting a Template

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 335


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

About Workflow Templates


A Workflow Template is an ordered series of steps that a Servicer Administrator creates to define a task and which
Servicers follow to perform that task.

• Comprised of Phases and Steps—A Workflow Template is comprised of a series of Workflow Phases, and
each Workflow Phase contains Workflow Steps.

• Projects are associated with one Workflow Template—When a Project is created, it is associated with
one Workflow Template.

• Application Request puts Workflow into action—When an Application Request is created for a Project, it
uses that Project’s Workflow Template, in effect putting that Workflow into action.

Example Workflow Template


A Workflow Template includes multiple Workflow Phases, and each Phase includes one or more Workflow Steps. In
the graphic below of an Application Request’s Application Progress page, there are five Workflow Phases:

Figure 7-18: Sample Workflow Template

Template Library Types: Global, Private, In Use Via Project, and In Use
The state of a Workflow Template, which is listed in the Library column on the Template Administration page,
can be one of the following:

• Global—Global templates were installed with Workflow Manager to serve as example templates for you to
copy and use, and cannot be modified. Global templates have the word Global listed in the Library column.
You cannot assign a Global template to a Project.

• Private—A Private template is a template that a Servicer Administrator created by either starting from scratch
or by copying and modifying a Global template. Private templates have the word Private listed in the Library
column. You can assign a Private template to a Project. As soon as a Private template is used to create an
Application Request, its type changes to In Use.

336 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

• In Use Via Project—An In Use Via Project template is a Private template that has been assigned to a
Project that does not yet have any Application Requests. You can edit some of the template fields and cannot
edit others. See Editing a Template That is in Use for a description of what can and cannot be edited.

• In Use—The status of an In Use Via Project template changes to In Use as soon as an Application Request
is submitted on that Project. You can edit some of the template fields and cannot edit others. See Editing a
Template That is in Use for a description of what can and cannot be edited.

Creating a New Template


A Template is made up of Workflow Phases, which are comprised of Workflow Steps. For a Workflow Template to
be usable by Projects, it must include at least one Data Group that is displayed when the Application Request is
submitted. You define the data to be collected in a Data Group (screens displayed when an Application Request is
submitted) comprised of Data Elements (questions asked on the Application Request form).

The first Workflow Step of the first Workflow Phase of a template is always associated with a Data Group, and this
Workflow Step is completed when the Application Request is submitted. However, you can define additional Data
Groups throughout the Workflow to prompt for data collection, and you can use this data for conditional
branching—meaning that the Workflow Phase that is displayed next can depend on the user's input. See Creating
Templates That Use Conditions.

Creating a new template consists of the following tasks:

• Initiating the Template

• Creating Data Groups

• Creating the First Workflow Phase

• Creating Subsequent Workflow Phases

Initiating the Template

The first step in creating a new template is to click Add on the Template Administration page, and then assign
the template a name, folder, and template type.

Note • Instead of creating a new template from scratch, you can copy an existing template. See Copying an
Existing Template.

Task: To initiate a new template:

1. On the Servicer Home page, click the Templates link in the Administration menu to open the Template
Administration page.

2. Click the Add button. The Template Properties view of the Template Details page opens.

3. Enter a Name to identify this template.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 337


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

4. Enter the name of a Folder on the Web server that will contain the Workflow Manager data help files and
Workflow instruction files for this Template. Enter a folder location relative to the wwwroot subfolder of the folder
to which Workflow Manager is installed. By default, the name of this directory is TemplateDocs.

5. From the Template Type list, select one of the following options:

• Application—Select if this template will define an ordered series of steps that a Service Company follows
to prepare an application for deployment to end users' computers.

• Deployment—Select if this template will be used to deploy a prepared application to end users'
computers.

6. If you are creating a template to serve as example template for your organization to copy and use, select the
Global Template option.

• Global templates cannot be modified directly; they must be copied first.

• Global templates have the word Global listed in the Library column on the Template Administration
page.

• You cannot assign a Global template to a Project.

7. Click the Create button. The Data and Workflow Phase tree on the left is now activated.

8. Proceed with Creating Data Groups.

Creating Data Groups

The information that is gathered during an Application Request is defined in a template Data Group (screens
displayed when an Application Request is submitted) comprised of Data Elements (questions asked on the
Application Request form).

Figure 7-19: Diagram Demonstrating Data Groups and Data Elements

A template must include at least one Data Group that is collected upon initial submission of an Application
Request, but it can also contain additional Data Groups to be collected later in the Workflow.

You specify when you want to collect a Data Group when you define it on the Template Details page by setting
the When Collected? option to one of the following:

338 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

• At initial submission—The Data Group will be collected when the Application Request is submitted.

• Later in the workflow—The Data Group will be available to be collected during any Workflow Step you
define in any of the phases of this Workflow.

Figure 7-20: “When Collected?” Option

To create a Data Group, perform the following steps:

• Creating a New Data Group

• Defining Data Elements

Creating a New Data Group


When an Application Request is submitted, each Data Group is displayed as a “page” of questions, and each Data
Element is a question. All Data Elements must belong to a Data Group.

Task: To create Data Groups:

1. After you have performed the steps described in Initiating the Template, open that template. The Template
Details page opens.

2. Before you can define the first Phase of this Workflow, you need to create a Data Group that defines the data
that a Customer will be prompted to enter when submitting an Application Request. To do this, click the New
Data Group button in the Data and Workflow Phase tree:

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 339


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

The Data Group Properties view opens.

3. In the Data Group Name field, enter a name to identify this group of questions.

4. From the Data Type list, select one of the following:

Data Type Description

AMS Data Type If this is a standard Data Group, meaning that you are going to define its Data
Elements in Workflow Manager, select AMS Data Type from the Data Type
list box and proceed to Step 7.

AdminStudio To create a Data Group whose Data Elements are automatically created and
Data Type populated by the fields defined in the currently selected AdminStudio
Extended Attributes Description File, select AdminStudio Data Type from
the Data Type list box, click the Update button, and skip to Step 24.

• Selecting the AdminStudio Data Type enables you to share application-


related data between AdminStudio and Workflow Manager.
• If the Extended Attribute data for this Application is already entered in the
AdminStudio Application Catalog, the corresponding fields that appear
during the data collection task during an Application Request will be
populated with the information in the AdminStudio Application Catalog.
• When you change the data in the AdminStudio Application Catalog, it will
automatically be changed for that Application when submitting a
Workflow Manager Application Request, and vice versa.

Note • The default Extended Attributes Description File is: C:\AdminStudio


Shared\EA_Default.xml

5. In the Sort Order field, enter a number to specify the order that this item will be displayed to the user (screens
are displayed from lowest sort order number to highest).

6. Set the When Collected? option to At initial submission.

7. The Data Group Condition area is used to conditionally hide or display a Data Group based upon user input.
See Setting Up Conditional Display of Data Groups, Data Elements, or Workflow Steps.

8. Click the Create button to add the Data Group to the Data tree.

9. Proceed with Defining Data Elements.

Defining Data Elements


When an Application Request is submitted, each Data Group is displayed as a “page” of questions, and each Data
Element is a question. All Data Elements must belong to a Data Group.

340 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Task: To define Data Elements:

1. To add a question to a “page” of questions, you add Data Elements to a Data Group. To do this, click the New
Data Element button in the Data and Workflow Phase tree:

The Data Element Properties view opens.

2. Set the Required field to Yes or No to indicate whether the requested data must be provided before this Data
Group can be submitted.

3. In the Sort Order field, enter a number to specify the order that this item will be displayed to the user (Data
Elements are displayed from lowest sort order number to the highest).

4. Optionally, enter text in the Help Text box. If you enter text in the Help Text box, when this Data Element is
displayed to the user, a help icon will appear to the right of the field. When the user hovers over that help icon,
this text will be displayed, as shown below:

5. From the Data Type list box, select the type of data entry field you want to add:

Data Type Description

Text Entry Box A single-line, editable text box.

To validate the data that a user enters into this text box, set the Validation Type
option to Mask or Regular Expression.

When you select Mask or Regular Expression, two additional options appear:
Validation Expression and Validation Message. See Text Entry Box Data
Type Validation Options for more information.

Text Area A multi-line, scrollable, and editable text box.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 341


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Data Type Description

Single Selection A drop down list prompting the user to select one value from a list of values.
When this option is selected, the Selection list items box appears, where you
enter the list values, one per line.

Important • Because a user can only select one value, Single Selection lists can be used
to control branching.

Multiple Selection List in which the user is permitted to select more than one value. When this
option is selected, the Selection list items field appears, where you enter the
list values, one per line.

Check Box Square box that is selected or cleared to turn on or off an option. More than one
check box can be selected. When this option is selected, the Selection list
items field appears, where you enter the check box values, one per line.

Radio Button A round button used to select one of a group of mutually exclusive options.
When this option is selected, the Selection list items field appears, where
you enter the radio button values, one per line.

Important • Because a user can only select one value, Radio Buttons can be used to
control branching.

Date A text box where the user is only permitted to either enter a date in date format
(such as MM/DD/YYYY) or select a date by clicking on the field’s associated
Calendar icon.

Document Upload, An upload link in a Workflow Step which enables a user to upload application,
Application Upload, documentation, or dependency files to a specific location on the Workflow
Dependency Upload Manager file server for the selected Application Request.

Downloadable File An upload link in a Workflow Step that occurs after the initial Data Entry step.
Upload These files are stored in the Workflow Manager Downloadable Files Directory
and are listed on the Downloadable Files tab for the selected Application
Request. Typically after a Servicer has completed his tasks, his next Workflow
Step would be to upload the revised application file.

Directory Service Select to map the Data Element to an attribute in a Directory Service, so that
when this field is presented to the user, its value will be pre-populated by the
value of the attribute for the current user.

When Directory Service is selected in the Data Type field, two additional
fields appear: the Directory Services list, where you pick the Directory Service
that contains the attribute that you want to use, and the Data Element list,
where you select the attribute that you want to map to.

342 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Data Type Description

Dynamic Pick List A selection list which is populated with values from a user-supplied XML file.
When this option is selected, the Data Source File field appears, where you
specify the XML file that you want to use, and the Column Value to Select field
appears, where you select which column's value in the XML file will be passed to
Workflow Manager. By default, the first column is selected.

When a Data Element with a data type of Dynamic Pick List is displayed in an
Application Request, the user is prompted to click a link to make a selection.
When the user clicks the Click to Select link, the Dynamic Pick List dialog
box opens containing a list of the data in the selected XML file. After the user
selects one or multiple items in the list and clicks OK, the selected values then
populate the text area, with entries separated by pipes.

Note • See Dynamic Pick List Data Type Options for more information.

DB Driven Type Select this option to populate a single-selection list with real time data values
obtained from an associated SQL Server or Oracle database. When you select
DB Driven Type from the Data Type list, three new fields appear:

• External Datasources—Select a database connection that was defined


on the External Data Sources Administration page. See Creating a
New External Datasource Connection.
• SQL Query—Define a query to select the columns of the database table
that you want to include on the selection list that is displayed to the user as
an Application Request is worked on. For example, if you want to display
the LastName and JobTitle and EmployeeID of all salespersons in the
Midwest region, enter a query that would return those values.
• Persisted Column—Enter the name of the column containing the value
you want to store in the database. In the previous example, you would
probably want to store the EmployeeID column as the Persisted Column
because it uniquely identifies the person that will be selected.

Note • See DB-Driven Type Data Type Options for more information.

6. [If you selected Single Selection or Radio Button] Set the Use to control Branching option to Yes or No.
For information on conditional branching and the conditional display of Data Groups, Data Elements, and
Workflow Steps, see Creating Templates That Use Conditions.

7. [If you selected Single Selection, Multiple Selection, Check Box, or Radio Button] In the Selection list
items text box, enter the list items, with one list item per line, such as:

Microsoft Windows XP
Macintosh OSX
UNIX

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 343


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

8. [If you selected Text Entry Box, Text Area, Single Selection, Multiple Selection, Check Box, Radio
Button] In the Default Value field, enter a default value or select a default value from the list. The item that
you enter into the Default Value field will be selected by default when this Data Element is shown to the user.

9. [If you selected Dynamic Pick List] From the Data Source File list, select an XML data source file to
populate your Dynamic Pick List Data Element. This field lists of all of the XML source files that have been
copied to the following Workflow Manager Web Server location:

AdminStudioEnterprise\wwwroot\DataSourceFiles

These XML data source files must adhere to the Microsoft Excel XML spreadsheet schema. To ensure that your
XML file is in the correct format, open your XML file in Microsoft Excel, and save it in Microsoft Excel XML
Spreadsheet format.

10. [If you selected Dynamic Pick List] From the Column Value to Submit list, select the name of the column
in the selected XML data source file that contains the value that you want to pass to Workflow Manager when
an item is selected.

An XML data source file can have multiple columns, but only one column value is passed to Workflow
Manager. By default, the first column in the XML file is selected. If no column names are listed, it means that
the selected XML data source file either contains no data or was not saved in Microsoft Excel XML
Spreadsheet format.

11. [If you selected DB Driven Type] Make the following selections:

• External Datasources—Select a database connection that was defined on the External Data Sources
Administration page. See Creating a New External Datasource Connection.

• SQL Query—Define a query to select the columns of the database table that you want to include on the
selection list that is displayed to the user as an Application Request is worked on. For example, if you
want to display the LastName and JobTitle and EmployeeID of all salespersons in the Midwest region,
enter a query that would return those values.

• Persisted Column— Enter the name of the column containing the value you want to store in the
database. In the previous example, you would probably want to store the EmployeeID column as the
Persisted Column because it uniquely identifies the person that will be selected.

12. If you have selected Text Entry Box from the Data Type list, the Validation Type option appears. To validate
the data that a user enters into this text box, set the Validation Type option to Mask or Regular Expression.

When you select Mask or Regular Expression, two additional options appear: Validation Expression and
Validation Message. See Text Entry Box Data Type Validation Options for more information.

13. If you selected Directory Service as the Data Type:

a. Select the Directory Service that you want to import an Attribute from.

b. From the Data element field, select the Attribute that you want to map to a user in the Directory Service.
Attributes are defined on the Directory Services Attributes Administration Page.

14. The Data Element Condition area is used to conditionally hide or display a Data Element based upon user
input. See Setting Up Conditional Display of Data Groups, Data Elements, or Workflow Steps.

15. Click the Update button to add the Data Element to the Data and Workflow Phase tree.

344 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

16. Repeat the steps above to add more fields (Data Elements) to the Customer data entry dialog box (Data
Group).

17. Repeat the steps above to add data entry dialog boxes (Data Groups).

18. To create the first phase of the template, proceed with Creating the First Workflow Phase.

Creating the First Workflow Phase

In the first Workflow Step of the first Workflow Phase of a template, you prompt a Customer or Servicer when
submitting an Application Request to enter the data that you defined in the Data Group associated with this
template. To integrate this Data Group into the first Workflow Step of this first Workflow Phase, you create a
Workflow Phase with a Phase type of Data Entry Phase by performing the following steps:

Task: To create the first Workflow Phase of a template:

1. After you have completed the steps described in Initiating the Template and Creating Data Groups, open that
template in the Template Details page.

2. To add a Workflow Phase, click the New Workflow Phase button in the Data and Workflow Phase tree:

The Workflow Phase Details view opens.

3. In the Workflow Phase Details area, specify the following for this first Workflow Phase:

• In the Workflow Phase name field, enter a name to identify this Workflow Phase.

• From the Phase Type list, select Data Entry Phase.

• Click Update. The Workflow Phase name is added to the list in the Data and Workflow Phase tree.

4. Click the New Workflow Step button in the Data and Workflow Phase tree. The Workflow Step Details
view opens.

5. In the Workflow Step Details area, specify the following for the first Workflow Step of the first Workflow
Phase:

• In the Workflow Step description field, enter a name for this Workflow Step.

• If you want to exclude the time it takes to complete this data entry Workflow Step from SLA calculations for
Application Requests created using this Template, clear the Track for SLA option. If this option is
selected, the time is tracked from the moment the Submit button is clicked when data is submitted.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 345


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

• From the Step Type list, select Data Entry/Edit (which is the only selection listed).

• Click Create. The new Workflow Step is now listed in the Data and Workflow Phase tree.

6. To add additional Workflow Steps to the first Workflow Phase, repeat the steps above, but this time specify the
Step type in the Workflow Step Details area as one of the following options:

Option Description

Normal When this Workflow Step is performed, the Servicer takes some action, and then records
the amount of time that it took to complete this step.

The Step Validation dialog box displays the HTML file that you specify in the Popup
HTML File field, along with OK and Cancel buttons, Time spent unit option buttons, and
a Total time spent edit box.

Update When this Workflow Step is performed, the Servicer is prompted to enter a comment to
History complete this step.

The Step Validation dialog box displays a text box and Save History and Cancel
buttons. This step type is typically used as the last step in a Workflow Phase to document
the completion of the Phase.

Work When this Workflow Step is performed, the Assignment Details page opens, and the
Assignment Servicer is prompted to assign a person from their Service Company to roles associated
with this application.

Script When a Servicer clicks this Workflow Step name on the Application Progress page, a
Execution user-specified executable file is launched.

This executable could be a batch file, an .EXE, a VB Script file, or any type of executable
that will run on the Server.

When this option is selected, the Script Path list appears listing all of the script files that
have been uploaded to the Workflow Manager Web Server location:

AdminStudioEnterprise\wwwroot\ScriptFiles

If no script files have been uploaded, the list does not appear and you are prompted to
upload an executable to the directory.

Note • When a Script Execution Workflow Step is initiated, Workflow Manager launches the executable
and advances the Workflow. However, the user is not prompted to enter any comments, and no
information is logged in the Workflow Manager database.

346 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Option Description

Custom When a user clicks this Workflow Step name on the Application Progress page,
Web Page Workflow Manager will launch a user-specified URL address in a new browser window. The
user then inputs or processes the information at this external URL.

When this Step Type option is selected, the Custom Site URL field appears where you
enter the external URL address. When the user has performed the tasks indicated on the
Custom Web Page, data will be sent back to Workflow Manager that will automatically
mark this step complete and advance the Workflow.

By default, Custom Site URL is set to a Custom Web Page that is shipped with Workflow
Manager:

http://SITE_IP_ADDRESS/CustomWorkflow/TestCustomWorkflow.aspx

You can use this Web page for testing prior to entering the URL of your Custom Web Page.

The user writing the Custom Web Page is responsible for calling the methods necessary to
pass data to Workflow Manager.

• The AdvanceWFMinorStep method is used to advance the Workflow Step.


• The EditWFMinorStep method is used to make it possible to change the data
collected during this step without performing a rollback
• The RollbackWFMinorStep is used to perform a rollback.

See Configuring a Custom Web Page for detailed instructions.

Automated When a user clicks this Workflow Step name on the Application Progress Page, Workflow
Import Manager will run a user-supplied IPlugin assembly that will programmatically import a
package that was uploaded in a previous Workflow Step into the Application Catalog.

After the IPlugin assembly completes, data will be sent back to Workflow Manager that will
automatically mark this step complete and advance the workflow.

For more information, see Defining an Automated Workflow Step.

Automated When a user clicks this Workflow Step name on the Application Progress Page, Workflow
Validation Manager will run a user-supplied IPlugin assembly that will programmatically validate a
package that was imported in a previous Workflow Step.

After the IPlugin assembly completes, data will be sent back to Workflow Manager that will
automatically mark this step complete and advance the workflow.

For more information, see Defining an Automated Workflow Step.

Automated When a user clicks this Workflow Step name on the Application Progress Page, Workflow
Conflict Manager will run a user-supplied IPlugin assembly that will programmatically perform
Analysis conflict analysis on a package that was imported in a previous Workflow Step.

After the IPlugin assembly completes, data will be sent back to Workflow Manager that will
automatically mark this step complete and advance the workflow.

For more information, see Defining an Automated Workflow Step.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 347


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

7. To add subsequent Workflow Phases, proceed with Creating Subsequent Workflow Phases.

Creating Subsequent Workflow Phases

In the first Workflow Phase, you specify its phase type as Data Entry Phase and you prompt the user to enter data
during the Application Request. To define the phases and individual steps of the Application Request, you create
additional Workflow Phases with the phase type of Work Phase, Customer Acceptance Phase, Last Phase, or
AdminStudio Workflow by performing the following steps:

Task: To create subsequent Workflow Phases:

1. After you have completed the steps described in Initiating the Template, Creating Data Groups, and Creating
the First Workflow Phase, open that template in the Template Details page.

2. To add a Workflow Phase, click the New Workflow Phase button in the Data and Workflow Phase tree:

The Workflow Phase Details view opens.

3. In the Workflow Phase name field, enter a name to identify this Workflow Phase.

4. Select one of the following from the Phase type list.

• Work Phase—Standard phase that has no restrictions.

• Customer Acceptance Phase—Phase that requires Customer approval to be completed.

• Last Phase—Phase including administrative tasks after Customer project has been completed.

• AdminStudio Workflow—Phase is performed in its entirety as an AdminStudio Project. If you select this
option, the AdminStudio WF list appears, and you select the AdminStudio Workflow that you want to
use.

5. In the Sort Order field, enter a sort order number. Workflow Phases are ordered from lowest sort order
number to highest.

6. Leave the Define a condition for workflow branching? option set to No.

Note • Information on defining a condition for workflow branching, see Setting Up Conditional Branching of
Workflow Phases.

7. If you have already created a Phase that you want to follow this Phase, select that Phase from the Link to next
phase list.

348 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

8. Click the Create button to add the new Workflow Phase to the Workflow Phase tree.

9. To add a step to this new Workflow Phase, click the New Workflow Step button in the Data and Workflow
Phase tree. The Workflow Step Details view opens.

10. In the Workflow Step description field, enter a description to identify this new Workflow Step.

11. From the Step type list, select one of the following options:

Option Description

Normal When this Workflow Step is performed, the Servicer takes some action, and then records
the amount of time that it took to complete this step.

The Step Validation dialog box displays the HTML file that you specify in the Popup
HTML File field, along with OK and Cancel buttons, Time spent unit option buttons, and
a Total time spent edit box.

Update When this Workflow Step is performed, the Servicer is prompted to enter a comment to
History complete this step.

The Step Validation dialog box displays a text box and Save History and Cancel
buttons. This step type is typically used as the last step in a Workflow Phase to document
the completion of the Phase.

Work When this Workflow Step is performed, the Assignment Details page opens, and the
Assignment Servicer is prompted to assign a person from their Service Company to roles associated
with this application.

Script When a Servicer clicks this Workflow Step name on the Application Progress page, a
Execution user-specified executable file is launched.

This executable could be a batch file, an .EXE, a VB Script file, or any type of executable
that will run on the Server.

When this option is selected, the Script Path list appears listing all of the script files that
have been uploaded to the Workflow Manager Web Server location:

AdminStudioEnterprise\wwwroot\ScriptFiles

If no script files have been uploaded, the list does not appear and you are prompted to
upload an executable to the directory.

Note • When a Script Execution Workflow Step is initiated, Workflow Manager launches the executable
and advances the Workflow. However, the user is not prompted to enter any comments, and no
information is logged in the Workflow Manager database.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 349


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Option Description

Custom When a user clicks this Workflow Step name on the Application Progress page,
Web Page Workflow Manager will launch a user-specified URL address in a new browser window. The
user then inputs or processes the information at this external URL.

When this Step Type option is selected, the Custom Site URL field appears where you
enter the external URL address. When the user has performed the tasks indicated on the
Custom Web Page, data will be sent back to Workflow Manager that will automatically
mark this step complete and advance the Workflow.

By default, Custom Site URL is set to a Custom Web Page that is shipped with Workflow
Manager:

http://SITE_IP_ADDRESS/CustomWorkflow/TestCustomWorkflow.aspx

You can use this Web page for testing prior to entering the URL of your Custom Web Page.

The user writing the Custom Web Page is responsible for calling the methods necessary to
pass data to Workflow Manager.

• The AdvanceWFMinorStep method is used to advance the Workflow Step.


• The EditWFMinorStep method is used to make it possible to change the data
collected during this step without performing a rollback
• The RollbackWFMinorStep is used to perform a rollback.

See Configuring a Custom Web Page for detailed instructions.

Automated When a user clicks this Workflow Step name on the Application Progress Page, Workflow
Import Manager will run a user-supplied IPlugin assembly that will programmatically import a
package that was uploaded in a previous Workflow Step into the Application Catalog.

After the IPlugin assembly completes, data will be sent back to Workflow Manager that will
automatically mark this step complete and advance the workflow.

For more information, see Defining an Automated Workflow Step.

Automated When a user clicks this Workflow Step name on the Application Progress Page, Workflow
Validation Manager will run a user-supplied IPlugin assembly that will programmatically validate a
package that was imported in a previous Workflow Step.

After the IPlugin assembly completes, data will be sent back to Workflow Manager that will
automatically mark this step complete and advance the workflow.

For more information, see Defining an Automated Workflow Step.

Automated When a user clicks this Workflow Step name on the Application Progress Page, Workflow
Conflict Manager will run a user-supplied IPlugin assembly that will programmatically perform
Analysis conflict analysis on a package that was imported in a previous Workflow Step.

After the IPlugin assembly completes, data will be sent back to Workflow Manager that will
automatically mark this step complete and advance the workflow.

For more information, see Defining an Automated Workflow Step.

350 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

12. If you want to exclude the time it takes to complete this Workflow Step from SLA calculations for Application
Requests created using this Template, clear the Track for SLA option.

For example, if this Workflow Step was something like “Receive Customer Approval”—which does require any
work to be performed by the Servicer, you may want to clear this option so that the time spent waiting for
approval would not be included in SLA calculations for this Application Request

13. If you selected the Normal step type, in the Popup HTML File field, enter the name of the HTML file that you
want to display in the step validation window’s upper frame. The file must be located in the folder that is
specified in the Template Properties view.

Note • To place a file in the folder that is specified on the Template Properties view, you must do so directly,
for example, by using Windows Explorer. Keep in mind that the folder is specified relative to the wwwroot
subfolder of the folder to which AdminStudio Enterprise Server is installed.

14. In the Sort order field, enter a sort order number. Workflow Steps are ordered from lowest sort order number
to highest.

15. From the Email templates to use lists, select the email templates to use to notify the Service Company and/
or Customer when this Workflow Step is initiated, rolled back, edited, or completed.

16. If a Data Group was created with the When Collected? option set to Later in the workflow, then the
Collect a data group in this workflow step option is enabled. To prompt the user to enter data during this
Workflow Step, set this option to Yes, and then select a Data Group from the Select the Data Group list.

Note • If no Data Group with the When Collected? option set to Later in the workflow exists, the Collect a
data group in this workflow step option is disabled.

17. Optionally, you can define a condition to conditionally display this Data Element. See Setting Up Conditional
Display of Data Groups, Data Elements, or Workflow Steps.

18. Click Create. The new Workflow Step is now listed in the Workflow Phase tree.

19. To add more Workflow Phases and Workflow Steps, repeat the steps above.

20. The final step when creating a Workflow Template is to link the phases together To do this, perform the
following steps:

a. Open the Workflow Phase that you want to be the first phase in this template by clicking on it in the
Workflow Phase tree. The Workflow Phase Details view for that Phase opens.

b. From the Link to next phase list, select the name of the Workflow Phase that you want to follow this
phase.

c. Repeat until all Phases are linked in the desired order.

21. Test this new Workflow Template as described in Previewing and Testing a Template.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 351


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Creating Templates That Use Conditions


When creating a Workflow Template, you can set conditions in a template to conditionally display a specific
Workflow Phase or Phases based upon user input. This is referred to as “workflow branching.” You can also set
conditions to conditionally display a Data Group, Data Element, or Workflow Step based on user input

• Setting Up Conditional Branching of Workflow Phases

• Setting Up Conditional Display of Data Groups, Data Elements, or Workflow Steps

Setting Up Conditional Branching of Workflow Phases

A Workflow Manager template can employ conditional branching—which means that the Workflow Phase that is
displayed next can depend on the user’s input.

To create a template using conditional branching, the first step is to create a template following the steps in
Creating a New Template. Then, perform the following tasks:

• Creating a Data Element to Use for Branching

• Collecting the Branching Data Element

• Creating a Workflow Phase That Branches

Creating a Data Element to Use for Branching


To create a Data Element to use for conditional branching of Workflow Phases, perform the following steps:

Task: To create a Data Element to use for conditional branching:

1. Begin creating a template as described in Creating a New Template.

2. Create at least one Data Group, as described in Creating Data Groups.

3. To that Data Group, create a new Data Element as described in Defining Data Elements.

4. On the Data Element Properties view for that Data Element, set the Data Type to either Single Selection
or Radio button, and enter the list values in the Selection list items box, one per line.

5. Set the Use to control Branching option to Yes.

6. Click the Create button to add the item to the Data tree.

7. Proceed with Collecting the Branching Data Element.

Collecting the Branching Data Element


To collect the Data Element you created in Creating a Data Element to Use for Branching, do one of the following:

• If the Data Group containing this Data Element has its When Collected? option set to At initial submission,
follow the instructions in Creating the First Workflow Phase to create a Workflow Step that collects this Data
Group.

352 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

• If the Data Group containing this Data Element has its When Collected? option set to Later in the
workflow, first create a Workflow Step with its Collect a data group in this workflow step? option set to
Yes, and then select this Data Group from the Select the Data Group list.

Proceed with Creating a Workflow Phase That Branches.

Creating a Workflow Phase That Branches


In this step, you create a Workflow Phase that branches conditionally to one Workflow Phase or another depending
on the user's response to a Data Element.

Before starting this procedure, first create all of the Workflow Phases that you want to include in your Workflow
Template, including the different Phases that will be displayed for each response, except the branching Phase. Do
not link the Phases together yet.

Task: To create a Workflow Phase that branches conditionally depending upon user input:

1. Complete the steps in Creating a Data Element to Use for Branching and Collecting the Branching Data
Element.

2. Create a Workflow Phase by completing steps in Creating Subsequent Workflow Phases.

3. In the Workflow Phase Details view, set the Define a condition for workflow branching? option to Yes.
The Select the branching condition list appears, along with a Condition Value table.

4. From the Select the branching condition list, select the Data Element that you want to use to control
branching.

5. For each value listed in the Condition Value table, select a Workflow Phase from the Next Phase list to
specify the next Workflow Phase that will be displayed to a user providing this response.

6. Click the Create button to add this Workflow Phase to the Workflow Phase tree.

7. If this branching Phase is not the first Phase in the Workflow Template, open the preceding Phase and link it to
this new branching Phase.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 353


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

8. Open each of the Workflow Phases that were selected in the Next Phase list and link them to the Workflow
Phase that you want to display next.

In the Workflow Phases tree, both branching Phases and merging Phases (where branching Workflows merge
back together) are indicated by a special icon:

9. Test this new Workflow Template as described in Previewing and Testing a Template.

Setting Up Conditional Display of Data Groups, Data Elements, or Workflow Steps

You can create a template that will conditionally hide or display a Data Group (a screen of questions collected
during a Workflow Step), a Data Element (one question in a Data Group), or a Workflow Step based on a user’s
response to a question. To do this, you need to perform the following steps:

• Creating a Data Element to Use for Conditional Display

• Collecting the Conditional Data Element

• Applying the Conditional Display Condition to a Data Group, Data Element or Workflow Step

Creating a Data Element to Use for Conditional Display


To create a Data Element to use for the conditional display of a Data Group, Data Element, or Workflow Step,
perform the following steps:

Task: To create a Data Element to use for conditional display:

1. Begin creating a template as described in Creating a New Template.

2. Create at least one Data Group, as described in Creating Data Groups.

3. To that Data Group, create a new Data Element as described in Defining Data Elements.

4. On the Data Element Properties view for that Data Element, set the Data Type to either Single Selection
or Radio button, and enter the list values in the Selection list items box, one per line.

5. Set the Use to control Branching option to Yes.

354 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Important • If you do not set the Use to control Branching option to Yes, this Data Element will not be
available when defining conditions.

6. Click the Create button to add the item to the Data tree.

7. Proceed with Collecting the Conditional Data Element.

Collecting the Conditional Data Element


To collect the Data Element you created in Creating a Data Element to Use for Conditional Display, do one of the
following:

• If the Data Group containing this Data Element has its When Collected? option set to At initial submission,
follow the instructions in Creating the First Workflow Phase to create a Workflow Step that collects this Data
Group.

• If the Data Group containing this Data Element has its When Collected? option set to Later in the
workflow, first create a Workflow Step with its Collect a data group in this workflow step? option set to
Yes, and then select this Data Group from the Select the Data Group list,

Proceed with Applying the Conditional Display Condition to a Data Group, Data Element or Workflow Step.

Applying the Conditional Display Condition to a Data Group, Data Element or


Workflow Step
To apply a condition to conditionally display a Data Group, Data Element, or Workflow Step, perform the following
steps:

Task: To apply the conditional display condition to a Data Group, Data Element, or Workflow Step:

1. Open the Template Details page and open the Data Group, Data Element, or Workflow Step that you want to
conditionally display.

2. In the Data Group Condition, Data Element Condition, or Workflow Step Condition area, click the Add
a Condition link to expand the Condition area.

3. From the Condition Item list, select the conditional Data Element you defined in Creating a Data Element to
Use for Conditional Display. The values of that Data Element are displayed in the Selections list.

4. From the Selections list, select the value or values of the Data Element for which you want to display the
current item. You can select multiple values by holding down the Shift or Ctrl key while clicking.

5. Click Save to save the condition.

Note • To edit or clear this defined condition, click Update the Condition.

6. Click Update.

7. Test this new Workflow Template as described in Previewing and Testing a Template.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 355


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Defining Specialized Data Elements, Workflow Phases, and Workflow


Steps
In both templates that use conditions and conditional branching and in those that do not, you can incorporate
specialized Data Elements, Workflow Phases, and Workflow Steps to achieve higher degrees of automation and
customization:

• Defining a Database-Driven Data Element

• Defining Automated Import, Validation, and Conflict Analysis Workflow Steps

• Defining a Custom Web Page Workflow Step

• Configuring a Custom Web Page

• Defining a Workflow Phase with a Phase Type of AdminStudio Workflow

• Including a Customer Acceptance Phase or Last Phase

• Specifying Email Templates for Workflow Steps

• File Upload Considerations in Application Requests

Defining a Database-Driven Data Element

If you first define a connection to an external data source, you can choose to populate a single-selection list
displayed on an Application Request with real time data values obtained from an associated SQL Server database.

To populate a single-selection list with real time data values obtained from an associated database, create a Data
Element with the Data Type of DB Driven Type. When you select DB Driven Type from the Data Type list, three
new fields appear:

• External Datasources—Select a database connection that was defined on the External Data Sources
Administration page. See Creating a New External Datasource Connection.

• SQL Query—Define a query to select the columns of the database table that you want to include on the
selection list that is displayed to the user as an Application Request is worked on. For example, if you want to
display the LastName and JobTitle and EmployeeID of all salespersons in the Midwest region, enter a
query that would return those values.

• Persisted Column—Enter the name of the column containing the value you want to store in the database. In
the previous example, you would probably want to store the EmployeeID column as the Persisted Column
because it uniquely identifies the person that will be selected.

356 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Defining Automated Import, Validation, and Conflict Analysis Workflow Steps

You can use Workflow Manager’s IPlugin interface to import packages into the Application Catalog and perform
validation and conflict analysis as part of a Workflow Manager Workflow Step via command line using AdminStudio
ConflictSolver. This feature enables Workflow Manager to provide a programmatic way to automate the
performance of conflict detection and resolution on a Windows Installer package in a specific Application Catalog
database.

• Defining an Automated Workflow Step

• About Custom Web Pages for Automated Workflow Steps

• Information on Using IPlugin

Defining an Automated Workflow Step


To define an automated import, validation or conflict analysis Workflow Step, you enter the following information in
the Workflow Step Details view:

• Set the Step Type to Automated Import, Automated Validation, or Automated Conflict Analysis.

• In the Custom Site URL text box, enter the external URL address to a Custom Web page that provides the
end-user instructions on how to complete this Workflow Step.

Figure 7-21: Workflow Step with the “Automated Import” Step Type

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 357


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

When a user clicks this Workflow Step name on the Application Progress Page, Workflow Manager will run a
user-supplied IPlugin assembly that will programmatically do one of the following:

• Import a package that was uploaded in a previous Workflow Step into the Application Catalog.

• Validate a package that was imported in a previous Workflow Step

• Perform conflict analysis on a package that was imported in a previous Workflow Step.

After the IPlugin assembly completes, data will be sent back to Workflow Manager that will automatically mark this
step complete and advance the workflow.

About Custom Web Pages for Automated Workflow Steps


This Custom Web page that you specify needs to contain the code that runs your user-defined IPlugin assembly.
By default, Custom Site URL is set to one of the following default pages that is shipped with Workflow Manager:

Table 7-9 • Default Custom Site URLs for Automated Workflow Steps

Step Type Default Custom Site URL

Automated Import http://SITE_IP_ADDRESS/CustomWorkflow/AutomatedImportStep.aspx

Automated Validation http://SITE_IP_ADDRESS/CustomWorkflow/AutomatedValidationStep.aspx

Automated Conflict http://SITE_IP_ADDRESS/CustomWorkflow/AutomatedConflictCheckStep.aspx


Analysis

358 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

By default, Custom Site URL is set to a page that is shipped with Workflow Manager. The following is an example
of one of the default Custom Web Pages:

Figure 7-22: Default Custom Web Page for Automated Import Step

Information on Using IPlugin


For additional information on setting up an Automated Import Workflow Step, see the following topics in the Using
the IPlugin Interface section:

• How to Use the IPlugin Interface.

• IPlugin Methods

• Data Passed in XML to IPlugin Methods

• Setting Up IPlugin Automation in Workflow Manager

Important • In order for Workflow Manager to successfully perform an Automated Import Workflow Step, a
Windows Installer package must have been uploaded to Workflow Manager in a previous Workflow Step in that
Workflow.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 359


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Defining a Custom Web Page Workflow Step

If a Workflow Template contains a Data Element with a Data Type of Custom Workflow Step, when a user clicks
this Workflow Step name on the Application Progress page, Workflow Manager will launch a user-specified URL
address in a new browser window. The user then inputs or processes the information at this external URL. When
this Step Type option is selected, the Custom Site URL field appears where you enter the external URL address.

When the user has performed the tasks indicated on the Custom Web Page, data will be sent back to Workflow
Manager that will automatically mark this step complete and advance the Workflow.

By default, Custom Site URL is set to a Custom Web Page that is shipped with Workflow Manager:

http://SITE_IP_ADDRESS/CustomWorkFlow/TestCustomWorkFlow.aspx

You can use this Web page for testing prior to entering the URL of your Custom Web Page.

The user writing the Custom Web Page is responsible for calling the methods necessary to pass data to Workflow
Manager. The following methods are used:

• AdvanceWFMinorStep—Advances the Workflow Step

• EditWFMinorStep—Makes it possible to change the data collected during this step without performing a
rollback

• RollbackWFMinorStep—Performs a rollback

See Configuring a Custom Web Page for detailed instructions

Configuring a Custom Web Page

Information about configuring a Custom Web Page as a Workflow Step is presented in the following topics:

• Parameters

• Web Methods

• HTTP GET Protocol Example

Parameters
Workflow Manager sends the web service location and the web method in the query string to the external custom
web page. The key value is WebServiceURL. This key has both the web service and the web method. The other
parameters needed are also passed through the query string as follows:

Table 7-10 • Custom Web Page Parameters

Parameter Description

ApplicationID Application ID

WFMajorItemID Workflow Phase ID

WFMinorItemID Workflow Step ID

360 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Table 7-10 • Custom Web Page Parameters

Parameter Description

PersonID Person ID of the person editing the Workflow Step in the Workflow Manager Workflow

MinorType Minor Item Type (10: Custom Step Type)

EditType EditType is sent to the external web page to do different actions according to the Minor
Item mode. For example, Workflow Manager will pass EditType =

• New the first time the Minor Item is edited


• Edit after advance of the Minor Item when it is edited
• Rollback when rollback is done

Web Methods
When configuring a Custom Web Page, use the following Web methods:

• AdvanceWFMinorStep

• RollbackWFMinorStep

• EditWFMinorStep

AdvanceWFMinorStep
This method advances the Workflow Step (Minor Step) and, if the Workflow Phase (Major Step) is completed,
advances the Workflow Phase in the Workflow Manager Workflow.

Table 7-11 • Custom Web Page Web Method: AdvanceWFMinorStep

Parameter Type Parameter Description

Input strAppID Application ID

strWFMajorItemID Current Workflow Phase ID that is getting advanced.

strWFMinorItemID Current Workflow Step ID that is getting advanced.

strPersonID Person ID of the person editing the Workflow Step in the


Workflow Manager Workflow

nWFMinorType Minor Item Type (10: Custom Step Type)

Output Bool The return value of AdvanceWFMinorStep is:

• True if the method call was successful


• False if the method call was not successful

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 361


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

RollbackWFMinorStep
This method rolls back the Workflow Step (Minor Step) from the current Workflow Step.

Table 7-12 • Custom Web Page Web Method: RollbackWFMinorStep

Parameter Type Parameter Description

Input strAppID Application ID

strWFMajorItemID Current Workflow Phase ID that is getting advanced.

strWFMinorItemID Current Workflow Step ID that is getting advanced.

strPersonID Person ID of the person editing the Workflow Step in the


Workflow Manager Workflow

nWFMinorType Minor Item Type (10: Custom Step Type)

Output Bool The return value of RollbackWFMinorStep is:

• True if the method call was successful


• False if the method call was not successful

EditWFMinorStep
This method edits the Workflow Step.

Table 7-13 • Custom Web Page Web Method: EditWFMinorStep

Parameter Type Parameter Description

Input strAppID Application ID

strWFMajorItemID Current Workflow Phase ID that is getting advanced.

strWFMinorItemID Current Workflow Step ID that is getting advanced.

strPersonID Person ID of the person editing the Workflow Step in the


Workflow Manager Workflow

nWFMinorType Minor Item Type (10: Custom Step Type)

Output Bool The return value of EditWFMinorStep is:

• True if the method call was successful


• False if the method call was not successful

362 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Note • When an action has been performed on a Custom Web Page, you may need to refresh the Workflow
Manager Application Progress page manually to see changes in the Workflow, such as: advance or rollback.

HTTP GET Protocol Example


The example below uses HTTP GET protocol for consuming Web Services. Other protocols can also be used, like
HTTP POST and SOAP.

-------- Code Example of implementing the Web Services --------------

//This method is called when page is loaded

void Page_Load(Object sender, EventArgs e)


{
//Displaying all the information received in the page from the Workflow Manager system through
//the URL for consumption of web services

//Web Service Location


this.lblWebServLocTxt.Text = HttpContext.Current.Request.QueryString["WebServiceURL"];
this.strWebServiceLoac = HttpContext.Current.Request.QueryString["WebServiceURL"];

//Application ID
this.lblAppIdTxt.Text = HttpContext.Current.Request.QueryString["ApplicationID"];
this.strAppId = HttpContext.Current.Request.QueryString["ApplicationID"];

//Major Item Id
this.lblMajorItemIdTxt.Text = HttpContext.Current.Request.QueryString["WFMajorItemID"];
this.strWFMajorItemID = HttpContext.Current.Request.QueryString["WFMajorItemID"];

//Minor Item Id
this.lblMinorItemTxt.Text = HttpContext.Current.Request.QueryString["WFMinorItemID"];
this.strWFMinorItemID = HttpContext.Current.Request.QueryString["WFMinorItemID"];

//Minor Type
this.lblMinorTypeTxt.Text = HttpContext.Current.Request.QueryString["MinorType"];
this.strWFMinorType = HttpContext.Current.Request.QueryString["MinorType"];

//Person Id
this.lblPersonIdTxt.Text = HttpContext.Current.Request.QueryString["PersonID"];
this.strPersonID = HttpContext.Current.Request.QueryString["PersonID"];;

//Mode (New:Advance work flow ; Edit:Editing the Step; Rollback:Rollback)


this.lblModeTxt.Text =HttpContext.Current.Request.QueryString["EditType"];
this.strEditType = HttpContext.Current.Request.QueryString["EditType"];

//Clearing any previous error


lblErr.Text = "";

//Changing the name of the Submit button according to the edit mode
if(strEditType == "New")
this.btnSubmit.Text = "Advance WorkFlow";
else if(strEditType == "Edit")
this.btnSubmit.Text = "Edit Custom Step";

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 363


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

else if(strEditType == "Rollback")


this.btnSubmit.Text = "Rollback";
}

//This method is called when Submit button is clicked


private void btnSubmit_Click(object sender, System.EventArgs e)
{

string retStr = "false";//String to hold return value of Web service called

/*
HTTP GET method is used for consuming the Web service
1. Query string containing all key value collection for the method signature of
the web service's web method is created
2. The query string is concatenated with "webservicelocation/webMethod"
3. A web request is sent to the web service.
4. The response is stored in an XML document and, using XPath query, the result is found out.
5. The result is checked for True value, and if True, the parent page is refreshed and the
present page is closed.
*/

//Query String containing all key value collection for the method signature
// of the web service's webmethod is created
string querystring ="strAppID=" + this.strAppId + "&WFMajorItemID=" + this.strWFMajorItemID +
"&WFMinorItemID="+ this.strWFMinorItemID + "&PersonID="+ this.strPersonID +
"&nWFMinorType="+ this.strWFMinorType ;

//The query string is concatenated with "webservicelocation/webMethod"


string uri = this.strWebServiceLoac +"?"+ querystring;

try
{
//A web request of "GET" type is created.
System.Net.WebRequest newReq = WebRequest.Create(uri);
newReq.Method = "GET";

//A web request is send to the web service and the web response is stored in ReceiveStream.
WebResponse res = newReq.GetResponse();
Stream ReceiveStream = res.GetResponseStream();

//The response is converted into XML document


XPathDocument document = new XPathDocument(ReceiveStream);

//XML navigator is created for using XPath query in the XML document to find the result
XPathNavigator nav = document.CreateNavigator();

//XML document is queried for the result of the webmethod ("bool")


XPathNodeIterator nodes = nav.Select("//bool");

//Result is stored in the retStr string


retStr = nodes.Current.Value;

}
catch(Exception ex)
{
//Displaying the exception error

364 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

lblErr.Text = ex.Message;
}

//If the result of the web method of the web service is true, then do the follwing

//1. Refresh the parent window of window.opener.location = window.opener.location.href


// refreshes the Workflow Manager page which opened the current page.
//2. Close the present window (self.close()).
//Note: If we do not refresh the parent window, then we will not be able to see
//the changes of the web service in Workflow Manager.

if(retStr.Trim() == "true")
{
StringBuilder sb = new StringBuilder();
sb.Append("<SCRIPT>window.opener.location = window.opener.location.href;
self.close();<" + "/SCRIPT>");
this.Page.RegisterClientScriptBlock("customWebPageScript",sb.ToString());
}
}

Defining a Workflow Phase with a Phase Type of AdminStudio Workflow

You can define a Workflow Manager Workflow Phase so that it is performed in its entirety as an AdminStudio
Project. When the last task of an AdminStudio Project is marked complete in AdminStudio, the Workflow Manager
Workflow Phase is automatically marked 100% complete on the Workflow Manager Application Progress page
and the Workflow is advanced.

For detailed information, see Defining a Workflow Manager Phase as an AdminStudio Workflow Project.

Including a Customer Acceptance Phase or Last Phase

You can create a Workflow Step to identify any task that you want to have performed as part of a Workflow.
However, if there are specific tasks that you want to always be part of a Workflow Phase, you can assign that phase
a specialized Phase Type. You can identify that you want a Phase to have customer approval before it is
completed, or that it requires additional administrative tasks prior to marking it complete:

• Customer Acceptance Phase—To require that a Customer approve a Workflow Phase before it can be
completed, you can include a Customer Acceptance phase in the Template. To do this, you would open the
Workflow Phase Details view for that phase, and assign it the Phase Type of Customer Acceptance
Phase .

• Last Phase—To require that specific identified administrative tasks always be performed before the last
phase of a Workflow is marked complete, you can assign a Phase the Phase Type of Last Phase.

Specifying Email Templates for Workflow Steps

When you create a template, you can use the Email templates to use field in the Workflow Step Details area of
the Workflow Phases View to select which email template to use when each Workflow Step is initiated, rolled
back, edited, or completed. See Managing Email Notifications for more information.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 365


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Figure 7-23: Email Template Options on Workflow Step Details View

File Upload Considerations in Application Requests

Application Requests have two distinct components: Workflow (executing the process steps), and Data (collecting
the data that is required to repackage the application). Workflow Manager allows collecting various types of data
items, such as entering text, selecting one of many options, making multiple selections from a list, etc. Workflow
Manager also supports file upload. Users can upload various files, such as documents or application files, and the
uploaded files are then saved to a predefined folder on a shared server.

When an Application Request is submitted, the first Workflow Step is the data entry step. During this step, if a field
is defined as a file upload type, users will see an Upload button. When they click Upload, the File Upload dialog
box appears, allowing them to upload one or more files for that field.

Please note the following regarding Workflow Manager file upload support:

• No file size restrictions—Users can upload files of any size without causing a timeout error. When
uploading a file, Workflow Manager streams the data into a disk file instead of receiving the entire upload
request in memory, so the only limitation to file size would be the amount of free disk space at the location of
the uploaded files.

• No limit on number of uploaded files—Users can upload multiple files.

366 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

For instructions on defining an upload Data Element and for more information on uploading files, see:

• Defining Data Elements

• Specifying Folders for Uploads and Downloads

• Viewing an Application Request’s Uploaded Files

Editing a Template

Note • After a template has been used to create an application, you can edit some of the template fields and cannot
edit others. See Editing a Template That is in Use for a description of what can and cannot be edited.

Task: To edit a template:

1. On the Servicer Home page, click the Templates link in the Administration menu to open the Template
Administration page.

2. Select a Template to open the Template Details page.

3. To modify the screens that a Customer sees when entering an Application Request, click the Edit Data button
to display the Data Groups View.

4. Select a Data Group Name to open the Data Group Properties and Data Elements areas.

5. In the Data Group Properties area, you can modify the name and sort order number (screens are displayed
from lowest sort order number to highest).

6. In the Data Elements area, to modify text or a control in the screen, click the Data Element name to display
the Data Element Properties area.

7. In the Data Element Properties area, you can modify the following:

• Data Element Description—The text for a text entry or text label for a control

• Data Type—The type of control of this Data Element.

• Use to control Branching—Specify that this Data Element can be used to define a Workflow branching
condition or a condition to display a Data Group, Data Element, or Workflow Step. For more information,
see Creating Templates That Use Conditions.

• Selection list items—The items in the list control (if you selected Single Selection or Multiple
Selection as the type of control)

• Required—Specify whether the requested data is required in order to successfully enter an Application
Request

• Sort order—The sort order number (screens are displayed from lowest sort order number to highest).

8. Click the Update button to update the information.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 367


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

9. To modify the phases and individual steps of the Application Request, click the Edit Workflow button to
display the Workflow Phases View.

10. To modify a phase of the Application Request, select a Workflow Phase Name to open the Workflow
Phase Details and Workflow Steps area.

11. In the Workflow Phase Details area, you can modify the Workflow Phase name, Phase type, Sort order
number, and Data Element for Branching. You can also edit the link to the next Workflow Phase or choose
to create a New Workflow Phase that will follow this one. Click the Update button to update the information.

12. In the Workflow Steps area, to modify a Workflow Step, select a Workflow Step Description to open the
Workflow Step Details area.

13. In the Workflow Step Details area, you can modify the following:

• Workflow Step description—A description of the step.

• Step type—The type of step, selected from the following options:

Table 7-14 • Workflow Step Types

Step Type Description

Normal The step validation window displays the HTML file that you specify in the Popup
HTML File field, along with OK and Cancel buttons, Time spent unit option
buttons, and a Total time spent edit box.

Update The step validation window displays a text box and Save History and Cancel
History buttons

Work When performing this step, the Assignment Details Page opens, prompting the
Assignment Servicer to assign a person from their Service Company to Roles associated with
this Application.

Script When a user clicks this Workflow Step name on the Application Progress page,
Execution a user-specified executable file is launched. This executable could be a batch file,
an .EXE, a VB Script file, or any type of executable that will run on the Server. When
this Step type option is selected, the Script Path list appears, listing all of the script
files that a Workflow Manager Administrator has uploaded to the Workflow Manager
Web Server location:

AdminStudioEnterprise\wwwroot\ScriptFiles

If no script files have been uploaded, the list does not appear and you are
prompted to upload an executable to the directory.

When a Script Execution Workflow Step is initiated, Workflow Manager launches


the executable, logs the event in the Workflow Manager database, and advances
the Workflow. However, Workflow Manager will not display or log any status
information about the process that was launched.

368 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Table 7-14 • Workflow Step Types (cont.)

Step Type Description

Custom Web When a user clicks this Workflow Step name on the Application Progress Page,
Page Workflow Manager will launch a user-specified URL address in a new browser
window. The user then inputs or processes the information at this external URL.
When this Step Type option is selected, the Custom Site URL field appears where
you enter the external URL address.

When the user has performed the tasks indicated on the Custom Web Page, data
will be sent back to Workflow Manager that will automatically mark this step
complete and advance the Workflow.

By default, Custom Site URL is set to a Custom Web Page that is shipped with
Workflow Manager:

http://SITE_IP_ADDRESS/CustomWorkFlow/TestCustomWorkFlow.aspx

You can use this Web page for testing prior to entering the URL of your Custom
Web Page.

The user writing the Custom Web Page is responsible for calling the methods
necessary to pass data to Workflow Manager. The following methods are used:

• AdvanceWFMinorStep—Advances the Workflow Step


• EditWFMinorStep—Makes it possible to change the data collected during
this step without performing a rollback
• RollbackWFMinorStep—Performs a rollback

See Configuring a Custom Web Page for detailed instructions

• Popup HTML file—The HTML file that the step validation window displays in its upper frame if you
selected the Normal step type; enter the file’s unqualified filename in the Popup HTML File text box; the
file must be located in the folder that is specified in the Template Details area.

14. Click the Update button to update the information.

Note • To place a file in the folder that is specified in the Template Details area, you must do so directly, for
example, by using Windows Explorer. Keep in mind that the folder is specified relative to the wwwroot subfolder of
the folder to which Workflow Manager is installed.

• Sort Order—The sort order number (steps are ordered from lowest sort order number to highest)
• Email templates to use—Specify the email templates to use when the step is complete or rolled back.
• Collect a Data Group during this Workflow Step—Specify whether you want to collect a Data Group
during this Workflow Step.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 369


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Previewing and Testing a Template


On the Template Details page, you can use the Preview Template option to display a visual representation of
the current template’s Workflow, exactly as it will appear on the Application Progress tab. The Preview
Template option enables you to view the Workflow and test the Workflow Steps and branches while you are
editing the template, instead of having to create a new Project and Application Request and then test it on the
Application Progress page.

Task: To test a Template:

1. Open the Template Details page for a template.

2. Click blue arrow next to the Template Name and then select Preview Template from the list. The Preview
Template area opens displaying a visual representation of this template's Workflow exactly as it will appear on
the Application Progress page.

3. Test the template by proceeding through the Workflow by marking steps complete, rolling back to previous
steps, and making branching decisions.

4. To clear any selections that you made and start the test over, click the Reset button.

5. To close the Preview Template area, click Close.

Note • When you click Close to close the Preview Template area, the test data (a project and an Application
Request) that Workflow Manager created to test this template is deleted. If, when you are viewing the template in the
Preview Template area, you close the window without clicking the Close button, the test data will not be deleted
and will be included in Workflow Manager listings. To delete this leftover test data, select Clean Sample
Applications from the blue arrow menu.

Copying a Template
If you want to create a new Template that is very similar to an existing Template, you can copy it and then modify it,
rather than re-building the entire Template.

You can make a copy of an existing Template in your installation of Workflow Manager by using the Copy button on
the Template Administration page. You can also copy an existing Template to another instance of Workflow
Manager by exporting the template to an external SQL Server script file, and then running that script against the
other Workflow Manager database.

• Copying an Existing Template

• Copying an Existing Template to Another Workflow Manager Database

370 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Copying an Existing Template

If you want to create a new Template that is very similar to an existing Template, you can copy it and then modify it,
rather than re-building the entire Template.

Task: To copy an existing Template:

1. On the Servicer Home page, click the Templates link in the Administration menu to open the Template
Administration page.

2. Click Copy to open the Copy Template View.

3. Select the name of the Template that you want to copy from the Copy from list.

4. In the Copy to field, enter a name to identify the new Template.

5. Click Copy to copy the Template and return to the Template Administration page, where the new template
will be listed.

Copying an Existing Template to Another Workflow Manager Database

If you want to copy a existing Template to another instance of Workflow Manager, you can export the template to an
external SQL Server script file, and then run that script against the other Workflow Manager database.

• Exporting a Template to an SQL Server Script

• Running a Template Script Against a Workflow Manager Database

Tip • Another reason to export a Workflow Template to an external script file is to make a back-up copy of it, so that
if it is accidentally deleted or modified, you would be able to quickly restore it.

Exporting a Template to an SQL Server Script


To export an existing Template to an external SQL Server script, so that it can be copied into another Workflow
Manager database, perform the following steps:

Task: To export an existing Template to an external script:

1. On the Servicer Home page, click the Templates link in the Administration menu to open the Template
Administration page.

2. Click Copy to open the Copy Template View.

3. Select the name of the Template that you want to copy from the Copy from list.

4. In the Copy to field, enter a name to identify the new Template.

5. Under Target, select the SQL Script option. The Enter the Filename box is displayed.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 371


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

6. In the Enter the Filename box, enter a name for the script file you are exporting. It is not necessary to enter a
file extension.

7. Click Copy. The File Download dialog box opens and you are then prompted to open or save the script file.

8. Click Save and select a location to save the script file.

9. When the file download is complete, click Cancel on the Copy Template view to return to the Template
Administration page.

Running a Template Script Against a Workflow Manager Database


To run a script to create a copy of an exported Template in a Workflow Manager database, perform the following
steps:

Task: To run a Template script against a Workflow Manager database:

1. Follow the steps in Exporting a Template to an SQL Server Script to export a Template to an SQL Server script
file.

2. Copy the script file to a location accessible to the Workflow Manager database that you want to copy the
Template into.

3. If you are running the script file against a different instance of Workflow Manager than the one it was exported
from, perform the following steps:

a. Open the script file in a text editor.

b. Locate the @updatedBy parameter, which identifies the user:

set @updatedBy = '7b31351c-f90c-4966-a61b-4d4626d86037'

c. Replace the identifier with your PersonID from the AMS_Person table.

d. Locate the @servicerCompanyID parameter, which identifies the Servicer Company that you want this
Template to be associated with:

set @servicerCompanyID = '7fa01539-9fb6-4a68-a749-f71f92276869'

e. Replace the identifier with the servicerCompanyID of the desired Servicer Company from the
AMS_Company table.

f. Save the script file.

Caution • If you do not update these parameters, you will receive an error message when you run the script
and the import will fail.

4. Use your database utilities to run the script.

5. When you open Workflow Manager, the “imported” Template will be listed on the Template Administration
page.

372 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Deleting a Template
To delete a template, perform the following steps.

Caution • If you delete a Template that is in use, all of its associated Projects and Application Requests will also be
deleted.

Task: To delete a template:

1. On the Servicer Home page, click the Templates link in the Administration menu to open Template
Administration page.

2. Click the Select link next to the name of the template that you want to delete. The Template Properties view
of that template’s Template Details page opens.

3. In the Template Properties view, click Delete. You are asked to confirm the deletion. If any Projects are
using this template, you will be warned that those Projects will be also be deleted, as well as each Project’s
corresponding Application Requests.

4. Click OK to delete the Template and return to the Template Administration page, where the Template you
deleted will no longer be listed.

Managing Email Notifications


Workflow Manager uses email as the notification mechanism for various events, such as when a Workflow Step is
advanced, edited, completed, or rolled back. You can assign email notifications to Roles, Workflow Manager users,
imported Directory Services users and groups, and to external email addresses.

You can specify email notifications at not only a Global and Project level, but also at an Application Request and
User level. Users can view a list of “My Notifications” that lists all of their assigned email notifications, and, if they
have the proper permissions, can subscribe to or unsubscribe from selected notification events.

Information about email notification is presented in the following sections:

• Email Notification Events

• Setting Email Notification Defaults for Projects and Application Requests

• Overriding Email Notification Defaults for an Application Request

• Adding Users, Groups, and External Email Addresses to an Email Notification List

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 373


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

• Manually Adding Email Notifications at Workflow Step Completion, Edit, or Rollback Event

• Managing My Notifications

Email Notification Events


In Workflow Manager, you can set automatic and manual email notifications on specific events that occur during
the completion of a Project’s Application Requests. These events are listed by category in the following table.

Table 7-15 • Email Notification Events / By Category

Event Category Events

Workflow Phase or Step Is initiated, rolled back to, edited, or completed

Application Request has its status changed

Data Is submitted, rejected, or edited

Issue Is submitted or rejected

Project Is nearing or is at its SLA due date

You have extensive control over whether or not email notification is sent when these events occur and who the
notifications are sent to. You can:

• set project defaults, which are inherited by all new projects

• set Application Request defaults for a project, which are inherited by all of its Application Requests

• override those defaults on a per-application-request basis.

• manually select recipients when a Workflow Step is completed or rolled back to.

374 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

The following table lists all of the email notification events and the location in the Workflow Manager interface
where each is specified:

Table 7-16 • Automatic and Manual Email Notification Events

AUTOMATIC AUTOMATIC MANUAL


AUTOMATIC Application Application Request Notification During an
Events Project Defaults Request Defaults Overrides Application Request

Data is Submitted Email Settings Project Permission Application Request N/A


or Rejected Administration and Notification Notifications Override
Page Settings Page Page
Issue is Submitted
or Responded To

Application Status
is Changed

SLA Date is at Risk


or Failed

Specific Workflow N/A Project Permission Application Request N/A


Phase or Step is and Notification Notifications Override
Initiated Settings Page Page

Rollback to a N/A Project Permission Application Request Rollback Workflow Item


Specific Workflow and Notification Notifications Override Dialog Box
Phase or Step Settings Page Page

Specific Workflow N/A Project Permission Application Request Update History Dialog
Phase or Step is and Notification Notifications Override Box
Edited Settings Page Page

Specific Workflow N/A Project Permission Application Request Application Request


Phase or Step is and Notification Notifications Override Notifications Override
Completed Settings Page Page Page

Data Group is N/A N/A N/A Edit Data Dialog Box


Edited

Workflow Phase or N/A N/A N/A Update History Dialog


Step is Completed Box

Workflow Step
Completion Dialog Box

There are both automatic and manual email notification events:

• Automatic email notifications—Emails are automatically sent to those users either belonging to the
selected roles or those specifically added on the Email Settings Administration, Project Permission and
Notification Settings, or Application Request Notifications Override pages.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 375


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

• Manual email notifications—Emails are sent to those users specifically selected on the Update History or
Workflow Step Completion dialog box that is displayed when a Workflow Step is completed, on the Edit Data
dialog box that is displayed when a Data Element is edited, or on the Rollback Workflow Item dialog box when
a Workflow Step is rolled back to.

Here is another way of looking at the email notification events, organized by level:

Table 7-17 • Notification Settings at the Default, Project, and Phase/Step Level

Default Level Project Level Phase/ Step Level

• Data Submitted/Rejected • Data Submitted/Rejected • Initiated


• Issue Submitted • Issue Submitted • Rolled Back
• Issue Responded • Issue Responded • Edited
• Application Status Changed • Application Status Changed • Completed
• SLA At Risk/Failed • SLA At Risk/Failed

Setting Email Notification Defaults for Projects and Application Requests


You can specify email notification defaults for both Projects and Application Requests.

• Projects—You can set email notification defaults for all new Projects on the Email Settings Administration
page. See Setting Email Notification Defaults for New Projects.

• Application Requests—You can set email notification defaults for each Project on the Project
Permissions and Notification Settings page. The email settings defined on this page serve as the default
email settings for all new Application Requests submitted for that Project. See Setting Email Notification
Defaults for Application Requests.

You have the ability to not only assign email notifications to Roles, but also to Workflow Manager users, imported
Directory Services users and groups, and to external email addresses.

Setting Email Notification Defaults for New Projects

You set default email notification options for new Projects on the Email Settings Administration page, which is
opened by clicking Email Settings in the Administration menu on the Servicer Home page. Once these
defaults are set, any new Project created in Workflow Manager will automatically inherit these settings.

Therefore, if you usually configure your email notifications the same for all of your Projects, you will very rarely
need to modify these settings.

Note • While these options are inherited by all new Projects, you can change these settings on a Project by Project
basis on the Project Permission and Notification Settings View. See Setting Email Notification Defaults for
Application Requests.

376 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Task: To set email defaults for all new Projects:

1. On the Servicer Home page, click Email Settings in the Administration menu. The Email Settings
Administration page opens, listing all of the Roles for the selected Company.

2. From the Company list, select the Company that you want to set default email settings for.

3. For each item listed in the Role/User/Email Address column, specify whether that user/group or users
assigned to that Role should be, by default, notified when the following events occur. To select all items in that
column, click the check box in the column header.

• Data Submitted/Rejected—Data element is submitted or rejected.

• Issue Submitted—Issue is submitted.

• Issue Responded—Issue is responded to.

• Application Status Changed—Status of Application Request is changed.

• SLA At Risk/Failed—Project is at risk to or failed to meet its SLA due date.

4. If you want to add additional Users or Groups to the list, perform the steps in Adding Users or Groups to an
Email Notification List.

5. If you want to add external email addresses to the list, perform the steps in Adding an External Email Address
to an Email Notification List.

6. Click Update.

Important • Changing the default email settings on the Email Settings Administration page has no effect on
existing Projects.

Setting Email Notification Defaults for Application Requests

Each time a new Project is created, it is automatically given the email settings defined on the Email Settings
Administration page (as described in Setting Email Notification Defaults for New Projects),

However, you can customize the email settings for each Project on the Project Permissions and Notification
Settings page. The email settings defined on this page serve as the default email settings for all Application
Requests created for that Project.

Task: To set email defaults for all of a Project’s New Application Requests:

1. On the Servicer Home page, click Project Permissions in the Administration menu. The Project
Permission and Notification Settings view opens.

2. From the Project list, select the Project that you want to specify email notification settings for.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 377


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

3. From the Template Type list, specify whether you want to edit the permissions for this Project’s Application
template or Deployment template (if one exists).

Note • The Template Type is a combination of the name of the Template used for this Project, followed by the
type Template that it is—Application or Deployment—in parentheses, such as: Packaging Template
(Application).

4. From the Company list, select the Service Company or Customer Company associated with this Project.

5. Select the root node of the Workflow Phase and Step List, which is the name of the selected Project.
The Project-Level email notification options are displayed:

6. For each item listed in the Role/User/Email Address column, specify whether that user/group or users
assigned to that Role should be notified when the following events occur. Click the check box in the column
header to select all items in that column.

• Data Submitted or Rejected

• Issue Submitted

378 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

• Issue Responded

• Application Status Changed

• SLA At Risk/Failed

7. If desired, click the Add User/Group or Add External Email buttons to add users, groups, or external email
addresses to the list, as described in Adding Users or Groups to an Email Notification List and Adding an
External Email Address to an Email Notification List.

8. Select a Phase in the Workflow Phase and Step List. The Phase View opens, providing Permission and
Receive Email options.

9. Under Receive Email, select the Role/User/Email Address that should receive email whenever the following
events occur for the selected Phase:

• Phase is Initiated

• Phase is Rolled Back

• Phase is Edited

• Phase is Completed

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 379


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

10. If desired, click the Add User/Group or Add External Email buttons to add users, groups, or external email
addresses to the Role/User/Email Address list, as described in Adding Users or Groups to an Email
Notification List and Adding an External Email Address to an Email Notification List.

Important • Each time you add a user, group, or external email address, remember to click Update after you
have assigned email notifications to it. If you jump to another Phase or Step before you click Update, your
changes will be lost.

11. The selections you make when a Phase is selected are also assigned to that Phase’s Workflow Steps. If you
want to override the settings for a Workflow Step, perform the following steps:

a. Select a Workflow Step. The check boxes in the Receive Email list are disabled.

b. Next to the Role, user, group, or email address that you want to edit, click the lock icon to unlock the
check boxes. You are notified that the permission is inherited from the parent item.

c. Click OK. The check boxes are now enabled.

d. Make the appropriate selections.

12. When you are finished editing the email settings, click Update.

Overriding Email Notification Defaults for an Application Request


When a new Application Request is created, it inherits the email notification settings defined on the Project
Permissions and Notification Settings page for its associated Project. However, you can modify these
notification settings on the Application Request Notifications Override page for that Application Request.

Task: To override email notification defaults for an Application Request:

1. Open an Application Request’s Application Progress page.

2. In the Quick Links menu, click Override Notifications. The Application Request Notifications
Override page opens.

380 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

3. Initially, the email notification options are locked. To unlock these options so that you can override the settings
that this Application Request inherited from its associated Project, click the Override Project Notifications
button. The notification options are unlocked and the name of the button changes to Inherit Project
Notifications.

Note • If, at any time after modifying these notification settings, you want to return to the Project defaults, click
the Inherit Project Notifications button.

4. Select the Application Request name at the root node of the tree and make any desired modifications to the
following notification events:

• Data Submitted/Rejected

• Issue Submitted

• Issue Responded

• Application Status Changed

• SLA At Risk/Failed

5. Select a Phase name in the tree. The Phase/Step level notification options are displayed: Initiated, Rolled
Back, Edited, and Completed.

6. Make any desired edits to these notification settings at the Phase level and click Update to save your
changes.

7. If you want to modify the notification settings at the Workflow Step level, select a Workflow Step. Because a
Step inherits its settings from its parent Phase, the settings are initially locked.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 381


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

8. To unlock the notification settings for one of the listed Roles, Users, or Email Addresses, click the lock icon
next to the name. A warning message opens:

9. Click OK. The notification settings for that item are unlocked.

10. Make any desired edits and click Update to save your changes.

11. If desired, click the Add User/Group or Add External Email buttons to add users, groups, or external email
addresses to the Role/User/Email Address list, as described in Adding Users or Groups to an Email
Notification List and Adding an External Email Address to an Email Notification List.

Important • Each time you add a user, group, or external email address, remember to click Update after you
have assigned email notifications to it. If you jump to another Phase or Step before you click Update, your
changes will be lost.

12. Click Update to save your modifications.

382 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Adding Users, Groups, and External Email Addresses to an Email


Notification List
In Workflow Manager, you have the ability to not only assign email notifications to Roles, but also to Workflow
Manager users, imported Directory Services users and groups, and to external email addresses.

• Adding Users or Groups to an Email Notification List

• Adding an External Email Address to an Email Notification List

Adding Users or Groups to an Email Notification List

To add a database user or a Directory Services user or group to the Role/User/Email Address list, so that you
can define email notification settings, perform the following steps.

Task: To add users or groups to the list:

1. Click the Add User/Group button. The Add User/Group dialog box opens.

2. Enter the first few letters of the user or group name in the User/Group Name box and click Check Names.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 383


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Note • To list all users in the Search Results list, leave the User/Group Name field blank and then click
Check Names.

One of the following happens:

• Only one match—If you have entered a complete user name or if there is only one match to the
characters you entered, that user or group is automatically selected and is listed in the User/Group
Name field.

• Multiple matches—If you entered characters that match more than one user or group, or if you left the
User/Group Name field blank, a list of Search Results is displayed, and you are prompted to make a
selection by clicking the Select link.

Caution • Database users that do not have an associated email address are listed in the Search Results
listing, but cannot be selected; the Select column for those users is empty.

384 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

3. Select the user or group you want to add to the list and click Apply. The user or group you just selected is now
listed on the Role/User/Email Address list.

4. Specify whether the newly added user or group should be notified when any of the listed events occur by
selecting the appropriate check boxes next to Data Submitted/Rejected, Issue Submitted, Issue
Responded, Application Status Changed, and SLA At Risk/Failed.

5. Click Update.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 385


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Adding an External Email Address to an Email Notification List

To add external email addresses to the Role/User/Email Address list, so that you can define email notification
settings, perform the following steps.

Task: To add external email addresses to the list:

1. On the Servicer Home page, click Email Settings in the Administration menu. The Email Settings
Administration page opens.

2. Click Add External Email. The Select External Email Address dialog box opens, and lists all of the email
addresses that have previously been added on the External Email Address Administration page.

Note • For more information on adding external email addresses, see Adding External Email Addresses to the
List.

386 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

3. Select the email address that you want to add and then click Apply. The email address you just selected is
now listed on the Email Settings Administration page.

4. Specify whether the newly added email address should be notified when any of the listed events occur by
selecting the appropriate check boxes next to Data Submitted/Rejected, Issue Submitted, Issue
Responded, Application Status Changed, and SLA At Risk/Failed.

5. Click Update.

Caution • When you click Update, any users, groups, or external email addresses that you have just added
that do not yet have any notification events assigned to them will be removed from the list. Therefore, to avoid
having recently added users, groups, or external email addresses accidentally removed from an email
notification list, make sure that you assign an email notification event to each of them as soon as you add them.

Deleting a User, Group, or External Email Address from a Notification List

On the following pages, you can add additional users, groups, and external email addresses to email notification
lists:

• Email Settings Administration

• Project Permission and Notification Settings

To remove a user, group, or external email address from an email notification list, perform the following steps:

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 387


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Task: To delete a user, group, or external email address from an email notification list:

1. Click on the user, group, or external email address name in the Role/User/Email Address column. A Remove
button appears under the name:

2. Click Remove. You are prompted to confirm the deletion.

3. Click OK.

Caution • When you click Remove, you will be deleting not only the item you selected, but also any other
additional users, groups, or external email addresses that you have just added that do not yet have any
notification events assigned to them. (These unassigned users are also deleted when you click the Update
button on this page.) Therefore, to avoid having recently added users, groups, or external email addresses
accidentally removed from an email notification list, make sure that you assign an email notification event to
each of them as soon as you add them.

Manually Adding Email Notifications at Workflow Step Completion, Edit,


or Rollback Event
In addition to the automatic email notification events that occur, you can also choose to send a email to a user,
group, or email address whenever you complete, edit, or roll back to a Workflow Step.

• Completing an “Update History” Workflow Step

• Completing a “Normal” Workflow Step

• Editing a Completed Workflow Step

• Rolling Back to a Workflow Step

• Editing Data

388 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Completing an “Update History” Workflow Step


When a Workflow Step has a Step Type of Update History, the Update History dialog box opens when you
mark the step complete. On this dialog box, you can enter email addresses to notify additional people that this
event has occurred.

On this dialog box, you can enter Additional E-mail Recipients (separated by commas) and Additional Email
Comments that will become the part of outgoing email to notify them of this event.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 389


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Completing a “Normal” Workflow Step


When a Workflow Step has a Step Type of Normal, this dialog box opens when you mark the step complete. On
this dialog box, you can enter email addresses to notify additional people that this event has occurred.

On this dialog box, you are prompted to enter the amount of time spent on that step.You can also enter Additional
E-mail Recipients (separated by commas) and Additional Email Comments that will become the part of
outgoing email to notify them of this event.

390 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Editing a Completed Workflow Step


When you choose to edit the information you entered when you completed a previous Workflow Step, the following
dialog box opens, where you are required to enter Edit Comments to explain what was edited. On this dialog box,
you can also choose to enter email addresses to notify additional people that this event has occurred.

On this dialog box, you can enter Additional E-mail Recipients (separated by commas) and Additional Email
Comments that will become the part of outgoing email to notify them of this event.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 391


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Rolling Back to a Workflow Step


When you choose to roll back to previous Workflow Step, the Rollback Workflow Item dialog box opens, where
you can enter email addresses to notify additional people that this event has occurred.

On this dialog box, you can enter Additional E-mail Recipients (separated by commas) and Additional Email
Comments that will become the part of outgoing email to notify them of this event.

392 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Editing Data
When you choose to edit data, the Edit Data dialog box opens, where you can enter email addresses to notify
additional people that this event has occurred.

On this dialog box, you can enter Additional E-mail Recipients (separated by commas) and Additional Email
Comments that will become the part of outgoing email to notify them of this event.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 393


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Managing My Notifications
To view and modify your email notification assignments, perform the following steps:

Task: To view and modify my email notification assignments:

1. On the Servicer Home page, click My Notifications in the Actions menu. The My Default Project
Notifications page opens.

2. To turn off a notification event on this list, so that emails are not sent to you when the event occurs, select the
event and clear the checkbox in the Status column.

Note • If the checkbox is disabled, it means that you do not have permission to modify the selected notification
event.

3. Click My Application Notifications in the Quick Links menu. The My Application Notifications page
opens, listing the Application Request notification settings that were assigned on an Application Request’s
Application Request Notifications Override page.

394 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

4. To turn off a notification event on this list, so that emails are not sent to you when the event occurs, select the
event and clear the checkbox in the Status column.

Note • If the checkbox is disabled, it means that you do not have permission to modify the selected notification
event.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 395


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Managing SLA Settings


Workflow Manager uses SLA settings to determine an Application Request’s status as either On Time, At Risk, Late,
Completed On Time, or Completed Late.

SLA status is calculated using the number of days defined for an Application Request’s Application Due Period
and Application at Risk Period. Any Holidays that you define are always excluded from calculations, and you
can also choose to exclude weekend days from these calculations. The Length of a Work Day value is used to
calculate the elapsed time value in SLA reports.

The default SLA calendar settings that you define are automatically applied to all new Projects. However, you can
modify these settings at the Project-level, and, for some settings, at the Application Request level.

This section includes the following SLA administrative tasks:

• Modifying Default SLA Calendar Settings

• Modifying Due/At Risk Period for an Application Request

• Dynamically Updating an Application Request’s Application Due Period

Modifying Default SLA Calendar Settings


SLA status is calculated using the number of days defined for an Application Request’s Application Due Period
and Application at Risk Period. Any Holidays that you define are always excluded from calculations, and you
can also choose to exclude weekend days from these calculations. The Length of a Work Day value is used to
calculate the elapsed time value in SLA reports.

When you create a new Project, or edit an existing Project, you can specify calendar settings to use when reporting
on Application Request compliance with that Project’s associated Service Level Agreement due dates:

• Work Week Information—Set the length of a work day (in hours and minutes) and whether to exclude
weekend days from the work week.

• Holiday Information—Specify the Holidays to exclude from SLA due date calculations.

You can define the default SLA calendar settings by clicking Calendar Settings under Administration on the
Servicer Home page. These settings are then automatically applied to all new Projects.

Note • You can override the default Calendar Settings for an individual Project on the Project Details page. See
Creating or Editing a Project.

396 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Task: To set default SLA Calendar settings:

1. On the Servicer Home page, click Calendar Settings in the Administration menu to open the Calendar
Settings Administration page.

Figure 7-24: Calendar Settings Page

2. In the Work Week Information area, specify the Length of a Work Day by making selections in the Hours
and Minutes lists.

Note • The Length of a Work Day value is used to convert hours into days when calculating values for
Elapsed Time, SLA Time, User Entered Time, Total Elapsed Time, Total SLA Time, and Total User Entered Time
in reports. For example, if the Elapsed Time for a Workflow Step is 45 hours, Workflow Manager, based on an 8-
hour work day, converts the 45 hours into 5 days and 5 hours.

3. To exclude Saturday and Sunday from the work week, select the Exclude Weekends? option.

Note • For example, if an Application Request was submitted on Tuesday, February 28, 2006 with an
Application Due Period of 5 days and with the Exclude Weekends? option turned on, the Application Due
Date would be March 7, 2006. If this option was turned off, then the Application Due Date would be March5,
2006.

4. The Holidays list lists the holidays that have already been identified to be excluded from the work week. To
add a new Holiday, perform the following steps:

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 397


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

a. In the Holiday Name field, enter a name to identify the Holiday.

b. Click the calendar icon next to the Date field and select the date of the Holiday.

c. Click Add.

5. To delete a Holiday, perform the following steps:

a. In the Holidays list, select the check box next to the Holiday(s) that you want to remove from the list.

b. Click Remove.

Modifying Due/At Risk Period for an Application Request


The SLA status of an Application Request is initially calculated using the SLA settings defined for the Application
Request’s associated Project (see Modifying Default SLA Calendar Settings). These SLA settings include:
Application Due Period, Application at Risk Period, Exclude Weekends?, Length of a Work Day, and
Holidays.

However, you can override the default Application Due Period and Application at Risk Period values for a
specific Application Request on the Properties tab of the Application Progress page.

Task: To set modify Due Period/At Risk Period SLA settings for an Application Request:

1. On the Servicer Home page, click View Project List in the Actions list. The All Projects page opens.

2. Select the Project that contains the Application Request that you want to edit. The Project Summary page
opens.

3. Select the Application Request that you want to edit. The Application Progress page for that Application
Request opens.

4. Open the Properties tab.

5. Under Service Level Agreement, edit the values for Application Due Period and Application at Risk
Period.

6. Click Update. The new values for Application Due Period and Application at Risk Period will be applied
to this Application Request and used in reporting.

Dynamically Updating an Application Request’s Application Due Period


Using an XML file (sla.xml), you can set up a Workflow so that the Application Due Period can be automatically
adjusted, if needed, at every Workflow Step advancement, depending upon user input.

Note • To set up dynamic Application Due Period adjustment, you need Visual Studio .NET 2003.

398 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

For example, let’s say you created a Workflow to prepare applications for deployment in your organization, and
that your organization uses several different operating systems, such as Windows NT and Windows XP. In your
organization, the deployment process for deploying an application to a Windows NT machine is considerably
longer than on a Windows XP machine, but you want to use the same Workflow for both processes. You could set
up a Workflow that would dynamically lengthen the Application Due Period for only those Application Requests
that are being deployed on Windows NT.

Sample sla.xml File


You set up the dynamic updating of Application Due Period using a file named sla.xml. A sample sla.xml file is
provided:

<?xml version="1.0" encoding="utf-8"?>


<SLACompanies>
<Company Name="Requester">
<CustomAttribute Name="OS">
<Value ID="XP">2</Value>
<Value ID="NT">4</Value>
</CustomAttribute>
<CustomAttribute Name="Priority">
<Value ID="Low">2</Value>
<Value ID="Medium">4</Value>
<Value ID="High">6</Value>
</CustomAttribute>
</Company>
<Company Name="GUID2">
<CustomAttribute Name="OS">
<Value ID="XP">12</Value>
<Value ID="2003">10</Value>
</CustomAttribute>
</Company>
</SLACompanies>

This XML file includes the following elements:

Table 7-18 • sla.xml File Elements

Element Description

SLACompanies Element containing Customer Company names that you want to set up dynamic SLA
updating for.

Company Name of Customer Company. In this example, the following Customer Companies are
listed:

<Company Name="Requester">
<Company Name="GUID2">

CustomAttribute Name of the Data Element that is collected during the Workflow that determines whether
the Application Due Period is adjusted. In this example, two CustomAttributes are
defined:

<CustomAttribute Name="OS">
<CustomAttribute Name="Priority">

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 399


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Table 7-18 • sla.xml File Elements (cont.)

Element Description

Value A Value line is entered for all possible values of the CustomAttribute Data Element, in
the following format:

<Value ID="NT">4</Value>

The ID attribute identifies a response to the Data Element, and the number specifies the
number of days that will be added to the Application Due Period if this value is chosen.

In this example, for the Requester Customer Company, if NT is chosen as the OS, four (4)
days are added to the existing Application Due Period for that Application Request.

Setting Up Dynamic Application Due Period Adjustment


To set up dynamic Application Due Period adjustment for a Workflow, perform the following steps.

Task: To set up dynamic Application Due Period adjustment:

1. Create a Workflow that collects a Data Element that you want to use to determine whether to adjust the
Application Due Period of an Application Request.

2. Open Visual Studio .NET 2003 and open the IPlugin.sln solution file found in the following location:

AdminStudioEnterprise/wwwroot/IPlugin/Test

Note • This IPlugin.sln solution file can be used as a basis to build Enterprise business logic and create the
DLL to interpret the sla.xml file.

3. In Visual Studio .NET 2003, click the Build button. A file named IPlugin.Test.dll is created in that solution’s
Output directory.

4. Copy the IPlugin.Test.dll file from the Output directory to the following directory:

AdminStudioEnterprise/wwwroot/bin/Plugins

5. Open the sla.xml file that is located in the following directory:

AdminStudioEnterprise/wwwroot/bin/Plugins

The sla.xml file consists of the following:

<?xml version="1.0" encoding="utf-8"?>


<SLACompanies>
<Company Name="Requester">
<CustomAttribute Name="OS">
<Value ID="XP">2</Value>
<Value ID="NT">4</Value>
</CustomAttribute>
<CustomAttribute Name="Priority">
<Value ID="Low">2</Value>

400 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

<Value ID="Medium">4</Value>
<Value ID="High">6</Value>
</CustomAttribute>
</Company>
<Company Name="GUID2">
<CustomAttribute Name="OS">
<Value ID="XP">12</Value>
<Value ID="2003">10</Value>
</CustomAttribute>
</Company>
</SLACompanies>

6. Set Company Name equal to the name of the Customer Company that you created the Workflow for.

7. Under Company Name, create a CustomAttribute for the Data Element that you want to use to determine
whether to adjust the Application Due Period of an Application Request.

Caution • Make sure that you name the CustomAttribute exactly the same as the Data Element that you
created in the Workflow.

Note • You can create several CustomAttributes for the same Company, and if both are collected during a
Workflow, then both will be applied to the Application Request. You can also define CustomAttributes for
more than one Customer Company in the same sla.xml file.

8. Create Value lines for each of the possible responses to the CustomAttribute, using the following format:

<Value ID="NT">4</Value>

The ID attribute identifies a possible response to the Data Element, and the number specifies the number of
days that will be added to the Application Due Period if this value is chosen.

9. Save the sla.xml file, using the same name, and place it back in the following directory:

AdminStudioEnterprise/wwwroot/bin/Plugins

The next time that an Application Request by the specified Company collects one of the listed
CustomAttribute Data Elements, the Application Due Period will automatically be adjusted based upon
the user response.

Managing Deployment Sites


Deployment sites are specific locations of a Customer Company where applications can be deployed. If a
deployment site is marked as Active, it is listed as a choice in the Available Sites section of an Application Request
that has an associated Deployment Template.

Administrators can use the Deployment Site Management functionality to add or edit deployment sites for each
Customer Company. Administrators can also add more sites even after an Application Request is created and is in
progress.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 401


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

This section includes the following tasks:

• Viewing Existing Deployment Sites

• Adding a New Deployment Site

• Editing a Deployment Site

• Setting Deployment Site Status

Viewing Existing Deployment Sites


To view existing deployment sites, perform the following steps.

Task: To view existing deployment sites:

1. On the Servicer Home page, click the Deployment Sites link in the Administration menu. The
Deployment Site Administration page opens, listing all defined deployment sites for all Customer
Companies. The following information is displayed:

Property Description

Company Name The company that this deployment site is associated with.

Deployment Site Name of deployment site. To open a deployment site's Deployment Site
Details View, click Select.

Status Indicates the deployment site's status:

• Active—Site will be listed as a choice in the Available Sites section of an


Application Request that has an associated Deployment Template.
• Inactive—Site will be listed on the Deployment Site Administration
page, but will not be listed as a choice in the Available Sites section of an
Application Request that has an associated Deployment Template.

Ready to Deploy Indicates whether the site administrator feels that this deployment site is ready
to receive deployed applications. No deployment Workflows can begin, and no
deployment progress will be shown on the Deployment Progress tab of the
Application Progress page unless this field is set to Yes.

402 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Adding a New Deployment Site


To add a new deployment site, perform the following steps.

Task: To add a new deployment site:

1. On the Servicer Home page, click the Deployment Sites link in the Administration menu. The
Deployment Site Administration page opens.

2. Click Add. The Deployment Site Details View opens.

3. In the Deployment Site Name field, enter a name for the new deployment site, such as a location name (New
York, London, Chicago, etc.) or a department name (Marketing, Finance, Development, etc.).

4. From the Company Name list, select the name of the company that you are creating this deployment site for.

5. From the Ready to Deploy list, specify whether this deployment site is ready to receive deployed applications
by selecting Yes or No.

6. From the Status list, select Active or Inactive. If you select Active, this deployment site will be listed as a
choice in the Available Sites section of an Application Request that has an associated Deployment Template.
If you select Inactive, this deployment site will not be offered as a choice on an Application Request.

7. Click Update. The new deployment site will now be listed on the Deployment Site Administration page
under its associated company.

Editing a Deployment Site


To edit a deployment site, perform the following steps.

Task: To edit a deployment site:

1. On the Servicer Home page, click the Deployment Sites link in the Administration menu. The
Deployment Site Administration page opens, listing all defined deployment sites for all Customer
Companies.

2. Locate the deployment site that you want to edit.

3. Select a deployment site to open its Deployment Site Details View.

4. In the Deployment Site Name field, you can edit the name of this field that was previously entered.

5. Next to Company Name, the company that this deployment site is associated with is listed. (This is a read
only field.)

6. From the Ready to Deploy list, select Yes or No to indicate whether the site administrator feels that this
deployment site is ready to receive deployed applications. No deployment Workflows can begin, and no
deployment progress will be shown on the Deployment Progress tab of the Application Progress page,
unless this field is set to Yes.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 403


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

7. From the Status list, select Active or Inactive. If you select Active, this deployment site will be listed as a
choice in the Available Sites section of an Application Request that has an associated Deployment Template.
If you select Inactive, this deployment site will not be offered as a choice on an Application Request.

8. Click Update to save your edits and return to the Deployment Site Administration page.

Setting Deployment Site Status


If a deployment site has a Status of Active, it will be listed as a choice in the Available Sites section of an
Application Request that has an associated Deployment Template. If a deployment site has the Status of Inactive, it
will not be offered as a choice on an Application Request.

To set the status of a deployment site, perform the following steps.

Task: To set the status of a deployment site:

1. On the Servicer Home page, click the Deployment Sites link in the Administration menu. The
Deployment Site Administration page opens, listing all defined deployment sites for all Customer
Companies.

2. Locate the deployment site that you want to set the status of.

3. Select a deployment site to open its Deployment Site Details View.

4. From the Status list, select Active or Inactive. If you select Active, this deployment site will be listed as a
choice in the Available Sites section of an Application Request that has an associated Deployment Template.
If you select Inactive, this deployment site will not be offered as a choice on an Application Request.

5. Click Update to save your edits and return to the Deployment Site Administration page.

Managing Application Status


Application Status is a user-configurable field you can use to assign metadata to an Application Request which can
be used when performing searches and generating reports. On the Application Status Administration page,
which is accessed by clicking Application Status in the Administration menu on the Servicer Home page, you
can add or edit Application Statuses.

• By default, Workflow Manager is installed with two statuses: Active and Inactive. These two statuses can be
renamed, but they cannot be deleted.

• Application Statuses can be assigned either an Active or Inactive state. If an Application Status’ State is set
to Inactive, Application Requests that have been assigned this Application Status will not be included in
reports or searches.

• You can change the Application Status of an Application Request on the Properties Tab of the Application
Progress page.

404 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

• Email notification is sent whenever an Application Requests's Application Status is changed. You specify the
users that receive the email notification Project Permission and Notification Settings view. If no user is
selected, no email is sent.

Creating a New Application Status


To create a new Application Status, perform the following steps.

Task: To create a new Application Status:

1. On the Servicer Home page, click the Application Status link in the Administration menu. The
Application Status Administration page opens.

2. Click Add. The New Application Status View opens.

3. Enter a Name to identify the Application Status.

4. Identify the State of this Application Status as either Active or Inactive. If the State is set to Inactive,
Application Requests that have been assigned this Application Status will not be included in Reports or
Searches.

5. Enter a Description to identify the purpose of this Application Status.

6. Click Submit to create the Application Status. The Application Status is now listed on the Application Status
Administration page.

Editing an Application Status


To edit an Application Status, perform the following steps.

Task: To edit an Application Status:

1. On the Servicer Home page, click the Application Status link in the Administration menu. The
Application Status Administration page opens.

2. Select the Application Status that you want to edit. The Edit Application Status View opens.

3. Edit the Name.

4. Choose Active or Inactive from the State list. If the State is set to Inactive, Application Requests that have
been assigned this Application Status will not be included in Reports or Searches.

5. Edit the Description.

6. Click Submit to save your edits.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 405


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Deleting an Application Status


To delete an Application Status, perform the following steps.

Task: To delete an Application Status:

1. On the Servicer Home page, click the Application Status link in the Administration menu. The
Application Status Administration page opens.

2. Select the Application Status that you want to delete. The Edit Application Status View opens.

3. Click Delete. The Application Status is no longer listed on the Application Status Administration page.

Note • By default, Workflow Manager is installed with two statuses: Active and Inactive. These two statuses can be
renamed, but they cannot be deleted. These two System Application Statuses are listed in italics.

Managing External Datasources


If you define a connection to an external data source, you can choose to populate a single-selection list displayed
on an Application Request with real time data values obtained from an associated SQL Server or Oracle database.

The information about managing external data sources is presented in the following topics:

• About Using External Datasources

• Creating a New External Datasource Connection

• Editing an Existing External Datasource Connection

• Deleting an External Datasource Connection

About Using External Datasources


In a Workflow Template, you define the information that you want to gather when an Application Request is
submitted by creating Data Groups comprised of Data Elements. When an Application Request is submitted, each
Data Group is displayed as a “page” of questions, and each Data Element is a question. When defining single-
selection lists, you have two options:

• Standard Single-Selection Lists Defined Within Workflow Manager

• Single-Selection Lists Populated by an External Datasource

406 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Standard Single-Selection Lists Defined Within Workflow Manager


To define a standard single-selection list, you would create a Data Element with the Data Type of Single
Selection, and enter each of the list values in the Selection list items text box:

Figure 7-25: Data Element with a Data Type of Single Selection

This question, when viewed by the person submitting an Application Request, looks like this:

Figure 7-26: Display of Data Element with Data Type of Single Selection

Single-Selection Lists Populated by an External Datasource


To define a single-selection list that is populated by an external datasource, you have to:

• Define an external data source, as explained in Creating a New External Datasource Connection.

• Create a Data Element with a Data Type of DB-Driven type, as explained in the DB Driven Type portion of
the Defining Data Elements procedure.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 407


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

After you have defined an external data source connection, you then create a Data Element with the Data Type of
DB Driven Type:

Figure 7-27: Display of Data Element with Data Type of DB Driven Type

When an Application Request is generated using this template, this question, as shown to the person submitting
an Application Request, displays an empty, non-editable text box and a Click to Select link:

Figure 7-28: DB Driven Data Element Displayed in an Application Request

408 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

When the Requester clicks Click to Select to make a selection for this question, the query that was entered on the
Data Element Properties view when this Data Element was defined is run, and the current values from that data
base are returned and are shown in the Database Record List:

The Requester selects one item from the list and clicks Select. The value of the column defined as the Persisted
Column is displayed:

Figure 7-29: DB Driven Data Element After User Makes Selection

Creating a New External Datasource Connection


To populate a single-selection list in an Application Request with real time data values obtained from an associated
SQL Server or Oracle database, you have to:

• Define an external data source, as explained below, and

• Create a Data Element with a Data Type of DB-Driven type, as explained in Defining Data Elements

Task: To create a new external data source connection

1. Click the Administration tab. The User Administration page opens.

2. Click the External Data Sources tab. The External Data Sources Administration page opens.

3. Click Add. The External Data Sources Details view opens.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 409


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

4. From the Database Type list, select Oracle or SQL Server.

5. In the Datasource Name box, enter a user-friendly name to identify this data source within Workflow
Manager. This name will be listed in the External Data Source List on the Data Element Properties view
when defining DB Driven Type Data Element.

6. In the Server box, enter the name of the Server that this external data source will connect to. For Oracle,
provide the local Net Service name.

7. In the Username and Password boxes, enter the user name and password of the user that will be used to
connect to the external database.

8. In the Database Name box, enter the name of the external database you are connecting to.

9. Click Update. The new external data source is now listed on the External Datasources Administration
page.

Note • The login credentials are not tested when you enter them here, so make sure that you have entered the
correct information.

Editing an Existing External Datasource Connection


To edit an existing external data source connection, perform the following steps:

Task: To edit an external data source connection

1. Click the Administration tab. The User Administration page opens.

2. Click the External Data Sources tab. The External Data Sources Administration page opens and lists all
defined external data sources.

3. Select the external data source you want to edit. The External Data Sources Details view opens.

4. Make any desired edits, as described in Creating a New External Datasource Connection.

5. Click Update.

Note • The login credentials are not tested when you enter them here, so make sure that you have entered the
correct information.

410 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Deleting an External Datasource Connection


To delete an external data source connection, perform the following steps.

Task: To edit an external data source connection

1. Click the Administration tab. The User Administration page opens.

2. Click the External Data Sources tab. The External Data Sources Administration page opens and lists all
defined external data sources.

3. Select the external data source you want to delete. The External Data Sources Details view opens.

4. Click Delete. You are prompted to confirm the deletion.

5. Click OK.

Workflow Manager Configuration Tasks


This section contains information on the following tasks:

• Specifying Folders for Uploads and Downloads

• Setting the System User Account

Specifying Folders for Uploads and Downloads

Task: To specify folders for uploads and downloads:

1. Open the file:

\\<file_server_name>\Workflow Manager
\_____Sample_Folder_Structure\DirectoryConfig.xml

2. In each tag that is listed in the following table, place the name of the desired subfolder of:

\\<file_server_name>\Workflow Manager\_____Sample_Folder_Structure

Table 7-19 • Folders for Uploads and Downloads

Tag Name Purpose of Folder

InstallationUploadDirectory Files uploaded from a data entry item of type Application Upload

DocumentUploadDirectory Files uploaded from a data entry item of type Document Upload

DependencyUploadDirectory Files uploaded from a data entry item of type Dependency Upload

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 411


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Table 7-19 • Folders for Uploads and Downloads (cont.)

Tag Name Purpose of Folder

CustomerDownloadDirectory Files that can be downloaded from the Project Summary page's
Applications In <phase name> Phase tab's Downloadable Files
subtab.

For example, the contents of directoryconfig.xml might look like this:

<DirectoryConfiguration>
<InstallationUploadDirectory>
6_Original_Install
</InstallationUploadDirectory>
<DocumentUploadDirectory>
7_Documentation_Misc
</DocumentUploadDirectory>
<DependencyUploadDirectory>
8_Dependencies
</DependencyUploadDirectory>
<CustomerDownloadDirectory>
1_MSI_Repackaged_Install
</CustomerDownloadDirectory>
</DirectoryConfiguration>

3. If any of the folder names that you specified in the previous step do not exist under the following directory,
create them:

\\<file_server_name>\Workflow Manager\_____Sample_Folder_Structure

Note • When creating the file structure for a new application, Workflow Manager does the following:

• Creates a folder using the Service Company name (unless it already exists).
• Creates a subfolder using the Customer Company name (unless it already exists).
• Creates a subfolder in the Customer Company folder for the new application, using an application GUID
appended to the Application Name.
• Copies all files and folders in the _____Sample_Folder_Structure folder to the new application directory.

Setting the System User Account


Workflow Manager performs many operations, such as sending emails and uploading/downloading files, by
impersonating the user specified on the System Settings page.

When Workflow Manager was installed, this user either already existed or was created during installation. If you
would like to change the System user account, perform the following steps:

412 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Task: To set the System Management User Account:

1. Click the Administration tab. The User Administration page opens.

2. Click the System Settings tab. The System Settings page opens.

3. To set the Workflow Manager System user account, enter the following information:

Option Description

User Name Enter the name of an existing user account in the domain specified in the User Domain
field.

User Enter the password of the user account defined in the User Name and User Domain
Password fields.

Note • Workflow Manager encrypts passwords.

User Domain Enter the domain of the user account listed in the User Name field.

Note • In a domain, usually a user’s password expires after a specified length of time. To avoid having to update
this password in the future, you may want to choose a user whose password does not expire.

Integrating AdminStudio and Workflow Manager


AdminStudio is a software packaging and testing solution. It includes a suite of tools—including ConflictSolver,
Repackager, and InstallShield Editor—that systems administrators use to migrate their organization software to
Windows Installer and deploy error-free software packages that meet enterprise requirements and standards.

You can use AdminStudio with Workflow Manager to make software packaging procedures easier and more
efficient:

Table 7-20 • AdminStudio and Workflow Manager Integration

Topic Description

Connecting the AdminStudio Client To integrate the AdminStudio client tools and Workflow Manager,
Tools to the AdminStudio Enterprise you have to open AdminStudio and connect to the AdminStudio
Server Application Catalog Enterprise Server Application Catalog where Workflow Manager
is installed.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 413


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Table 7-20 • AdminStudio and Workflow Manager Integration (cont.)

Topic Description

Associating a Workflow Manager You can associate a Workflow Manager Application Request with
Application Request with a Package a package, from either the AdminStudio or Workflow Manager
interfaces. This links that package’s Package Report with the
Application Request’s Application Report.

Sharing AdminStudio Extended You can define a AdminStudio Data Group so that Data elements
Attribute Data With Workflow Manager are automatically created based upon the elements defined in
Workflows the Adminstudio Extended Attributes XML file.

Defining a Workflow Manager Phase When defining a Template, you can choose to define a Workflow
as an AdminStudio Workflow Project Phase as an AdminStudio Workflow Project, and receive
progress notification from AdminStudio as the Project Steps are
completed.

Automatically Performing You can use the IPlugin interface to import packages into the
ConflictSolver Tasks from a Workflow Application Catalog and perform validation and conflict analysis
Manager Workflow Step as part of a Workflow Manager Workflow Step via command line
using AdminStudio ConflictSolver.

Connecting the AdminStudio Client Tools to the AdminStudio Enterprise


Server Application Catalog
To integrate the AdminStudio client tools and Workflow Manager, you have to open AdminStudio and connect to
the AdminStudio Enterprise Server where Workflow Manager is installed.

Task: To connect the AdminStudio client tools with Workflow Manager:

1. From the AdminStudio Start Page, select Connect on the Catalog menu. The Connect Application
Catalog dialog box opens.

2. Open the Enterprise Server tab.

3. Click the link under Please login to AdminStudio Enterprise Server. The Select AdminStudio
Enterprise Server URL dialog box opens.

414 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

4. In the AdminStudio Enterprise Server URL field, enter the URL of the AdminStudio Enterprise Server
where Workflow Manager is installed and click OK. That URL is now listed on the Enterprise Server tab of
the Connect Application Catalog dialog box.

5. Enter the User Name and Password for the AdminStudio Enterprise Server which was provided by your
System Administrator. AdminStudio Enterprise Server User Names are in the form of and email address, such
as:

myname@mycompany

6. Click Login. You are logged into the AdminStudio Enterprise Server and details about that Application Catalog
are listed:

7. Optionally, select the Make this the default shared Application Catalog option.

8. Click OK. The following functions are now enabled:

• Associating a Workflow Manager Application Request with a Package

• Sharing AdminStudio Extended Attribute Data With Workflow Manager Workflows

• Defining a Workflow Manager Phase as an AdminStudio Workflow Project

Associating a Workflow Manager Application Request with a Package


When you associate a package with an Application Request, their respective reports are also linked together:

• Application Report—The Application Request’s Application Report contains a link to open the Package
Report of its associated package.

• Package Report—The package’s Package Report contains a link to open the Application Report of its
associated Application Request.

You can associate a package with an Application Request from both AdminStudio Application Manager and
Workflow Manager.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 415


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Associating a Package With an Application Request from Application Manager


You can select a package in the Application Manager Product View and select an Application Request from a list.

Task: To associate a package with an Application Request from Application Manager:

1. Open AdminStudio Application Manager and connect to the AdminStudio Enterprise Server Application
Catalog.

2. In the Product View, right-click a package in the package tree and then click Associate With Workflow
Manager Application.

The Associate with Workflow Manager Application Request dialog box opens.

3. From the list, select the name of the Application Request that you want to associate with this package and
click OK.

416 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Associating a Package With an Application Request from Workflow Manager


You can open an Application Request’s Application Progress page and associate it with a package in the
AdminStudio Enterprise Server Application Catalog.

Task: To associate an Application Request with a package from Workflow Manager:

1. Open the Application Progress page of the Application Request that you want to associate with a package,
as described in Opening an Application Request’s Application Progress Page.

2. Open the Properties tab.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 417


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

3. Next to the Associated Package field, click Change. The Select Package dialog box opens, displaying the
Application Catalog package tree:

4. Select a package in the tree and click Select Package. The name of the selected package is now listed in the
Associated Package field, and is linked to the package’s Package Report.

Tip • On the Select Package dialog box, you could also use the tools in the Search Packages area to find a
specific package.

Sharing AdminStudio Extended Attribute Data With Workflow Manager


Workflows
You can create a Workflow Manager Template that includes a Data Group that contains Data Elements that are
defined in the AdminStudio Extended Attributes XML file.

When you create a Data Group with a Data Type of AdminStudio Data Type, that Data Group is automatically
populated with a Data Element for each entry in the AdminStudio Extended Attributes XML file.

Also, because you can associate an Application Request with a package:

• If you edit this package’s data in the Extended Attributes view in Application Manager, the data stored in the
Workflow Manager Application Request is automatically updated.

• If you edit the data submitted with the Application Request, the package data displayed in the Extended
Attributes view in Application Manager is automatically updated.

418 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Note • By design, extended attributes data in Application Manager and Workflow Manager data have a one-to-one
relationship. You can only associate one Workflow Manager Application Request with a package in the AdminStudio
Enterprise Server Application Catalog; once the Application Request is associated with a package, it is no longer
available for association with other packages in the Application Catalog.

Task: To share extended attributes between AdminStudio and Workflow Manager:

1. Enable data sharing between Workflow Manager and AdminStudio Application Manager by selecting the
Integrate with Workflow Manager check box on the Extended Attributes tab of the Application Manager
Options dialog box.

Note • The default Extended Attributes Description File is: C:\AdminStudio Shared\EA_Default.xml

2. Open the Template Details page of the Template that you want to share data with.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 419


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

3. Create a new Data Group and set the Data Type to AdminStudio Data Type.

4. After you click Update, that Data Group’s Data Elements are automatically created and populated by the
fields defined in the AdminStudio Extended Attributes Description File:

420 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Default Extended Attribute Description File

A portion of the default Extended Attribute Description File (EA_Default.xml) is displayed below:

<?xml version="1.0" encoding="UTF-8"?>


<Extended_Attribute UniqueIdentifier="ISASEA40"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="EA.xsd">

<AttributeDetails>
<Name>Application Name</Name>
<Type>Text</Type>
<HelpText>Common name used for the application.</HelpText>
</AttributeDetails>

<AttributeDetails>
<Name>Application Description</Name>
<Type>Text</Type>
<HelpText>description of software's core function. </HelpText>
</AttributeDetails>

<AttributeDetails>
<Name>Application Type</Name>
<Type>Selection</Type>
<Values>General;Accounting;Sales;CRM;Graphics;
Communication;Database;Management;Development;
Engineering;</Values>
<HelpText>Select the Application Type</HelpText>
</AttributeDetails>

As you can see, each <AttributeDetails> element in the EA_Default.xml file defines the data entry field on the
Application Manager Extended Attributes View, and the <Type> element defines the type of entry field: text box,
selection list, uploaded file, etc.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 421


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Figure 7-30: Application Manager Extended Attributes View

422 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Defining a Workflow Manager Phase as an AdminStudio Workflow Project


Workflow Manager Application Requests are based upon the Workflow Template selected for its associated
Project. AdminStudio has a similar concept: you create Workflows and then execute Projects using these
Workflows.

AdminStudio’s Workflows are displayed in a “checklist” format, similar to a Workflow Manager Workflow Phase:

Figure 7-31: Sample AdminStudio Project in Progress

To define an Workflow Manager Workflow Phase as an AdminStudio Workflow, you give the Workflow Phase a
Phase type of AdminStudio Workflow:

Figure 7-32: Specifying an AdminStudio Workflow as one of the Workflow Phases in Workflow Manager Workflow
Template

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 423


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

When AdminStudio Workflow is selected for Phase type, Workflow Manager communicates with AdminStudio,
obtains a list of the current AdminStudio Workflows, and displays them in the AdminStudio WF list. You select the
AdminStudio Workflow that you would like to insert into this template. When you click Update on the Workflow
Phase Details area, a Workflow Step is automatically created, indicating that this Workflow Phase will be
performed using AdminStudio:

Figure 7-33: Workflow Manager creates a single Workflow Step for AdminStudio Workflows

When that Template is viewed, the AdminStudio tasks appear as a single Workflow Phase, with no Workflow Steps
displayed. Instead, the following message appears:

All the items in AdminStudio workflow “Workflow Name”

Figure 7-34: Workflow with AdminStudio Integration

When a Workflow Phase is defined as an AdminStudio Workflow, the following occurs:

Table 7-21 • Events Associated with Using an AdminStudio Workflow Step

Event Description

AdminStudio Users When an Application Request is created using a Template that has a Phase defined
Can be Assigned to as an AdminStudio Workflow, AdminStudio Enterprise Server Users are available
Workflow Steps for selection on the Assignment Details Page.

424 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

Table 7-21 • Events Associated with Using an AdminStudio Workflow Step (cont.)

Event Description

Progress is While the actual task names are not displayed on the Application Progress page,
Displayed on the as progress is made on the AdminStudio Project (as tasks are marked complete on
Application Progress the AdminStudio Projects tab), the percentage that those tasks are complete is
Page displayed on the Application Progress page. For example, if an AdminStudio
Project has 10 tasks and 4 have been marked complete in AdminStudio, the
Workflow Manager Workflow Phase will have a percentage complete of 40%.

When the last task of an AdminStudio Project is marked complete, the Workflow
Manager Workflow Phase is marked 100% complete on the Application Progress
page and the Workflow is advanced.

Progress Can Be If, on the Projects tab, an AdminStudio user opens a Project that is not yet
Decreased completed and unselects tasks that were previously completed, the percentage
complete displayed on the Application Progress page reflects the change, resulting
in decreasing the percentage complete displayed.

Note • If an AdminStudio Project is complete, it can no longer be changed.

AdminStudio On the Application Progress page, a Workflow Manager user can choose to either
Workflow Phase Can rollback directly to the AdminStudio Workflow Phase or to a Step in a previous
Be Rolled Back Phase. The AdminStudio Project will then be performed again in AdminStudio.

Automatically Performing ConflictSolver Tasks from a Workflow Manager


Workflow Step
You can use the IPlugin interface to import packages into the Application Catalog and perform validation and
conflict analysis as part of a Workflow Manager Workflow Step via command line using AdminStudio ConflictSolver.

• For information on how to set up Workflow Manager automation, see Setting Up IPlugin Automation in
Workflow Manager.

• For information on how to set up Workflow to include an Automated Import, Automated Validation, or
Automated Conflict Analysis Workflow Step, see Defining Automated Import, Validation, and Conflict
Analysis Workflow Steps.

• For information on how to use the IPlugin interface, see Using the IPlugin Interface.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 425


Chapter 7: Using Workflow Manager to Manage Enterprise Software Packaging
Performing Administrative Tasks

426 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


8
Workflow Manager Reference

The Workflow Manager Reference section includes the same topics that are displayed when you open help from
the Workflow Manager interface. Reference information for Workflow Manager is presented in the following
sections:

Table 8-1 • Workflow Manager Reference

Section Description

Home Page Describes the menus and lists available on the Home Page.

Application Request Describes the Pages and Views used to submit an Application Request,
Related Pages and Views perform Application Request tasks, and check on an Application Request’s
progress.

Administration Pages and Describes the Pages and Views used to perform Workflow Manager
Views administrative tasks.

Dialog Boxes Specific help for each pop-up dialog box in Workflow Manager is covered in
this section.

Configuration File: Explains the settings that are defined in the Workflow Manager Configuration
web.config file: web.config.

Extending Workflow A list of the officially supported mechanisms for extending the functionality of
Manager Workflow Manager.

Using the IPlugin Explains how to create custom plugins for Workflow Manager. The IPlugins
Interface interface defines some standard callback methods which will be called by
Workflow Manager during the course of application submission and workflow
advancement. Your custom implementation of this plugin can have custom
code to link these events with external systems.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 427


Chapter 8: Workflow Manager Reference
Home Page

Table 8-1 • Workflow Manager Reference (cont.)

Section Description

Workflow Manager Points you to information you can find in the AdminStudio Web Server
Installation Issues Installation Guide.

When a company is created by a Workflow Manager administrator, it is designated as either a Customer Company
(a company or department whose members request that application services be performed), or a Service
Company (a company or department whose members perform requested application services). At log in,
members of a Service Company see the Servicer Home page, while members of a Customer Company see the
Customer Home page. See Customers, Servicers, and Companies for more information.

Home Page
The Home page provides access to all of the functionality of Workflow Manager. It also includes lists that are
customized to your needs, allowing you to quickly jump to the area of Workflow Manager that you access
frequently.

Note • For help on how to perform specific Workflow Manager tasks, see Using Workflow Manager to Manage
Enterprise Software Packaging.

The areas of Workflow Manager that a user can access depends upon the user’s assigned Roles and whether the
user is a Customer or a Servicer, and therefore the links and lists that appear on the Home page vary accordingly.
The Home page is organized in the following areas:

Table 8-2 • Home Page Functionality

Area Available To Description

Actions Menu All Users Links to tasks that you have permission to perform.

Administration Menu Servicers Links to the administrative functionality of Workflow Manager,


which includes managing Projects, Templates, and Companies.

Search By Name or AR All Users Use to quickly locate an Application Request. Enter an
Number Application Request name, part of a name, or an AR number
and click Go.

428 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Home Page

Table 8-2 • Home Page Functionality

Area Available To Description

Assignments List Servicers The Assignments included in this list depend upon the
Servicer’s role membership. A Servicer with non-administrative
roles sees only Application Requests Assigned to Me, while
a Servicer with administrative roles has the following choices:

• Unassigned Application Requests


• Application Requests Assigned to Me
• Partially Assigned Application Requests

Issues List All Users List of recently submitted issues.

My Reports List All Users List of Reports that the user has permission to view.

My Page Servicers A list of favorite links. You can choose to display any HTML page
in this window. See Displaying a Custom Web Page on the
Home Page.

Submit a New Customers Enter information in this area to submit a new Application
Application Request Request.
Area

My Application Customers List of Application Requests that the user has submitted.
Requests

Actions Menu
The following items are available in the Actions Menu of the Customer and Servicer Home page. The display of
these items depends upon the permissions of a user’s assigned Role.

Table 8-3 • Action Tasks on Servicer Home Page

Option Available To Description

Assign Work Servicers Click to open the Work Assignment Listing Page, where you can
edit an application's work assignments.

My Notifications All Users Click to open the My Default Project Notifications page, which
lists the default email notifications that the user is currently
subscribed to, including those that were assigned via Role(s) or
Group(s), and those assigned explicitly.

Search Application All Users Click to open the Application Search Page, where you can search
Requests for an application on the system.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 429


Chapter 8: Workflow Manager Reference
Home Page

Table 8-3 • Action Tasks on Servicer Home Page (cont.)

Option Available To Description

Submit Application Servicers Click to open the Submit Application Request Page, where you
Request can search for an application on the system.

View Assignments Servicers Click to open the Working Queue View Page, which lists all of the
by User assignments that have been made for all Application Requests at
your company.

View Issues All Users Click to open the Issues List Page where you can view a list of
issues filtered by status.

View Project List All Users Click to open the All Projects page, where you can view Projects by
company, or view progress on applications in a Project.

Administration Menu
The following items are available on the Administration menu on the Servicer Home page. The display of these
items depends upon the permissions of a user’s assigned Role.

Table 8-4 • Administration Tasks on My Home Page (Servicer)

Option Description

Application Status Click to access the Application Status Administration Page. Application Statuses are
user-definable metadata that can be used to filter Application Requests in searches,
listings, and reporting. Each Application Status can have a state of either Active or
Inactive.

Calendar Settings Click to access the Calendar Settings Administration Page, where you specify the
calendar settings to use when reporting on Application Request compliance with
Project Service Level Agreement (SLA) due dates.

Companies Click to access the Company/Business Unit Administration Page, where you can view
and edit company information and add a new company to the system.

Deployment Sites Click to access the Deployment Site Administration Page, where you can view and edit
existing deployment sites, add new deployment sites, and set deployment site status.

Email Settings Click to access the Email Settings Administration Page, where you can specify default
email notification settings for all new Projects.

Project Click to access the Project Permission and Notification Settings View, where you can
Permissions edit permissions of Roles for a particular Project, and also set notification settings.

Projects Click to access the Project Administration Page, where you can view and edit existing
Projects, and add a new Project to the system.

430 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-4 • Administration Tasks on My Home Page (Servicer) (cont.)

Option Description

Templates Click to access the Template Administration Page, where you can view and edit existing
templates, view and edit Data and Workflow items, and add a new template to the
system.

Terminology Click to access the Terminology Customization Page, where you can customize
Workflow Manager terminology.

Application Request Related Pages and Views


The pages and Views described in this section are used to submit, perform, and manage Application Requests.
This section provides information on the following pages and views:

Table 8-5 • Application Request Related Pages and Views

Option Description

All Application(s)/Application Customer and Servicer Application Request search-related pages.


Search Page

All Projects Page List of all Projects for a Company (for Customers) or all Projects for all
Customer Companies (for Servicers).

Application Progress Page Used by Customers and Servicers to view data entry, workflow, issues,
(Customer) and associated file information for a selected Application Request.

Application Progress Page


(Servicer)

Application Progress Page


(Shared)

Issues List Page Used by Servicers and Customers to communicate with each other about
application activity.

Submit Application Request Used by Customers and Servicers to submit a new Application Request.
Page

Work Assignment Listing Page Used by Servicers to assign an application task to a Role.

Note • The availability of these pages for a particular user is dependent upon the user’s assigned Roles. See
Managing Roles and Permissions.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 431


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

All Application(s)/Application Search Page


This page is opened from the Customer Home page, and its name depends upon how you opened it:

• All Application(s) Page—Click View Application Request List in the Actions menu.

• Application Search Page—This page opens in two ways:

• Click Search Application Requests in the Actions menu.

• Perform a Quick Search by entering text in the Application Search box and clicking Go.

This page has two views:

• Search Criteria View

• Application Request List View

Search Criteria View


On the Application Search page, enter the following search criteria:

Table 8-6 • All Application(s)/Application Search Page, Search Criteria View Options

Option Description

Application Select an Application Family to restrict your search to Application Requests belonging to that
Family Application Family.

Application Enter the name or part of the name of the Application Request you are searching for. If you
Name enter a word or part of a word, Workflow Manager will search for all Application Requests
that include that word or part of a word in the Application Name. If you enter more than one
word or word fragment, Workflow Manager will find only those Application Requests that
include that exact text in that order.

Metadata Text Enter the text you want to search for in the Data Elements (data entry fields) that were
entered either upon submission of an Application Request or as part of a Workflow Phase. If
you enter a word or part of a word, Workflow Manager will search for all Application
Requests that have data entries that include that word or part of a word. If you enter more
than one word or word fragment, Workflow Manager will find only those Application
Requests that have data entries that include that exact text in that order.

Issue or Enter the text you want to search for in any of the Issues or Messages associated with
Message Text Application Requests. If you enter a word or part of a word, Workflow Manager will search for
all Application Requests that have Issues or Messages that include that word or part of a
word. If you enter more than one word or word fragment, Workflow Manager will find only
those Application Requests that have Issues or Messages that include that exact text in that
order.

432 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-6 • All Application(s)/Application Search Page, Search Criteria View Options (cont.)

Option Description

AR Number Enter the numeric portion of the AR Number to restrict your search to the Application
Request matching that number. The Application Request Prefix is not included in the search,
and only exact numeric matches are found. For example, if you enter 12, only one
Application Request will be found: AR 12; Application Request with numbers of AR 120 or AR
1235 are not found.

Note • Application Requests for one Service Company are assigned sequential numbers in the order
they were created. Creating a new Project that uses a different Application Request Prefix does not reset
the sequence number to zero, so entering just the numeric portion of the AR Number will not return
duplicate entries, such as AR 103 and HO 103. Only one Application Request for that Service Company
will have the AR Number of 103.

Created After Enter a date to restrict your search to Application Requests created after that date.

Created Enter a date to restrict your search to Application Requests created before that date.
Before

Project Select a Project from the list to narrow your Application Request search to only that Project.

Search Click to initiate the search. Search results are displayed in the Search Results View of the
Application Search Page. (For Servicers, the results page is titled Search Results).

Application Request List View


This list view appears in one of two ways:

• If you click View Application Request List on the Customer Home page, all of your Company’s Application
Requests are listed.

• If you perform an Application Search, the search results are listed on this page. All of the Application
Requests that meet the search criteria you entered are listed.

You can select an Application Request to open its Application Progress Page (Customer). This page includes the
following information and options:

Table 8-7 • All Application(s)/Application Search Page, Search Results View Options

Option Description

Application Name of Application Request meeting your search criteria. Select an Application Request to
Name open its Application Progress Page (Customer)

Project Name Name of the Project that this Application Request is associated with.

Status Identifies this Application Request's Application Status, such as Active or Inactive.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 433


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-7 • All Application(s)/Application Search Page, Search Results View Options (cont.)

Option Description

AR Number Number which uniquely identifies this Application Request.

Submitted Date Application Request was submitted.

For Company Name of company that submitted this Application Request.

Workflow Identifies the workflow status of the Application Request as being in one of the following
Status statuses:

• Application Complete
• Deployment Complete
• Data Entry Phase
• Last Phase
• Merging Workflow Steps
• Work Phase

Workflow Active Workflow Phase of this Application Request.


Phase

Assigned Identifies whether someone has been assigned to one of the Roles associated with this
Application Request.

Status Note Lists note, if any, entered by the Servicer.

Site Name Name of Application Request's selected deployment sites. Only available for Application
Requests based on a Deployment Template.

Application Search Page


The Application Search page, which opens when you perform an Application Request search from the Servicer
Home page, has two views:

• Search Criteria View

• Search Results View

434 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Search Criteria View


On the Application Search page, enter the following search criteria:

Table 8-8 • Application Search Page / Search Criteria View Options

Option Description

Application Family [Customers Only] Select an Application Family to restrict your search to Application
Requests belonging to that Application Family.

Application Name Enter the name or part of the name of the Application Request you are searching for. If
you enter a word or part of a word, Workflow Manager will search for all Application
Requests that include that word or part of a word in the Application Name. If you enter
more than one word or word fragment, Workflow Manager will find only those
Application Requests that include that exact text in that order.

Metadata Text Enter the text you want to search for in the Data Elements (data entry fields) that were
entered either upon submission of an Application Request or as part of a Workflow
Phase. If you enter a word or part of a word, Workflow Manager will search for all
Application Requests that have data entries that include that word or part of a word. If
you enter more than one word or word fragment, Workflow Manager will find only those
Application Requests that have data entries that include that exact text in that order.

Issue or Message Enter the text you want to search for in any of the Issues or Messages associated with
Text Application Requests. If you enter a word or part of a word, Workflow Manager will
search for all Application Requests that have Issues or Messages that include that word
or part of a word. If you enter more than one word or word fragment, Workflow
Manager will find only those Application Requests that have Issues or Messages that
include that exact text in that order.

AR Number Enter the numeric portion of the AR Number to restrict your search to the Application
Request matching that number. The Application Request Prefix is not included in the
search, and only exact numeric matches are found. For example, if you enter 12, only
one Application Request will be found: AR 12; Application Request with numbers of AR
120 or AR 1235 are not found.

Note • Application Requests for one Service Company are assigned sequential numbers in the
order they were created. Creating a new Project that uses a different Application Request Prefix
does not reset the sequence number to zero, so entering just the numeric portion of the AR
Number will not return duplicate entries, such as AR 103 and HO 103. Only one Application
Request for that Service Company will have the AR Number of 103.

Created After Enter a date to restrict your search to Application Requests created after that date.

Created Before Enter a date to restrict your search to Application Requests created before that date.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 435


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-8 • Application Search Page / Search Criteria View Options (cont.)

Option Description

Project Select a Project from the list to narrow your Application Request search to only that
Project.

Application Status [Servicer Only] Select to restrict your search to a specific Application Status, such as
Active or Inactive.

Search Click to initiate the search. Search results are displayed in the Search Results View of
the Application Search Page. (For Servicers, the results page is titled Search Results).

Search Results View


When you click Search on the Application Search page, the search results page appears, providing a list of
Application Requests that met the search criteria you entered. Select an Application Request to open its
Application Progress Page (Servicer) or Application Progress Page (Customer).

Table 8-9 • Application Search Page / Search Results View Options

Option Description

Application Name of Application Request meeting your search criteria. Select an Application Request
Name to open its Application Progress (Servicer) page or Application Progress
(Customer) page.

Project Name Name of the Project that this Application Request is associated with.

Status Identifies this Application Request's Application Status, such as Active or Inactive.

AR Number Number which uniquely identifies this Application Request.

Submitted Date Application Request was submitted.

For Company Name of company that submitted this Application Request.

Workflow Status Identifies the workflow status of the Application Request as being in one of the following
statuses:

• Application Complete
• Deployment Complete
• Data Entry Phase
• Last Phase
• Merging Workflow Steps
• Work Phase

Workflow Phase Active Workflow Phase of this Application Request.

436 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-9 • Application Search Page / Search Results View Options (cont.)

Option Description

Assigned Identifies whether someone has been assigned to one of the Roles associated with this
Application Request.

Status Notes Lists note, if any, entered by the Servicer. Notes can be added:

• On the Edit Status Comment dialog box, which is opened by clicking Edit Status
Comment on the Application Progress page.
• In the Comment text box on the Properties tab of the Application Progress page.

Site Name Name of Application Request's selected deployment sites. Only available for Application
Requests based on a Deployment Template.

All Projects Page


The All Projects page opens when a Customer or Servicer clicks View Project List on the Actions menu of the
Home page. Servicers see a list of the Projects for all of their Customers, and Customers see all of their company’s
Projects.

Table 8-10 • All Projects Page Options

Option Description

View Click this link to access the Assignments Page where you will, depending upon your
Assignments assigned Roles, see either a listing of all of the Application Requests that you are currently
assigned to that have Phases which are in progress, or a listing of who is assigned to all
Application Requests.

Project Name Name assigned to the project.

Total Total number of applications associated with the project.


Applications

In Entry Number of applications associated with this Project that are in a Workflow Phase defined
as Data Entry Phase type.

In Progress Number of applications associated with this Project that are in a Workflow Phase defined
as Work Phase type.

In Acceptance Number of applications associated with this Project that are in a Workflow Phase defined
as Customer Acceptance Phase type.

In Final Number of applications associated with this Project that are in a Workflow Phase defined
as Last Phase type.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 437


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-10 • All Projects Page Options (cont.)

Option Description

Completed Number of applications associated with this Project that are completed.

Start Date Date the Application Request for this Project was submitted.

End Date Date this Project was completed.

Customer Name The Customer Company associated with this project.

Assignments Page
The Assignments page, which can be accessed by clicking the View Assignments link on the All Projects page,
provides a listing of all of the Application Requests you are currently assigned to that have Phases which are in
progress. Select an Application Request to open its Application Progress page.

Table 8-11 • Assignments Page

Option Description

Role Name Name of the role associated with your assignment to this in-progress application phase.
For example, if you are a member of both the Packager and QA Tester roles, you could
be assigned to one application as a Packager and another application as a QA Tester.

Application Name Name of Application Request. To open the Application Progress Page for this
Application Request, click Select.

Workflow Phase Name of the active Workflow Phase.

Workflow Step Name of the active Workflow Step.

Status Status of the Workflow Phase, which can be one of the following:

• Data Entry Phase—Phase containing the data collection step that is required
when submitting an Application Request.
• Work Phase—Standard phase that has no restrictions.
• Customer Acceptance Phase—Phase that requires Customer approval to be
completed.
• Last Phase—Phase including administrative tasks after Customer project has
been completed.
• AdminStudio Workflow—Phase is performed in its entirety as an AdminStudio
Project.

438 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Project Summary Page


The Project Summary page, which is opened by selecting a Project on the All Projects page, displays a list of all
of the Application Requests associated with a Project. The Project Summary page differs for Servicers and
Customers:

Servicers
The Project Summary page includes the following options and information:

Table 8-12 • Project Summary Page Options

Option Description

View Policy Click to open the Policy Documents Page for this Project, where all of this Project's
Documents associated Policy Documents are listed.

View Project Click to open the Projects Report.


Report

Submit an Click to access the Submit Application Request Page, where you can create a new
Application Application Request associated with this Project. Select an Application Request to open
Request its Application Progress Page.

AR Number Number which uniquely identifies the Application Request.

Application Name Name of Application Request.

Template Template assigned to the Project that this Application Request is associated with.

Total Issues & Number of total issues associated with this application and number of issues that have
Unread Issues not yet been read.

An issue is only marked as being "read" when someone other than the issue creator
opens it.

Upload Date Date application was uploaded to Workflow Manager.

Due Date Date when this Application Request is scheduled to be completed.

Workflow Phase Active Workflow Phase of this Application Request.

Application Family Application Family assigned to this application by the person who submitted the
Application Request.

Customers
This page is accessed by selecting a Project on the All Projects page.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 439


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Status Tab
The Status tab includes the following options and information:

Table 8-13 • Customer Project Summary Page / Status Tab

Option Description

AR Number Number uniquely identifying this Application Request.

Application Name Lists the applications that are associated with this project. Select an application to
view its Application Progress Page.

Template Template assigned to the Project that this Application Request is associated with.

Total Issues and Number of total issues associated with this Project and number of messages that
Unread Issues have not yet been read.

Upload Date Date application was uploaded to Workflow Manager.

Due Date Date when this application migration project is scheduled to be completed.

Workflow Phase Current Workflow Phase of the application.

Application Family Application Family assigned to this application by the person who submitted the
Application Request. .

Project Information Tab


The Project Information tab includes the following options and information:

Table 8-14 • Customer Project Summary Page / Project Information Tab

Option Description

Contact Information Name, phone number and email address for the Customer and Servicer associated
with this Project.

Policy Documents List of Policy Documents associated with this Project. A Policy Document is a file
that you upload to associate it with a Project, making it centrally available to all
people involved, such as a contract, company procedures for packaging
applications, software distribution procedures, etc.

440 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

View Policy Documents Page


A Policy Document is a file that you upload to associate it with a Project, making it centrally available to all people
involved, such as a contract, company procedures for packaging applications, software distribution procedures,
etc.

The View Policy Documents page, which opens when you click View Policy Documents on the Servicer
Application Progress page or the Project Summary page, lists all of this project’s associated Policy
Documents. Click on a Policy Document to view it.

To add a Policy Document to a Project, click Add/Edit Policy Documents for this Project on the Project
Details View.

Application Progress Page (Customer)


The Application Progress page (Customer) includes the following tabs:

• Data Entry Tab

• Workflow Tab

• Issues Tab

• Uploaded Files Tab

• Downloadable Files Tab

The Customer Application Progress page allows you to view data entry, workflow, issues, and associated file
information for the selected Application Request. This page includes the following navigation links:

Table 8-15 • Customer Application Progress Page Options

Option Description

View Application Click to view the Application Report for this Application Request.
Report

Create a New Click to open the Submit Application Request Page and create a new Application
Application Request Request.

Copy an Application Click to Copy an existing Application Request. You can then modify the data
Request fields, selections, and uploaded files, and then submit it, rather than re-entering all of
the requested data.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 441


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Data Entry Tab


The Data Entry tab allows you to view all of the data entry fields that are displayed when an Application Request is
submitted or during the Workflow. The names of the Data Groups associated with the application are displayed
under the application name with a number following it in the format of (n/r), where:

n = number of data entry fields completed


r = number of data entry fields that are required

For example, (2/3) means that the Data Group contains three required data entry fields, but only two have been
answered, and (4/4) means that all four required data entry fields have been completed. These data entry fields are
enabled (editable) only when an application is in a Data Entry phase:

• If an application is in a Data Entry phase—You can use the Next button to scroll through the data entry
fields and enter the requested data. When all required fields are complete, the Submit AR button appears.
Click Submit AR to submit the Application Request or to indicate that the Data Entry phase is complete.

• If an application is in Work phase—You can use the Next button to scroll through the data entry fields, but
you cannot make any edits. This data is locked, and a padlock icon appears over the application name:

Copy an Application Request Page


If you want to create a new Application Request that is very similar to an existing Application Request, you can
copy it and then modify it, rather than re-entering all of the requested data. Servicers can also choose whether to
copy the Application Request's current Workflow state (the data items and state of each Workflow Step), and
whether to link the copy to the original Application Request. (For Customers, the copy of the Application Request is
automatically linked with the source Application Request.)

This page is accessed by a Customer by selecting Copy an Application Request on the Application Progress
page, and by the Servicer by clicking Copy on the Properties Tab of the Application Progress page.

The following fields are included:

Table 8-16 • Copy an Application Request Page Options

Option Description

Company Name (Servicer Only) Name of company that submitted this Application Request.

Application Name Enter a unique name to identify the new Application Request

Copy the Workflow (Servicer Only) Select this option if you want to copy the data items and state of
Progress State each Workflow Step from the source Application Request to the new Application
Request. If this option is not checked, Workflow Manager only copies the initial
data entry step, and the Application Request is not automatically submitted.

442 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-16 • Copy an Application Request Page Options (cont.)

Option Description

Link with source (Servicer Only) Select this option if you want to link the copy to the original
Application Request Application Request. Linked Application Requests are listed on the Related
Applications Tab.

Copy Click to create the copy of the Application Request.

Workflow Tab
The Workflow tab lists all of the phases defined in the template that this Application Request was based upon.

Table 8-17 • Workflow Tab Example

• Each gray box represents a Workflow Phase.


• Each check box represents a Workflow Step.
When a Workflow Step is complete, a check
appears in the check box.
• When a Workflow Phase is not complete, the
phase name appears in a white box, one or
more of the Workflow Steps are not checked,
and the percentage complete is less than
100%.
• When a Workflow Phase is complete, the
Workflow Phase name appears reversed out in
a green band, all of the check boxes are
marked complete, and the message 100%
complete appears.

Data Entry Workflow Steps


The first step of the first Workflow Phase is always a data entry step, but data entry steps can also appear later in
the workflow. Data entry Workflow Steps that are not complete are indicated as a check box with a red arrow, and
the name of the step is underlined, indicating that it is linked to the Data Entry tab:

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 443


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Application Progress Page (Servicer)


The Servicer Application Progress page allows you to view workflow progress, application properties, related
applications, deployment progress, issues, and associated file information for the selected application on the
following tabs:

• Application Progress Tab

• Properties Tab

• Related Applications Tab

• Deployment Progress Tab

• Issues Tab

• Uploaded Files Tab

• Downloadable Files Tab

The Application Progress page (Servicer) includes the following navigation links and buttons:

Table 8-18 • Application Progress Page (Servicer) / Template Properties View

Option Description

View Policy Click to open the Policy Documents page for this Application Request.
Documents

View Application Click to open the Application Report for this Application Request.
Report

View Assignments Click to open the Assignments page for this Application Request.

Edit Status Comment Click to open the Edit Status Comment dialog box and enter text that will appear in
the Comment text box on the Properties tab of the Application Progress page.

Stop Clock Click to stop (or restart) the monitoring of time for the current Workflow Step. If work
on an Application Request has been interrupted, you could stop the SLA clock to
Start Clock
prevent that Application Request from inaccurately being listed in SLA reports as At
Risk or Late.

When the Stop Clock button is clicked, its name changes to Start Clock, and the
date and time that the clock was stopped is listed. Click the Start Clock button to
restart the monitoring of time.

444 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Application Progress Tab


The Application Progress tab lists all of the phases defined in the template that this Application Request was based
upon.

Table 8-19 • Workflow Tab Example

• Each gray box represents a Workflow Phase.


• Each check box represents a Workflow Step. When a
Workflow Step is complete, a check appears in the
check box.
• When a Workflow Phase is not complete, the phase
name appears in a white box, one or more of the
Workflow Steps are not checked, and the percentage
complete is less than 100%.
• When a Workflow Phase is complete, the Workflow
Phase name appears reversed out in a green band, all
of the check boxes are marked complete, and the
message 100% complete appears.

Data Entry Workflow Steps


The first step of the first Workflow Phase is always a data entry step, but data entry steps can also appear later in
the workflow. Data entry Workflow Steps that are not complete or have not yet been accepted are indicated as a
check box with a red arrow, and the name of the step is underlined, indicating that it is linked to a data entry page:

The data entry page allows you to view all of the data entry fields that are displayed when an Application Request is
submitted or during the Workflow. The names of the Data Groups associated with the application are displayed
under the application name with a number following it in the format of (n/r), where:

n = number of data entry fields completed


r = number of data entry fields that are required

For example, (2/3) means that the Data Group contains three required data entry fields, but only two have been
answered, and (4/4) means that all four required data entry fields have been completed.

• If all of the required fields have not been completed—You can use the Next button to scroll through the
data entry fields and make entries. As soon as you complete all required data entry fields, the Submit AR
button appears. Click this button to submit the Application Request.

• If the required fields have been completed, but the data has not yet been accepted—If all required
fields have been completed and the Application Request has been submitted, you can use the Next button to
scroll through the data entry fields, but you cannot make any edits to the data, and you are prompted to
Accept or Reject it. A padlock icon appears above the Application name:

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 445


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

If the data is filled in completely and correctly, click Accept Data; if the data is not filled out correctly, click
Reject Data. When you click Accept Data, you are marking that step complete, and work on the next
Workflow Step can begin.

• If the data has already been accepted—You can use the Next button to scroll through the data entry
fields, but the Accept Data and Reject Data buttons do not appear.

Properties Tab
On the Properties tab of the Application Progress page, you can review Application Request information, edit
specific properties, and you can choose to copy or delete the Application Request.

Table 8-20 • Application Progress Page (Servicer) / Properties Tab

Option Description

Application Name Name that identifies the Application Request.

AR Number (Read Only) Number generated by Workflow Manager to uniquely identify the
Application Request.

Folder Location Link to the directory on the Workflow Manager server where this Application
Request's data is stored.

Company Name (Read Only) Name of the Company that submitted this Application Request.

Project Name (Read Only) Name of Project that this Application Request is associated with. Click
this link to open the Project Summary Page for this Project.

Status Summary (Read Only) Identifies the active Workflow Phase of this Application Request as
being in one of the following four statuses:

• Data Entry
• Work Phase
• Migration Completed
• Deployment Completed

Application Due Date (Read Only) Date that this Application Request should be completed in order to
meet the SLA requirements of this Project.

This date is calculated by adding the number of business days in the Application
Due Period field to the date that this Application Request was submitted.

Note • If you edit the number in the Application Due Period field on this tab and click
Update, the Application Due Date will be updated to reflect the change.

Application End Date Actual date that the Application Request was completed.

446 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-20 • Application Progress Page (Servicer) / Properties Tab (cont.)

Option Description

Application Family User-definable Application Request designation that you can use to filter searches
and listings in various views, and can be included in reports.

Click Create New to open the Create Application Family Dialog Box where you
can create additional Application Families.

Status Select the Application Status that you want to assign to the Application Request.

• Application Status is a user-configurable field used to assign metadata to an


Application Request. This metadata can be used when performing searches
and generating reports.
• By default, Workflow Manager is installed with two statuses: Active and
Inactive.
• The Workflow Manager Administrator can create a new Application Status, and
assign it either an Active or Inactive state.
• If an Application Request’s Status is set to either the default Inactive status or
a user-defined status that is assigned the Inactive state, it will not be included
in reports or searches.

Associated Package Click the Change button to associate this Application Request to a package in the
AdminStudio Enterprise Server Application Catalog database.

When you click Change, the Select Package page opens, listing all of the
packages in the Enterprise Server Application Catalog. Select a package in the
package tree and click Select Package.

• Click the name of the associated package to view its Package Report.
• Click Clear to remove the association with this package.

Note • You can also associate a package with an Application Request from the AdminStudio
Application Manager interface.

Exclude Weekends? (Read Only) When calculating an Application Request’s at risk date and due date
(using the values in the Application Due Period and Application at Risk Period
fields), this field indicates whether Saturdays and Sundays are being counted as
business days.

The value of this field is set at the Project level.

Application Due Number of days after its submission date that this Application Request should be
Period completed (in order to be in SLA compliance).

The value of this field is initially set at the Project level, but can be edited here.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 447


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-20 • Application Progress Page (Servicer) / Properties Tab (cont.)

Option Description

Application at Risk Number of days after its submission date that this Application Request will be
Period considered At Risk of not meeting its due date.

When an Application Request is At Risk, it is noted in Application Request and


Projects reports, and an “at risk” notification email is sent out if the Send Emails
at Application Risk option is selected.

The value of this field is set is initially set at the Project level, but can be edited
here.

Send Emails at When “at risk” Application Requests are identified, select whether to send out an
Application Risk email notification of this by selecting Yes or No.

Comment You can document this Application Request by writing comments in this box.

Comments entered on the Edit Status Comment dialog box are also displayed
here. You open the Edit Status Comment dialog box by clicking Edit Status
Comment in the Quick Links menu on the Application Progress page.

Copy Click to copy this Application Request. See Copying an Existing Application
Request.

Update Click to save your edits to this Application Request’s properties.

Delete Click to delete this Application Request.

Related Applications Tab


The Related Applications Tab lists all Application Requests that have been related to this Application Request, and
allows you to link additional Application Requests or remove links. By linking related Application Requests to each
other, you can track related applications by easily navigating to the Application Progress page of these related
applications, performing searches, and producing reports that use this information.

The Application Request listing includes standard Application Request information. You can select an Application
Request to open its Application Progress page. Application linking is bidirectional, meaning that if you related one
Application Request to another, an entry is added to the Related Applications tab of both Application Requests.

• Click Add Related Applications to open the Add Related Applications View.

• Select Application Requests and click Delete Application Links to remove the linkage to another Application
Request.

448 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Add Related Applications Dialog Box

The Add Related Application dialog box, which is accessed by clicking Add Related Applications on the
Related Applications Tab, lists all Application Requests and enables you to select those Application Requests
that you want to link to the current Application Request.

Select the Application Requests that you want to link to the current Application Request and click Add. The
selected Application Requests would then be listed on the current Application Request's Related Applications
tab.

Note • You can use the Search for feature or the list filtering features to quickly find the Application Requests that
you want to select. See Filtering a List for more information.

Deployment Progress Tab


Each time a template is created, it is defined as being one of the following types:

• Application workflow—An ordered series of steps that a Service Company follows to prepare an application
for deployment on end user computers.

• Deployment workflow—Used to deploy a prepared application on end user computers.

If the Application workflow associated with this Application Request is complete, this tab will display the
Deployment workflow.

If the Application workflow associated with this Application Request is not complete, a message will appear on
this tab.

Note • You can view the Deployment workflow for this application only after the Application workflow is
complete.

Application Report
An Application Report contains detailed information about an Application Request’s progress, including Workflow
history and SLA status.

• Opening an Application Report

• Information Included in an Application Report

• Saving an Application Report

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 449


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Opening an Application Report


To open an Application Report, perform the following steps.

Task: To open an Application Report:

1. Open an Application Request’s Application Progress page, as described in Opening an Application


Request’s Application Progress Page.

2. Click View Application Report in the Quick Links menu. The Application Report opens in a new browser
window.

3. Click the plus signs to display the content of each section: Workflow Phase Summary, Workflow Steps
Summary, Application Metadata, Workflow History, and Issues.

450 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Information Included in an Application Report


The Application Report includes the following information:

Table 8-21 • Application Report Information

Option Description

General Information This area of the report lists the following information:

• Customer—Name of Customer Company that submitted this Application


Request.
• Project Name—Name identifying the Project.
• Project ID—Number to uniquely identify the Project.
• Application—Name of Application Request.
• Iteration Count—Number of times this Application Request's workflow has
been rolled back, causing Workflow Steps to be performed an additional time.
• Start Date—Date this Application Request was submitted.
• Due Date—Date that this Application Request needs to be completed in order
to be in SLA compliance.
• Risk Date—Date that this Application Request’s status will change to At Risk of
not meeting its SLA due date.
• End Date—Date Application Request was actually completed.
• Elapsed Time—Elapsed SLA time from the time the Application Request was
submitted until it was completed. The elapsed time value takes into
consideration the Length of a Work Day that was specified for this Project,
whether weekend days or any holidays were excluded from SLA calculations,
and if the SLA clock was stopped.
• User Entered Time—Total time entered by users on the Step Validation dialog
box when completing Workflow Steps.
• SLA Time—Total elapsed SLA time of a completed Application Request.
• Application Status Summary—Phase type of the of current Workflow Phase.
• SLA Compliance—Status of Application Request as one of the following: On
Time, At Risk, Late, Completed On Time, Completed Late.
• Business Hours Per Day—Number of hours of work per day used in SLA
calculations.

Workflow Phase Lists the percentage complete for each Phase in this Workflow. It also includes the
Summary Start Date, End Date, Elapsed Time, SLA Time, and User Entered Time for each
Workflow Phase.

Workflow Steps Lists the End Date, Elapsed Time, SLA Time, and User Entered Time for each
Summary Workflow Step in this Application Request.

Application Lists names of all of the Data Elements that were defined for this Workflow, and the
Metadata value that was entered for each Data Element.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 451


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-21 • Application Report Information (cont.)

Option Description

Workflow History Lists the activities that have occurred for each Phase of this Workflow. An entry is
added each time a data collection step is submitted and when a Workflow Step is
completed. Also Rollback information is listed in additional tables.

Also, if the value of a Data Element was changed, both the old and new values are
listed.

Note • For a more detailed look at the activities that occur during the progression of an
Application Request, see Creating an Activity Report

Issues Lists a summary of the number of issues submitted for this Application Request and
whether those issues are open or closed. Also lists detailed information on all of this
Application Request's issues.

Save Click to save this report in MHT format.

Expand All Click to open all of the hidden sections of this report.

Print Click to print this report.

Close Click to close this report window.

Saving an Application Report


To save an Application Report in .mht format, perform the following steps.

Task: To save an Application Report:

1. On an Application Report, click the Save button. The Save Webpage dialog box opens.

2. Enter a name and location for the report and click OK.

Troubleshooting Browser Support of Saving Application Reports


Sometimes the ActiveX controls on a browser will prevent you from saving an Application Report, and the following
message will be displayed:

Internet Explorer has blocked this site from using an ActiveX control in an unsafe manner.
As a result, this page may not display correctly.

If you receive this error message, perform the following steps to adjust your browser’s ActiveX settings:

452 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Task: To adjust ActiveX browser settings:

1. In Internet Explorer, select Internet Options on the Tools menu. The Internet Options dialog box opens.

2. Open the Security tab.

3. In the Select a web content zone area, select Local intranet.

4. In the Security level for this zone area, click Custom Level. The Security Settings dialog box opens.

5. Scroll down to the section named Initialize and script ActiveX controls not marked as safe, and select
Prompt.

6. Click OK to close the Security Settings dialog box and click OK to confirm the change.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 453


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

7. Click OK to close the Internet Options dialog box.

8. Quit Internet Explorer and restart it.

9. Login to Workflow Manager. You will now be permitted to save an Application Report using the Save button.

Application Progress Page (Shared)


The following tabs of the Application Progress page are used by both Servicers and Customers:

• Issues Tab

• Uploaded Files Tab

• Downloadable Files Tab

Issues Tab
The Issues tab includes the following views:

• Issue List

• Issue Details View: Existing Issue

• Issue Details View: New Issue

Issue List
The Issues tab lists all issues associated with the selected application. Click an issue to display the Issue Details
View, where you can view, respond, or close that issue. For each issue, the following information is provided. To
sort this list, click on one of the column headings.

Table 8-22 • Application Progress Page / Issues Tab / Issue List

Option Description

Issue Abstract Short description of issue that was entered by the person who created the issue.

View/Respond Click to open the Issue Details view for the issue.

Attach File Click to access the File Upload Dialog Box, where you can upload a file to attach to
this issue. The Uploaded File field of this listing lists the name of the most recently
uploaded file associated with this issue. You can upload multiple files for an issue, but
only the most recently uploaded file is listed in this column. To see a list of all uploaded
files for this issue, click the Uploaded Files Tab.

454 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-22 • Application Progress Page / Issues Tab / Issue List (cont.)

Option Description

Issue Type Identifies the issue as one of the following types:

• Knowledge Base—Issue is posted on the Issues tab.


• Email—Issue is posted on the Issues tab and a notification email is sent out to the
users assigned to the Roles identified on the Project Details View.
• Critical—All work is stopped on this Application Request (the workflow is read-
only), and this issue must be closed before work can continue.

Issue Date Date issue was created.

Created By User Name of person who created the message.

Owner User assigned to this issue.

Issue Due Date Due date that was assigned to this issue when it was created.

Issue Message Issue content.


Text

Issue Status Indicates whether this issue is New (has not been responded to), Responded (issue
has been responded to), or Closed.

Uploaded File Lists the name of the most recently uploaded file associated with this issue. Click this
name to open or download the file.

• You can upload multiple files for an issue, but only the most recently uploaded file
is listed in this column.
• To see a list of all uploaded files for this issue, click the Uploaded Files Tab.
• To download any other files attached to this issue, click the Uploaded Files Tab.

File Name Name of most recently uploaded file.

New Button Click to create a new issue in the Issue Details View.

Refresh Button Click to refresh the Issue List with the most recent information.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 455


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Issue Details View: Existing Issue


When you click View/Respond for an existing issue, the Issue Details view appears below the list, where you
can view and respond to an issue (if it is not already Closed):

Table 8-23 • Application Progress Page / Issues Tab /Issue Details View / Existing Issue

Option Description

Issue Abstract Short description of issue that was entered by the person who created the issue.

Application Name Name of application associated with the issue.

Issue Type Indicates the type of issue, such as Email, Knowledge Base, or Critical.

Issue Date Date issue was created.

Issue Due Date Due date assigned to this issue when it was created.

Owner Name of the user assigned to this issue.

Created By User Name of person who created the message.

Status Indicates whether this issue is New (has not been responded to), Responded (issue has
been responded to), or Closed.

Issue Message Issue content.


Text

Respond Button To respond to the message you are viewing, click Respond. A Response text box
appears, where you can type in the text of your response. When you have finished, click
Submit to post your response. As soon as the screen is refreshed, this response will
appear in the Issue List. (Does not appear if you are viewing an issue with a Status of
Closed.)

Close Issue Click to change the status of this issue to Closed.


Button

Issue Details View: New Issue


When you click New, the Issue Details view appears below the list, where you create a new issue:

Table 8-24 • Application Progress Page / Issues Tab / Issue Details View / New Issue

Option Description

Enter the issue Enter a short abstract of the issue to identify this issue in listings.
abstract

Issue text box Enter the text of this issue.

456 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-24 • Application Progress Page / Issues Tab / Issue Details View / New Issue (cont.)

Option Description

Issue Type Specify one of the following issue types:

Knowledge Base—Select if you want to post this issue on the Issues tab but do not
want to send a notification email to anyone.

• A Knowledge Base issue is used to share information between several users in a


discussion board forum.
• Other users must open the Issues tab to read it.
• Each time someone responds to an issue, their response is listed below the
original issue on the Issues tab.

Email—Select Email if you want to send a notification email to all users with
permission on this Project.

• You use the Email type for issues that you do not consider critical, but which
require that people associated with this project be notified.
• When you create an Email issue, the issue is posted on the Issues tab and a
notification email is sent to all users who are members of Roles that are selected
in the Issue Submitted column of the Project Permission and Notification
Settings View for this Application Request’s associated Project.

Critical—Select Critical if you want to stop all work on this Application Request until
the issue is resolved.

• Only users who have edit permission for a Workflow Step will be able to create a
Critical issue for that Step.
• Whenever an Application Request has an open Critical issue, its workflow
becomes read only until the issue is resolved. The following note appears at the
top of the Issues tab:
Open Critical issue present in Application.

Also, the following note appears at the top of the Application Progress tab:

The workflow is READ-ONLY because of Critical issues.

• Each time a person opens the Issues tab of an Application Request that has an
open Critical issue, the Issue Details view of the Critical issue is opened.
• Before any steps can be performed on this Application Request, a user with edit
permission on this Workflow Step must close the issue.
• The amount of time it takes to close a Critical issue is tracked and is listed on the
Application Report.

Note • Users assigned to Roles with appropriate permissions can edit the names of the three
types of Issues (Email, Critical, Knowledge Base), but cannot create any additional issue
types.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 457


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-24 • Application Progress Page / Issues Tab / Issue Details View / New Issue (cont.)

Option Description

Issue Due Date To assign a due date to this issue, click the calendar icon and select a date.

Owner [Servicer Only] To assign a user to this issue, click the Assign User button to open
the Select User dialog box. Select a user as described in Searching User/Group
Listings in Workflow Manager.

Create Button Click to create the issue. The issue is then listed on the Issues tab.

Uploaded Files Tab


The Uploaded Files tab lists files that have been uploaded to Workflow Manager during the submission of an
Application Request, when completing a Workflow Step that collects a Data Element with a Data Type of Document
Upload, Application Upload, or Dependency Upload, or in association with an issue. Click the link to download and
view a file.

The following information is provided for each file:

Table 8-25 • Application Progress Page / Uploaded Files Tab

Option Description

Client File Path Location of uploaded file.

Server File Name Name of uploaded file.

Upload Date Date and time file was uploaded.

File Size Size of file.

File Status Lists the status of the file as one of the following:

• Uploaded—File is uploaded internally.


• External—Link to an external file.
• Deleted—File was uploaded internally but has been deleted.

File Type Identifies the type of file as one of the following:

• Issue Uploaded File—File is uploaded internally as an attachment to an Issue


• APP—Application
• DEP—Dependency file
• DOC—Miscellaneous uploaded file, such as a word processing file, a JPG, an
spreadsheet, etc.

458 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Downloadable Files Tab


The Downloadable Files tab lists files that Servicers have moved to the Workflow Manager Downloadable Files
Directory in one of two ways:

• When completing a Workflow Step that collects a Data Element with a Data Type of Downloadable File Upload.

• By copying a file directly to the Workflow Manager Downloadable Files Directory, which can be opened by
clicking the downloadable files location link.

You can download any of these files by clicking the link in the Download column.

The following information is provided for each file:

Table 8-26 • Application Progress Page / Downloadable Files Tab

Option Description

Client File Path Location of file.

Server File Name Name of file.

Upload Date Date and time file was uploaded.

File Size Size of file.

Application Request Notifications Override Page


On the Application Request Notifications Override page, which is opened by clicking Override
Notifications in the Quick Links menu of the Application Progress page, you can view the email notification
subscriptions that the Application Request inherited from its Project, and you can choose to override those
subscriptions by either adding or deleting subscriptions.

This page lists all of this Application Request’s email notification subscriptions, including those that were assigned
via Role(s) or Group(s) and those assigned explicitly. This purpose of this page is to enable an Administrator to
tweek the email notifications for a particular Application Request.

Figure 8-1: Note that if an individual wanted to add or delete his own subscription to this Application Request, he
would make those changes on the My Default Project Notifications and the My Application Notifications
pages rather than on this page.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 459


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Figure 8-2: Application Request Notifications Override Page / Initial View

When you initially open this page, the default email notification settings that were inherited from the Application
Request’s Project are displayed.

If you want to override these default settings, click the Override Project Notifications button. The name of the
Application Request is selected and the root level email notification settings are instantly enabled. To override an
email notification setting on a Workflow Phase or Step, select the Phase or Step and then click the lock icon to
unlock that element.

To reset the email notification settings back to those it inherited from the Project, click the Inherit Project
Notifications button.

Issues List Page


Issues are entered by Servicers and Customers to communicate with each other about application activity. This
page, which appears when you click View Issues in the Actions menu of the Home page, lists all application
issues. For each issue, the following information is provided. To sort this list, click on one of the column headings.

Table 8-27 • Issues List Page Options

Option Description

Issue Abstract Title of the issue.

View/Respond Click to view or respond to the issue.

460 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-27 • Issues List Page Options (cont.)

Option Description

Attach File Click to attach a file to the issue.

Application Name Name of application associated with the issue.

Issue Type Identifies the issue type as being either Email, Knowledge Base, or Critical.

Issue Date Date issue was created.

Created By User Name of person who created the message.

Issue Message Text First few words of the issue.

Issue Status Indicates the status of the Issue: New, Responded, or Closed.

Uploaded Files Click to view an uploaded file.

Submit Application Request Page


This dialog box appears when:

• A Servicer clicks the Submit Application Request link on the Actions menu of the Home page or on the
Project Summary Page.

• Customer clicks the Create a New Application Request link in the navigation bar of many Workflow
Manager pages.

The Submit Application Request page includes the following options:

Table 8-28 • Submit Application Request Page Options

Option Description

Project Select the Project that you want to submit an Application Request for.

For Servicers, the Project that was open on the Project Summary Page is selected by
default, but you can change this selection.

Application Name Enter a name to uniquely identify this Application Request.

Application Select the Application Family that this application will belong to, or click Create New
Family to create a new Application Family.

Note • See Application Families for more information.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 461


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-28 • Submit Application Request Page Options (cont.)

Option Description

Create New Click to access the Create Application Family Dialog Box, where you can create a new
Application Family.

Note • If the Service Company associated with this Project was created with the Is an Application
Family Owner? option selected, this button will only appear when a Servicer is submitting an
Application Request; if the option was not selected, this link will appear for both Servicers and
Customers.

Available Sites [For Projects associated with Deployment Templates only] Select the deployment sites at
your company where you want this application deployed. To select all deployment sites,
click Select All. To unselect all sites, click Clear All

Create a New [Customer only] Click to submit your Application Request.


Application
Request

Submit [Servicer only] Click to submit your Application Request.

Copy an Application Request Page


If you want to create a new Application Request that is very similar to an existing Application Request, you can
copy it and then modify it, rather than re-entering all of the requested data.

Servicers can also choose whether to copy the Application Request’s current Workflow state (the data items and
state of each Workflow Step), and whether to link the copy to the original Application Request. (For Customers, the
copy of the Application Request is automatically linked with the source Application Request.)

This page is accessed by a Customer by selecting Copy an Application Request on the Application Progress
Page (Customer), and by the Servicer by clicking Copy on the Properties Tab of the Application Progress Page
(Servicer).

The following options and information are included:

Table 8-29 • Copy an Application Request Options

Option Description

Company Name (Servicer Only) Name of company that submitted this Application Request.

Application Name Enter a unique name to identify the new Application Request

462 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-29 • Copy an Application Request Options

Option Description

Copy the Workflow (Servicer Only) Select this option if you want to copy the data items and state of
Progress State each Workflow Step from the source Application Request to the new Application
Request. If this option is not checked, Workflow Manager only copies the initial
data entry step, and the Application Request is not automatically submitted.

Link with source (Servicer Only) Select this option if you want to link the copy to the original
Application Request Application Request. Linked Application Requests are listed on the Related
Applications Tab.

Copy Click to create the copy of the Application Request.

Work Assignment Listing Page


This Work Assignment Listing page, which is opened by clicking Assign Work in the Actions menu on the
Workflow Manager Home page, lists all of the Application Requests for all of the Projects at your company,
including those Application Requests that are unassigned. From this page, you can open an Application Request’s
Assignment Details page and assign a user to each Role that has permission to perform tasks on the Application
Request.

Table 8-30 • Work Assignment Listing Page Options

Option Description

Filter Assignments Choose to filter this list of Application Requests by one of the following criteria to
List restrict the list to:

• Hide Completed Applications—List only those Application Requests that are


still in progress.
• Data Entry Phase—List only those that are currently in the initial data
collection step that is required when submitting an Application Request.
• Work Phase—List only Application Requests that are in a standard work
phase (a phase with no restrictions).
• Customer Acceptance Phase—List only Application Requests that require
Customer approval to be completed.
• Last Phase—List only Application Requests that include administrative tasks
after the Customer project has been completed.
• Application Complete—List only those Application Requests that have been
completed.
• AdminStudio Workflow—List only those Application Requests that are in a
phase that is performed in its entirety as an AdminStudio Project.
• Merging Workflow Steps—Lists only those Application Requests that are in
a phase that implements conditional branching.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 463


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Table 8-30 • Work Assignment Listing Page Options (cont.)

Option Description

Select Click to access the Assignment Details page for this Application Request, where
you can and assign a user to each Role that has permission to perform tasks in the
Application Request.

Application Listing Lists the following information for each Application Request:

• AR Number—Number that uniquely identifies this Application Request.


• Application Name—Name of the Application Request that was entered when
this Application Request was created.
• Status—Indication of the assignment status of that application. Status can be
Yes (all tasks are assigned), Partial (some tasks are assigned), or No (no
tasks are assigned).
• Company Name—Name of company that this application is associated with.
• Project Name—Name of Project that this application is associated with.
• Application Family—Application family that this application belongs to.
• Status Summary— Identifies the type of Workflow Phase: Data Entry Phase,
Work Phase, Customer Acceptance Phase, Last Phase, Application Complete,
AdminStudio Workflow, or Merging Workflow Steps.
• Workflow Phase—Name of active Workflow Phase that this assignment is
associated with.
• Workflow Step—Name of active Workflow Step that this assignment is
associated with
• Upload Date—Date application was uploaded.
• Site Name—For deployment workflows, the site where this Application
Request is being deployed.

View Work Click to open the Working Queue View Page, which lists all of the assignments
Assignments by User that have been made for all Application Requests at your company.

464 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Assignment Details Page


On the Assignment Details page, which is opened by selecting an Application Request on the Work
Assignment Listing page, you can assign a user to each Role that has permission to perform tasks on the
Application Request.

Table 8-31 • Assignment Details Page Options

Option Description

General Information Identifies the Application Request:

• Company—Name of the Customer Company associated with this Application


Request.
• Project—Name of the Project that this Application Request is associated with.
• Application Name—Name of the Application Request.

Current Table listing all of the Roles that have permission to perform tasks on this Application
Assignments Request and the users that have been Assigned To those Roles. If no user has been
assigned to a Role, Not Assigned is displayed in the Assigned To column for that
Role.

Note • If this table is not visible, click the blue arrow to display it.

Company Select the Company that you would like to perform assignments on.

Role Lists all Roles that have permission to perform tasks for this Application Request for
the selected Company.

User Name Select a user by entering a user name in this field or by searching a comprehensive list
containing all Workflow Manager users as well as all of the Directory Services users
that have been imported, as described in Searching User/Group Listings in Workflow
Manager. When you perform a search and generate a list of users, the number of
current assignments each user has is included in the list.

After selecting a user, click Apply. The selected user name is then displayed in the
Assigned To column of the Current Assignments list next to the name of the Role.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 465


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Working Queue View Page


This page, which is accessed by clicking View Work Assignments by User on the Work Assignment Listing
page, lists work assignments grouped by user.

Table 8-32 • Working Queue View Page Options

Option Description

Work Assignment Click to open the Work Assignment Listing Page where you can assign application
Listing tasks to Roles.

Select Click to access the Assignment Details Page for this application, where you can
assign specific users to the Roles associated with this Workflow Step.

Application Lists the following information for Application Requests that are currently in progress:
Request Listing
• Application Name—Name of Application Request.
• Status—Indication of the assignment status of that application. Status can be Yes
(all tasks are assigned), Partial (some tasks are assigned), or No (no tasks are
assigned).
• Company Name—Name of company that this application is associated with.
• Project Name—Name of Project that this application is associated with.
• Application Family—Application family that this Application Request belongs to.
• Status Summary—Status of the Workflow Phase, such as: Data Entry Phase,
Work Phase, Customer Acceptance Phase, Last Phase, or AdminStudio Workflow.
• Workflow Phase—Name of active Workflow Phase that this assignment is
associated with.
• Workflow Step—Name of active Workflow Step that this assignment is associated
with
• Upload Date—Date Application Request was uploaded.
• Site Name—For deployment workflows, the site where this Application Request is
being deployed.
• User Name—Name of assigned user.
• Roles—Roles that the assigned user is a member of.

466 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

My Notifications Pages
Users can be subscribed to receive email notification when any of the following events occur:

Table 8-33 • Event Sources

Project Level Events Workflow Step Level Events

Data Submitted/Rejected Workflow Step Initiated

Issue Submitted Workflow Step Rolled Back

Issue Responded Workflow Step Edited

Application Status Changed Workflow Step Completed

SLA At Risk/Failed

You can view a list of your current email notification event subscriptions, and you can also choose to unsubscribe
from existing events or subscribe to additional events. To do this, click My Notifications in the Actions menu of
the Servicer Home page.

Two email notification views are provided:

Table 8-34 • My Notifications Pages

Page Description

My Default Project Lists the email notification event subscriptions that were assigned to you at the
Notifications Page Project level via Role or Group or User Name.

• How were they assigned?—These notification settings are assigned to a


Project on the Project Permission and Notification Settings view.
• When are they applied?—These notification settings are applied to all of the
Project’s new and existing Application Requests for which subscriptions are not
overridden.

My Application Lists the email notification event subscriptions that were assigned to the current user
Notifications Page via Role or Group or User Name by overriding an Application Request’s Project
defaults.

• How were they assigned?—These notification settings are assigned directly


to an Application Request on the Application Request Notifications
Override page.
• When are they applied?—These notification settings apply to only this
specific Application Request.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 467


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

My Default Project Notifications Page


The My Default Project Notifications page lists the Project email notification events that you have been
subscribed to on a project's Project Permissions and Notification Settings view—both those assigned
indirectly via Role and those assigned explicitly by User or Group.

The subscriptions listed on the My Default Project Notifications page will be applied to all of the Project’s new
and existing Application Requests for which email notification event subscriptions are not overridden.

Figure 8-3: My Default Project Notifications Page

468 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Event Tree
Notification events are grouped by Event. If you expand the Event list, the Source of the subscription and the
name of the Project are displayed:

Figure 8-4: Email Notification Event Tree on the My Default Project Notifications Page

The Source can be either of the following:

• Project Root—Email notification event was assigned at the root level of the project and it was inherited by all
of its child Workflow Phases/Steps.

• Workflow Step Name—If the name of a Workflow Step is the Source, that means that this email notification
event was assigned directly on a Workflow Phase (and inherited by all of its Steps) or directly to one Workflow
Step.

Note • When each new Project is created, it inherits the email notification settings that are defined on the Email
Settings Administration page. See Email Settings Administration Page for more information.

Status Column
A check mark in the status check box indicates that the subscription is in effect. To unsubscribe from that
notification event, clear the check box.

To unsubscribe from an email notification event for an individual Project, clear the check box in the Status column.

Tip • If the Status column is disabled, contact your System Administrator and ask for permission to modify your
notification subscriptions.

My Application Notifications Page


The My Application Notifications page lists the Application Requests for which you have an email notification
event subscription—both those assigned indirectly via Role and those assigned explicitly by User or Group.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 469


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

An Application Request’s email notification subscriptions are inherited from those set on its Project. However,
Administrators can also override these default Project settings for a specific Application Request by making
selections on that Application Request’s Application Request Notifications Override Page.

Figure 8-5: My Application Notifications Page

Filtering This List


To filter this list to display email notification subscriptions for only those Application Requests that you have been
assigned to work on, select All Application Requests with Work Assigned to Me from the list. You can also
select a Project name from the list to display your email notification subscriptions for all Application Requests for a
particular Project.

470 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Application Request Related Pages and Views

Event Tree
Notification events are grouped by Event. If you expand the Event list, the Source of the subscription and the
name of the Application Request are displayed:

Figure 8-6: Email Notification Event Tree on the My Application Notifications Page

The Source can be either of the following:

• Application Root—Email notification event was assigned at the root level of the Application Request and it
was inherited by all of its child Workflow Phases/Steps.

• Workflow Step Name—If the name of a Workflow Step is the Source, that means that this email notification
event was assigned directly on a Workflow Phase (and inherited by all of its Steps) or directly to one Workflow
Step.

Status Column
A check mark in the status check box indicates that the subscription is in effect. To unsubscribe from that
notification event, clear the check box.

To unsubscribe from an email notification event for an individual Project, clear the check box in the Status column.

Tip • If the Status column is disabled, contact your System Administrator and ask for permission to modify your
notification subscriptions.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 471


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Administration Pages and Views


The section includes descriptions of pages and Views used to perform Workflow Manager administrative tasks:

Table 8-35 • Administration Related Pages and Views

Option Description

Application Status Use to add or edit Application Statuses, a user-configurable field you can use to
Administration Page assign metadata to an Application Request which can be used when performing
searches and generating reports.

Calendar Settings Specify the calendar settings to use when reporting on Application Request
Administration Page compliance with Project Service Level Agreement (SLA) due dates.

Company/Business Create and edit Companies.


Unit Administration
Page

Deployment Site Create and edit deployment sites that have been created for all Customer
Administration Page Companies.

Email Settings Set the default email notification options for new Projects.
Administration Page

Project Create or edit a Project.


Administration Page

Role Administration View, add, or edit Roles.


Page

System Settings Set the System user account.


Page

Template Create, edit, or copy a Template.


Administration Page

Terminology Change the terminology used throughout Workflow Manager.


Customization Page

Note • The availability of these pages for a particular user is dependent upon the user’s assigned Roles. See
Managing Roles and Permissions.

472 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Application Status Administration Page


Application Status is a user-configurable field you can use to assign metadata to an Application Request which can
be used when performing searches and generating reports. On the Application Status Administration page,
which is accessed by clicking Application Status on the in the Administration menu of the Servicer Home
page, you can add or edit Application Statuses.

• By default, Workflow Manager is installed with two statuses: Active and Inactive. These two statuses can be
renamed, but they cannot be deleted.

• Application Statuses can be assigned either an Active or Inactive state. If an Application Status’ State is set
to Inactive, Application Requests that have been assigned this Application Status will not be included in
reports or searches.

• You can change the Application Status of an Application Request on the Properties Tab of the Application
Progress page.

• Email notification is sent whenever an Application Requests's Application Status is changed. You specify the
users that receive the email notification in the Application Status is changed area of the Project Permission
and Notification Settings View of the Project Administration page. If no user is selected, no email is sent.

The following fields are included:

Table 8-36 • Application Status Administration Page Options

Option Description

Add Click to open the New Application Status View, where you can create a new Application
Status.

Select Click on the Edit link to open the Edit Application Status View where you can edit the
Application Status Name, State, and Description, and where you can also delete an
Application Status.

Status Name The names of all of the defined Application Statuses are listed. The two default Application
Statuses, Active and Inactive, are displayed in Italics and cannot be deleted.

Active/Inactive The State of the Application Status: Active or Inactive. If an Application Status' State is set to
State Inactive, Application Requests that have been assigned this Application Status will not be
included in reports or searches.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 473


Chapter 8: Workflow Manager Reference
Administration Pages and Views

New/Edit Application Status View


On the New/Edit Application Status View, which is accessed by clicking Add or Edit on the Application Status
Administration page, you can create a new status or edit an existing status.

Table 8-37 • New/Edit Application Status View

Option Description

Name Name to identify the Application Status.

State Identify the state of this Application Status as either Active or Inactive. If the State is set to
Inactive, Application Requests that have been assigned this Application Status will not be
included in Reports or Searches.

Description Enter text to identify the purpose of this status.

Submit / Update Click to create a new status or save updates to an existing status.

Delete Click to delete the Application Status. If you delete a status that is assigned to existing
Application Requests, those Application Requests are assigned one of the default
system statuses according to the Status State of the deleted status: Active or Inactive.

Calendar Settings Administration Page


On the Calendar Settings Administration page, you specify the calendar settings to use when reporting on
Application Request compliance with Project Service Level Agreement (SLA) due dates:

• Work Week Information—Specify the number of hours in a work day, and whether to include weekend days
in the work week.

• Holiday Information—Identify the holidays that should be excluded from SLA calculations.

The Calendar Settings Administration page is opened by clicking Calendar Settings on the Administration
menu of the Servicer Home page. These settings will automatically be applied to new Projects.

Table 8-38 • Calendar Settings Administration Page

Option Description

Length of a Work Make a selection from the Hours and Minutes lists to specify how many hours in a
Day day are considered work hours when performing SLA calculations.

Note • The Length of a Work Day value is used to convert hours into days when calculating
values for Elapsed Time, SLA Time, User Entered Time, Total Elapsed Time, Total SLA Time, and
Total User Entered Time in reports. For example, if the Elapsed Time for a Workflow Step is 45
hours, Workflow Manager, based on an 8-hour work day, converts the 45 hours into 5 days and 5
hours.

474 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-38 • Calendar Settings Administration Page (cont.)

Option Description

Exclude Select this option to exclude weekend days from SLA calculations.
Weekends?

Existing Holidays List of the holidays that have already been identified. These holidays will be excluded
from SLA calculations.

New Holiday To add a holiday to the list, enter a Holiday Name and Date, and click Add.

Remove To delete a holiday from the list, select that holiday’s check box and click Remove.

Update Click to save your changes.

Company/Business Unit Administration Page


This page, which is opened by clicking Companies on the Administration menu of the Servicer Home page,
lists all defined Companies. Click a Company name to edit it, or click Add to create a new Company.

Table 8-39 • Company/Business Unit Administration Page

Option Description

Add Click to display the Company/Business Unit Details View, where you can create a
new Company.

Note • Only users assigned to Roles with Add Servicer Company permission can create a new
Service Company.

Company/ Name of Customer Company. Click to display the Company/Business Unit Details
Business Unit View, where you can edit the details of this company.
Name

Company ID For Customer companies, this column lists the company’s ID number.

AR Number Number of Application Requests associated with this Company.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 475


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Company/Business Unit Details View


This page is opened by selecting a Company on the Company/Business Unit Administration Page or by clicking
Add to create a new Company.

Table 8-40 • Company/Business Unit Details View Options

Option Description

Company/Business Unit Enter the name of the Company.


Name

Company ID If this is a Customer Company, enter any unique identifier used by your
organization.

Location This field can be any zone or city used in your organization. For example, a
location could be Chicago or Zone 1.

This is a Service Select this check box to create a Service Company.


Company

Note • Only users assigned to Roles with Add Servicer Company permission can
create a new Service Company.

Is an Application Family [Service Company only] Select this option to permit only the Service Company
Owner? to create Application Families; to allow the Service Company and its Customer
Company to create Application Families, leave the check box unselected.

My Page URL By default, the Servicer Home Page includes a My Page list of favorite links,
and the Customer Home Page includes a brief description of how to submit an
Application Request:

If you want to change what is displayed in this Window, enter the URL of the
page that you want to display in the My Page URL field. See Displaying a
Custom Web Page on the Home Page.

Upload Logo To customize this Company’s Home Page so that it displays this Company’s
logo, upload a graphic of that logo. See Changing the Home Page Logo.

Note • You can also change the logo displayed on the Workflow Manager Login Page, the
banner at the top of all of the Workflow Manager pages, and you can customize the Step
Completion dialog boxes. See Customizing Workflow Manager for Your Organization for
detailed instructions.

Update Click to save your entries.

476 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-40 • Company/Business Unit Details View Options (cont.)

Option Description

Delete Click to delete this company.

Caution • When a Service Company is deleted, Workflow Manager deletes all the
Customer Companies, Templates, Users, Roles, Projects, and Application Requests
associated with it.

Deployment Site Administration Page


The Deployment Site Administration page, which is accessed by clicking Deployment Sites on the
Administration menu on the Servicer Home page, lists all deployment sites that have been created for all Customer
Companies.

Table 8-41 • Deployment Site Administration Page Options

Option Description

Add Click to access the Deployment Site Details View where you can create a new deployment
site for a specific customer company.

Deployment Name of deployment site. To open the Deployment Site Details View for that deployment
Site site, click Select.

Company Name The name of the company that the deployment site is associated with.

Status Indicates the deployment site's status:

• Active—Site will be listed as a choice in the Available Sites section of an Application


Request that has an associated Deployment Template.
• Inactive—Site will be listed on the Deployment Site Administration Page, but will not
be listed as a choice in the Available Sites section of an Application Request that has
an associated Deployment Template.

Ready to Indicates whether the site administrator feels that this deployment site is ready to receive
Deploy deployed applications. No deployment workflows can begin, and no deployment progress
will be shown on the Deployment Progress Tab of the Application Progress Page (Servicer)
unless this field is set to Yes.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 477


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Deployment Site Details View


This page is accessed by selecting a Deployment Site on the Deployment Site Administration Page or by clicking
Add to create a new Deployment Site

Table 8-42 • Deployment Site Details View Options

Option Description

Deployment Site When creating a new deployment site, enter a name for the new site. When editing
Name an existing deployment site, you can edit the existing site name.

Company Name When creating a new deployment site, select the company that you are creating this
deployment site for from this list. If you are editing an existing deployment site, this
field is read only.

Ready to Deploy Specify whether this deployment site is ready to receive deployed applications by
selecting Yes or No. No deployment workflows can begin, and no deployment
progress will be shown on the Deployment Progress Tab of the Application
Progress Page unless this field is set to Yes.

Status Specify the deployment site's status by selecting one of the following:

• Active—Site will be listed as a choice in the Available Sites section of an


Application Request that has an associated Deployment Template.
• Inactive—Site will be listed on the Deployment Site Administration Page, but
will not be listed as a choice in the Available Sites section of an Application
Request that has an associated Deployment Template.

Update Click to save your entries.

Email Settings Administration Page


Workflow Manager automatically sends emails to users assigned to selected Roles when certain Workflow events
occur, such as when:

• data is submitted or rejected

• an issue is submitted or responded to

• the status of an Application Request changes, and

• an Application Request is nearing or is at its Service Level Agreement deadline

To set the default email notification options for new Projects, click Email Settings in the Administration menu on
the Servicer Home page. Once these defaults are set, any new Project created in Workflow Manager will
automatically inherit these selections.

Therefore, if you usually configure your email notifications the same for all of your Projects, you will very rarely
need to modify these settings.

478 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

While these options are inherited by all new Projects, you can change these settings on a Project by Project basis
on the Project Permission and Notification Settings View.

Note • Changing the default email settings on the Email Settings Administration page has no effect on existing
Projects.

Use the following options to specify notification options for Application Request Workflow events:

Table 8-43 • Email Settings Administration Page Options

Option Description

Company Select the name of the Company that you want to configure email notification
settings for.

Role / Email Address All of the selected Company’s Roles are listed here. Users assigned to those Roles
will receive automatic emails upon the occurrence of the selected Workflow events.

You can also add external email addresses to this list so that the specified user will
always receive the selected notifications even if he is not a member of any of the
selected Roles or he does not even have a Workflow Manager user account. See
External Email Address Administration Page.

Date Submitted/ Select this option to notify the selected Roles/Email addresses whenever data is
Rejected submitted or rejected during an Application Request workflow.

Issue Submitted Select this option to notify the selected Roles/Email addresses whenever an issue
is submitted during an Application Request workflow.

Issue Responded Select this option to notify the selected Roles/Email addresses whenever an issue
is responded to during an Application Request workflow.

Application Status Select this option to notify the selected Roles/Email addresses whenever an
Changed Application Request’s Status changes during an Application Request workflow.

SLA at Risk/Failed Select this option to notify the selected Roles/Email addresses whenever an
Application Request is nearing or is at its Service Level Agreement deadline.

Manage External Email Click to open the External Email Address Administration Page, where you can add
Address an external email address to the Roles/Email Address list.

View Project List Click to jump to the Project Administration Page.

Update Click to save your edits.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 479


Chapter 8: Workflow Manager Reference
Administration Pages and Views

External Email Address Administration Page


On the External Email Address Administration page, you can add external email addresses to Workflow
Manager so that email can be sent to these addresses when selected workflow events occur.

After an external email address has been added, it is listed in the Role/Email Address column of the Email
Settings Administration Page and the Project Permission and Notification Settings View, making it available for
selection when setting default or Project email notification options.

You could add an external email address so that a user would always receive the selected notifications even if he is
not a member of any of the selected Roles, or even if he does not have a Workflow Manager user account.

Use the following options to define external email addresses:

Table 8-44 • External Email Address Administration Page Options

Option Description

Add Click to open the Add External Email Address View where you can enter a new
email address.

External Email List of the external email addresses that have been added.
Address

Email Settings Click to open the Email Settings Administration Page

Set Project Click to open the Project Permission and Notification Settings View
Permissions and
Notifications

Add External Email Address View


The Add External Email Address view opens when you click Add on the External Email Address Administration
Page. Enter an email address and click Submit.

After an external email address has been added to the Workflow Manager, it is listed in the Role/Email Address
column of the Email Settings Administration Page and the Project Permission and Notification Settings View,
making it available for selection when setting default or Project email notification options.

Project Permission and Notification Settings View


On the Project Permission and Notification Settings view of the Project Administration page, you can
assign Role Permissions and Email Notification Settings to either to individual Workflow Steps or to an entire
Workflow Phase. You can also set permissions on Data Groups and Data Elements.

Each Workflow Phase and Data Group is listed in the tree control on the left. If you expand the listing, the all of the
Data Elements/Workflow Steps in each Workflow Phase/Data Group are also listed.

480 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

The following topics are included:

• Project Permissions Options

• Project Email Notification Options

Project Permissions Options


You open the Project Permission and Notification Settings view by opening the Home page and selecting
Project Permissions on the Administration menu. The following permissions-related options are included:

Table 8-45 • Project Permission and Notification Settings View Options

Option Description

Project Select the Project that you want to edit the permissions of.

Template Type Specify whether you want to edit the permissions for this Project’s Application
template or Deployment template.

Company Company that this Project is associated with.

Workflow Phase and Listing of all of the Workflow Phases, Workflow Steps, Data Groups, and Data
Step List Elements defined in the Template that this Project is associated with.

You select items in this list to assign Role permissions. Selections you make on a
Workflow Phase/Data Group are inherited by their child Workflow Steps/Data
Elements, but these settings can be overridden.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 481


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-45 • Project Permission and Notification Settings View Options (cont.)

Option Description

Role / Permission / When any of the Phase or Step nodes are selected, the Role / Permission /
Receive Email List Receive Email list opens and check boxes appear in the View and Edit columns
for each of the selected Company’s listed Roles. Make a selection for each Role.
Workflow Phase/Step
or Data Group/Element If you do not select a check box, users assigned to that Role will have no permission
Selected on the selected Workflow Phase/Step or Data Group/Element.

To set a permission for a Data Element/Workflow Step that is different from the
permission for the associated Data Group/Workflow Phase, do the following:

To override an inherited permission:

1. Select the Data Element or Workflow Step in the tree control on the left. The
check boxes in the Permission / Receive Email list are disabled.

2. Next to the Role that you want to edit, click the lock icon to unlock the check
boxes. You are notified that the role permission is inherited from the parent item
and asked to confirm that you wish to stop this inheritance.

3. Click OK. The check boxes are now enabled.

4. Make desired selections in the View and Edit columns.

5. Click Update.

Tip • You can use this feature to restrict what sort of work a person has permission to do. For example, to restrict
persons with the Role of “Quality Control” to work only on quality-control-related Workflow Steps, assign that Role
the View and Edit permissions for quality control related steps and no permission for any other steps.

Project Email Notification Options


For each Project, you can specify who is notified via email when the following events take place:

Table 8-46 • Notification Settings at the Default, Project, and Phase/Step Level

Default Level Project Level Phase/ Step Level

• Data Submitted/Rejected • Data Submitted/Rejected • Initiated


• Issue Submitted • Issue Submitted • Rolled Back
• Issue Responded • Issue Responded • Edited
• Application Status Changed • Application Status Changed • Completed
• SLA At Risk/Failed • SLA At Risk/Failed

482 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

These email notification settings are applied to all Application Requests submitted for this Project. You can set both
the Project level and Phase/Step level notification settings on the Project Permissions and Notification
Settings view.

Note • You have multiple options when configuring email notification events:

• You can set the default level notification settings for all new projects on the Email Settings Administration
page. See Setting Email Notification Defaults for New Projects.
• To override email notification settings for an Application Request, see Overriding Email Notification Defaults for
an Application Request.
• To view and modify your own email notification subscriptions, see Managing My Notifications.

You open the Project Permission and Notification Settings view by opening the Home page and selecting
Project Permissions on the Administration menu. The following options are included:

Table 8-47 • Project Permission and Notification Settings View Options

Option Description

Project Select the Project that you want to set email notifications for.

Template Type Specify whether you want to edit this Project’s Application template or Deployment
template.

Company Select the company that you want to set email notifications for. Both the Customer
and Servicer company associated with this Project are listed.

Workflow Phase and Listing of all of the Workflow Phases, Workflow Steps, Data Groups, and Data
Step List Elements defined in the Template that this Project is associated with.

The node that you should select depends upon which set of email notification
options you want to set:

• Project level email notification settings—To specify Project Level email


notification settings, select the root node in the Workflow Phase and Step list.
You can then specify email notification settings for the Data Submitted/
Rejected, Issue Submitted, Issue Responded, Application Status
Changed, and SLA at Risk/Failed events.
• Workflow Phase/Workflow Step level email notification settings—To
specify Phase/ Step Level email notification settings, select a Workflow Phase,
Workflow Step, Data Group, or Data Element. You can then specify email
notification settings for the Initiated, Rolled Back, Edited, or Completed
events.

Note • Selections you make on a Workflow Phase/Data Group are inherited by their child
Workflow Steps/Data Elements, but these settings can be overridden.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 483


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-47 • Project Permission and Notification Settings View Options (cont.)

Option Description

Role / Permission / When the root node is selected (which is the Project name), email notification
Receive Email List settings for the entire Project can be set. You can choose to send an email to the
listed Role when any of the following events occur:
Root Node Selected
• Data Submitted/Rejected
• Issue Submitted
• Issue Responded
• Application Status Changed
• SLA at Risk/Failed

To select all check boxes in a column, click the check box in the column header.

Note • You can use the Email Settings Administration Page to select the default email settings
that will be used for each new Project.

Role / Permission / When any of the Phase or Step nodes are selected, the Receive Email notification
Receive Email List settings appear.

Workflow Phase/Step For each Workflow Phase and Data Group, select those Roles that you want to be
or Data Group/Element notified when any of the following events occur:
Selected
• Initiated—Phase or Step initiated
• Rolled Back—Phase or Step rolled back to
• Edited—Phase or Step edited
• Completed—Phase or Step completed

To set a permission for a Data Element/Workflow Step that is different from the
permission for the associated Data Group/Workflow Phase, do the following:

1. Select the Data Element or Workflow Step in the tree control on the left.The check
boxes in the Permission / Receive Email list are disabled.

2. Next to the Role that you want to edit, click the lock icon to unlock the check
boxes. You are notified that the Role permission is inherited from the parent item
and asked to confirm that you wish to stop this inheritance.

3. Click OK. The check boxes are now enabled.

4. Make desired selections in the Initiated, Rolled Back, Edited and Completed
columns.

Note • To specify default email settings for all new projects, see Setting Email Notification Defaults for New
Projects.

484 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Project Administration Page


On this page, which is accessed by clicking Projects on the Administration Home page, you can edit an
existing Project or create a new one.

Table 8-48 • Project Administration Page Options

Option Description

Project Listing The Project Listing includes the following information for each Project:

• Project Name—Click a name in this column to access the Project Details View,
where you can edit this Project.
• Company/Business Unit—The Customer Company associated with this Project.
• Template—The template that is used for Application Requests for this Project.
• Customer Contact—The user at the Customer Company selected as the contact for
this Project.
• Servicer Contact—The user at the Service Company selected as the contact for this
Project.
• Status—Whether the Project is Active or Inactive.

Add Click to access the Project Details view, where you can create a new Project.

Status Select Active or Inactive to filter this project listing.

The Project Administration page has the following associated views:

• Project Details View

• Policy Documents Page

• Policy Document Details View

Project Details View


On the Project Details view of the Project Administration page, you can edit an existing Project or create a
new Project. From it you can also view a Project’s Policy Documents Page and add new policy documents.

You open the Project Details view by:

• Selecting a project on the Project Administration page.

• Clicking the Add button on the Project Administration page.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 485


Chapter 8: Workflow Manager Reference
Administration Pages and Views

General Information
The General Information area of the Project Details view includes the following options:

Table 8-49 • Project Details View - General Information Area

Option Description

Project Name Enter a name to identify this project.

Company/Business Select the company that this project will be associated with.
Unit

Application Enter a prefix to identify the Application Requests created for this Project.
Request Prefix
This prefix will be pre-pended to the AR Number, the number that Workflow Manager
generates to uniquely identify an Application Request.

To enable you to quickly identify an Application Request's associated Project (and


associated Customer Company) just by looking at the AR Number, enter a unique
Application Request prefix for that Project.

Template The Application Template associated with this Project.

Deployment The Deployment Template associated with this Project.


Template

Note • If a template with the Template Type of Deployment does not exist, this field will be
blank.

Customer Contact The user at the Customer Company selected as the contact for this Project. Click
Assign Customer Contact to make a selection.

Servicer Contact The user at the Service Company selected as the contact for this Project. Click Assign
Servicer Contact to make a selection.

Project Information Area


The Project Information area includes the following options:

Table 8-50 • Project Details View - Project Information Area

Option Description

Status Specify whether this Project is Active or Inactive.

Applications List of Application Requests associated with this Project. If you are creating a new Project,
this field will be blank.

486 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-50 • Project Details View - Project Information Area (cont.)

Option Description

Project ID This field can be any unique identifier used in your organization, such as an ID used by
your CRM software, or an internal project-tracking number.

Project Locator Not currently in use.

SLA Information Area


The SLA Information area includes the following options:

Table 8-51 • Project Details View - SLA Information Area

Option Description

Application Due Number of days in which an Application Request associated with this Project should
Period be completed.

Application at Risk Number of days before Application Request is due that the Application Request will
Period be considered “at risk” of not being completed on time.

Start Date By default, this is the date this Project was created. Click on the calendar icon to
change this date.

End Date Estimated date when all Application Requests associated with this Project will be
complete.

Note • Currently, the information you enter in the End Date field is not used by Workflow
Manager. This field is provided for future use.

Acceptance Term Not currently in use.

Send Emails at When “at risk” Application Requests are identified, select whether to send out an
Application Risk email notification of this by selecting Yes or No.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 487


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Work Week Information Area


The Work Week Information area includes the following options:

Table 8-52 • Project Details View - Work Week Information Area

Option Description

Length of a Work Make a selection from the Hours and Minutes lists to specify the length of the work
Day day to be used in SLA calculations.

Note • The Length of a Work Day value is used to convert hours into days when calculating
values for Elapsed Time, SLA Time, User Entered Time, Total Elapsed Time, Total SLA Time, and
Total User Entered Time in reports. For example, if the Elapsed Time for a Workflow Step is 45
hours, Workflow Manager, based on an 8-hour work day, converts the 45 hours into 5 days and 5
hours.

Exclude Weekends? When tracking SLA due date compliance, indicate whether Saturdays and Sundays
should be excluded as work days by either selecting or clearing this check box.

Note • For example, if an Application Request was submitted on Tuesday, February 28, 2006 with
an Application Due Period of 5 days and with the Exclude Weekends? option turned on, the
Application Due Date would be March 7, 2006. If this option was turned off, then the Application
Due Date would be March 5, 2006.

Holiday Information Area


The Holiday Information area includes the following options:

Table 8-53 • Project Details View Options

Option Description

Existing Holidays List of holidays to exclude from SLA due date calculations.

Holiday Name and Enter a name and date to identify a holiday that you are adding to the Existing
Date Holidays list.

Add Click to add the holiday identified in the Holiday Name and Date fields to the
Existing Holidays list.

Remove Click to remove the selected holiday from the Existing Holidays list.

488 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Buttons and Links


The following buttons and links are available on the Project Details view:

Table 8-54 • Project Details View Buttons and Links

Option Description

Update Click to save your entries.

Delete Click to delete the selected Project.

Caution • When a Project is deleted, all of the Application Requests associated with that
Project are also deleted.

Note • When creating a new Project, this button is not displayed.

Cancel Click to return to the Project Administration Page without saving your entries.

Add/Edit Policy Click to open the Policy Documents view of the Project Administration Page,
Documents for this where you can view this Project's associated Policy Documents and add new Policy
Project Documents.

A Policy Document is a file that you upload to associate it with a Project, making it
centrally available to all people involved, such as a contract, company procedures
for packaging applications, software distribution procedures, etc.

Set Project Click to open the Project Permission and Notification Settings View of the Project
Permissions & Administration Page, where you can assign Role Permissions and Email Notification
Notifications Settings for each Phase / Workflow Step in this Project.

Policy Documents Page


A Policy Document is a file that you upload to associate it with a Project, making it centrally available to all people
involved, such as a contract, company procedures for packaging applications, software distribution procedures,
etc.

The Policy Documents page, which opens when you click Add/Edit Policy Documents for this Project on the
Project Details view, lists all of this Project's associated Policy Documents. Click on a Policy Document to view it.

To add a Policy Document to a Project, click Add to open the Policy Document Details view.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 489


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Policy Document Details View


On this view, which appears when you click Add on the Policy Documents page, you enter the details about the
new Policy Document:

• Policy document name—Enter the name of the file containing this Policy Document.

• Document folder—Specify a location, relative to the wwwroot subfolder of the folder to which Workflow
Manager is installed, where Policy Documents will be stored.

System Settings Page


Workflow Manager performs many operations—such as sending emails and uploading and downloading files—by
impersonating the user specified in this page. The User Account you enter here must have the following
permissions on your domain:

• Permission to upload and download files

• Permission to send email

• Permission to run scripts

When Workflow Manager was installed, this user either already existed or was created during installation. If you
would like to change the System user account, specify that user account on this page.

Table 8-55 • System Settings Page

Option Description

User Name Enter the name of an existing user account in the Domain specified in the User Domain field.
This user must have the following permissions:

• Upload and download files


• Send email
• Run scripts

User Enter the password of the user account defined in the User Name and User Domain fields.
Password Workflow Manager encrypts passwords before storing them in the database.

If your network domain requires that user passwords are changed periodically, you will have
to open this view again to update this account’s password. To avoid this, try to obtain a User
Account that has a password that does not expire.

User Domain Enter the Domain of the user account listed in the User Name field.

Serial To activate the AdminStudio Enterprise tools or Workflow Manager, a valid serial number must
Number be entered into either the Workflow Manager or AdminStudio Enterprise Server boxes.

490 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Template Administration Page


From the Template Administration page—which is opened by clicking Templates in the Administration menu
on the Servicer Home page—you can edit an existing template, copy an existing template, or create a new
template from scratch.

The Template Administration page includes the following options:

Table 8-56 • Template Administration Page Options

Option Description

Add Click to open the Template Details page, where you can create a new template.

Copy Click to open the Copy Template view, where you can copy an existing template.

Status Use to filter the list of existing templates to only display the ones meeting the
selected status condition: Active, Inactive, or All.

Note • You can edit a template's status using the Status field on the Template Details page.

Manage Directory Click to open the Directory Services Attributes Administration Page page where you
Service Attributes can add a new Directory Service attribute.

You can map an existing Data Element to an attribute in a Directory Service, so that
when this field is presented to the user, its value will be pre-populated by the value of
the attribute for the current user. See Defining Data Elements for more information.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 491


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-56 • Template Administration Page Options (cont.)

Option Description

Template List View A list of all existing Workflow Templates. The following information is included:

• Template Name—Uniquely identifies this template.


• Template Type—Identifies the template as either being an Application or a
Deployment Template,

Application—Select if this template will define an ordered series of steps that a


Service Company follows to prepare an application for deployment to end users'
computers.

Deployment—Select if this template will be used to deploy a prepared


application to end users' computers.

• Data Sections—Number of Data Groups defined in this Template.


• Workflow Phases—Number of Workflow Phases defined for this Template.
• Created—Date and time this template was created.
• Last Updated—Date and time that this template was last edited.
• Updated By—User name of the user who made the most recent edits to this
template.
• Library—Identifies the state of the template as one of the following:

Global—Global templates were installed with Workflow Manager to serve as


example templates for you to copy and use, and cannot be modified. You
cannot assign a Global template to a Project.

Private—A Private template is a template that a Servicer Administrator created


by either starting from scratch or by copying and modifying a Global template.
You can assign a Private template to a Project.

In Use—An In Use template is a Private template that has been used to create
an Application Request, you can edit some of the template fields and cannot
edit others. See Editing a Template That is in Use for a description of what can
and cannot be edited.

• Applications—Number of Application Requests created for all Projects that use


the Template.
• Status—Identifies the template as being either Active or Inactive.

To edit a template, click Select next to the template name. The template will be
opened in the Template Details page.

Caution • If a template is in use, it can only be partially modified. See Editing a Template That is
in Use for a description of what can and cannot be edited. Also, if you edit an in-use template, all
of the current Application Requests using this template will be affected by the changes.

492 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Copy Template Page


This area appears when you click Copy on the Template Administration page.

Table 8-57 • Template Administration / Copy Template View Options

Option Description

Copy from Select the name of the template that you want to copy from this list.

Copy to Enter a name to identify the new template.

Target Select the target location for this copied template:

• Current database—Select this option to create a copy of this template in the currently
open Workflow Manager database.
• SQL Script—Select this option to export a copy of this template to an external SQL
script file, which can then be imported into another instance of Workflow Manager. After
you select this option, a text box named Enter the Filename is displayed. Enter an
appropriate name for this SQL script and click Copy. It is not necessary to enter the .sql
extension. You are then prompted to select a location where you want to save the script
file.

After you have downloaded the script file, you can run it against any other Workflow
Manager database to import the exported Template. For more information, see Copying
an Existing Template to Another Workflow Manager Database.

Copy Click to copy the template and return to the Template Administration Page, where the
new template will be listed.

Cancel Click to return to the Template Administration Page without creating a new template.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 493


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Template Report
The Template Report appears when you select View Template Report on the Template Options menu on the
Template Details page.

Figure 8-7: Template Options Menu

This report provides a summary of all of the information related to this template, including a listing of all Data
Groups and Workflow Phases in the template.

494 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Figure 8-8: Template Report

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 495


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Template Details Page


On the Template Details page, which is opened from the Template Administration page by either clicking Add
or selecting an existing Template, you create a new Workflow template or edit an existing template.

Figure 8-9: Template Details Page

The Template Details page includes the following options:

Table 8-58 • Template Details Page

Option Description

Name This field displays the name of the template.

• If you are creating a new template, the text Create a new Template
appears. As soon as you enter a name into the Name field in the Template
Properties view and click Create, the name of the template is listed in this field.
• If you are editing an existing template, the template name is displayed.

496 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-58 • Template Details Page

Option Description

Template Options Menu Click on this arrow to display a menu containing the following additional Template
options:

• Preview Template
• Validate Template
• View Template Report
• View Workflow Summary
• Clean Sample Applications

See Template Options Menu for more information.

Information Indicates the status of the Template:

• Global—This Template is a Global Template and therefore cannot be modified.


• Not in use—This Template is not used by any Application Requests and
therefore is fully editable.
• In use—This Template is in use and therefore can only be partially modified.
Any Application Requests currently using this Template will be affected by any
changes that are made. See Editing a Template That is in Use for more
information.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 497


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-58 • Template Details Page

Option Description

Data Group and Expandable list of all of the Data Groups and Workflow Phases defined in the
Workflow Phase Tree Template. Data Group and Workflow Phase names are preceded by an identifying
icon:

When you click on the plus sign next to the Data Group or Workflow Phase name, its
child elements are listed:

To edit one of the listed items, select it in the tree to open its corresponding view.
Depending upon what is selected in the tree, the following child views are displayed:

• Template Properties View


• Data Group Properties View
• Data Element Properties View
• Workflow Phase Details View
• Workflow Step Details View

Note • To return to the Template Properties view from any view on this page, click on the
Template Name at the top of the page.

498 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Template Options Menu


The following table describes the available options on the Template Options menu:

Table 8-59 • Template Options Menu

Option Description

Preview Select the Preview Template option to view and test a Template’s workflow. The Preview
Template Template option is found by clicking on the blue arrow next to the Template Name on the
Template Details page. When you click this button, the Preview Template page opens
and displays a visual representation of the current template's workflow exactly as it will
appear on the Application Progress page. You can test the template by marking steps
complete, rolling back to previous steps, and making branching decisions.

• To clear any selections that you made and start the test over, click the Reset button.
• To close the Preview Template area, click Close.

Note • When you click Close to close the Preview Template area, the test data (a project and an
application) that Workflow Manager created to test this template is deleted. If, when you are viewing
the template in the Preview Template area, you close the window without clicking the Close button,
the test data will not be deleted and will be included in Workflow Manager listings. To delete this
leftover test data, you can click Delete Test Data in the Template Properties View.

Note • For more information, see Previewing and Testing a Template.

Validate Select the Validate Template option to analyze a Template to determine if it is ready to
Template use. The Validate Template option is found by clicking on the blue arrow next to the
Template Name on the Template Details page.

The Template Validation Results report opens in a new screen, stating whether or not
the template is valid. If it is invalid, the reasons will be listed. A template would be invalid,
for example, if a Workflow Phase does not contain any Workflow Steps, or if a Data Group
did not contain any Data Elements, etc.

View Template Select the View Template Report option to view a summary of all of the information
Report related to a template, including a listing of all Data Groups and Workflow Phases in the
Template. The View Template Report option is found by clicking on the blue arrow next
to the Template Name on the Template Details page.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 499


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-59 • Template Options Menu

Option Description

View Workflow Select the View Workflow Summary option to view a listing of all Workflow Phases
Summary defined in a Template. The View Workflow Summary option is found by clicking on the
blue arrow next to the Template Name on the Template Details page.

• Workflow Phases are shown in order.


• Conditional Branch Points and Merge Points are also shown. A legend at the bottom
of the report differentiates between Workflow Phase, Branch Point and Merge Point.

In a Branch Phase, the Workflow proceeds in two different paths depending upon an
item of data that was collected. A Merge Phase is where a Workflow with Branch
Phases merges back together.

• You can click on a Branch Point condition to jump to the resulting Workflow Phase.

Clean Sample You can use the Clean Sample Application option to delete any test data that was
Applications created when you previewed a Template and tested its workflow. The Clean Sample
Applications option is found by clicking on the blue arrow next to the Template Name on
the Template Details page.

Template Properties View


On the Template Properties view, which is displayed when the Template Name is selected on the Template
Details page, you can set general properties for the entire Template.

Figure 8-10: Template Properties View on the Template Details Page

500 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

The Template Properties view includes the following properties and options:

Table 8-60 • Template Properties View

Option Description

Name The information displayed in the Name field depends upon whether you are adding or
editing a template and whether or not you are editing a Global or Private template.

• Creating a new template—Enter a unique name for this new template.


• Editing an existing private template—You can edit the template name.
• Viewing a global template—You can view the template name, but you cannot edit it.

Folder Specify a location, relative to the wwwroot subfolder of the folder to which Workflow
Manager is installed, for files used by the template. It is the folder on the Web server that will
contain Data help files and Workflow instruction files.

Template Type Select one of the following options:

• Application—Select if this template will define an ordered series of steps that a


Service Company follows to prepare an application for deployment to end users'
computers.
• Deployment—Select if this template will be used to deploy a prepared application to
end users' computers.

Status Select one of the following options:

• Active—Choose to make this template available for selection when creating a new
Project.
• Inactive—Choose to make this template unavailable for use.

Note • If you are creating a new Template, this option is not displayed until after you click the Create
button.

Global Select the Yes option if you want to create a Global template.
Template
• Global templates serve as example templates that can be copied and used, but cannot
be modified.
• Global templates cannot be assigned to a Project.
• Global templates have the word Global listed in the Library column on the Template
Administration page.

Note • For more information, see Template Library Types: Global, Private, In Use Via Project, and In
Use.

Create When creating a new template, click to proceed with template creation. When you are
editing an existing template, this button is labeled Update.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 501


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-60 • Template Properties View (cont.)

Option Description

Update Click to save any edits you have made. When creating a new template, this button is
labeled Create.

Done Click to cancel any changes you have made and to return to the Template Administration
page.

Delete Click to delete this template.

Caution • If you delete a Template that is in use, all of its associated Projects and Application Requests
will also be deleted.

Editing a Template That is in Use


After a Template has been used to create an Application Request, you can edit some of the Template fields and
cannot edit others. The following chart details the allowable changes:

Table 8-61 • Changes Permitted When Editing a Template that is in Use

Item or Field Permitted to Change Not Permitted to Change Delete?

Templates Name field Template Type selection No

Folder field

Data Groups Data Group Name field Data Type selection No

Sort Order field

Data Elements Data Element description field Data Type selection Yes
(Standard)
Selection list items field Use to control Branching selection

Sort order field

Data Elements Nothing Everything No


(Branching)

Workflow Phase Workflow Phase name field Phase type selection No

Cannot add a Phase

Workflow Step Workflow Step description field Sort order field Yes

Popup HTML File field

502 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Data Group Properties View


The information that is gathered during an Application Request is defined in a template Data Group (screens
displayed when an Application Request is submitted) comprised of Data Elements (questions).

Figure 8-11: Diagram Demonstrating Data Groups and Data Elements

On the Data Group Properties view, which opens when you select a Data Group or create a new Data Group on
the Template Details page, you identify groups of questions that are displayed to a user during work on an
Application Request.

Figure 8-12: Data Group Properties View

The Data Group Properties view consists of the following areas:

• Properties Area

• Data Group Condition Area

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 503


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Properties Area
The Properties area of the Data Group Properties view includes the following options:

Table 8-62 • Data Group Properties View

Option Description

Data Group Name Enter a unique name to identify this Data Group.

Data Type Select one of the following:

• AMS Data Type—Select if you are going to define the Data Elements of this
Data Group in Workflow Manager.
• AdminStudio Data Type—Select to create a Data Group whose Data Elements
are automatically created and populated by the fields defined in the currently
selected AdminStudio ConflictSolver Extended Attributes Description File, which
by default is:
C:\AdminStudio Shared\EA_Default.xml

Selecting the AdminStudio Data Type enables you to share application-related


data between AdminStudio ConflictSolver and Workflow Manager. If the
Extended Attribute data for this Application is already entered in the
ConflictSolver database, the corresponding fields that appear during the data
collection task during an Application Request will be populated with the
information in the ConflictSolver database. When you change the data in
ConflictSolver, it will automatically be changed for that Application when
submitting a Workflow Manager Application Request, and vice versa.

Note • This field is only enabled when you are creating a new Data Group. If you are editing an
existing Data Group, this field is disabled.

Sort Order Enter a number to identify where this Data Group will appear in the Data Group list,
with lower numbers appearing higher in the list.

When Collected? Specify when you want to collect this Data Group by selecting one of the following:

• At initial submission—The Data Group will be collected when the Application


Request is submitted.
• Later in the workflow—The Data Group will be available to be collected during
any Workflow Step you define in any of the phases of this workflow.

504 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-62 • Data Group Properties View (cont.)

Option Description

Data Items n Lists the number of currently defined Data Elements for this Data Group. Click the
Add Data Item button to add a new Data Element.

You can also add a new Data Element by clicking the Add a new Data Element icon in
the Data Group tree:

Update Click to add the new Data Group or save the changes you have made to an existing
Data Group.

Delete Click to delete this Data Group.

Cancel Click to cancel the creation of a new Data Group or to cancel any edits that you have
just made.

Data Group Condition Area


You can use the fields in the Data Group Condition area to make the display of this Data Group be conditional
upon the data collected during this Workflow.

Figure 8-13: Data Group Condition Area

The Data Group Condition area includes the following fields:

Table 8-63 • Data Group Condition Area

Property Description

Defined Condition Lists any conditions that are assigned to this Data Group.

Note • If you are editing a Template that is in use, this field is not available.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 505


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-63 • Data Group Condition Area (cont.)

Property Description

Add a Condition Click to display the condition definition fields (Condition Item, Operator,
Selections), where you can define a condition to determine whether or not this Data
Group is displayed. For more information, see Setting Up Conditional Display of Data
Groups, Data Elements, or Workflow Steps.

Note • If you are editing a Template that is in use, this field is not available.

Condition Item If any of the other Data Groups in this Template includes a Data Element that has its
Use to control Branching option set to Yes, that Data Element will be listed in the
Condition Item list.

From the Condition Item list, select the Data Element you want to use to determine if
this Data Group is displayed.

• Data Elements are listed in the following format: Data Group - Data Element.
• If no Data Elements in this template are defined with the Use to control
Branching option selected, the Condition Item list will be empty.

For more information, see Setting Up Conditional Display of Data Groups, Data
Elements, or Workflow Steps.

Operator This field is set to Equals to indicate how to read this condition. For example:

• IF Data Element EQUALS Value(s) THEN display this Data Group


• IF Operating System EQUALS Windows XP THEN display this Data Group

Selections Lists all values defined for the selected Data Element.

Save Click to create the new condition or update an existing condition.

Clear Click to remove all conditions that have been defined.

Cancel Click to close the expanded Data Group Condition area without saving any
changes.

506 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Data Element Properties View


On the Data Element Properties view, which opens when you select a Data Element or create a new Data
Element on the Template Details page, you define questions that are displayed to users during work on an
Application Request.

The options that are displayed on the Data Element Properties view depend upon the Data Type that is
selected.

• Common Properties

• Data Element Data Types

• Data Type-Specific Properties

• Data Element Condition Area

Common Properties

When defining a Data Element, you always specify the name of a Data Element and also set its Data Type.

Figure 8-14: Data Element Properties View

The Data Element Properties view includes the following options:

Table 8-64 • Data Element Properties View

Option Description

Description Enter a description to identify the type of data that is being collected in this Data
Element.

Required Select Yes or No to specify whether the user will be required to provide an answer to
this question before the data can be submitted.

Sort Order Enter a number to identify where this Data Element will appear in the Data Elements
list, with lower numbers appearing higher in the list.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 507


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-64 • Data Element Properties View (cont.)

Option Description

Help Text If you enter text in this field, when this Data Element is displayed to the user, a help
icon will appear to the right of the field. When the user hovers over that help icon, this
text will be displayed, as shown below:

Data Type Select the type of entry field you want this Data Element to be. See Data Element
Data Types for a description of each data type.

Note • Additional properties appear on the Data Element Properties view depending upon
which Data Type is selected. See Data Type-Specific Properties for a list of those Data Type-
specific fields.

Update Click to create a new Data Element or save the edits that you have made to an
existing Data Element.

Delete Click to delete this Data Element.

Cancel Click to cancel the creation of a new Data Element, or cancel the changes that you
just made to an existing Data Element.

Data Element Data Types

You can define a Data Element with any of the following data types:

Table 8-65 • Available Data Element Data Types

Data Type Description

Text Entry Box A single-line, editable text box.

To validate the data that a user enters into this text box, set the Validation Type
option to Mask or Regular Expression.

When you select Mask or Regular Expression, two additional options appear:
Validation Expression and Validation Message. See Text Entry Box Data Type
Validation Options for more information.

Text Area A multi-line, scrollable, and editable text box.

508 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-65 • Available Data Element Data Types (cont.)

Data Type Description

Single Selection A drop down list prompting the user to select one value from a list of values. When
this option is selected, the Selection list items field appears, where you enter the list
values, one per line.

Important • Because a user can only select one value, Single Selection lists can be used to
control branching.

Multiple Selection List in which the user is permitted to select more than one value. When this option is
selected, the Selection list items field appears, where you enter the list values, one
per line.

Check Box Square box that is selected or cleared to turn on or off an option. More than one
check box can be selected. When this option is selected, the Selection list items field
appears, where you enter the check box values, one per line.

Radio Button A round button used to select one of a group of mutually exclusive options. When
this option is selected, the Selection list items field appears, where you enter the
radio button values, one per line.

Important • Because a user can only select one value, Radio Buttons can be used to control
branching.

Date A text box where the user is only permitted to either enter a date in date format (such
as MM/DD/YYYY) or select a date by clicking on the field's associated Calendar icon.

Document Upload, An upload link in a Workflow Step which enables a user to upload application,
Application Upload, documentation, or dependency files to a specific location on the Workflow Manager
Dependency Upload file server for the selected Application Request.

Downloadable File An upload link in a Workflow Step that occurs after the initial Data Entry step. These
Upload files are stored in the Workflow Manager Downloadable Files Directory and are listed
on the Downloadable Files tab for the selected Application Request. Typically after a
Servicer has completed his tasks, his next Workflow Step would be to upload the
revised application file.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 509


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-65 • Available Data Element Data Types (cont.)

Data Type Description

Directory Service Select to map the Data Element to an attribute in a Directory Service, so that when
this field is presented to the user, its value will be pre-populated by the value of the
attribute for the current user.

When Directory Service is selected in the Data Type field, two additional fields
appear: the Directory Services list, where you pick the Directory Service that
contains the attribute that you want to use, and the Data element list, where you
select the attribute that you want to map to.

Dynamic Pick List A selection list which is populated with values from a user-supplied XML file. When
this option is selected, the Data Source File field appears, where you specify the XML
file that you want to use, and the Column Value to Select field appears, where you
select which column's value in the XML file will be passed to Workflow Manager. By
default, the first column is selected.

When a Data Element with a data type of Dynamic Pick List is displayed in an
Application Request, the user is prompted to click a link to make a selection. When
the user clicks the Click to Select link, the Dynamic Pick List dialog box opens
containing a list of the data in the selected XML file. After the user selects one or
multiple items in the list and clicks OK, the selected values then populate the text
area, with entries separated by pipes.

Note • See Dynamic Pick List Data Type Options for more information.

DB Driven Type Select this option to populate a single-selection list with real time data values
obtained from an associated SQL Server or Oracle database. When you select DB
Driven Type from the Data Type list, three new fields appear:

• External Datasources—Select a database connection that was defined on the


External Data Sources Administration page. See Creating a New External
Datasource Connection.
• SQL Query—Define a query to select the columns of the database table that
you want to include on the selection list that is displayed to the user as an
Application Request is worked on. For example, if you want to display the
LastName and JobTitle and EmployeeID of all salespersons in the Midwest
region, enter a query that would return those values.
• Persisted Column—Enter the name of the column containing the value you
want to store in the database. In the previous example, you would probably want
to store the EmployeeID column as the Persisted Column because it uniquely
identifies the person that will be selected.

Note • See DB-Driven Type Data Type Options for more information.

510 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Data Type-Specific Properties

The Data Element Properties view includes the following properties, depending upon the selected Data Type:

• Properties Common to Multiple Data Types

• Text Entry Box Data Type Validation Options

• DB-Driven Type Data Type Options

• Dynamic Pick List Data Type Options

Properties Common to Multiple Data Types


The following Data Element options are common to multiple Data Types:

Table 8-66 • Data Element Properties View

Displayed for
Option Data Types ... Description

Default Value Text Entry Box, To set default values for text fields, selection lists, radio buttons, or
Text Area, dates, use this option:
Single Selection,
• For text boxes, if you would like text to appear in this text
Multiple Selection,
field by default, enter that text here.
Radio Button,
Check Box, Date • For selection lists, if you would like one of the selections to
be selected by default, make a selection from this list.
• For dates, you click the calendar icon and select a date.

Use to control Single Selection, Enables this Data Element to be specified as controlling a
Branching Radio Button workflow branching condition. When Workflow Phases are
defined, Data Elements with this option can be selected as the
condition of the phase. The default value for this field will be No.

Important • This field is only shown if you have selected a Workflow


Manager Data Type that supports branching (Single Selection or Radio
Button).

Selection list Single Selection, Enter the items in the list control (if you selected Single
items Multiple Selection, Selection or Multiple Selection in the Data Type field).
Radio Button,
Check Box

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 511


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-66 • Data Element Properties View (cont.)

Displayed for
Option Data Types ... Description

Directory Directory Service If you selected Directory Service as the Data Type, this field
Services appears allowing you to select a Directory Service Attribute
(which are defined on the Directory Services Attributes
Administration Page) to map to a user in the Directory Service.

If you select the Directory Service data type and no Directory


Service information has been defined, the Add New... link
appears. Click Add New... to define Directory Service
information, or select a different Data Type. See Adding a
Directory Service Connection.

Text Entry Box Data Type Validation Options


The following additional options are displayed when the Data Type is set to Text Entry Box:

Table 8-67 • Text Entry Box Data Type Validation Options

Option Description

Validation Type From the Validation Type list, select one of the following options to specify if you would
like to validate the data that is entered into that field:

• None—Do not validate this field.


• Mask—Validate this field using a mask expression, where you use # to represent a
number and @ to represent an alphanumeric character.
• Regular Expression—Validate this field using a special text string that describes a
search pattern.

If you select the Mask or Regular Expression options, the Validation Expression and
Validation Message options are displayed.

Validation Enter one of the following:


Expression
• For Regular Expression validations—Enter a valid regular expression that will be
used to validate this data item. For example, to validate a United States phone
number, you would enter
\(\d{3}\)\d{3}-\d{4}

• For Mask validations—Enter a valid mask validation expression, using # to


represent a number and @ to represent an alphanumeric character. You can also use
the following characters:
( ) - \ / . $

An example of a mask validation for a United States phone number would be:

(###)-(###)-(####)

512 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-67 • Text Entry Box Data Type Validation Options

Option Description

Validation Enter the error message text that you would like to display if the users’ entry is not valid.
Message The error will be generated when the user attempts to navigate out of the text field.

DB-Driven Type Data Type Options


On the Data Element Properties view, when the Data Type of a Data Element is set to DB Driven Type, the
following additional options are displayed

Table 8-68 • DB-Driven Type Data Type Options

Option Description

External Data Select a database connection that was defined on the External Data Sources
Source Administration page. See Creating a New External Datasource Connection.

SQL Query Define a query to select the columns of the database table that you want to include on the
selection list that is displayed to the user as an Application Request is worked on. For
example, if you want to display the LastName and JobTitle and EmployeeID of all
salespersons in the Midwest region, enter a query that would return those values.

Persisted Enter the name of the column containing the value you want to store in the database. In
Column the previous example, you would probably want to store the EmployeeID column as the
Persisted Column because it uniquely identifies the person that will be selected.

Dynamic Pick List Data Type Options


On the Data Element Properties view, when the Data Type of a Data Element is set to Dynamic Pick List, the
following additional options are displayed:

Table 8-69 • Dynamic Pick List Data Type Options

Option Description

Data Source File Select an XML data source file to populate your Dynamic Pick List Data Element. This field
lists of all of the XML source files that have been copied to the following Workflow
Manager Web Server location:

[Workflow Manager Web Application Root]\ DataSourceFiles

These XML data source files must adhere to the Microsoft Excel XML spreadsheet
schema. To ensure that your XML file is in the correct format, open your XML file in
Microsoft Excel, and save it in Microsoft Excel XML Spreadsheet format.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 513


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-69 • Dynamic Pick List Data Type Options

Option Description

Column Value to For Dynamic Pick List Data Elements, select the name of the column in the selected XML
Submit data source file that contains the value that you want to pass to Workflow Manager when
an item is selected. An XML data source file can have multiple columns, but only one
column value is passed to Workflow Manager. By default, the first column in the XML file is
selected. If no column names are listed, it means that the XML data source file that you
selected either contains no data or was not saved in Microsoft Excel XML Spreadsheet
format.

Data Element Condition Area

You can use the properties in the Data Element Condition area to make the display of this Data Element be
conditional upon the data collected during this Workflow.

Figure 8-15: Data Element Condition Area

The Data Element Condition area includes the following options:

Table 8-70 • Data Element Condition Area

Option Description

Defined Condition Lists any conditions that are assigned to this Data Element.

Note • If you are editing a Template that is in use, this field is not available.

514 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-70 • Data Element Condition Area (cont.)

Option Description

Add a Condition Click to display the condition definition fields (Condition Item, Operator,
Selections), where you can define a condition to determine whether or not this Data
Element is displayed. For more information, see Setting Up Conditional Display of
Data Groups, Data Elements, or Workflow Steps.

Note • If you are editing a Template that is in use, this field is not available.

Condition Item If any of the Data Groups in this Template includes a Data Element that has its Use to
control Branching option set to Yes, that Data Element will be listed in the
Condition Item list.

From the Condition Item list, select the Data Element you want to use to determine if
this Data Element is displayed.

• Data Elements are listed in the following format: Data Group - Data Element.
• If no Data Elements in this Template are defined with the Use to control
Branching option selected, the Condition Item list will be empty.

For more information, see Setting Up Conditional Display of Data Groups, Data
Elements, or Workflow Steps.

Operator This field is set to Equals to indicate how to read this condition. For example:

• IF Data Element EQUALS Value(s) THEN display this Data Element


• IF Operating System EQUALS Windows XP THEN display this Data Element

Selections Lists all values defined for the selected Data Element.

Save Click to create the new condition or update an existing condition.

Clear Click to remove all conditions that have been defined.

Cancel Click to close the expanded Defined Condition area without saving any changes.

Workflow Phase Details View


On the Workflow Phase Details view, which opens when you create a new Workflow Phase or edit an existing
Workflow Phase on the Template Details page, you build the Workflow Phases of a Template.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 515


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Figure 8-16: Workflow Phase Details View

The Workflow Phase Details view consists of the following options:

Table 8-71 • Workflow Phase Details View

Option Description

Workflow Phase Enter a name to identify this Workflow Phase.


Name

Phase Type Select one of the following options to identify the Workflow Phase type:

• Data Entry Phase—Phase containing the data collection step that is required
when submitting an Application Request.
• Work Phase—Standard phase that has no restrictions.
• Customer Acceptance Phase—Phase that requires Customer approval to be
completed.
• Last Phase—Phase including administrative tasks after Customer project has
been completed.
• AdminStudio Workflow—Phase is performed in its entirety as an AdminStudio
Project.

Note • By default, an AdminStudio Phase is automatically assigned to the AdminStudio user


named admin@servicer.com. To change this default user to a different user, go to the
<appSettings> section of the AdminStudioEnterprise\wwwroot\web.config file on the Web
server and edit the following line:
<add key="ASProjectOwner" value="admin@servicer.com" />

Note • If you are editing a Workflow Phase that is in use, the Phase Type field is disabled.

Sort Order Enter a number to determine where this Workflow Phase will appear in the Workflow
Phase list, with lower numbers appearing higher in the list.

516 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-71 • Workflow Phase Details View (cont.)

Option Description

Define a condition Select one of the following options:


for workflow
• No—Select No to create a standard, non-branching Workflow Phase.
branching?
• Yes—Select Yes to define this Workflow Phase as a Workflow Branch or Merge
Phase. When you select Yes, additional options are displayed.

Branch and Merge Phases

In a Branch Phase, the Workflow proceeds in two different paths depending upon an
item of data that was collected. A Merge Phase is where a Workflow with Branch
Phases merges back together.

Merge and Branch phases are identified by a special icon in the Data Group/Workflow
Phase tree:

This Workflow would proceed in the following order:

Link to next phase Select the existing Phase that you want to follow this Phase in the Workflow.

Note • This option is displayed only if the Define a condition for workflow branching? option
is set to No.

Caution • Even though Phases are listed in a specific order in the Phase/Step tree, they are not
automatically linked together. If you create a Phase but fail to link it to a preceding phase, it will not
be visible in the Workflow.

Tip • The easiest way to link Phases is to create all of the Phases first, and then edit each of them
to link the Phases together.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 517


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-71 • Workflow Phase Details View (cont.)

Option Description

Select the Select a Data Element to use as the branching condition.


branching
If one the following is true, the Select the branching condition list will be empty:
condition
• You have not created a Data Group with the When Collected? option set to Later
in the workflow.
• You have created a Data Group with the When Collection? option set to Later in
the workflow but that Data Group does not contain a Data Element with the Data
Type of Single Selection List or Radio Button.
• You have created a Data Group with the When Collection? option set to Later in
the workflow and the Data Group contains a Data Element with the Data Type of
Single Selection List or Radio Button, but the Use to Control Branching
option for that Data Element is set to No.

Note • This option is displayed only if the Define a condition for workflow Branching? option
is set to Yes.

Condition Value / If the Define a condition for workflow branching? option is set to Yes and you
Next Phase List have selected a Data Element from the Select the branching condition list, a table
displaying the possible values for that Data Element is displayed:

• Condition Value—Lists all of the possible responses for the Data Element that
was selected.
• Next Phase—For each Condition Value listed, select the Phase that will be
displayed to users who selected that value.

Create / Update Click to save your entries.

Delete Delete this Workflow Phase.

518 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Workflow Step Details View


On the Workflow Step Details view, which opens when you create a new Workflow Step or edit an existing
Workflow Step on the Template Details page, you build the Workflow Steps of a Workflow Phase.

Figure 8-17: Workflow Step Details View

The Workflow Step Details view consists of the following options:

Table 8-72 • Workflow Phases View / Workflow Steps Area Options

Option Description

Workflow Step Enter a label to identify this Workflow Step.


description

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 519


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-72 • Workflow Phases View / Workflow Steps Area Options (cont.)

Option Description

Step Type Select one of the following Step Types:

• Data Entry/Edit
• Normal
• Update History
• Work Assignment
• Script Execution
• Custom Web Page
• Automated Import
• Automated Validation
• Automated Conflict Analysis

For detailed information on each of these Step Types, see Workflow Step Types.

Track for SLA Select this option to specify that the time spent to perform this Workflow Step will be
included in SLA calculations. Clear this selection to exclude the time from SLA
calculations.

For example, if a Workflow Phase included a Workflow Step such as “Receive Customer
Approval”—which does require any work to be performed by the Servicer— you may
want to clear this option so that the time spent waiting for approval would not be included
in SLA calculations for this Application Request.

Note • SLA (Service Level Agreement) time tracking is used to determine the status of an Application
Request in relationship to its SLA Due Date as either: On Time, At Risk, Late, Completed on Time, or
Completed Late. See Calculating an Application Request’s SLA Status for more information.

Sort Order Enter a number to determine where this Workflow Step will appear in the Workflow Step
list, with lower numbers appearing higher in the list.

Popup HTML File If you selected Normal as Step Type, enter the name of the HTML file that you want the
Step Validation dialog box to display. Click Preview to view the specified HTML file.

Email templates Select the email template to use when this Workflow Step is Initiated, rolled back,
to use edited, or completed. For more information on email templates, see Managing Email
Notifications.

Collect a data If you want to collect a Data Group in this Workflow Step, select Yes and select a Data
group in this Group name from the Select the Data Group list.
workflow step?

Important • If you have not created a Data Group with the When Collected? option set to Later in
the workflow, the Select the Data Group list will be empty.

520 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Workflow Step Types

You can define a Workflow Step with any of the following Step Types:

• Data Entry/Edit

• Normal

• Update History

• Work Assignment

• Script Execution

• Custom Web Page

• Automated Import

• Automated Validation

• Automated Conflict Analysis

Data Entry/Edit
Select this option to specify that user input is required to complete this Workflow Step. This is the only option listed
when you create the first Workflow Step in the first Workflow Phase of a Template.

This step is completed when the Servicer or Customer enters the data defined in this Template's Data Group when
they submit the Application Request. If you are defining a Workflow Step other than the first one in the first
Workflow Phase, this option is not listed.

Normal
When this Workflow Step is performed, the Servicer takes some action, and then, optionally, records the amount of
time that it took to complete this step. The Step Validation dialog box displays the HTML file that was selected in
the Popup HTML File field, along with Time spent unit option buttons, and a Total time spent edit box. If the
user does not enter the time spent, 0 minutes will be recorded for this Workflow Step.

Figure 8-18: Normal Workflow Step

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 521


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Update History
When this Workflow Step is performed, the Servicer is prompted to enter a comment to complete this step. The
Step Validation dialog box displays a text box and Save History and Cancel buttons. This step type is typically used
as the last step in a Workflow Phase to document the completion of the Phase.

Figure 8-19: Update History Workflow Step

522 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Work Assignment
When this Workflow Step is performed, the Assignment Details Page opens and the Servicer is prompted to
assign a person from their Service Company to roles associated with this Application Request.

Figure 8-20: Work Assignment Workflow Step

Script Execution
When a user clicks this Workflow Step name on the Application Progress Page, a user-specified executable file
is launched. This executable could be a batch file, an .EXE, a VB Script file, or any type of executable that will run
on the Server. When this Step Type option is selected, the Script Path list appears listing all of the script files that
a Workflow Manager Administrator has uploaded to the Workflow Manager Web Server location:

AdminStudioEnterprise\wwwroot\ScriptFiles

If no script files have been uploaded, the list is disabled and you are prompted to upload an executable to the
directory.

Note • When a Script Execution Workflow Step is initiated, Workflow Manager launches the executable, logs the
event in the Workflow Manager database, and advances the workflow. However, Workflow Manager will not display
or log any status information about the process that was launched.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 523


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Custom Web Page


When a user clicks this Workflow Step name on the Application Progress Page, Workflow Manager will launch a
user-specified URL address in a new browser window. The user then inputs or processes the information at this
external URL. When this Step Type option is selected, the Custom Site URL text box appears where you enter the
external URL address. When the user has performed the tasks indicated on the Custom Web Page, data will be
sent back to Workflow Manager that will automatically mark this step complete and advance the workflow.

By default, Custom Site URL is set to a Custom Web Page that is shipped with Workflow Manager:

wwwroot/CustomWorkFlow/TestCustomWorkFlow.aspx

You can use this Web Page for testing prior to entering the URL of your Custom Web Page.

The user writing the Custom Web Page is responsible for calling the methods necessary to pass data to Workflow
Manager. The AdvanceWFMinorStep method is used to advance the Workflow Step, the EditWFMinorStep method is
used to make it possible to change the data collected during this step without performing a rollback, and the
RollbackWFMinorStep is used to perform a rollback. See Configuring a Custom Web Page for detailed instructions.

Automated Import
When a user clicks this Workflow Step name on the Application Progress Page, Workflow Manager will run a
user-supplied IPlugin assembly that will programmatically import a package that was uploaded in a previous
Workflow Step into the Application Catalog. After the IPlugin assembly completes, data will be sent back to
Workflow Manager that will automatically mark this step complete and advance the workflow.

Important • In order for Workflow Manager to successfully perform an Automated Import Workflow Step, a
Windows Installer package must have been uploaded to Workflow Manager in a previous Workflow Step in that
Workflow. check mark

In the Custom Site URL text box, which appears when you select Automated Import, enter the external URL
address to the page containing the code that runs the IPlugin assembly. By default, Custom Site URL is set to a
page that is shipped with Workflow Manager:

http://172.17.11.150/CustomWorkflow/AutomatedImportStep.aspx

For additional information on setting up an Automated Import Workflow Step, see the following topics:

• For information on how to create a Workflow Template that contains automated Workflow Steps, see Defining
Automated Import, Validation, and Conflict Analysis Workflow Steps.

• For information on how to set up Workflow Manager automation, see Setting Up IPlugin Automation in
Workflow Manager.

Automated Validation
When a user clicks this Workflow Step name on the Application Progress Page, Workflow Manager will run a
user-supplied IPlugin assembly that will programmatically validate a package that was imported in a previous
Workflow Step. After the IPlugin assembly completes, data will be sent back to Workflow Manager that will
automatically mark this step complete and advance the workflow.

524 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Important • In order to successfully perform an Automated Validation Workflow Step, the following two
statements need to be true:

• A Windows Installer package must have been uploaded to Workflow Manager in a previous Workflow Step in
that Workflow.
• An Automated Validation Workflow Step must be preceded by an Automated Import Workflow Step.

In the Custom Site URL text box, which appears when you select Automated Validation, enter the external URL
address to the page containing the code that runs the IPlugin assembly. By default, Custom Site URL is set to a
page that is shipped with Workflow Manager:

http://172.17.11.150/CustomWorkflow/AutomatedValidationStep.aspx

For additional information on setting up an Automated Import Workflow Step, see the following topics:

• For information on how to create a Workflow Template that contains automated Workflow Steps, see Defining
Automated Import, Validation, and Conflict Analysis Workflow Steps.

• For information on how to set up Workflow Manager automation, see Setting Up IPlugin Automation in
Workflow Manager.

Automated Conflict Analysis


When a user clicks this Workflow Step name on the Application Progress Page, Workflow Manager will run a
user-supplied IPlugin assembly that will programmatically perform conflict analysis on a package that was
imported in a previous Workflow Step. After the IPlugin assembly completes, data will be sent back to Workflow
Manager that will automatically mark this step complete and advance the workflow.

Important • In order to successfully perform an Automated Conflict Analysis Workflow Step, the following two
statements need to be true:

• A Windows Installer package must have been uploaded to Workflow Manager in a previous Workflow Step in
that Workflow.
• An Automated Conflict Analysis Workflow Step must be preceded by an Automated Import Workflow Step.

In the Custom Site URL text box, which appears when you select Automated Conflict Analysis, enter the
external URL address to the page containing the code that runs the IPlugin assembly. By default, Custom Site
URL is set to a page that is shipped with Workflow Manager:

http://172.17.11.150/CustomWorkflow/AutomatedConflictCheckStep.aspx

For additional information on setting up an Automated Import Workflow Step, see the following topics:

• For information on how to create a Workflow Template that contains automated Workflow Steps, see Defining
Automated Import, Validation, and Conflict Analysis Workflow Steps.

• For information on how to set up Workflow Manager automation, see Setting Up IPlugin Automation in
Workflow Manager.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 525


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Workflow Step Condition Area

You can use the properties in the Workflow Step Condition area to make the display of this Workflow Step be
conditional upon the data collected during this Workflow.

Figure 8-21: Workflow Step Condition Area

The Workflow Step Condition area includes the following options:

Table 8-73 • Workflow Step Condition Area

Option Description

Defined Condition Lists any conditions that are assigned to this Workflow Step.

Note • If you are editing a Template that is in use, this field is not available.

Add a Condition Click to display the condition definition fields (Condition Item, Operator,
Selections), where you can define a condition to determine whether or not this
Workflow Step is displayed. For more information, see Setting Up Conditional Display
of Data Groups, Data Elements, or Workflow Steps.

Note • If you are editing a Template that is in use, this field is not available.

526 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-73 • Workflow Step Condition Area (cont.)

Option Description

Condition Item If any of the Data Groups in this Template includes a Data Element that has its Use to
control Branching option set to Yes, that Data Element will be listed in the
Condition Item list.

From the Condition Item list, select the Data Element you want to use to determine if
this Workflow Step is displayed.

• Data Elements are listed in the following format: Data Group - Data Element.
• If no Data Elements in this Template are defined with the Use to control
Branching option selected, the Condition Item list will be empty.

For more information, see Setting Up Conditional Display of Data Groups, Data
Elements, or Workflow Steps.

Operator This field is set to Equals to indicate how to read this condition. For example:

• IF Data Element EQUALS Value(s) THEN display this Workflow Step


• IF Operating System EQUALS Windows XP THEN display this Workflow Step

Selections Lists all values defined for the selected Data Element.

Save Click to create the new condition or update an existing condition.

Clear Click to remove all conditions that have been defined.

Cancel Click to close the expanded Defined Condition area without saving any changes.

External Data Sources Administration Page


If you define a connection to an external data source, you can choose to populate a single-selection list displayed
on an Application Request with real time data values obtained from an associated SQL Server or Oracle database.

To populate a single-selection list with data from an external data source, you have to:

• Define an external data source, as explained in Creating a New External Datasource Connection.

• Create a Data Element with a Data Type of DB-Driven type, as explained in the DB Driven Type portion of
the Defining Data Elements procedure.

All of the defined external data sources are listed on the External Data Sources Administration page, and you
can define a new connection by clicking Add on this page. You open this page by clicking the External Data
Sources tab on the Administration tab.

Note • For more information, see About Using External Datasources.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 527


Chapter 8: Workflow Manager Reference
Administration Pages and Views

The External Data Sources Administration page includes the following:

Table 8-74 • External Data Sources Administration Page

Item Description

Name Name that was assigned to this external data source connection when it was created to
identify it within Workflow Manager. This name is listed in the External Data Source List
on the Data Element Properties view when defining DB Driven Type Data Element.

Server Name of the server that this external data source connects to. For Oracle, it is the local
Net Service name.

User Name The user name of the user that is used to connect to the external database.

Database Name Name of the external database that is connected to.

Database Type Identifies the database type as either SQL Server or Oracle.

Add Click to create a new external data source connection.

External Data Source Details View


If you define a connection to an external data source, you can choose to populate a single-selection list displayed
on an Application Request with real time data values obtained from an associated SQL Server or Oracle database.
You enter the connection information for a data source connection on the External Data Source Details page,
which is opened by clicking Add on the External Data Sources Administration page.

To populate a single-selection list with data from an external data source, first you have to define an external data
source connection, as described in Creating a New External Datasource Connection, and then you have to create
a Data Element with a Data Type of DB-Driven type, as explained in the DB Driven Type portion of the Defining
Data Elements procedure.

Note • For more information, see About Using External Datasources.

On the External Data Sources Administration page, enter the following information:

Table 8-75 • External Data Source Details View

Option Description

Database Type Select the type of database you are connecting to: SQL Server or Oracle.

Datasource Name Enter a user-friendly name to identify this data source within Workflow Manager. This
name will be listed in the External Data Source List on the Data Element
Properties view when defining DB Driven Type Data Element.

528 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-75 • External Data Source Details View

Option Description

Server Enter the name of the Server that this external data source will connect to. For
Oracle, provide the local Net Service name.

Username Enter the user name of the user that will be used to connect to the external
database.

Password Enter the password of the user that will be used to connect to the external database.

Database Name Enter the name of the external database you are connecting to.

Update Click to save entries.

Delete Click to delete this external data source connection.

Terminology Customization Page


From the Terminology Customization page, which is opened by clicking Terminology on the Administration
menu of the Servicer Home page, you can change the terminology used throughout Workflow Manager.

There are approximately 45 terms defined in Workflow Manager that are used throughout the system, such as:
Application Request, Customers, Servicers, Projects, Templates, Data Group, Data Element, etc.

If you feel that changing any of these words would be helpful to your Workflow Manager users, you can make edit
it on the Terminology Customization page, and the term would automatically be updated throughout Workflow
Manager.

Caution • Because making terminology changes make a global impact on Workflow Manager, changes are usually
made infrequently. In order to change system Terminology, you must be assigned to a Role that has the Terminology
View permission assigned.

The Terminology Customization page includes the following options:

Table 8-76 • Terminology Customization Page Options

Option Description

View Terminology Click to view the Terminology Report, which lists all currently defined Workflow
Report Manager terminology.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 529


Chapter 8: Workflow Manager Reference
Administration Pages and Views

Table 8-76 • Terminology Customization Page Options (cont.)

Option Description

[Terminology Listing of all the terms used in Workflow Manager that are available for customization.
Listing] The following columns are included:

• Default System Terms—The terms used by default throughout Workflow


Manager.
• Customized System Terms—The terms as they are used at your organization. If
the term in this column matches the term in the Default System Terms column, this
term has not been customized.
• Description of System Terms—Description of purpose of term, if necessary.

Click on the arrows next to Page n of n to scroll through the pages of terminology. Click
on the column heading to sort the list by that column. When you click on a term, the
Selected Term text boxes below the list are populated.

Selected Term In this area, you can edit the selected term.

• Default System Term—Lists the default system term for the selected term. This
field is read-only.
• Customized System Term—Lists the customized system term. You can edit the
term in this text box.
• Update—Click Update to save your edits or entries.

Terminology Report
The Terminology Report, which is accessed by clicking View Terminology Report on the Terminology
Customization Page, lists all of the terminology used throughout Workflow Manager, and includes the following
information:

• Default System Terms—The terms used by default throughout Workflow Manager.

• Customized System Terms—The terms as they are used at your organization. If the term in this column
matches the term in the Default System Terms column, this term has not been customized.

• Description of System Terms—Description of purpose of term, if necessary.

Unlike the terminology listing on the Terminology Customization page, this listing appears all on one page,
making it suitable for printing.

Caution • Only users assigned to Roles that have the View Terminology permission can view or edit Workflow
Manager terminology.

530 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Dialog Boxes

Dialog Boxes
To learn about a specific Workflow Manager dialog box, click on one of the links below:

• Select External Email Address Dialog Box

• Add User/Group Dialog Box

• Create Application Family Dialog Box

• Dynamic Pick List Dialog Box

• File Upload Dialog Box

• Select User Dialog Box

• Edit Status Comment Dialog Box

• Validate Template Dialog Box

Select External Email Address Dialog Box


The Select External Email Address dialog box opens when you click Add External Email on the Project
Permissions and Notification Settings View or the Application Notifications Override pages.

Figure 8-22: Select External Email Address Dialog Box

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 531


Chapter 8: Workflow Manager Reference
Dialog Boxes

Adding External Email Addresses to the List


From the Select External Email Address dialog box, you can select an existing external email address. To add
new external email addresses to this list, perform the following steps:

Task: To add a new external email address to the Select External Email Address list:

1. On the Workflow Manager Home page, click Email Settings in the Administration menu. The Email
Settings Administration page opens.

2. Click Manage External Email Addresses in the Quick Links menu. The External Email Address
Administration page opens.

3. Click Add. The Add External Email Address view opens.

4. Enter an email address into the Email Address box and click Submit.

Add User/Group Dialog Box


The Add User/Group dialog box opens when you click Add User/Group on the Project Permission and
Notification Settings view to assign email notification events to specific users or groups.

On this dialog box, you can select a Directory Services user or group, as well as a database user.

Select a user, as described in Searching User/Group Listings in Workflow Manager, and click Apply to continue.

Figure 8-23: Add User/Group Dialog Box

532 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Dialog Boxes

About Unimported Directory Services Users


When Workflow Manager performs a search, Directory Services users and groups (and subgroups) in all domains
registered with Workflow Manager are searched, even those that have not yet been imported into the Workflow
Manager database. If you select an unimported user, one of the following will occur:

• For email notification assignment—When an unimported user is selected for email notification
assignment, the user is selected as an external email address only. It is not imported into the Workflow
Manager database.

• All other types of Workflow Manager assignment—When an unimported user is selected for all other
types of Workflow Manager assignments (such as issue assignment, work assignment, Project contact), that
user is automatically imported into the Workflow Manager database.

Create Application Family Dialog Box


This dialog box opens when you click Create New on the Submit Application Request page or on the
Company/Business Unit Details View. Enter a name for the new Application Family and click Add. This dialog
box remains open, allowing you to add additional application families before exiting the dialog box.

For a description of the purpose of application families, see Application Families.

Note • The ability to add to the list of available application families rests with the Service Company and may also
rest with the Customer Company, depending on the choice made when the Service Company was created in
Workflow Manager. See Creating a Service Company.

Dynamic Pick List Dialog Box


When a Data Element defined with a Data Type of Dynamic Pick List is rendered (either during the submission of an
Application Request or as part of a subsequent Workflow Step), this dialog box opens when a user clicks the Click
to Select link next to the Data Element.

The Dynamic Pick List dialog box contains a searchable and sortable list of the data in an XML data source file that
was specified when the Data Element was defined. An XML data source file can have multiple columns, but only
one column value is passed to Workflow Manager when an item is selected. By default, the value in the first column
of the XML file is passed to Workflow Manager for each selected item, but a different column can be selected when
the Data Element is defined.

After the user selects one or multiple items in the Dynamic Pick List and clicks OK, the selected values then
populate the text area, with entries separated by pipes.

Note • You can use the Search for [TEXT] in [COLUMN NAME] feature to quickly find the list items that you want to
select. See Using List Features for more information.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 533


Chapter 8: Workflow Manager Reference
Dialog Boxes

File Upload Dialog Box


On the File Upload dialog box, you can upload one or multiple files. Specify the path names of all of the files you
want to upload, and then click Upload Now to start uploading the files in the Upload File List. The Upload Progress
Dialog Box appears, displaying progress information, and notifying you when the upload is complete.

Table 8-77 • File Upload Dialog Box Options

Option Description

Browse Click to select a file to upload. The file’s path name is listed in the text box.

Add to Upload List After you have used the Browse button to select a file to upload, click this button to
add the selected file to the Upload File List. There is no limit on the number of files
you can upload.

Upload File List Lists all of the files that you have selected to upload.

Remove All Click to clear the Upload File List.

Upload Now Click to start uploading the files in the Upload File List.

Cancel Click to cancel the file upload and close this dialog box.

Note • You can upload files of any size without causing a time-out error. When uploading a file, Workflow Manager
streams the data into a disk file instead of receiving the entire upload request in memory, so the only limitation to file
size would be the amount of free disk space at the location of the uploaded files.

Select User Dialog Box


The Select User dialog box opens when you:

• Click Assign Customer Contact or Assign Servicer Contract on the Project Details view.

• Click Assign User on Issue Details view.

On this dialog box, you can select a Directory Services user or a database user.

Select a user, as described in Searching User/Group Listings in Workflow Manager, and click Apply to continue.

534 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Dialog Boxes

About Unimported Directory Services Users


When Workflow Manager performs a search, Directory Services users and groups (and subgroups) in all domains
registered with Workflow Manager are searched, even those that have not yet been imported into the Workflow
Manager database. If you select an unimported user, one of the following will occur:

• For email notification assignment—When an unimported user is selected for email notification
assignment, the user is selected as an external email address only. It is not imported into the Workflow
Manager database.

• All other types of Workflow Manager assignment—When an unimported user is selected for all other
types of Workflow Manager assignments (such as issue assignment, work assignment, Project contact), that
user is automatically imported into the Workflow Manager database.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 535


Chapter 8: Workflow Manager Reference
Dialog Boxes

Edit Status Comment Dialog Box


This dialog box appears when you open an application in the Application Progress page and click Edit Status
Comment in the Quick Links menu.

Figure 8-24: Edit Status Comment Dialog Box

Enter the comment in the text box and then click Save.

The text that you enter here will appear in the Comment text box on the Properties tab of the Application
Progress page.

Validate Template Dialog Box


The Validate Template dialog box appears when you select Validate Template on the Template Options menu on
the Template Details page.

Figure 8-25: Template Options Menu

536 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Configuration File: web.config

When you click Validate Template, Workflow Manager analyzes the current template to determine if it is ready for
use. Then, the Validate Template dialog box opens stating whether or not the template is valid. If it is invalid, the
reasons will be listed.

A template would be invalid, for example, if a Workflow Phase does not contain any Workflow Steps, or if a Data
Group did not contain any Data Elements, etc.

Configuration File: web.config


The Workflow Manager Configuration file, named web.config, is located in the Workflow Manager Web Application
wwwroot directory.

The settings that are defined in the web.config file are presented in the following sections:

• Connection Settings

• Timeout Settings

• Application Request-Related Settings

• Email Settings

• List Settings

Connection Settings
The following connection settings are defined in web.config:

• Database Connection String for ASP.net Pages

• Database Connection String for ASP Pages

• Workflow Manager Web Services URL

• AdminStudio Enterprise Platform

• Web Service Bridge to AdminStudio

Database Connection String for ASP.net Pages


Workflow Manager uses the value of connectionStrings setting in the web.config file to connect to the Workflow
Manager database from ASP.net pages.

The default value of this setting is:

<connectionStrings>
<add name="DefaultConnectionString" connectionString="Data Source=SERVERNAME;
Initial Catalog=CATALOGNAME;Persist Security Info=True;User ID=sa;Password=sa"
providerName="System.Data.SqlClient"/>
</connectionStrings>

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 537


Chapter 8: Workflow Manager Reference
Configuration File: web.config

The first connection string, DefaultConnectionString, is used to describe the database that needs to be
connected to from ASP.net pages.

The second connection string, StandardConnectionString, is used by the Report Control in Report Center.

To modify the database connection string for ASP.net pages, perform the following steps.

Task: To modify the database connection string for ASP.net pages:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the connectionStrings portion of this file.

<connectionStrings>
<add name="DefaultConnectionString" connectionString="Data Source=TESTLABSQL2K;
Initial Catalog=WM31TO35;Persist Security Info=True;User ID=sa;Password=sa"
providerName="System.Data.SqlClient"/>
</connectionStrings>

3. The first connection string, DefaultConnectionString, is used to describe the database that needs to be
connected to from ASP.net pages. Modify this connection string by using the following syntax:

String Default How to Modify

Data Source Data Source=TESTLABSQL2K; Replace the default value for Data Source with the
name of the database that you want to connect to:

Data Source=MYDATABASE;

Initial Catalog Initial Catalog=WM31TO35; The Initial Catalog string is used internally by
AdminStudio Enterprise Server and should not be
modified.

Persist Persist Security Info=True; The Persist Security Info string specifies
Security Info whether the connection persists (caches) the
password information used while connecting, and
should not be modified.

User ID User ID=sa; Replace the value of User ID with a valid User ID for
the specified database:

User ID=myuserid;

Password Password=sa; Replace the value of Password with a valid password


for the specified database and User ID:

Password=mypassword;

538 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Configuration File: web.config

4. The second connection string, StandardConnectionString, is used by the Report Control in Report Center.
Modify this connection string by using the following syntax:

String Default How to Modify

Data Source Data Source=TESTLABSQL2K; Replace the default value for Data Source with the
name of the database that you want to connect to:

Data Source=MYDATABASE;

Persist Persist Security Info=True; The Persist Security Info string specifies whether
Security the connection persists (caches) the password
Info information used while connecting, and should not be
modified.

User ID User ID=sa; Replace the value of User ID with a valid User ID for
the specified database:

User ID=myuserid;

Password Password=sa; Replace the value of Password with a valid password


for the specified database and User ID:

Password=mypassword;

Database Connection String for ASP Pages


Workflow Manager uses the value of SQLConnectionString setting in the web.config file to connect to the Workflow
Manager database from .asp pages. The default value of this setting is:

<!--Database connection string for ASP pages-->


<add key="SQLConnectionString" value="Driver={SQL Server}; server=.; database=wm; uid=sa; pwd=sa;
Max Pool Size=50000;"/>

To modify the database connection string for .asp pages, perform the following steps.

Task: To modify the database connection string for .asp pages:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the Database connection string for ASP pages portion of this file.

<add key="SQLConnectionString" value="Driver={SQL Server}; server=.; database=wm; uid=sa;


pwd=sa; Max Pool Size=50000;"/>

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 539


Chapter 8: Workflow Manager Reference
Configuration File: web.config

3. Modify the database connection string using the following syntax:

String Default How to Modify

Server Name server=.; Replace the default value for server (a period) with the name of the
server that contains the database that you want to connect to:

server=myservername;

Database database=wms; Replace the value for database with the name of the database that
Name you want to connect to:

database=mydatabasename;

User ID uid=sa; Replace the value of uid with a valid User ID for the specified
database:

uid=myuserid;

Password pwd=sa Replace the value of pwd with a valid password for the specified
database and User ID:

pwd=mypassword;

Workflow Manager Web Services URL


The AdminStudioWebSvc setting identifies the IP address of the Workflow Manager application Web Site. The default
value of this setting in web.config is:

<!--AdminStudioWebSvc URL (this service provides information about AdminStudio)-->


<add key="ASDataServiceProxy.localhost.AdminStudioWebSvc" value=
"http://localhost/Webservicesroot/ASDataService/AdminStudioWebSvc.asmx"/>

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the ASDataServiceProxy portion of this file.

<add key="ASDataServiceProxy.localhost.AdminStudioWebSvc"
value="http://localhost/Webservicesroot/ASDataService/AdminStudioWebSvc.asmx"/>

3. To modify the IP address of the Workflow Manager application Web Site, change the root directory of the URL
(http://localhost in this example) to the new IP address. For example:

<add key="ASDataServiceProxy.localhost.AdminStudioWebSvc"
value="http://178.22.333.44/Webservicesroot/ASDataService/AdminStudioWebSvc.asmx"/>

540 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Configuration File: web.config

AdminStudio Enterprise Platform


Before you can access the AdminStudio Enterprise Server, you need to make a modification to the Workflow
Manager web.config file. The default value of this setting in web.config is:

<!-- URL for AdminStudio Enterprise Platform -->


<add key="PlatFormURL" value="" />

Task: To connect to the AdminStudio Enterprise Server:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the PlatFormURL portion of this file:

<add key="PlatFormURL" value="" />

3. Enter the URL of your AdminStudio Enterprise Server as the value for the PlatFormURL using the following
format:

<add key="PlatFormURL" value="http://178.22.333.44" />

Web Service Bridge to AdminStudio


As explained in Integrating AdminStudio and Workflow Manager, you can integrate Workflow Manager with
AdminStudio to make software packaging procedures easier and more efficient. Integration with AdminStudio
enables you to:

• Launch Workflow Manager inside of the AdminStudio interface.

• Define a Workflow Manager Workflow Phase as an AdminStudio Workflow Project, and receive
progress notification from AdminStudio as the Project Steps are completed.

• Share application-related data between AdminStudio and Workflow Manager using AdminStudio
Extended Attributes and Workflow Manager Data Groups.

• Open the AdminStudio Report Center from the Workflow Manager All Reports Page and view reports
that give you a centralized view of information regarding packages in the Application Catalog.

The default value of the AttributeBridgeWebServiceUrl setting in web.config is:

<!--This is a Web service talk to the AdminStudio Web service to import the extended attributes. It
was used by ASP pages, now it is used by .net pages (this service can be removed later)-->
<add key="AttributeBridgeWebServiceUrl" value="http://localhost/ASInterfaceBridge/
AttributeBridge.asmx"/>

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 541


Chapter 8: Workflow Manager Reference
Configuration File: web.config

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the AttributeBridgeWebServiceUrl portion of this file.

<add key="AttributeBridgeWebServiceUrl" value="http://localhost/ASInterfaceBridge/


AttributeBridge.asmx"/>

3. To modify the IP address of the connection to AdminStudio, change the root directory of the URL (http://
localhost in this example) to the new IP address. For example:

<add key="AttributeBridgeWebServiceUrl" value="http://178.22.333.44/ASInterfaceBridge/


AttributeBridge.asmx"/>

Timeout Settings
The following timeout settings are defined in web.config:

• HTTP Request Length and Execution Timeout

• Login Page Timeout Value

• System Session Mode Value

• Set System Authentication to “Forms”

HTTP Request Length and Execution Timeout


You can specify the maximum file upload size supported by ASP.NET, and the maximum time that a request is
allowed to execute before being automatically shut down by ASP.NET.

The default value of this setting in web.config is:

<!--Set http request length and execution timeout-->


<httpRuntime maxRequestLength="614400" executionTimeout="2400" />

Task: To modify these settings:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the maxRequestLength portion of this file:

<!--Set http request length and execution timeout-->


<httpRuntime maxRequestLength="614400" executionTimeout="2400" />

3. To specify the maximum file upload size supported by ASP.NET, edit the value for maxRequestLength. This limit
can be used to prevent denial of service attacks caused by users posting large files to the server. By default,
the value is 614400.

542 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Configuration File: web.config

4. To specify the maximum number of seconds that a request is allowed to execute before being automatically
shut down by ASP.NET, edit the value for executionTimeout. By default, the value is 2400.

Login Page Timeout Value


The LoginPageTimeOut setting identifies the length of time that you can leave the login page open before it times
out. The default value of this setting in web.config is:

<!--If a user keeps the login page open for too long, he will run into an error as the system's
session is time out. This LoginPageTimeOut setting will change the front login page after the time
valued (in minutes), so the user has to re-visit the site and obtain a new session.-->
<add key="LoginPageTimeOut" value="19.5" />

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the LoginPageTimeOut portion of this file.

<add key="LoginPageTimeOut" value="19.5" />

3. Set the value to the number of minutes that the login page can remain open before it times out and requires
the user to refresh the login screen to obtain a new session. Set this value to match the timeout value you
specified for System Session Mode Value.

System Session Mode Value


You can change the session timeout value by editing the sessionState timeout value in the web.config file. The
default value of this setting in web.config is:

<!--Set system session mode-->


<sessionState timeout="20" mode="InProc" stateConnectionString="tcpip=127.0.0.1:42424"
sqlConnectionString="data source=127.0.0.1;Trusted_Connection=yes" cookieless="false" />

Task: To change the session timeout value:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the sessionState timeout portion of this file:

<sessionState timeout="20" mode="InProc" stateConnectionString= "tcpip=127.0.0.1:42424"


sqlConnectionString="data source=127.0.0.1; Trusted_Connection=yes" cookieless="false" />

3. Change the value specified for sessionState timeout="nn" to the new timeout value, in minutes. Set this
value to match the timeout value you specified for Login Page Timeout Value.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 543


Chapter 8: Workflow Manager Reference
Configuration File: web.config

Set System Authentication to “Forms”


You can set the forms timeout value to specify the number of minutes a user can be inactive before Workflow
Manager automatically logs them out of a session. The default value of this setting in web.config is:

<!-- Set the system authentication to "Forms"-->


<authentication mode="Forms" >
<forms timeout="20" name="AMMS.ASPXAUTH" loginUrl="login.aspx" protection="All" path="/" />
</authentication>

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the forms timeout portion of this file:

<authentication mode="Forms" >


<forms timeout="20" name="AMMS.ASPXAUTH" loginUrl="login.aspx" protection="All" path="/" />
</authentication>

3. Set the timeout value to the number of minutes a user can be inactive before Workflow Manager automatically
logs them out of a session.

Application Request-Related Settings


The following Application Request-related settings are defined in web.config:

• Auto-Acceptance of Submitted Data

• Guest System Access

• Setting the Default AdminStudio User Work Assignment

• Project Summary Page Workflow Percentage Display Setting

• Root Folder for Uploading and Downloading Files

• SLA Disable/Enable Flag

Auto-Acceptance of Submitted Data


By default, each time someone submits data as part of an Application Request, that data needs to be accepted or
rejected before that Workflow Step can be marked complete.

544 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Configuration File: web.config

The default value of this setting in web.config is 0, meaning that submitted data must be accepted manually:

<add key="AutoAcceptApplicationSubmissions" value="0"></add>

If you change the value of this setting to 1, submitted data would always be automatically accepted, meaning that
the Accept Data and Reject Data buttons would not appear.

Task: To turn on the auto-acceptance feature:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the AutoAcceptApplicationSubmissions portion of this file:

<add key="AutoAcceptApplicationSubmissions" value="0"></add>

3. Set the AutoAcceptApplicationSubmissions value to 1:

<add key="AutoAcceptApplicationSubmissions" value="1"></add>

Guest System Access


You can set up a Guest account to permit users without Workflow Manager login credentials to access features –
such as viewing Reports or searching for an Application Request – without entering a User ID or Password.

The default value of this setting in web.config is:

<!-- Guest System Access -->


<add key="GuestAccount" value="" />

Task: To specify the Guest Account:

1. Create a new Workflow Manager user to use as the Guest Account.

2. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

3. Locate the GuestAccount portion of this file:

<add key="GuestAccount" value="" />

4. Set the GuestAccount value to the name of the Workflow Manager user that you just created:

<add key="GuestAccount" value="username@companyname.com" />

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 545


Chapter 8: Workflow Manager Reference
Configuration File: web.config

Setting the Default AdminStudio User Work Assignment


You can modify the ASProjectOwner setting to specify which AdminStudio user is automatically assigned to an
AdminStudio Project that is created as part of a Workflow Manager Phase. The default value of this setting in
web.config is:

<!--Default AdminStudio project owner-->


<add key="ASProjectOwner" value="admin@servicer.com" />

By default, an AdminStudio Project is automatically assigned to the AdminStudio user named


admin@servicer.com.

Task: To set the default AdminStudio user Work Assignment:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the Default AdminStudio project owner portion of this file:

<add key="ASProjectOwner" value="admin@servicer.com" />

3. Edit the following line:

<add key="ASProjectOwner" value="admin@servicer.com" />

Project Summary Page Workflow Percentage Display Setting


You can edit the ApplicationListQuickView setting to specify whether or not you want the percentage complete
value to be displayed on the Workflow Manager Project Summary page. The default value of this setting in
web.config is True, which means that the Workflow percentage will not be displayed on the Project Summary
page:

<!--In the Project Summary page, the system will not display the WF percentage in order to show the
page quickly, if this value is set to "True"-->
<add key="ApplicationListQuickView" value="True" />

While it might be helpful to see the percentage complete value of a Workflow Phase on the Project Summary page,
it could cause performance delays if you are viewing a long list of Projects and Application Requests.

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the ApplicationListQuickView portion of this file:

<add key="ApplicationListQuickView" value="True" />

3. To turn on the display of percentage complete on the Project Summary page, set this value to False:

<add key="ApplicationListQuickView" value="False" />

546 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Configuration File: web.config

Project Report Time Spent on Each Phase Display Setting


You can edit the ShowPhaseAvgTimeInProjectRpt setting to specify whether or not you want the average time spent
by Application Requests in each Phase to be displayed on the Project Report. The default value of this setting in
web.config is 0, which means that the average time spent will not be displayed on the Project Report:

<!-- ShowPhaseAvgTimeInProjectRpt-->
<!-- 0 means Project Report does not show Average Time Spent by Applications on each Phase-->
<!-- 1 means Project Report shows Average Time Spent by Applications on each Phase-->
<add key="ShowPhaseAvgTimeInProjectRpt" value="0" />

While it might be helpful to see the average time spent by Application Requests in each Phase to be displayed on
the Project Report, it could cause performance delays if you are generating a Project Report that includes multiple
Projects.

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the ShowPhaseAvgTimeInProjectRpt portion of this file:

<add key="ShowPhaseAvgTimeInProjectRpt" value="0" />

3. To turn on the display of average time spent by Application Requests in each Phase, set this value to 1:

<add key="ShowPhaseAvgTimeInProjectRpt" value="1" />

Root Folder for Uploading and Downloading Files


You can modify the FileShareRoot setting to specify the Workflow Manager File server, the root folder for
uploading and downloading files to Workflow Manager. The default value of this setting in web.config is:

<!--Root folder for uploading and downloading files-->


<add key="FileShareRoot" value="\\SERVER\AMS$"/>
XXXXXX
<add key="FileShareRoot" value="\\schfiler\Scratch\AdminStudio"/>

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the FileShareRoot folder portion of this file:

<add key="FileShareRoot" value="\\SERVER\AMS$"/>

3. Modify the FileShareRoot value to include the new location of the File Server, such as:

<add key="FileShareRoot" value="\\MYSERVER\WMFILES"/>

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 547


Chapter 8: Workflow Manager Reference
Configuration File: web.config

SLA Disable/Enable Flag


The SLADisabled key in the web.config file is no longer used by Workflow Manager.

Email Settings
The following email settings are defined in web.config:

• Email Server URL

• SMTP Authentication Type

• Send One Email to All Users

• Send Email to Automatically Imported Members of a Directory Service Group

• Send Email as BCC

• System Email Sender’s Email Address

• System Email Subject

• Location of Email Template Folder and Template Files

• System Support Email Address

• Company Name for Email Notification

Email Server URL


The AMSSMTPServer setting in the web.config file is the address of your email server, such as:

smtp.yourcompany.com

The default value of this setting in web.config is:

<!--Email Server URL-->


<add key="AMSSMTPServer" value="smtp.installshield.com"/>

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the AMSSMTPServer portion of this file:

<add key="AMSSMTPServer" value="smtp.installshield.com"/>

3. Set the value to the name of your email server, such as:

<add key="AMSSMTPServer" value="smtp.yourcompany.com"/>

548 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Configuration File: web.config

SMTP Authentication Type


The value that is entered for SmtpAuthenticationType determines if Workflow Manager email is authenticated and
how it is authenticated.

The default value of this setting in web.config is:

<!-- SMTP Authentication Type-->


<!-- 0 means "Perform no authentication"-->
<!-- 1 means "Use the basic (clear text) authentication mechanism"-->
<!-- 2 means "Use the NTLM authentication mechanism."-->
<add key="SmtpAuthenticationType" value="0" />

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the SMTP Authentication Type portion of this file:

<add key="SmtpAuthenticationType" value="0" />

3. Enter one of the following values for the SmtpAuthenticationType key:

Value Description

0 Enter this value if you do not want to perform authentication on Workflow Manager email.

1 Enter this value if you want to use the basic (clear text) authentication mechanism to
authenticate Workflow Manager email.

2 Enter this value if you want to use the NTLM authentication mechanism to authenticate
Workflow Manager email.

Send One Email to All Users


Workflow Manager uses email as the notification mechanism for various events. Email is sent when an issue is
raised or responded to; a Workflow Step is advanced, edited, completed, or rolled back; and when a Data Element
(metadata) is submitted or rejected.

In this portion of web.config, you can specify whether you want Workflow Manager to send one email to all of the
specified users, or to send a separate email to each specified user.

The default value of this setting in web.config is:

<!-- SendOneEmailToAllUsers-->
<!-- 0 means Send separate emails to each user-->
<!-- 1 means Send one email to all users-->
<add key="SendOneEmailToAllUsers" value="1" />

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 549


Chapter 8: Workflow Manager Reference
Configuration File: web.config

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the SendOneEmailToAllUsers portion of this file:

<add key="SendOneEmailToAllUsers" value="1" />

3. Set SendOneEmailToAllUsers to one of the following values:

• 0—Send separate emails to each user

• 1—Send one email to all users.

Send Email to Automatically Imported Members of a Directory Service


Group
In this portion of web.config, you can specify whether you want Workflow Manager to send emails to users who
were imported as part of an Directory Service group.

The default value of this setting in web.config is:

<!-- SendEmailToAutoImportedUsers-->
<!-- 0 means Do not send Emails to All users (who were automatically imported)
of a LDAP Group, if a Role is applied to a group-->
<!-- Setting this to 1 will send email notifications to all automatically imported members
of a Group that was set to receive Email Notifications.-->
<add key="SendEmailToAutoImportedUsers" value="0"/>

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the SendEmailToAutoImportedUsers portion of this file:

<add key="SendEmailToAutoImportedUsers" value="0"/>

3. Set SendEmailToAutoImportedUsers to one of the following values:

• 0—If a Directory Service group was assigned a Role that was selected to receive notification emails, do
not send emails to all automatically imported members of that Directory Service group.

• 1—If a Directory Service group was assigned a Role that was selected to receive notification emails, send
emails to all automatically imported members of that Directory Service group.

Send Email as BCC


In the SendEmailAsBCC portion of web.config, you specify whether email recipients can see the email address of
the other users that are receiving that same email.

550 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Configuration File: web.config

The default value of this setting in web.config is:

<!-- SendEmailAsBCC-->
<!-- 0 means recipients can see the email address of other users who are getting emails-->
<!-- 1 means recipients cannot see the email address of other users who are getting emails-->
<add key="SendEmailAsBCC" value="0" />

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the SendEmailAsBCC portion of this file:

<add key="SendEmailAsBCC" value="0" />

3. Set SendEmailAsBCC to one of the following values:

• 0—Recipients can see the email address of other users who are getting emails.

• 1—Recipients cannot see the email address of other users who are getting emails.

System Email Sender’s Email Address


You modify the AMSEmailAddress setting in web.config to specify the Workflow Manager system email address. All
emails sent by Workflow Manager would be from this email address. The default value of this setting in web.config
is:

<!--System Email sender's email address-->


<add key="AMSEmailAddress" value="noreply@installshield.com"/>

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the AMSEmailAddress portion of this file:

<add key="AMSEmailAddress" value="noreply@installshield.com"/>

3. Set the value to the email address that you want to use for the Workflow Manager system email account.

System Email Subject


You modify the EmailSubject setting in web.config to specify the subject line that is displayed each time Workflow
Manager sends out an email. The default value of this setting in web.config is:

<!--System Email subject-->


<add key="EmailSubject" value="[AMS] %CUSTNAME% %APPNAME%"/>

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 551


Chapter 8: Workflow Manager Reference
Configuration File: web.config

Note • You can use text and replaceable parameters (system variables) when defining the value of the
EmailSubject. For a list of replaceable parameters, see Using Replaceable Parameters in Email Templates

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the EmailSubject portion of this file:

<add key="EmailSubject" value="[AMS] %CUSTNAME% %APPNAME%"/>

3. Specify the value of the EmailSubject, using a combination of text and replaceable parameters, as described
in Using Replaceable Parameters in Email Templates.

Location of Email Template Folder and Template Files


Outgoing email is based on customizable email templates. The email templates are stored as text files in the
following directory:

AdminStudioEnterprise\wwwroot\EmailTemplate

To change the location of email templates at your organization, you can update an entry in the Workflow Manager
Web site web.config file.

The default value of this setting in web.config is:

<!--Email template folder and template files-->


<add key="AMSEmailTemplateFolder" value="EmailTemplate"/>
<add key="IssueCreationTemplate" value="IssueCreation.txt"/>
<add key="IssueResponseTemplate" value="IssueResponse.txt"/>
<add key="WFAdvancedTemplate" value="WFAdvanced.txt"/>
<add key="WFRollbackTemplate" value="WFRollback.txt"/>
<add key="DataChangedTemplate" value="DataChanged.txt"/>
<add key="SLABreakageTemplate" value="NewSLABreakage.txt"/>
<add key="SLARiskTemplate" value="NewSLARisk.txt"/>
<add key="DataChangedTemplateNewRequest" value="DataChangedNewRequest.txt"/>
<add key="ApplicationStatusChangedTemplate" value="ApplicationStatusChanged.txt"/>

When you select an email template to use when defining a Workflow Step or an issue, all of the templates in this
location will be included in the selection list. To add a new email template to the system, copy the text file into this
email templates folder.

Task: To modify these settings

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the Email template folder and template files portion of this file.

<add key="AMSEmailTemplateFolder" value="EmailTemplate"/>

552 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Configuration File: web.config

<add key="IssueCreationTemplate" value="IssueCreation.txt"/>


<add key="IssueResponseTemplate" value="IssueResponse.txt"/>
<add key="WFAdvancedTemplate" value="WFAdvanced.txt"/>
<add key="WFRollbackTemplate" value="WFRollback.txt"/>
<add key="DataChangedTemplate" value="DataChanged.txt"/>
<add key="SLABreakageTemplate" value="SLABreakage.txt"/>
<add key="SLARiskTemplate" value="SLARisk.txt"/>
<add key="DataChangedTemplateNewRequest" value="DataChangedNewRequest.txt"/>
<add key="ApplicationStatusChangedTemplate" value="ApplicationStatusChanged.txt"/>

3. Specify the default folder for the email templates, and the default template files to use for each type of email
event.

System Support Email Address


You can modify the SupportEmail setting in web.config to indicate the email address that your users can use to
contact on-site Workflow Manager support. The default value of this setting in web.config is:

<!--system support email address-->


<add key="SupportEmail" value="noreply@installshield.com"/>

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the SupportEmail portion of this file:

<add key="SupportEmail" value="noreply@installshield.com"/>

3. Specify the System Support email address that you want to use.

Company Name for Email Notification


You can specify the company name that is used in the body of Workflow Manager emails by modifying the
AMSCompanyName setting in the web.config file. This would usually be set to the name of the primary Service
Company. The default value of this setting in web.config is:

<!--Company name-->
<add key="AMSCompanyName" value="InstallShield"/>

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the AMSCompanyName portion of this file:

<add key="AMSCompanyName" value="InstallShield"/>

3. Enter the company name to use in Workflow Manager emails.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 553


Chapter 8: Workflow Manager Reference
Configuration File: web.config

List Settings
The following list settings are defined in the web.config file:

• Default Number of Lines Displayed in Lists

• Default Font for Lists

Default Number of Lines Displayed in Lists


You can edit the ApplicationGridSize value to specify the number of lines that are displayed in listings. The
default value of this setting in web.config is:

<!--In the project summary page, number of lines shows up in the data grid-->
<add key="ApplicationGridSize" value="45" />

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the ApplicationGridSize portion of this file:

<add key="ApplicationGridSize" value="45" />

3. Specify the number of lines that you want to be displayed in listings.

Default Font for Lists


You can modify the WebGridFontName value in the web.config file to set the default font that is used in Workflow
Manager data listings. The default value of this setting in web.config is:

<!-- Default Font Name for WebGrid-->


<add key="WebGridFontName" value="Tahoma" />

Task: To modify this setting:

1. Open the wwwroot directory of the Workflow Manager installation and open web.config in a text editor.

2. Locate the WebGridFontName portion of this file:

<add key="WebGridFontName" value="Tahoma" />

3. Specify the name of the font you want Workflow Manager to use in all listings.

554 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Extending Workflow Manager

Extending Workflow Manager


The following are the officially supported mechanisms for extending Workflow Manager:

Table 8-78 • Methods to Extend Workflow Manager

Topic Description

Using the IPlugin The IPlugin interface is the interface your custom plugins should implement. The
Interface interface defines some standard callback methods which will be called by Workflow
Manager during the course of Application Request submission and Workflow
advancement. Your custom implementation of this plugin can have custom code to
link these events with external systems.

Topics include:

• How to Use the IPlugin Interface


• IPlugin Methods
• Data Passed in XML to IPlugin Methods
• Setting Up IPlugin Automation in Workflow Manager
• Defining Automated Import, Validation, and Conflict Analysis Workflow Steps

Defining a Database- Explains how to create a single-selection list Data Element that is populated with real
Driven Data Element time data values obtained from an associated SQL Server database.

Using Replaceable Explains how to use replaceable parameters in Workflow Manager email templates
Parameters in Email that are replaced with data before an email is sent.
Templates

Configuring a Explains how to create a Workflow Template with a Workflow Step that will launch a
Custom Web Page user-specified custom Web page. When the user has performed the tasks indicated
on the custom Web page, data will be sent back to Workflow Manager that will
automatically mark this step complete and advance the workflow.

Generating a Custom Explains how to generate a Report Center report by entering an SQL Query to
SQL Query Report retrieve data from the Workflow Manager database.

Using the IPlugin Interface


The IPlugin interface is the interface your custom plugins should implement. The interface defines some standard
callback methods which will be called by Workflow Manager during the course of Application Request submission
and Workflow advancement. Your custom implementation of this plugin can have custom code to link these events
with external systems.

For more information on using the IPlugin interface, see the following:

• How to Use the IPlugin Interface

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 555


Chapter 8: Workflow Manager Reference
Using the IPlugin Interface

• IPlugin Methods

• Data Passed in XML to IPlugin Methods

• Setting Up IPlugin Automation in Workflow Manager

How to Use the IPlugin Interface


The IPlugin.sln solution file can be used as a basis to build Enterprise business logic. To use the IPlugin interface
to create custom functionality, perform the following steps.

Task: To modify the IPlugin solution file:

1. Open Visual Studio .NET 2003 and open the IPlugin.sln solution file found in the following location:

AdminStudioEnterprise/wwwroot/IPlugin/Test

2. Modify the code using the methods described below.

3. In Visual Studio .NET 2003, click the Build button. A file named IPlugin.Test.dll is created in that solution’s
Output directory.

4. Copy the IPlugin.Test.dll file from the Output directory to the following directory:

AdminStudioEnterprise/wwwroot/bin/Plugins

556 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Using the IPlugin Interface

IPlugin Methods
The IPlugin interface implements the following methods:

• AppBinariesSubmitted Method

• AppRequestSubmitted Method

• AppMetaDataChanged Method

• AppRepackageApproved Method

• AppWorkflowStepInitiated Method

• AppWorkflowStepComplete Method

• AsyncOperationCompleted Method

AppBinariesSubmitted Method
This method is called for an event when application binaries are submitted. This callback can be used to trigger
external events when application binaries are uploaded via a Workflow.

Syntax
This method has the following syntax:

AppBinariesSubmitted(System.String,System.String)

Parameters
This method implements the following parameters:

Table 8-79 • AppBinariesSubmitted Method Parameters

Parameter Description

strAppId Application ID of the Application Request

strAppXMLInfo Contains the application info XML

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 557


Chapter 8: Workflow Manager Reference
Using the IPlugin Interface

AppRequestSubmitted Method
This method is a callback for an event when Application Request is submitted. This callback can be used to trigger
external events/notifications when a new Application Request is submitted.

Syntax
This method has the following syntax:

AppRequestSubmitted(System.String,System.String)

Parameters
This method implements the following parameters:

Table 8-80 • AppRequestSubmitted Method Parameters

Parameter Description

strAppId Application ID of the newly submitted Application Request

strAppXMLInfo Contains the application info XML

AppMetaDataChanged Method
This method is called when application metadata is changed after being accepted. Use this callback to get
notifications of any metadata change after an Application Request has been submitted.

Syntax
This method has the following syntax:

AppMetaDataChanged(System.String,System.String)

Parameters
This method implements the following parameters:

Table 8-81 • AppMetaDataChanged Method Parameters

Parameter Description

strAppId Application ID of the Application Request

strAppXMLInfo Contains the application info XML

558 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Using the IPlugin Interface

AppRepackageApproved Method
This method is called when an Application Request Workflow is completed. Use this callback to trigger external
events/notifications when a Workflow is completed.

Syntax
This method has the following syntax:

AppRepackageApproved(System.String,System.String)

Parameters
This method implements the following parameters:

Table 8-82 • AppRepackageApproved Method Parameters

Parameter Description

strAppId Application ID of the Application Request

strAppXMLInfo Contains the application info XML

AppWorkflowStepInitiated Method
This method is called whenever a Workflow Step is initiated.

Syntax
This method has the following syntax:

AppWorkflowStepInitiated(System.String,System.String)

Parameters
This method implements the following parameters:

Table 8-83 • AppWorkflowStepInitiated Method Parameters

Parameter Description

strAppId Application ID of the Application Request

strAppXMLInfo Contains the application info XML

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 559


Chapter 8: Workflow Manager Reference
Using the IPlugin Interface

AppWorkflowStepComplete Method
This method is called whenever a Workflow Step is completed.

Syntax
This method has the following syntax:

AAppWorkflowStepComplete(string strAppId, string strAppXMLInfo)

Parameters
This method implements the following parameters:

Table 8-84 • AppWorkflowStepComplete Method Parameters

Parameter Description

strAppId Application ID of the Application Request

strAppXMLInfo Contains the application info XML

AsyncOperationCompleted Method
The AsyncOperationCompleted method is called when an automated Workflow Step or operation is finished. It is
called only in response to the previous calling of one of the RunAsync methods (RunAsyncImport,
RunAsyncConflicts, or RunAsyncValidate).

Syntax
This method has the following syntax:

AsyncOperationCompleted(string ApplicationID, string OperationType, string OperationResults)

Parameters
This method implements the following parameters:

Table 8-85 • AsyncOperationCompleted Method Parameters

Parameter Description

ApplicationID A known value.

OperationType Step Type identifier, which maps to the type of RunAsync method called.

OperationResults Large XML based string with detailed information about how the operation performed.

560 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Using the IPlugin Interface

Data Passed in XML to IPlugin Methods


When IPlugin methods pass Application Request data to the Workflow Manager database, it is in the following XML
format:

<ApplicationInfo>
<CompanyName>Requester</CompanyName>
<AppId>876fb7b8-c51b-4aba-a3bc-7f19f7aebdae</AppId>
<AppSName>AppName</AppSName>
<AppLName>AppNameLong</AppLName>
<UserName>7b31351c-f90c-4966-a61b-4d4626d86037</UserName>
<StepID>e2c568c9-b9a6-46df-aecd-20c715cb277f</StepID>
<PhaseID>da1f2878-de05-471b-8043-45b62990c7e6</PhaseID>
<StepName>SomeWorkflowStep</StepName>
<StepType>14</StepType>
<BinaryFiles>
<BinaryFile>
<BinaryName />
<BinarySize />
<BinaryType />
<BinarySavedLocation />
</BinaryFile>
</BinaryFiles>
<MetaDatas>
<MetaData>
<DataName>Name</DataName>
<DataValue>Ravneet</DataValue>
<DataChanged>NO</DataChanged>
</MetaData>
</MetaDatas>
</ApplicationInfo>

The following table describes the elements contained in this XML file:

Table 8-86 • XML Data Passed to IPlugin Methods

Data Element Description

<CompanyName> Name of company that submitted this Application Request.

<AppId> Number that uniquely identifies this Application Request in the database.

Note • This number is not the Application Request number that is displayed in the Workflow
Manager interface.

<AppSName> First eight characters of the name of the Application Request that was entered at
submission.

<AppLName> Full name of the Application Request that was entered at submission.

<UserName> User ID of the user who submitted this Application Request.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 561


Chapter 8: Workflow Manager Reference
Using the IPlugin Interface

Table 8-86 • XML Data Passed to IPlugin Methods (cont.)

Data Element Description

<StepID> GUID that uniquely identifies the Workflow Step that this event is associated with.

<PhaseID> GUID that uniquely identifies the Phase in this Application Request that this event
is associated with.

<StepName> Name of Workflow Step that this event is associated with

<StepType> Step Type of Workflow Step that this event is associated with

<BinaryFiles> Identifies the beginning of a group of uploaded files.

<BinaryFile> Identifies the beginning of a group of elements that identify one uploaded file.
There is one <BinaryFile> element for each uploaded file.

<BinaryName> Name of file that was uploaded.

<BinarySize> Size of the uploaded file.

<BinaryType> Identifies the file type of the uploaded file.

<BinarySavedLocation> Location where file the was uploaded.

<Metadatas> Identifies the beginning of a group of Data Elements that were collected as part of
this Application Request.

<Metadata> Identifies the beginning of a one Data Element that was collected as part of this
Application Request. There is one <Metadata> element for each Data Element
submitted.

<DataName> Name of Data Element.

<DataValue> Value entered for that Data Element.

<DataChanged> Identifies whether the data has been updated after it was submitted.

• No—Data has not been updated.


• Yes—Data has been updated.

562 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Using the IPlugin Interface

Setting Up IPlugin Automation in Workflow Manager


You can use the IPlugin interface to import packages into the Application Catalog and perform validation and
conflict analysis as part of a Workflow Manager Workflow Step via command line using AdminStudio ConflictSolver.

This feature enables Workflow Manager to provide a programmatic way to automate the performance of conflict
detection and resolution on a Windows Installer package in a specific Application Catalog database.

• Prerequisites

• Steps to Achieve Automation

• Advanced Configuration Options

Prerequisites
The callback mechanism in the automation feature requires Read/Write permissions on the Windows\Temp folder for
the user that is used in IPlugin to impersonate the automation calls. If no impersonation is being done (such as for
import step), then the user used in the Administration/System Settings tab needs Read/Write permissions to the
Windows\Temp folder.

Out of the three automation steps, two need Administrator rights on the local machine, where the web server is
running. This is due to the fact that the validation and conflict analysis operations on Windows Installer packages
need Administrator rights. The import process does not need Administrator rights. For validation and conflict
analysis, you can impersonate the code execution in IPlugin to an Admin user, and then call
AutomationServices.RunAsynchValidation or AutomationServices.RunAsyncConflicts.

Steps to Achieve Automation


To set up Workflow Manager automation, perform the following steps:

Task: To set up automation:

1. Open the solution EndUserIplugin.sln which should be under <WFMLocation>\wwwroot\IPlugin\Test2.

2. References to the following three binaries need to be added in the project. All of these binaries can be found in
the <WFMLocation>\wwwroot\bin folder.

• Adminstudio.Public.dll
• IPlugin.dll
• IPlugin2.dll

3. Once the references are added to the above DLLs, the solution should now build.

4. Once built, you can start overriding the callbacks in the Test solution to suit your customizations.

5. Once the IPlugin.Test2.dll is built, copy that DLL to the <WFMLocation>\wwwroot\bin\Plugins folder.

6. Restart IIS. Your custom code should now be executing on various WFM events.

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 563


Chapter 8: Workflow Manager Reference
Using the IPlugin Interface

Advanced Configuration Options


You might need to impersonate to an Administrator user for validation and conflict analysis operations. For this,
users generally need to store the Admin user name and password in the web.config file in clear text. Since this
could be a security risk, it is advised to encrypt just this part of the web.config file. Sample changes shown below
will help you achieve this.

• Step 1: Make Changes to the web.config File

• Step 2: Write Code to Read These Values

• Step 3: Encrypt the Web.config File

Step 1: Make Changes to the web.config File


To store your user name/password in the web.config file, it is advised to do so in a new custom section in the main
web.config file of Workflow Manager. This is achieved by modifying the existing web.config in two places.

Task: To store your user name/password in the web.config file:

1. Locate <configuration> at the top of the web.config file. Immediately after this tag, add the following:

<configSections>
<section name="IPluginSettings" type="System.Configuration.NameValueSectionHandler" />
</configSections>

2. Scroll to the bottom of web.config, and place the following, immediately before the closing <configuration>
tag:

<IPluginSettings>
<add key="IPluginUserName" value="SomeAdminUser" />
<add key="IPluginPassword" value="AdminPassword" />
<add key="IPluginDomain" value="YourDomainORYourLocalMachine" />
</IPluginSettings>

3. Save the web.config file, and try to open Workflow Manager.

If you receive an error about web.config, make sure the above changes were done in the right places.

Step 2: Write Code to Read These Values


Now that you have your custom section in the web.config file, your next step is to write code to read these values
in your IPlugin code. To read these values, use the following snippet:

object oSection = System.Configuration.ConfigurationManager.GetSection("IPluginSettings");

System.Collections.Specialized.NameValueCollection IPluginSettings =
oSection as System.Collections.Specialized.NameValueCollection;

string UserName = IPluginSettings["IPluginUserName"];


string Password = IPluginSettings["IPluginPassword"];
.
.
.

564 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Chapter 8: Workflow Manager Reference
Workflow Manager Installation Issues

Step 3: Encrypt the Web.config File


Once you have this working, you then need to encrypt the entries in the web.config file so that they are not in clear
text. This is done using the .NET 2.0 Framework executable.

Task: To encrypt the entries in the web.config file:

1. On the web server, open a command line and change the directory to:

<WindowsVolume>\Windows\Microsoft.NET\Framework\v2.0.50727

2. Run the following:

aspnet_regiis.exe -pef IPluginSettings "<WFM Location>\wwwroot"

The above assumes your custom section in IPlugin is named IPluginSettings and your web.config file is in
the <WFM Location>\wwwroot location.

You should see a Succeeded! message if encryption worked.

3. Open your web.config file and confirm that your custom section is now encrypted.

Now, to access the encrypted values, certain rights needs to be given to the user under which the web
application is running. This is done to allow the application to access the RSA Key Stores.

4. On the same command line above, run the following command:

aspnet_regiis.exe -pa "NetFrameworkConfigurationKey" "IUSR_MACHINENAME"

IUSR_MACHINENAME is the user under which the web application is running. This user can be found under
Directory Security settings in IIS for the Workflow Manager web site.

Once the above steps are successful, you can now read the values from the encrypted section in web.config.
ASP.NET will automatically, at runtime, decrypt these values for you.

Workflow Manager Installation Issues


The AdminStudio Web Server Installation Guide includes information on the following issues:

• Hardware and software requirements

• Required NTFS permissions

• Required user rights assignment for Windows 2000 Server

• Installing the Workflow Manager Web site software

• Setting up the File Share Server

• Assigning permissions on the SMTP Server

• Installing the Workflow Manager Web Portal software

• Manually installing Workflow Manager

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 565


Chapter 8: Workflow Manager Reference
Workflow Manager Installation Issues

• Set up the virtual directories

• Enable buffering and session state

• Create database manually

• Assigning static IP addresses to a Server

A copy of the AdminStudio Web Server Installation Guide PDF is included on the AdminStudio Workflow Manager
installation CD. You can also download it from the AdminStudio Downloads site:

http://www.flexerasoftware.com/downloads.htm

566 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Index

A sharing data with Workflow Manager 418


Workflow Phase in Workflow Manager 515
access accounts 228 workflow phase in Workflow Manager 438
accounts AdminStudio Enterprise Server
deleting a group account 60 forgetting your password 70
deleting a user account 60 Report Center 83
activating deployment sites 404 Advanced Client 217
Active Directory 81, 503 advertisements 217, 237
Active Directory Configurations Page 81 Advertisements View 259
automatic login to Workflow Manager 74 All Projects Page 437
data element data type 503 All Reports page 127
importing users 77 AMS Data Service URL 539
LDAP attributes 81 anonymous access 545
Active Directory Configurations Page 81 anonymous account 71, 72
Active Directory User Import View 77 logging in 72
activities 114 setting up 71
Activity Report 114 AppBinariesSubmitted method 557
activities displayed in 114 Application Due Period
creating 114 dynamically updating 398
Add Related Applications dialog 449 application families 277
Add User/Group dialog box 291 application management 296, 334
administration tasks 296
copying roles 52 Application Progress Page (Customer) 444
creating new roles 51 Data Entry tab 441, 442
deleting roles 52 Workflow tab 443
administrative tasks 327 Application Progress Page (Servicer) 444, 445
AdminStudio 418, 515 Add Related Applications dialog 449
AdminStudio data type 503 Application Progress tab 445
connecting to 541 Deployment Progress tab 449
connecting to the AdminStudio Enterprise Server 541 Downloadable Files Tab 459
Enterprise Server 541 Properties tab 446
extended attributes 503 Uploaded Files tab 458
setting default assigned user 546 View Policy Documents Page 441

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 567


Index

Application Report 304 Application Upload 342


Application Report Dialog 449 AppMetaDataChanged method 558
application requests 276, 301, 304, 308, 310, 365 AppRepackageApproved method 559
accepting 308, 365 AppRequestSubmitted method 558
activities recorded in database 114 AppWorkflowStepComplete method 560
advancing 312, 314 ASP pages 539
advancing (Servicer) 312 Assignment Details Page 465
assigning person to job 310 assignments 311
changing data 315 viewing Application Request assignments 311
changing data (Servicer) 315, 316 viewing by person 466
checking status of 305 Work Assignment Listing Page 463
completing 308 Assignments Page 438
completing a Workflow Step 312 attributes 81
completing a Workflow Step (Servicer) 312 creating Active Directory 81
copying 442, 462 Automated Conflict Analysis 347
copying (Customer) 304 Automated Import 347
copying (Servicer) 300 Automated Validation 347
creating 304 automated workflow steps 357
definition 276 automatic job execution
deleting (Servicer) 300 Job Manager 167
editing data of 312 automatic login 74
file upload considerations 366 using Active Directory 74
linking together 324 automation
managing Application Status 473 Job Manager 167
overriding email notification defaults 380 setting up in Workflow Manager 563
related applications 324
rolling back 312, 314
rolling back (Servicer) 314
B
searching (Servicer) 301 branding Workflow Manager 281, 282, 285, 287
Submit Application Request Page 461 buffering
tracking SLA status 305 enabling 566
tracking work done by users 304
typical 280
updating 312, 314 C
updating (Servicer) 312 calendar settings 474
updating Application Due Date automatically 398 Calendar Settings Administration page 474
viewing 303 CAPS (Client Access Points) 217
viewing assignments 311 Check Box 342
viewing information about 304 Client Access Points (CAPS) 217
viewing status of all 304 Client Agent 217
viewing uploaded files 324 clock
viewing uploaded files (Servicer) 324 starting and stopping 306
Application Requests Summary Report 123 collection 217
Application Search Page 432, 434 columns 30
Application Status 404 changing order 30
Application Status Page 473 companies 330
creating 404, 474 deleting a customer company 329
deleting 404 deleting a service company 330
editing 474 Company/Business Unit Administration Page 475
managing 404 Company/Business Unit Details View 476
Application Status Administration Page 473 conditional display 354

568 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Index

configuration file 537 Create Application Family Dialog 533


Configuration Manager 216 creating 328, 329
Configuration Manager Server 217 customer company 328
saving a package on using Configuration Manager Web reports 112
Console 240 roles 51
Configuration Manager Web Console 215, 217, 220 service company 329
access accounts 228 custom functionality 555
advertisements 217, 237 custom plugins 555
Advertisements View 259 Custom Report 113
and Microsoft Configuration Manager 216 Custom SQL Query Report 119
Client Access Points (CAPS) 217 Custom Web Page 347, 348, 360, 515
Client Agent 217 code examples 360
collection 217 configuring 360
configuring distribution settings 221 using Workflow Manager parameters 360
distributing a package to Configuration Manager Server using Workflow Manager web methods 360
240 Workflow Step type 360, 515
distributing packages 220, 222 customer company 276
Distribution Points 217 creating 328
distribution points 229 deleting 329
Distribution Points View 251 Customers
Distribution Settings page 262 managing 330
getting started 220 customizing 281
Management Points 217 login screen graphic 281, 282
modifying distribution settings 240 step completion dialogs 281, 287
Package Administration Page 263 Workflow Manager 281, 282, 285, 287
package definition file 245 Workflow Manager page header 281, 285
package settings 224 customizing Workflow Manager 281, 282, 285, 287
programs 230
reference 243
saving a package on Configuration Manager Server 240
D
Select a Configuration Manager Collection dialog box data 316
262 editing after workflow step is complete 316, 318, 319,
setting package configuration options 223 321, 322
setting package configuration options\>\ 223 data elements 503
target collection 217 Active Directory 503
viewing status of distributed package 240 Active Directory data type 503
conflict analysis Application Upload 503
in Workflow Manager 357 conditional display of 354
ConflictSolver database-driven 356
extended attributes 503 Dependency Upload 503
resolution and the Software Repository 172 Document Upload 503
contextual packages 171 Downloadable File Upload 503
Copy application requests 442, 462 Dynamic Pick List 503
Copy Template View 493 Dynamic Pick List Dialog 533
copying 442, 462 Data Entry/Edit 515
an application request 462 Workflow Step type 515
Application Request (Customer) 304 data group
Application Request (Servicer) 300 conditional display of 354
application requests 442 creating 338
roles 52 Directory Services 338
copying a template 371 data groups 503

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 569


Index

Active Directory 503 disabling a user account 59


AdminStudio data type 503 distributing packages 220
Data Groups View 503 Distribution Points 217
Data Groups View 503 distribution points 229
data souces distribution settings 240
external 406 modifying in Configuration Manager Web Console 240
data type 503 Distribution Wizard 215
Active Directory 503 distributing packages using Configuration Manager Web
AdminStudio data type 503 Console 215
database preparing packages for Microsoft Configuration Manager
creating manuall 566 215
database connection string for ASP pages 539 Document Upload 342
database-driven data element 356 Downloadable File Upload 342, 503
Date 342 Downloadable Files Tab 459
dates and times downloads 411
display of 277 specifying folder for 411
DB Driven Type 343 due date 305
deleting 300, 329, 330, 334, 373 Dynamic Pick List 343, 503
Application Request (Servicer) 300 Dynamic Pick List Dialog 533
customer company 329 Dynamically 398
groups 60
Project 485
projects 334
E
roles 52 Edit Application Status View 474
service company 330 editing existing Application Status 474
templates 500 editing 367, 403
users 60 a deployment site 403
deleting a template 373 a template 367
Dependency Upload 342 a Workflow Step without performing rollback 316
Deployment Progress tab 449 projects 330
Application Progress Page (Servicer) 449 submitted data after step is complete 316, 318, 319, 321,
Deployment Site Administration Page 477 322
Deployment Site Detail Information View 478 email 289
deployment sites 277, 401 location of email templates 552
adding 403 specifying email server 548
editing 403 templates 289
filtering 402 using replaceable parameters 289
making active or inactive 404 using tokens 289
modifying 403 email notifications 373
setting status of 404 adding users, groups and external email addresses 383
viewing 402 events 374
Directory Service 342 managing 373
Directory Service Attributes 61 overriding for Application Request 380
Directory Services 51 setting defaults 376
automatic login 70 setting defaults for Application Request 377
creating Directory Service Attributes 61 setting defaults for new projects 376
creating new role with Directory Services 51 email server 548
Data Group 338 email settings 548, 550
Directory Service Attributes 61 email templates 289
managing Directory Services configurations 61 location of 552
Directory Services Page 78 using tokens 289

570 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Index

Enterprise Server
connecting to 541
I
Excel 35, 125, 126 import
exporting data to 35, 125, 126 in Workflow Manager 357
exporting data to from lists 35, 126 inactivating deployment sites 404
exporting 35, 126 installation 565
data in lists 35, 126 installing the Web Portal software 565
report data 35, 126 installing Workflow Manager manually 565
reports 112 Workflow Manager Web site 565
supported export file types 35, 126 IP addresses
Extended attributes 418 assigning static IP addresses to a server 566
sharing with AdminStudio 418 IPlugin 398, 555
extended attributes 503 setting up automation 563
external data sources 406 XML data passed to IPlugin methods 561
IPlugin interface (Workflow Manager) 555
F AppBinariesSubmitted method 557
AppMetaDataChanged method 558
file share server 565 AppRepackageApproved method 559
file upload 366 AppRequestSubmitted method 558
considerations in application requests 366 AppWorkflowStepComplete method 560
File Upload Dialog 534 issues 324, 325, 326, 327
Files 324 closing an Issue (Servicer) 326
filtering lists 28 creating a new issue (Servicer) 325
font responding to an Issue (Servicer) 326
selecting default for listings 554 viewing 327
Issues Page (Customer) 460

G Issues Tab (Servicer) 454

generating reports 112


getting started 278
J
GMT format 277 Job Manager 167
grouping 20 about Templates 185
lists 20 available Job Steps 169
groups configuration options 189
adding to Workflow Manager lists 291 conflict resolution and the Software Repository 172
deleting 60 contextual packages 171
guest account 71, 72 creating a new Custom Job 175
configuring 545 creating a new Job 174
setting up 71 creating a new Template 186
Custom Jobs 171

H deleting a Job 184


deleting a Template 189
hardware and software requirements 565 dynamic group content identification 171
help editing a Job 180
Help Library conventions 36 editing a Template 188
using 36 email alerts 182
holidays executing jobs 193
defining for SLA calculations 474 Job Manager Engine 191
HTML 35, 126 rescheduling a Job 181
exporting data to 35, 126 selecting packages imported in previous Job Steps 171
setting detection options 189

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 571


Index

Template Job vs. Custom Job 170 Microsoft System Center Configuration Manager 216
user permissions 173 integration with Configuration Manager Web Console 216
viewing Job Manager Engine status 194 modifying a template 367
viewing Job status 183 Multiple Selection 342
Job Manager Engine 191
adding an Application Catalog to 192
deleting a connection to 192
N
executing jobs 193 New Application Status View 474
opening 192 creating new Application Status 474
setting conflict detection options 195 Normal 346
setting validation options 196 notifications
shutting down and restarting Application Catalog 193 managing 373
viewing status of in Job Manager 194 NTFS permissions
required 565
L
LDAP attributes 81
P
Active Directory 81 package 222
Legacy Client 217 distributing to Configuration Manager Server using
linking application requests 449 Configuration Manager Web Console 240
list settings 554 distributing using Configuration Manager Web Console
lists 20 222
changing column order 30 modifying distribution settings in Configuration Manager
customizing 31 Web Console 240
exporting 20, 35, 126 saving a package on Configuration Manager Server
filtering 28 using Configuration Manager Web Console 240
grouping 20 selecting for distribution using Configuration Manager
loading additional data 20 Web Console 222
refreshing 20 Package Administration Page (Configuration Manager Web
searching 28 Console) 263
setting number of lines in listings 554 package configuration options 224
sorting 25 access accounts 228
logging in to AdminStudio Enterprise Server 70, 71 advertisements 237
anonymous 71 distribution points 229
anonymous account 72 package settings 224
automatically 70 programs 230
forgetting your password 70 setting in Configuration Manager Web Console 223
logging in to Workflow Manager package definition file 245
guest account 71, 72 Configuration Manager Web Console 245
login screen graphic 282 package definition file (PDF) 245
customizing 281, 282 package settings 224
packages 220
M distributing with Configuration Manager Web Console
220
Management Points 217 page header 285
managing projects 334 customizing the page header 285
managing projects and Customers 330 customizing the Workflow Manager page header 281
Microsoft Configuration Manager 216 password 70
Microsoft Configuration Manager Server 217 forgetting your Workflow Manager password 70
Microsoft Excel 35, 125, 126 resetting your Workflow Manager password 70
exporting data to 35, 125, 126 PDF 35, 126

572 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Index

exporting as 35, 126


exporting data to 35, 126
R
PDF (package definition file) 245 Radio Button 342
using in Configuration Manager Web Console 245 related applications 324
People Administration Page 74 Report Center 83, 127
permissions 48 available reports 93
assigning SMTP Server permissions 565 Package reports 89
copying roles 52 queries 120
creating new roles 51 searches 120
deleting roles 52 use of wildcard character in searches 120
Job Manager 173 Report View 132
required NTFS permissions 565 reports 127
person 310 Activity Report 114
assigning to an Application Request 310 All Reports page 127
disabling their user account 59 Application Report 304
Person Details View 76 Application Requests Summary Report 123
plug-ins 398, 555 assigning Role permission to view 112, 147
plugins 398, 555 creating 112, 127
Policy document 334, 335 Custom Report 113
storing policy documents for a project 334 Custom SQL Query Report 119
viewing 441 editing Role permissions to view 112, 147
viewing a project's Policy documents (Servicer) 335 export formats 112
Policy Document Details View 490 exporting 35, 126
Policy Documents Page 489 exporting to Microsoft Excel 112
programs (in Configuration Manager Web Console) 230 filtering 112
Project 485 generating 112
creating 485 Projects Report 124
deleting 485 Report Center 83, 127
editing 485 Report View 132
project 275, 304, 330, 334, 335 Report Wizard 143
All Projects Page 437 viewing 112
creating 330 Reports Wizard 143
deleting 334 Requests 276
editing 330 Role 51, 53
managing 330, 334 assigning permission to view reports 112, 147
storing policy documents 334 creating 51
viewing 304 Role Administration Page 53
viewing Policy documents (Servicer) 335 Role Details View 55
viewing policy documents (Servicer) 335 roles
Project Administration Page 485 copying 52
Project Details View 485 creating 51
Project Report deleting 52
displaying average time spent on each Phases 547 system roles 48
Project Summary page user roles 48
displaying percentage complete value 546 RTF 35, 126
projects exporting data to 35, 126
Service Level Agreements 275
Projects Report 124
Properties tab 446 S
Application Progress Page (Servicer) 446 Script Execution 346, 515
Workflow Step type 515

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 573


Index

Searching 301 customizing 281, 287


for Application Requests (Servicer) 301 Submit Application Request Page 461
searching system requirements 565
lists 28 system roles 48
user/group listings in Workflow Manager 291
service company 329
creating 329
T
deleting 330 target collection 217
Service Level Agreement (SLA) 275 template 274, 323, 335, 337, 338, 345, 348, 353, 365, 367,
dynamically updating Application Due Period 398 371, 373, 418
Service Provider 276 conditional branching 323, 352, 353, 365
Servicer Home Page 428 copying 371
session state copying to another Workflow Manager database 371
enabling 566 creating 337, 338
Single Selection 342 creating a new 337
SLA creating first Workflow Phase 345
defining holidays for 474 creating subsequent Workflow Phases 348
setting calendar options 474 deleting 373
SLA (Service Level Agreement) 275 editing 367
calculations 305 exporting to a script file 371
modifying default SLA settings 396 global 336
status 305 in use 336
stopping or starting the SLA clock 306 in use via project 336
tracking 305 managing 335
SLA clock modifying 367
starting 306 previewing 370
stopping 306 private 336
SLA feature sharing application-related data between AdminStudio
disable or enable 548 and Workflow Manager 418
SLA tracking testing 370
enabling or disabling for a Workflow Step 351 types 336
stopping or starting the SLA clock 306 with conditional Data Elements 354
sla.xml with conditional Data Groups 354
using to dynamically update Application Due Period 398 with conditional Workflow Steps 354
SMS distribution 401 Template Administration Page 491
SMTP authentication type 548, 549 Template Details View 496, 500
SMTP Server Validate Template 536
assigning permissions on 565 Templates 491, 500
Software Repository assigning AdminStudio user to AdminStudio Project 515
conflict resolution and 172 copying 493
sorting lists 25 deleting 500
standard reports 120 editing 500
static IP addresses 566 exporting to a script file 493
status 240, 404 validating 536
creating new Application Statuses 404 Terminology
setting for deployment sites 404 Terminology Customization Page 529
viewing Job Manager Engine status 194 Terminology Report 530
viewing status of distributed package in Configuration text 35, 126
Manager Web Console 240 exporting data to 35, 126
Status Dialog 536 Text Entry Box 341
step completion dialogs 287 TIFF 35, 126

574 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide


Index

exporting data to 35, 126 Web services URL 540


time web.config 537
display of 277 AMS Data Service URL 539
time zones 277 database connection string for ASP pages 539
timeout email settings for Active Directory groups 550
setting for Workflow Manager 544 WebGrid features 20
timeout settings 542 Windows 2000 Server
timeout values required user rights assignment 565
login page 543 Worfklow Manager
system session 543 email settings 548
track for SLA 351 Work Assignment 346, 515
Workflow Step type 515

U Work Assignment Listing Page 463


work week
Update History 346, 515 defining number of hours 474
Workflow Step type 515 Workflow Manager 270, 554
Uploaded Files Tab AMS Data Service URL 539
Application Progress Page (Servicer) 458 assigning permissions on the SMTP server 565
Uploaded Files Tab (Servicer) 458 assigning static IP addresses 566
uploads 411 auto-acceptance of submitted data 544
specifying folders for 411 automatically accepting submitted data 544
user accounts 77 automation using IPlugin 563
disabling a user account 59 branding 281, 282, 285, 287
importing from Active Directory 77 changing the login screen graphic 281, 282
user rights changing the page header 285
required assignment for Windows 2000 Server 565 changing the step completion dialogs 281, 287
user roles 48 changing the Workflow Manager page header 281
users conditional display of items 354
adding to Workflow Manager lists 291 configuration file 537
assigning iser to an Application Request 310 connecting to AdminStudio 541
deleting 60 creating custom plugins 555
People Administration Page 74 creating databases manually 566
Person Details View 76 customizing for your organization 281, 285, 287
viewing the number of a user's currently assigned defining automated workflow steps 357
Application Requests 310 displaying average time spent on each Phases on Project
UTC format 277 Report 547
displaying percentage complete on Project Summary

V page 546
enabling buffering and session state 566
Validate Template dialog 536 external data sources 406
validation getting started 278
in Workflow Manager 357 guest account 545
View Policy Documents Page 441 installing 565
View Work Assignments By Person 466 installing manually 565
virtual directories installing the Web Portal software 565
setting up 566 installing the Web site application 565
IPlugin 357
IPlugin interface 555
W logging in as a guest 72
managing email notifications 373
Web Portal software
overview 271
installing 565

AdminStudio Workflow Manager 5.0 User Guide WFM-050-UG02 575


Index

plugins 398, 555


populating a selection list with data from an external
X
database 406 XML data 561
Search Results list 294
searching user/group listings 291
setting default AdminStudio user work assignments 546
setting email notification defaults 376
setting login page timeout value 543
setting system session timeout value 543
setting the database connection string for ASP pages 539
setting timeout value 544
setting up the File Share server 565
setting up virtual directories manually 566
SLA feature 548
SMTP authentication type 548
specifying directory for file upload and download 547
specifying email server 548
system requirements 565
timeout settings 542
turning off Accept Data and Reject Data buttons 544
web.config 537
Workflow Manager anonymous access 545
Workflow Manager users 276
customer company 276
customers 276
organization 276
Service Provider 276
Service Provider Administrator 276
types of 276
Workflow Manager Web Services URL 540
Workflow Phase 348
AdminStudio 348
creating subsequent to first phase 348
Workflow Step 316
conditional display of 354
Custom Web Page Step Type 360
editing without performing rollback 316
enabling or disabling SLA tracking for 351
Workflow Step types 515
Custom Web Page 515
Data Entry/Edit 515
Normal 515
Script Execution 515
Update History 515
Work Assignment 515
Workflow Template. See template.
workflow. See template.
Working Queue View Page 466

576 WFM-050-UG02 AdminStudio Workflow Manager 5.0 User Guide

Você também pode gostar