Professional Documents
Culture Documents
Process Designer
User Guide
Version 8.3.2
April 2012
This document is the property of BMC Software, Inc.. and the information contained herein is confidential. This document, either in
whole or in part, must not be reproduced or disclosed to others or used for purposes other than that for which it has been supplied,
without BMC's prior written permission, or, if any part hereof is furnished by virtue of a contract with a third party, as expressly
authorised under that contract. BMC shall not be liable for any errors or omissions.
Contents
CONTENTS .............................................................................................................................................................II
ABOUT THIS GUIDE .............................................................................................................................................4
INTRODUCTION ....................................................................................................................................................4
AUDIENCE AND SCOPE .......................................................................................................................................4
CONVENTIONS ......................................................................................................................................................4
RELATED DOCUMENTATION ...........................................................................................................................5
STARTING PROCESS DESIGNER ......................................................................................................................6
PROCESS DESIGNER USER INTERFACE ........................................................................................................8
PROCESS DESIGNER EXPLORER ...............................................................................................................................8
IMPORTING A REMEDY DEFINITION FILE .............................................................................................................9
CREATING PROCESS TEMPLATES ..................................................................................................................9
DESIGNING PROCESS TEMPLATES...............................................................................................................11
PALETTE ................................................................................................................................................................12
ADDING TASKS TO THE PROCESS DIAGRAM ..........................................................................................................14
SUB-PROCESS TASKS.............................................................................................................................................16
ADDING DEPENDENCIES TO THE PROCESS DIAGRAM ............................................................................................17
COPYING AND PASTING .........................................................................................................................................20
AUTO-LAYOUT ......................................................................................................................................................20
ALIGNING TASKS ...................................................................................................................................................20
APPLYING ACTIONS TO TASKS ..............................................................................................................................21
ADDING FIELDS TO TASKS .....................................................................................................................................36
ADDING DIAGRAM NOTES .....................................................................................................................................37
MAINTAINING PROCESS TEMPLATES.........................................................................................................38
CHANGING THE STATUS OF A PROCESS TEMPLATE ................................................................................................38
AMENDING A PROCESS TEMPLATE ........................................................................................................................39
MAKING CHANGES TO A LIVE PROCESS TEMPLATE ...............................................................................................39
REMOVING PROCESS TEMPLATES ..........................................................................................................................40
PROCESS LOCKING ................................................................................................................................................40
IMPORTING AND EXPORTING PROCESS TEMPLATES...........................................................................40
EXPORTING PROCESS TEMPLATES .........................................................................................................................40
IMPORTING PROCESS TEMPLATES..........................................................................................................................41
IMPORTING XPDL FILES .......................................................................................................................................43
SETTING OPTIONS..............................................................................................................................................44
COLOURS ...............................................................................................................................................................44
LOGGING ...............................................................................................................................................................44
MISC ......................................................................................................................................................................44
LOGIN TO ANOTHER SERVER ........................................................................................................................45
LOCALISATION ...................................................................................................................................................45
Copyright BMC Software, Inc.. All Rights Reserved.
Page ii
Page iii
Introduction
The aim of this guide is to step through all the functional components of the
Process Designer client and its use in designing processes for BMC Remedybased applications. This guide relates to release 8 and 8.x sub-releases of
Process Designer unless indicated otherwise.
The guide covers the on demand, on premise and standalone versions of the
client. The content covers all varieties except where indicated.
Conventions
The following typographical conventions are used in this guide:
Item
Convention
Example
Initial
Capitals
>
Page 4
Related Documentation
The following guides provide additional information about the Process Designer
product:
Guide
Description
Process Designer
Configuration Guide
Page 5
This will download and start the Process Designer client and you will be automatically
logged in.
On Premise
For an on premise installation, start Process Designer by clicking on your windows Start
button, then select Program Files-> BMC Software -> Process Designer 8, or simply click
on the Process Designer 8 icon on your desktop.
This should launch Process Designer 8 and present you with a login screen:
Provide your BMC Remedy server name together with your login username and
password. Optionally change the port number if your BMC Remedy server is not
configured to use Port-Mapper.
Process Designer requires you to have previously configured a user on your BMC
Remedy server as a member of either the Process Designer Admin or Process
Designer Sub Administrator group. You may then login as one of these users.
Copyright BMC Software, Inc.. All Rights Reserved.
Page 6
If you are unsure of these details, please contact your BMC Remedy administrator for
assistance.
You may also optionally enable logging via the Logging tab. When enabled, client activity
will be written into the log file displayed on the tab. Use the browse button (...) to change
the folder location where the file will be written to.
Standalone
The standalone version of the Process Designer client is also started from the shortcut
icon on your desktop.
Page 7
When running the Process Designer on demand or on premise the top-most node is the
currently connected server. All the processes are displayed in the company/group node
that they belong to. Below each company node, the nodes are:
Design
Lists all Process Templates with a status of Design. This is the initial
default status.
In Test
Live
Lists all Process Templates which are Live and so available for
selection from within BMC Remedy.
Page 8
Suspended
Archived
Process nodes have a pop-up menu which will appear when selecting the node and pressing
the right-click mouse button.
For the standalone Process Designer client, all processes are effectively In Test.
Page 9
Field Descriptions:
Field
Description
Name
Type
SLA (Optional)
Notes (Optional)
Request (Optional)
Audit (Optional)
Page 10
Process Designer makes use of the Business Time forms within BMC Remedy to
calculate target completion times. For more details on defining the SLA, please refer to the
Process Designer Configuration Guide.
If you are running Process Designer on a server with BMC Remedy ITSM and/or SRM
applications then you can assign the process to a company. Then only process designers
who are defined within the people of the Company may access the process.
Similarly, if you are not using the BMC applications, you can assign the process to a
standard Remedy group and the process will then be restricted to users within that group.
button can be used to provide a quicker and easier method of locating the form
The
for selection.
Clicking OK on the new process dialog will create the Process Template in the right-hand
pane, ready to be populated with Tasks.
Page 11
Palette
The following palette items are available for the construction of and updates to existing
processes. To add an item to the process, simply click and drag it onto the drawing page.
Action icons can only be dropped onto existing tasks.
Palette Item
Description
This icon is used for creating standard
unconditional tasks.
This icon is used for creating conditional tasks,
i.e. those that have one or more possible
outcome.
This icon is used to create a sub-process task
which references a sub-process of the current
process.
This icon is used where the outcome is
determined by a sub-process of the current
process.
The Run Process command can be used to run
processes/executables on your BMC Remedy
server.
You should use the full path in the Run Process
Command Field up to and including the process
that you wish to execute.
There are no return values for this option.
(Only available in the palette if Restricted flag is
not set in ABYD:UserPreferences
form Options tab Advanced Functionality )
Page 12
Palette Item
Description
Set Outcome SQL can be used to perform an
SQL query that will return a value which is used
to set in the Task Outcome value.
The value returned should be one of the
conditional outcomes on the dependencies that
relate to the task for which the action is defined.
If more than one record is returned, then only
the first record is used.
(Only available in the palette if Restricted flag is
not set in ABYD:UserPreferences
form Options tab Advanced Functionality )
Page 13
Description
Category
Type
Name
Description (optional)
Page 14
Field
Description
Process Name
Version
Audit
Description
Assigned To Group*
(optional)
List Position
Starting Task
Return to Parent
Page 15
Field
Description
Outcome Field
* If you are building a process for execution against the ITSM applications, then you will
be able to assign the task to a support group.
Click on the Support Groups... button to select the Company, Organisation and Group for
the tasks assignment.
Task shapes can be moved or resized to by selecting the task shape to show the control
handles. The control point in the centre of the Task allows you to move the shape while
the outer points allow you to resize it. Use the Align to Grid option to align the tasks to the
grid lines.
Sub-Process Tasks
Process Designer allows you to link in other defined Process Templates. Should you have
a common set of Tasks you can avoid re-creating the same Tasks by creating a Process
Copyright BMC Software, Inc.. All Rights Reserved.
Page 16
Template with the common Tasks and Dependencies and reference it from your main
Process Template.
This is achieved by dropping a Sub-Process Task shape onto your diagram and selecting
the Process name and version from the drop-down list. There is no limit to the number of
Sub-Process Tasks your Process Template can contain. There is also no limit to the
number of levels so a Sub-Process Template can have its own Sub-Process Tasks.
When the request is created in BMC Remedy using the top-most Parent process, the SubProcess Tasks will not be created but will be replaced by the Tasks in the Sub-Process
the Task references.
Please refer to the Process Designer Concepts Guide for more information.
Each Dependency line has two control points to allow you to move the line around any
other shapes on the diagram.
Tasks with actions are shown as the icon based on the first action within the task. If there
are no actions, the task is either displayed as standard or conditional. Tasks are shown as
conditional when they have at least one conditional dependency and standard when all its
dependencies are unconditional. When a dependency is modified, the first task shape is
modified automatically (if necessary), using this rule.
Copyright BMC Software, Inc.. All Rights Reserved.
Page 17
Here, the dependency can be created (and modified) with the following details:
Field
Description
First
Dependent
Restart Task
Page 18
Field
Description
Restart OLA
Dependency conditional outcomes can be set from a field on the parent by applying a Set
Outcome action. See the section on Actions for more details.
Use the [...] button next to the Outcome to specify a Dependency Qualification. The
following dialog will appear to specify a condition to compare the value of a parent or
process field with a literal value or the value o another process or parent field. For
example, you may have a currency field and wish to assign a task if the currency value is
above $1000.
Page 19
In the above example, the task titled Repeating Task will be assigned 4 times as defined
by the qualification on the dependency from the task titled Repeat Loop. The other
dependency from this task should have the condition set to [Else] to continue out of the
loop.
Auto-Layout
Process Designer can automatically layout your process Diagram, with four options
available; Centered, Cascading, Radial and Flowchart. To auto-layout the process,
select a blank area of the diagram and right-click to open the popup menu. Then select
the layout option you prefer.
Note that once the process diagram is altered, it cannot be undone. You will need to close
the process and not save changes (update the process) to revert back to the original
layout.
Aligning Tasks
If you wish to align tasks horizontally or vertically, select multiple tasks using the Ctrl key
and then click either the
button to align them horizontally, or
to align them vertically.
All selected tasks will then be aligned to the first task shape selected.
Page 20
Field Descriptions:
Field
Description
Task Name
Trigger Outcome
The outcome of the task that will trigger the action. (Only
applies when task status value is Complete.)
The status that the task should be set to when the action
is completed.
Page 21
Field
Description
Post-Action Outcome
Once an action has been created, it forms part of the process definition and will be
inherited by any requests that are based on that process.
Actions can reference fields which will then be substituted with the actual values when
executed within the request in your Remedy application. For example, within an Email
message text.
button. A popSelect where you wish to insert the field and then click on the
up list will appear presenting a list of any Designer related fields within the process and
fields on the Processs request form (if selected within the Process definition).
The list also includes references to the request identifier (p_request_id) and the task
identifier (p_task_id). These are reserved words which will also be substituted within the
action when executed.
To modify an existing one, modify the Task and then select the Actions tab. Select the
Action that you want to update, and then click on the View button. To delete an
Action, select the one that you want to delete, and then click on the Delete button.
Page 22
When an Action is applied to a Task, the shape reflects the action applied to it. If you have
multiple actions applied to the same Task, then the icon displayed will be that of the Action which
sets the Task to auto-complete. Only one Action can auto-complete the Task.
If you wish to display the Task name below a Task with an Action applied, select it and resize it:
Page 23
Email Actions
The Email action utilises the BMC Remedy Email Engine which must be pre-configured for
your email server. Please refer to the BMC Remedy manual Email Engine Guide for
more information.
Email Destination
The Email destination field on the Email action can be set to one of four pre-defined
values or to any text string that you may want to use to control the setting of the email
address:
Destination
Description
Defined Address
Assignee
Example
Creating an Email action with a defined email address will send an email to that address
using the subject and text defined in the action. The defined email address, subject and
text can include any number of Designer or Remedy fields as described above. The value
of any field used will then be substituted when the process is executed in Remedy.
Notification Action
The Notify Text can include any Designer or Remedy fields. The recipient can also be set
to the value of a field on the parent request by setting the Notification Type to Request
Copyright BMC Software, Inc.. All Rights Reserved.
Page 24
Field. (This requires that the parent request form be specified in the Process definition for
this option to be available).
Running Processes
The Run Process and Set Outcome Process Actions can both be used to invoke an
executable file or script on the machine running AR Server. The permissions on the file or
script must allow execution by the operating system user running the BMC Remedy ARS
server. The command can include any Designer or Remedy fields.
(Run Process, SQL Set Outcome, Process Outcome, Direct SQL actions will only
available in the palette if Restricted flag is not set in ABYD:UserPreferences
form Options tab Advanced Functionality for the currently logged in user in Remedy )
For existing processes, these actions will be read- only if the Restricted flag is set in the
above form. Howvever, they can still be deleted from all the processes.
Page 25
By default, the Request Form will be set to the processs parent request form. You can
select an alternative form, although if you do, you should provide a query to obtain the
record from which you wish to retrieve the fields value.
The query can be built from a combination of the forms fields and also process related
fields. The p_request_id and p_task_id keywords can be used to query the form based on
the current requests request_id or current task id respectively.
When an integer process field is selected, you can set its value from a list of predefined
queries, specifying the time period the value is to be obtained for.
Copyright BMC Software, Inc.. All Rights Reserved.
Page 26
Otherwise, select Other and select the specific form from the secondary drop-down list.
You can optionally specify a process field in which the entry Id for the record created will
be stored. You can then use this information within the process within actions or task
descriptions.
Click on the Details... button to open up the wizard which will assist in obtaining the entire
field data required to successfully create the request.
Page 27
Here you can specify the company and individual making the request. Alternatively, you
can indicate that these values are the same as the originating request which is running the
process. In this example, a Change Request will be created from a process running for a
Service Request.
Click Next to progress to the next stage.
The next stage prompts for details common to all the request types. You can optionally
select an existing template and the fields will all be populated from the templates values.
All fields other than the template are mandatory for a successful request creation.
Click Next to progress to the next stage.
Page 28
This stage prompts for the remaining mandatory details required to create the specify type
of request you wish to create. Therefore, if you create an Incident for example, you will
see Incident specific details here. Again these will be pre-populated from the template if
you selected one on the previous stage.
Click Next to progress to the final stage.
Here you can optionally also provide the Operational and Product categorizations to be
set on the new request. Again these will be pre-populated if the categorization values are
set on a template if selected previously.
If you have Designer processes mapped against categorizations in your Remedy server
then the process which will be triggered for the request will be displayed when
categorizations are selected from the drop-down list here. Alternatively, you can click the
Select from Process Mapping... button to see all current mappings.
Page 29
If you select one of the mappings and click OK, the categorizations will be set to those
selected. This will also confirm the Designer process which will be trigged when the
request is created in Remedy.
Click OK to confirm all the details. You can also see all the fields for the request by
clicking the Full Field List... button.
Here you can then populate any additional fields you wish. The fields can be populated
with values from the originating request (for example the service request) which is running
the process
Page 30
The field values can be typed or selected from the drop-down list of Task Related Fields,
Remedy Keywords or the variables p_request_id or p_task_id.
Here you can specify the Requested By and Requested For Company and Name.
Alternatively, you can indicate that these values are the same as the originating request
which is running the process. In this example, a Change Request will be creating the
Purchase Request.
Page 31
On the next page, you can specify the general information including an offset from the
date the purchase request is created to determine the date required. The Description and
Justification can be include process and request field values, added through the []
buttons.
Unless the auto-assignment of purchase requests is configured within ITSM, you will need
to specify the assignment here.
Page 32
Finally you provide the address details which can optionally be set from request or
process field values.
Click OK to complete the action configuration.
Note that you should select a process field to store the id of the created Purchase
Request if you wish to also create line items within the Purchase Request.
Once you have an action to create a purchase request, you can then define an action to
create line items.
Page 33
The first step is to select the process field which was selected to store the id of the created
purchase request in the previous action. This will define the link and ensure the line items
are created within the same purchase request.
On the next tab, provide general information using process or request fields where
required.
Copyright BMC Software, Inc.. All Rights Reserved.
Page 34
Approval Action
This action allows you to select an approval process and specify an individual approver for
the request. The approver can also be defined from a process related field, making the
requests approver completely dynamic at run-time.
Page 35
The approval action can only be used with processes defined for Service Requests (SRM)
and Change Requests (Change Management). Please see the Process Designer
Configuration Guide for more details.
If you are designing a process for use with the Process Designer Wizard (for user
data entry) you can define the order in which the fields will appear. Use the up and
down arrow buttons to change the sequence.
Page 36
Within the Field definition, you must specify the field name and the type. The type of
field is a subset of the main field types supported within BMC Remedy. Setting the
option to indicate that the field is mandatory will prevent the user from completing the
Task in Remedy unless the field is populated.
A default value can optionally be specified which can be based on a relevant BMC
Remedy keyword. For example, a date/time field can be set to be the current
$TIMESTAMP$. Default values will be set once the Task is assigned.
A minimum and maximum value can enforce either minimum and/or maximum length of a
character or diary field, or minimum/maximum values for integer and real number field
types.
A description can be entered to provide help text to the user when entering the fields
value from within the requests Task in BMC Remedy.
Character field types can also have a menu attached that has been pre-defined within
BMC Remedy Administrator tool or BMC Developer Studio.
You can also select an existing field from another task in the same process. When the
process is running in Remedy all fields of the same name will have the same value.
Page 37
Once the status change is confirmed, these menu options will be changed to reflect the
new status. The Process Template will be moved in the tree to within the node for the new
status.
Page 38
To make use of a Process Template for requests in BMC Remedy, its status must be set
to Live. Note that when a Process Template is either Live, Suspended or Archived, it
cannot be updated. Tasks, Dependencies, Actions and Fields can be viewed but are readonly.
When promoting a Process Template to Live, a check is made to ensure there is not
already another version of it Live. If there is, you will be promoted to confirm whether you
wish to replace the current Live version or not. If you do, the previous version will be
automatically set to the status of Archived.
Note that you must be a member of the Process Designer Admin group in Remedy
before you can promote a Process Template to Live status.
When selected, the Process Template form will appear with the current details. Click OK
to confirm your changes.
Page 39
You should receive confirmation that a copy has been created. This new copy will be
listed within the In Test node on the tree with a new version number.
2. Make your changes to the newly created In Test Process Template as necessary.
For more information, see the sections titled Designing Process Templates.
3. Change the status of the In Test Process Template to Live. Details on this can be
seen in the section titled Changing the status of a Process Template.
4. When prompted, confirm that you wish to replace the current version of the Process
Template. This will set the status of the current version to Archived and set the
newly updated one to Live.
Process Locking
Process locking ensures that two users cannot update the same Process Template at the
same time. When a process is opened for edit, a lock is taken out against that user so no
other user can load the same process. Process locks can be manually removed if
necessary through the Process Designer Console from within the BMC Remedy User Tool
(or mid-tier login). See the following section for more details.
Page 40
Select the Process Templates that you wish to export or select all processes using the
Select All button. Then click on the OK button.
A File Save window will appear in which you can specify the path and filename of the
export file. Click-on the Save button to initiate the export process.
Page 41
Select the process Templates that you wish to import or use the Select All button. If the
Process Template already exists with the same version number then you can specify the
option to import it as a new version of the process. If the existing process is in the Live or
Suspended state, then the imported version can be set to In Test.
Processes can now be imported only by attaching any company (ITSM)/ group (nonITSM) user has access to. This can be done by selecting a company in the individual
process records or by specifying a default for all selected companies in the option below
the table.
Page 42
If company or group is specified at both places, the company that is selected for all
processes (Import company dropdown below the table) will override any companies (if
selected) in the table list.
If processes have to imported by selecting company individually for all selected
processes, then the Import process company option below the table should be left blank.
Click OK to confirm that you wish to import the processes from the file. Process Designer
supports the following features of XPDL:
Workflow Processes
Activities
Transitions (including conditions)
Data Fields
Data Types (including String, Float, Integer, DateTime, Boolean and enumeration values)
Page 43
Setting Options
The options available from the Tools->Options menu are as follows:
Colours
The colours of the shapes within the Process diagrams are fully configurable. The shapes
consist of two colours (referred to as the Primary and Secondary), with one blending into
the other. Clicking the colours on the form allows you to pick an alternative colour. The
preview will update to indicate how the shape will look.
Click the Designer Classic button should you wish to set the colours to those used for
Process Designer 7.
Should you make any changes, these will not be fully reflected until Process Designer is
restarted.
Logging
Enable logging and specify the location of the Process Designer.log file on your client to
log all client activity. Logging will continue until you disable logging or close Designer.
Misc
New Actions auto-complete Tasks
Set this option on to default new task actions to auto-complete the task that they are
applied to.
Show Gridlines on startup
Set this option for gridlines to be set on for diagrams when starting Process Designer.
Page 44
User can then re-login to the same Remedy server or login to a different one (that has Process
Designer installed on it).
Page 45
Fields
Description
Company
Field Type
Locale
Original Text
Localised Text
Text for each field type that will be displayed for the
associated field type
Keyword
Page 46
AR System User Preference record in Remedy should be set to the desired locale for the
Designer wizard to be displayed in that locale.
For e.g.: When the wizard launches for de_DE locale (German), it will look as in the below
screenshot at runtime:
Page 47
If this is the case the Process Designer client will need to be launched in a
slightly different way. Instead of using the shortcuts created you will need to run
the following command either from the command line or within a Windows batch
file.
Java jar <Designer Client Install Path>/ProcessDesigner.jar
DsocksProxyHost=Proxy Hostname DsocksProxyPort=Proxy Port Number
(Port Number is optional and only if port 1080 is not being used)
Example
Java -jar "C:\Program Files\BMC Software\Process Designer
8\ProcessDesigner.jar" -DsocksProxyHost=socks.hostname.com DsocksProxyPort=2850
Page 48
*12345*
*262626*
Page 49