http://rational-tools.info UML2ClearQuest. ClearQuest Enterprise schema report The purpose of this application is to ease the process of programming ClearQuest Designer's state transitions matrix for change requests. UML2ClearQuest can export UML state charts to ClearQuest Designer, which makes for a simple visual design process. UML Export is supported from StarUML, IBM Rational Software Architect or MS Visio. The demo version can export diagrams to IBM Rational ClearQuest with no more than 3 states. See success story. Compatibility: Compatible with any ClearQuest version (including ClearQuest 7.1).

1. Report on the ALM Schema
This document is generated by UML2ClearQuest v 3.0

2. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
Contents
1 ALM Schema .......................................................................................................................................................................... 5
1.1 General Information ................................................................................................................................................... 5
1.2 Relations Between Requests ................................................................................................................................... 5
2 Description of Record Types ........................................................................................................................................... 6
2.1 ALMActivity .................................................................................................................................................................... 6
2.1.1 Relations with Other Requests ....................................................................................................................... 6
2.1.2 State Diagram ...................................................................................................................................................... 7
2.1.3 Transition Matrix .................................................................................................................................................. 7
2.1.4 List of Actions ....................................................................................................................................................... 7
2.1.5 List of Fields .......................................................................................................................................................... 9
2.1.6 Description of the field behavior ................................................................................................................. 12
2.2 ALMProject ................................................................................................................................................................... 13
2.2.1 Relations with Other Requests ..................................................................................................................... 13
2.2.2 State Diagram .................................................................................................................................................... 14
2.2.3 Transition Matrix ................................................................................................................................................ 14
2.2.4 List of Actions ..................................................................................................................................................... 14
2.2.5 List of Fields ........................................................................................................................................................ 15
2.2.6 Description of the field behavior ................................................................................................................. 17
2.3 ALMRequest ................................................................................................................................................................. 20
2.3.1 Relations with Other Requests ..................................................................................................................... 20
2.3.2 State Diagram .................................................................................................................................................... 21
2.3.3 Transition Matrix ................................................................................................................................................ 21
2.3.4 List of Actions ..................................................................................................................................................... 21
2.3.5 List of Fields ........................................................................................................................................................ 23
2.3.6 Description of the field behavior ................................................................................................................. 26
2.4 ALMTask ........................................................................................................................................................................ 27
2.4.1 Relations with Other Requests ..................................................................................................................... 27
2.4.2 State Diagram .................................................................................................................................................... 28
2.4.3 Transition Matrix ................................................................................................................................................ 28
2.4.4 List of Actions ..................................................................................................................................................... 28
2.4.5 List of Fields ........................................................................................................................................................ 29
2.4.6 Description of the field behavior ................................................................................................................. 32
2.5 BTBuild .......................................................................................................................................................................... 33
2.5.1 Relations with Other Requests ..................................................................................................................... 33
2.5.2 State Diagram .................................................................................................................................................... 33
2.5.3 Transition Matrix ................................................................................................................................................ 34
2.5.4 List of Actions ..................................................................................................................................................... 34
2.5.5 List of Fields ........................................................................................................................................................ 35
2.5.6 Description of the field behavior ................................................................................................................. 37
2.6 UCMUtilityActivity ...................................................................................................................................................... 38
2.6.1 Relations with Other Requests ..................................................................................................................... 38
2.6.2 State Diagram .................................................................................................................................................... 38
2.6.3 Transition Matrix ................................................................................................................................................ 39
2.6.4 List of Actions ..................................................................................................................................................... 39
2.6.5 List of Fields ........................................................................................................................................................ 40
2.6.6 Description of the field behavior ................................................................................................................. 42
3 Description of Stateless Record Types ...................................................................................................................... 43
3.1 ALMAdmin .................................................................................................................................................................... 43
3.1.1 Relations with Other Requests ..................................................................................................................... 43
3.1.2 List of Fields ........................................................................................................................................................ 44
3.1.3 Description of the field behavior ................................................................................................................. 45
3.2 ALMBaseline ................................................................................................................................................................ 46
3.2.1 Relations with Other Requests ..................................................................................................................... 46
3.2.2 List of Fields ........................................................................................................................................................ 47
3.2.3 Description of the field behavior ................................................................................................................. 48
3.3 ALMCategory ............................................................................................................................................................... 49
2

3. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
3.3.1 Relations with Other Requests ..................................................................................................................... 49
3.3.2 List of Fields ........................................................................................................................................................ 50
3.3.3 Description of the field behavior ................................................................................................................. 53
3.4 ALMCategoryTypeLabel ........................................................................................................................................... 54
3.4.1 Relations with Other Requests ..................................................................................................................... 54
3.4.2 List of Fields ........................................................................................................................................................ 55
3.4.3 Description of the field behavior ................................................................................................................. 56
3.5 ALMComment .............................................................................................................................................................. 57
3.5.1 Relations with Other Requests ..................................................................................................................... 57
3.5.2 List of Fields ........................................................................................................................................................ 58
3.5.3 Description of the field behavior ................................................................................................................. 59
3.6 ALMIteration ................................................................................................................................................................ 60
3.6.1 Relations with Other Requests ..................................................................................................................... 60
3.6.2 List of Fields ........................................................................................................................................................ 61
3.6.3 Description of the field behavior ................................................................................................................. 64
3.7 ALMIterationLabel ..................................................................................................................................................... 65
3.7.1 Relations with Other Requests ..................................................................................................................... 65
3.7.2 List of Fields ........................................................................................................................................................ 66
3.7.3 Description of the field behavior ................................................................................................................. 67
3.8 ALMPhase ..................................................................................................................................................................... 68
3.8.1 Relations with Other Requests ..................................................................................................................... 68
3.8.2 List of Fields ........................................................................................................................................................ 69
3.8.3 Description of the field behavior ................................................................................................................. 72
3.9 ALMPhaseLabel ........................................................................................................................................................... 73
3.9.1 Relations with Other Requests ..................................................................................................................... 73
3.9.2 List of Fields ........................................................................................................................................................ 74
3.9.3 Description of the field behavior ................................................................................................................. 75
3.10 ALMReleaseLabel..................................................................................................................................................... 76
3.10.1 Relations with Other Requests .................................................................................................................. 76
3.10.2 List of Fields ...................................................................................................................................................... 77
3.10.3 Description of the field behavior ............................................................................................................... 78
3.11 ALMResolutionCode ................................................................................................................................................ 79
3.11.1 Relations with Other Requests .................................................................................................................. 79
3.11.2 List of Fields ...................................................................................................................................................... 80
3.11.3 Description of the field behavior ............................................................................................................... 81
3.12 ALMResolutionCodeLabel ..................................................................................................................................... 82
3.12.1 Relations with Other Requests .................................................................................................................. 82
3.12.2 List of Fields ...................................................................................................................................................... 83
3.12.3 Description of the field behavior ............................................................................................................... 84
3.13 ALMRole ...................................................................................................................................................................... 85
3.13.1 Relations with Other Requests .................................................................................................................. 85
3.13.2 List of Fields ...................................................................................................................................................... 86
3.13.3 Description of the field behavior ............................................................................................................... 89
3.14 ALMRoleLabel ........................................................................................................................................................... 90
3.14.1 Relations with Other Requests .................................................................................................................. 90
3.14.2 List of Fields ...................................................................................................................................................... 91
3.14.3 Description of the field behavior ............................................................................................................... 93
3.15 ALMSecurityPolicy ................................................................................................................................................... 94
3.15.1 Relations with Other Requests .................................................................................................................. 94
3.15.2 List of Fields ...................................................................................................................................................... 95
3.15.3 Description of the field behavior ............................................................................................................... 96
3.16 ALMStatusLabel ....................................................................................................................................................... 97
3.16.1 Relations with Other Requests .................................................................................................................. 97
3.16.2 List of Fields ...................................................................................................................................................... 98
3.16.3 Description of the field behavior ............................................................................................................... 99
3.17 ALMType ................................................................................................................................................................... 100
3.17.1 Relations with Other Requests ................................................................................................................ 100
3.17.2 List of Fields .................................................................................................................................................... 101
3

4. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
3.17.3 Description of the field behavior ............................................................................................................. 102
3.18 ALMTypeLabel ........................................................................................................................................................ 103
3.18.1 Relations with Other Requests ................................................................................................................ 103
3.18.2 List of Fields .................................................................................................................................................... 104
3.18.3 Description of the field behavior ............................................................................................................. 105
3.19 ALMWorkConfiguration ....................................................................................................................................... 106
3.19.1 Relations with Other Requests ................................................................................................................ 106
3.19.2 List of Fields .................................................................................................................................................... 107
3.19.3 Description of the field behavior ............................................................................................................. 109
3.20 attachments ............................................................................................................................................................ 110
3.20.1 List of Fields .................................................................................................................................................... 110
3.20.2 Description of the field behavior ............................................................................................................. 111
3.21 Email_Rule............................................................................................................................................................... 112
3.21.1 Relations with Other Requests ................................................................................................................ 112
3.21.2 List of Fields .................................................................................................................................................... 113
3.21.3 Description of the field behavior ............................................................................................................. 120
3.22 groups ....................................................................................................................................................................... 121
3.22.1 Relations with Other Requests ................................................................................................................ 121
3.22.2 List of Fields .................................................................................................................................................... 122
3.22.3 Description of the field behavior ............................................................................................................. 123
3.23 UCM_Project ........................................................................................................................................................... 124
3.23.1 Relations with Other Requests ................................................................................................................ 124
3.23.2 List of Fields .................................................................................................................................................... 125
3.23.3 Description of the field behavior ............................................................................................................. 128
3.24 users .......................................................................................................................................................................... 129
3.24.1 Relations with Other Requests ................................................................................................................ 129
3.24.2 List of Fields .................................................................................................................................................... 130
3.24.3 Description of the field behavior ............................................................................................................. 131
4

5. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
1 ALM Schema
1.1 General Information
Table 1. ALM Schema - general information
Name Value
Version 1
Description Schema for Application Lifecycle Management.
Unix Script Language PERL
Windows Script Language BASIC
Package_ALMProject_Return_String_Mode RETURN_STRING_UNICODE
Package_ALMProject_Windows_Script_Language PERL
Package_Email_Return_String_Mode RETURN_STRING_UNICODE
Package_UCMPolicyScripts_Windows_Script_Language BASIC
Package_UnifiedChangeManagement_Windows_Script_Lang BASIC
uage
Applied Package Form Tab Names_AMStateTypes_1 SUBMITTABNAMES=;RECORDTABNAMES=
Applied Package Form Tab SUBMITTABNAMES=Unified Change
Names_UnifiedChangeManagement_11 Management;RECORDTABNAMES=Unified Change
Management
Package_BuildTracking_Windows_Script_Language PERL
Package_BuildTracking_Return_String_Mode RETURN_STRING_UNICODE
Package_ALMWork_Return_String_Mode RETURN_STRING_UNICODE
Package_ALMWork_Windows_Script_Language PERL
Applied Package Form Tab Names_Email_13 SUBMITTABNAMES=;RECORDTABNAMES=
1.2 Relations Between Requests
Figure 1. ALM Schema - relations between requests
5

6. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2 Description of Record Types
2.1 ALMActivity
2.1.1 Relations with Other Requests
Figure 2. ALMActivity - relations with other requests
6

7. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.1.2 State Diagram
Figure 3. ALMActivity - state diagram
2.1.3 Transition Matrix
Table 2. ALMActivity - transition matrix
To From Activated Completed Opened Submitted
Activated Activate Activate
Completed Complete Complete
Opened ReOpen Open
Submitted ReadyToWaiting
2.1.4 List of Actions
Table 3. ALMActivity - list of actions
Name Description Access Initialization Validation Commit Notification
control
Activate All Users
Approval PERL PERL
Complete All Users
Delete All Users
Import All Users
7

8. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
Modify All Users
Open All Users
QuestionOrCo All Users
mment
ReadyToWaiti All Users
ng
ReOpen All Users PERL
Send_Email_N All Users BASIC
otif
Submit All Users PERL
ucm_base_sync All Users PERL BASIC
hronize
WorkOn All Users
8

9. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.1.5 List of Fields
Table 4. ALMActivity - list of fields
Name Type Size Description Default value Permission Value Changed Validation Choice List
am_statetype STATETYPE 0
dbid DBID 0
history JOURNAL 0
id ID 13
is_active INT 0
is_duplicate INT 0
lock_version INT 0
locked_by REFERENCE 0 DEFAULT
ratl_mastership REFERENCE 0 the replica site DEFAULT
where this record
can be modified
record_type RECORDTYPE 30
State STATE 0
unduplicate_state SHORT_STRING 50
version INT 0
ActivitiesRelated REFERENCE_LI 0 Sometimes work DEFAULT
ST assigments are
related to other
assignments. You
can establish a
relationship
between activities
to help identify
dependencies.
Attachments ATTACHMENT_ 0 N/A
LIST
Description MULTILINE_ST 0
RING
Doc_Related SHORT_STRING 50 CONSTANT: CONSTANT_LIS
NO T:
NO
YES
9

10. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
FailedInBuilds REFERENCE 0 If the activity DEFAULT
represents
development
work, identify if
the build failed.
Headline SHORT_STRING 125
NoPlanToTestInB REFERENCE 0 If the activity DEFAULT
uilds represents
development
work, identify if
there is no plan to
test.
NotifyList REFERENCE_LI 0 Identify a list of DEFAULT
ST users to notify.
OldID SHORT_STRING 13 PERL
Owner REFERENCE 0 PERL PERL
Project REFERENCE 0 Work is PERL DEFAULT
completed in the
context of a
project. Choose
the project where
this will be
completed.
ResolutionCode REFERENCE 0 Identify the result PERL
of this
assignment.
ResolutionSumma MULTILINE_ST 0 Describe how this
ry RING activity was
resolved.
Roles REFERENCE_LI 0 PERL DEFAULT
ST
SecurityPolicy REFERENCE 0 DEFAULT
Task REFERENCE 0 PERL PERL DEFAULT
Type REFERENCE 0 PERL PERL
10

11. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
ucm_project REFERENCE 0 This should be set BASIC DEFAULT
to the
UCM_Project
entity which
corresponds to the
ClearCase project
where this entity
will be worked
on.
ucm_stream SHORT_STRING 50 This is a display- BASIC
only field which
shows the
ClearCase stream
where this entity
has been worked
on (if it has been
worked on
already).
ucm_stream_obje SHORT_STRING 128
ct
ucm_view SHORT_STRING 50 This is a display- BASIC
only field which
shows the
ClearCase view
where this entity
is being worked
on (if there is
one).
ucm_vob_object SHORT_STRING 128
ValidatedInBuilds REFERENCE 0 If this activity DEFAULT
represents
development
work that requires
testing, identify
the build in which
it is validated.
11

12. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.1.6 Description of the field behavior
Table 5. ALMActivity - description of the field behavior
Activated Completed Opened Submitted Default
behavior
am_statetype OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
dbid READONLY READONLY READONLY READONLY READONLY
history READONLY READONLY READONLY READONLY READONLY
id READONLY READONLY READONLY READONLY READONLY
is_active READONLY READONLY READONLY READONLY READONLY
is_duplicate READONLY READONLY READONLY READONLY READONLY
lock_version READONLY READONLY READONLY READONLY READONLY
locked_by READONLY READONLY READONLY READONLY READONLY
ratl_mastership OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
record_type READONLY READONLY READONLY READONLY READONLY
State READONLY READONLY READONLY READONLY READONLY
unduplicate_sta READONLY READONLY READONLY READONLY READONLY
te
version READONLY READONLY READONLY READONLY READONLY
ActivitiesRelat OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
ed
Attachments OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Description OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Doc_Related OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
FailedInBuilds OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Headline MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY
NoPlanToTestI OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
nBuilds
NotifyList OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
OldID READONLY READONLY READONLY READONLY READONLY
Owner MANDATORY MANDATORY MANDATORY OPTIONAL MANDATORY
Project READONLY READONLY READONLY READONLY OPTIONAL
ResolutionCod OPTIONAL MANDATORY OPTIONAL OPTIONAL OPTIONAL
e
ResolutionSum OPTIONAL MANDATORY OPTIONAL OPTIONAL OPTIONAL
mary
Roles READONLY READONLY READONLY MANDATORY READONLY
SecurityPolicy MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY
Task MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY
Type MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY
ucm_project USE_HOOK USE_HOOK USE_HOOK USE_HOOK USE_HOOK
ucm_stream USE_HOOK USE_HOOK USE_HOOK USE_HOOK USE_HOOK
ucm_stream_o OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
bject
ucm_view USE_HOOK USE_HOOK USE_HOOK USE_HOOK USE_HOOK
ucm_vob_obje OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
ct
ValidatedInBui OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
lds
12

13. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.2 ALMProject
2.2.1 Relations with Other Requests
Figure 4. ALMProject - relations with other requests
13

14. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.2.2 State Diagram
Figure 5. ALMProject - state diagram
2.2.3 Transition Matrix
Table 6. ALMProject - transition matrix
To From Canceled Completed InProgress Pending Postponed
Canceled Cancel Cancel
Completed Complete
InProgress ResumeInProgress Launch ResumeInProgress
Pending ResumePending ResumePending
Postponed Postpone Postpone
2.2.4 List of Actions
Table 7. ALMProject - list of actions
Name Description Access Initialization Validation Commit Notification
control
ALMApproval PERL PERL
ALMCheckFor All Users PERL
Duplicates
Cancel All Users
Complete All Users
Create All Users
Delete All Users
Import All Users
Launch All Users
Modify All Users
Postpone All Users
ResumeInProgr All Users
ess
ResumePendin All Users
g
SetDefault All Users
14

15. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.2.5 List of Fields
Table 8. ALMProject - list of fields
Name Type Size Description Default value Permission Value Changed Validation Choice List
dbid DBID 0
history JOURNAL 0
id ID 13
is_active INT 0
is_duplicate INT 0
lock_version INT 0
locked_by REFERENCE 0 DEFAULT
ratl_context_grou REFERENCE_LI 0 Context groups DEFAULT
ps ST associated with
the context record
type
ratl_mastership REFERENCE 0 the replica site DEFAULT
where this record
can be modified
record_type RECORDTYPE 30
State STATE 0
unduplicate_state SHORT_STRING 50
version INT 0
Category REFERENCE 0 A means of PERL PERL
identifying the
context of the
project. If the list
is blank, create
new
ALMCategory.
Examples include
the Solution
name, a Product
name, a product
feature, a SOA
service name, a
reusable
component.
15

16. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
CopyToCategory REFERENCE 0 DEFAULT
CopyToProjectNa SHORT_STRING 254
me
CopyToRelease REFERENCE 0 DEFAULT
CurrentPhase REFERENCE 0 Phases can be DEFAULT
used to divide a
project into
smaller units of
time. For
example, the
Rational Unified
Process defines
the four phases of
Inception,
Elaboration,
Construction, and
Transition. This
field is optional.
CurrentPhaseLabe REFERENCE 0 Phases can be PERL PERL
l used to divide a
project into
smaller units of
time. For
example, the
Rational Unified
Process defines
the four phases of
Inception,
Elaboration,
Construction, and
Transition. This
field is optional.
DefaultRequest REFERENCE 0 PERL DEFAULT
DefaultTask REFERENCE 0 PERL DEFAULT
Description MULTILINE_ST 0
RING
EndDate DATE_TIME 0
16

17. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
Name SHORT_STRING 50 An identifier for
the project such as
the solution name,
or code name.
Obsolete SHORT_STRING 3 CONSTANT: CONSTANT_LIS
No T:
Yes
No
OldID SHORT_STRING 13 PERL
Owner REFERENCE 0 PERL PERL
PriorProject REFERENCE 0 DEFAULT
Release REFERENCE 0 An identifier for PERL DEFAULT
the version of the
solution created in
the context of this
project. An
example is:
version 7.1.0.0.
SecurityPolicy REFERENCE 0 Determine who DEFAULT
can access this
project by
selecting a
security policy. If
the list is blank,
create a new
ALMSecurityPoli
cy.
StartDate DATE_TIME 0
SuperProjects REFERENCE_LI 0 DEFAULT
ST
UCM_Project REFERENCE 0 DEFAULT
2.2.6 Description of the field behavior
Table 9. ALMProject - description of the field behavior
Canceled Completed InProgress Pending Postponed Default behavior
dbid READONLY READONLY READONLY READONLY READONLY READONLY
history READONLY READONLY READONLY READONLY READONLY READONLY
17

18. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
id READONLY READONLY READONLY READONLY READONLY READONLY
is_active READONLY READONLY READONLY READONLY READONLY READONLY
is_duplicate READONLY READONLY READONLY READONLY READONLY READONLY
lock_version READONLY READONLY READONLY READONLY READONLY READONLY
locked_by READONLY READONLY READONLY READONLY READONLY READONLY
ratl_context_groups OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
ratl_mastership OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
record_type READONLY READONLY READONLY READONLY READONLY READONLY
State READONLY READONLY READONLY READONLY READONLY READONLY
unduplicate_state READONLY READONLY READONLY READONLY READONLY READONLY
version READONLY READONLY READONLY READONLY READONLY READONLY
Category MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY
CopyToCategory OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
CopyToProjectNam OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
e
CopyToRelease OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
CurrentPhase READONLY READONLY READONLY READONLY READONLY READONLY
CurrentPhaseLabel OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
DefaultRequest OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
DefaultTask OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Description OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
EndDate OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Name OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Obsolete OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
OldID READONLY READONLY READONLY READONLY READONLY READONLY
Owner MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY
PriorProject OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Release OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
SecurityPolicy MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY
StartDate OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
SuperProjects OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
18

19. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
UCM_Project OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
19

20. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.3 ALMRequest
2.3.1 Relations with Other Requests
Figure 6. ALMRequest - relations with other requests
20

21. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.3.2 State Diagram
Figure 7. ALMRequest - state diagram
2.3.3 Transition Matrix
Table 10. ALMRequest - transition matrix
To From Completed Opened Rejected Withdrawn
Completed Accept Accept
Opened ReOpen ReOpen ReOpen
Rejected Reject_Solution
Withdrawn Withdraw
2.3.4 List of Actions
Table 11. ALMRequest - list of actions
Name Description Access Initialization Validation Commit Notification
control
Accept All Users
CreateTask All Users
Delete PERL
DuplicateComp All Users
lete
Import PERL
MarkAsDuplic All Users
ate
Modify All Users
Open All Users PERL
QuestionOrCo All Users
mment
21

22. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
Reject_Request All Users
Reject_Solutio All Users
n
ReOpen All Users
Send_Email_N All Users BASIC
otif
Unreproducible All Users
Withdraw All Users
WorksAsDesig All Users
ned
22

23. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.3.5 List of Fields
Table 12. ALMRequest - list of fields
Name Type Size Description Default value Permission Value Changed Validation Choice List
dbid DBID 0
history JOURNAL 0
id ID 13
is_active INT 0
is_duplicate INT 0
lock_version INT 0
locked_by REFERENCE 0 DEFAULT
ratl_mastership REFERENCE 0 the replica site DEFAULT
where this record
can be modified
record_type RECORDTYPE 30
State STATE 0
unduplicate_state SHORT_STRING 50
version INT 0
Attachments ATTACHMENT_ 0 N/A
LIST
BTBuild REFERENCE_LI 0 DEFAULT
ST
Category REFERENCE 0 A category is a PERL PERL
user provided
organizing
mechanism used
to name or
classify objects.
Categories can be
hierarchical.
Select the
category that best
classifies this
request.
23

24. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
CategoryPath REFERENCE_LI 0 A category is a DEFAULT
ST user provided
organizing
mechanism used
to name or
classify objects.
Categories can be
hierarchical.
Select the
category that best
classifies this
request.
CategoryStringPat MULTILINE_ST 0
h RING
CategoryTypeLab REFERENCE 0 PERL PERL
el
Description MULTILINE_ST 0
RING
Headline SHORT_STRING 125
Iteration REFERENCE 0 DEFAULT
IterationLabel REFERENCE 0 Iterations can be PERL PERL
used to divide a
Phases into
smaller units of
time. If your
project is using
Iterations they
will appear on the
drop down.
NotifyList REFERENCE_LI 0 DEFAULT
ST
OldID SHORT_STRING 13 PERL
Owner REFERENCE 0 PERL PERL DEFAULT
24

25. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
Phase REFERENCE 0 Phases can be DEFAULT
used to divide a
project into
smaller units of
time. If your
project is using
Phases, they will
appear on the
drop down.
PhaseLabel REFERENCE 0 PERL PERL
Project REFERENCE 0 Requests arise PERL DEFAULT
within the context
of a project. It
might a defect in
the project
currently under
construction, it
could be an
enhancement
request to a
project that is
already deployed.
Identify the
project from
which this request
originates.
RequestsRelated REFERENCE_LI 0 DEFAULT
ST
SecurityPolicy REFERENCE 0 DEFAULT
Severity REFERENCE 0 PERL
Type REFERENCE 0 PERL
25

26. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.3.6 Description of the field behavior
Table 13. ALMRequest - description of the field behavior
Completed Opened Rejected Withdrawn Default
behavior
dbid READONLY READONLY READONLY READONLY READONLY
history READONLY READONLY READONLY READONLY READONLY
id READONLY READONLY READONLY READONLY READONLY
is_active READONLY READONLY READONLY READONLY READONLY
is_duplicate READONLY READONLY READONLY READONLY READONLY
lock_version READONLY READONLY READONLY READONLY READONLY
locked_by READONLY READONLY READONLY READONLY READONLY
ratl_mastership OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
record_type READONLY READONLY READONLY READONLY READONLY
State READONLY READONLY READONLY READONLY READONLY
unduplicate_sta READONLY READONLY READONLY READONLY READONLY
te
version READONLY READONLY READONLY READONLY READONLY
Attachments OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
BTBuild OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Category OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
CategoryPath OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
CategoryString READONLY READONLY READONLY READONLY READONLY
Path
CategoryTypeL OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
abel
Description OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Headline MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY
Iteration READONLY READONLY READONLY READONLY READONLY
IterationLabel OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
NotifyList OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
OldID READONLY READONLY READONLY READONLY READONLY
Owner MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY
Phase READONLY READONLY READONLY READONLY READONLY
PhaseLabel OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Project MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY
RequestsRelate OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
d
SecurityPolicy MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY
Severity MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY
Type MANDATORY MANDATORY MANDATORY MANDATORY MANDATORY
26

27. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.4 ALMTask
2.4.1 Relations with Other Requests
Figure 8. ALMTask - relations with other requests
27

28. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.4.2 State Diagram
Figure 9. ALMTask - state diagram
2.4.3 Transition Matrix
Table 14. ALMTask - transition matrix
To From Activated Completed Opened
Activated Activate Activate
Completed Complete Complete
Opened ReOpen ReOpen
2.4.4 List of Actions
Table 15. ALMTask - list of actions
Name Description Access Initialization Validation Commit Notification
control
Activate All Users PERL
Approval PERL
Complete All Users PERL
CreateActivity All Users
Delete All Users
Import All Users
Modify All Users
Open All Users PERL PERL
QuestionOrCo All Users
mment
ReOpen All Users PERL
Send_Email_N All Users BASIC
otif
28

29. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.4.5 List of Fields
Table 16. ALMTask - list of fields
Name Type Size Description Default value Permission Value Changed Validation Choice List
dbid DBID 0
history JOURNAL 0
id ID 13
is_active INT 0
is_duplicate INT 0
lock_version INT 0
locked_by REFERENCE 0 DEFAULT
ratl_mastership REFERENCE 0 the replica site DEFAULT
where this record
can be modified
record_type RECORDTYPE 30
State STATE 0
unduplicate_state SHORT_STRING 50
version INT 0
Attachments ATTACHMENT_ 0 N/A
LIST
BTBuild REFERENCE_LI 0 DEFAULT
ST
Description MULTILINE_ST 0
RING
Headline SHORT_STRING 125
Iteration REFERENCE 0 DEFAULT
29

30. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
IterationLabel REFERENCE 0 Iterations can be PERL PERL
used to divide a
phase into smaller
units of time. If
your project is
using iterations
they will appear
on the drop down
list. Determine
when to address
this task by
choosing a
Iteration.
NotifyList REFERENCE_LI 0 DEFAULT
ST
OldID SHORT_STRING 13 PERL
Owner REFERENCE 0 PERL PERL
Phase REFERENCE 0 Phases can be DEFAULT
used to divide a
project into
smaller units of
time. If your
project is using
Phases, they will
appear on the
drop down list.
Determine when
to address this
task by choosing a
Phase.
PhaseLabel REFERENCE 0 PERL PERL
Priority REFERENCE 0 PERL
Project REFERENCE 0 Work is PERL PERL DEFAULT
completed in the
context of a
project. Choose
the project where
this will be
completed.
30

31. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
Request REFERENCE 0 PERL PERL DEFAULT
ResolutionCode REFERENCE 0 Identify the result PERL
of this
assignment.
ResolutionSumma MULTILINE_ST 0
ry RING
Roles REFERENCE_LI 0 PERL DEFAULT
ST
SecurityPolicy REFERENCE 0 DEFAULT
TasksRelated REFERENCE_LI 0 DEFAULT
ST
Type REFERENCE 0 PERL PERL
31

32. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.4.6 Description of the field behavior
Table 17. ALMTask - description of the field behavior
Activated Completed Opened Default behavior
dbid READONLY READONLY READONLY READONLY
history READONLY READONLY READONLY READONLY
id READONLY READONLY READONLY READONLY
is_active READONLY READONLY READONLY READONLY
is_duplicate READONLY READONLY READONLY READONLY
lock_version READONLY READONLY READONLY READONLY
locked_by READONLY READONLY READONLY READONLY
ratl_mastership OPTIONAL OPTIONAL OPTIONAL OPTIONAL
record_type READONLY READONLY READONLY READONLY
State READONLY READONLY READONLY READONLY
unduplicate_state READONLY READONLY READONLY READONLY
version READONLY READONLY READONLY READONLY
Attachments OPTIONAL OPTIONAL OPTIONAL OPTIONAL
BTBuild OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Description OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Headline MANDATORY MANDATORY MANDATORY MANDATORY
Iteration OPTIONAL OPTIONAL OPTIONAL OPTIONAL
IterationLabel OPTIONAL OPTIONAL OPTIONAL OPTIONAL
NotifyList OPTIONAL OPTIONAL OPTIONAL OPTIONAL
OldID MANDATORY MANDATORY MANDATORY MANDATORY
Owner MANDATORY MANDATORY MANDATORY MANDATORY
Phase OPTIONAL OPTIONAL OPTIONAL OPTIONAL
PhaseLabel OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Priority MANDATORY MANDATORY MANDATORY MANDATORY
Project USE_HOOK USE_HOOK USE_HOOK USE_HOOK
Request MANDATORY MANDATORY MANDATORY MANDATORY
ResolutionCode OPTIONAL MANDATORY OPTIONAL OPTIONAL
ResolutionSummar OPTIONAL MANDATORY OPTIONAL OPTIONAL
y
Roles READONLY READONLY MANDATORY READONLY
SecurityPolicy MANDATORY MANDATORY MANDATORY MANDATORY
TasksRelated OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Type MANDATORY MANDATORY MANDATORY MANDATORY
32

33. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.5 BTBuild
2.5.1 Relations with Other Requests
Figure 10. BTBuild - relations with other requests
2.5.2 State Diagram
Figure 11. BTBuild - state diagram
33

34. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.5.3 Transition Matrix
Table 18. BTBuild - transition matrix
To From Completed Failed Retired Submitted
Completed Complete
Failed Failure
Retired Retire Retire
Submitted ReSubmit
2.5.4 List of Actions
Table 19. BTBuild - list of actions
Name Description Access Initialization Validation Commit Notification
control
ALMFieldReq All Users PERL
uiredness
Approval PERL PERL
BTBase All Users PERL
Complete All Users
Delete All Users
Failure All Users
Import All Users
Modify All Users
ReSubmit All Users
Retire All Users
Send_Email_N All Users BASIC
otif
Submit All Users
34

35. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.5.5 List of Fields
Table 20. BTBuild - list of fields
Name Type Size Description Default value Permission Value Changed Validation Choice List
dbid DBID 0
history JOURNAL 0
id ID 13
is_active INT 0
is_duplicate INT 0
lock_version INT 0
locked_by REFERENCE 0 DEFAULT
ratl_mastership REFERENCE 0 the replica site DEFAULT
where this record
can be modified
record_type RECORDTYPE 30
State STATE 0
unduplicate_state SHORT_STRING 50
version INT 0
ALMBaseline REFERENCE 0 DEFAULT
ALMBuildStatus REFERENCE 0 PERL
ALMBuildType REFERENCE 0 PERL
ALMObsolete SHORT_STRING 50 CONSTANT: CONSTANT_LIS
NO T:
NO
YES
ALMOwner REFERENCE 0 PERL PERL
ALMProject REFERENCE 0 PERL DEFAULT
ALMRoles REFERENCE_LI 0 PERL DEFAULT
ST
ALMSecurityPoli REFERENCE 0 DEFAULT
cy
Build_System_ID SHORT_STRING 50
Build_System_U SHORT_STRING 254
RL
BuildLog MULTILINE_ST 0
RING
End_DateTime DATE_TIME 0
35

36. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
OldID SHORT_STRING 254 PERL
Start_DateTime DATE_TIME 0
36

37. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.5.6 Description of the field behavior
Table 21. BTBuild - description of the field behavior
Completed Failed Retired Submitted Default
behavior
dbid READONLY READONLY READONLY READONLY READONLY
history READONLY READONLY READONLY READONLY READONLY
id READONLY READONLY READONLY READONLY READONLY
is_active READONLY READONLY READONLY READONLY READONLY
is_duplicate READONLY READONLY READONLY READONLY READONLY
lock_version READONLY READONLY READONLY READONLY READONLY
locked_by READONLY READONLY READONLY READONLY READONLY
ratl_mastership OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
record_type READONLY READONLY READONLY READONLY READONLY
State READONLY READONLY READONLY READONLY READONLY
unduplicate_sta READONLY READONLY READONLY READONLY READONLY
te
version READONLY READONLY READONLY READONLY READONLY
ALMBaseline OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
ALMBuildStat OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
us
ALMBuildTyp OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
e
ALMObsolete OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
ALMOwner OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
ALMProject OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
ALMRoles READONLY READONLY READONLY READONLY OPTIONAL
ALMSecurityP OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
olicy
Build_System_ READONLY READONLY READONLY MANDATORY MANDATORY
ID
Build_System_ OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
URL
BuildLog OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
End_DateTime OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
OldID OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Start_DateTim READONLY READONLY READONLY OPTIONAL OPTIONAL
e
37

38. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.6 UCMUtilityActivity
2.6.1 Relations with Other Requests
Figure 12. UCMUtilityActivity - relations with other requests
2.6.2 State Diagram
Figure 13. UCMUtilityActivity - state diagram
38

39. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.6.3 Transition Matrix
Table 22. UCMUtilityActivity - transition matrix
To From Active Complete Ready Submitted
Active Activate
Complete Complete
Ready ReOpen Assign
Submitted Postpone Postpone
2.6.4 List of Actions
Table 23. UCMUtilityActivity - list of actions
Name Description Access Initialization Validation Commit Notification
control
Activate All Users
Assign All Users
Complete All Users
Contributors All Users
Delete All Users
Import All Users
Modify All Users
Postpone All Users
ReOpen All Users
Submit All Users
ucm_base_sync All Users PERL BASIC
hronize
WorkOn All Users
39

40. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.6.5 List of Fields
Table 24. UCMUtilityActivity - list of fields
Name Type Size Description Default value Permission Value Changed Validation Choice List
am_statetype STATETYPE 0
dbid DBID 0
history JOURNAL 0
id ID 13
is_active INT 0
is_duplicate INT 0
lock_version INT 0
locked_by REFERENCE 0 DEFAULT
ratl_mastership REFERENCE 0 the replica site DEFAULT
where this record
can be modified
record_type RECORDTYPE 30
State STATE 0
unduplicate_state SHORT_STRING 50
version INT 0
Description MULTILINE_ST 0
RING
Headline SHORT_STRING 128
Owner REFERENCE 0 DEFAULT
ucm_project REFERENCE 0 This should be set BASIC DEFAULT
to the
UCM_Project
entity which
corresponds to the
ClearCase project
where this entity
will be worked
on.
40

41. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
ucm_stream SHORT_STRING 50 This is a display- BASIC
only field which
shows the
ClearCase stream
where this entity
has been worked
on (if it has been
worked on
already).
ucm_stream_obje SHORT_STRING 128
ct
ucm_view SHORT_STRING 50 This is a display- BASIC
only field which
shows the
ClearCase view
where this entity
is being worked
on (if there is
one).
ucm_vob_object SHORT_STRING 128
41

42. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
2.6.6 Description of the field behavior
Table 25. UCMUtilityActivity - description of the field behavior
Active Complete Ready Submitted Default
behavior
am_statetype OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
dbid READONLY READONLY READONLY READONLY READONLY
history READONLY READONLY READONLY READONLY READONLY
id READONLY READONLY READONLY READONLY READONLY
is_active READONLY READONLY READONLY READONLY READONLY
is_duplicate READONLY READONLY READONLY READONLY READONLY
lock_version READONLY READONLY READONLY READONLY READONLY
locked_by READONLY READONLY READONLY READONLY READONLY
ratl_mastership OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
record_type READONLY READONLY READONLY READONLY READONLY
State READONLY READONLY READONLY READONLY READONLY
unduplicate_sta READONLY READONLY READONLY READONLY READONLY
te
version READONLY READONLY READONLY READONLY READONLY
Description OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
Headline MANDATORY MANDATORY MANDATORY MANDATORY OPTIONAL
Owner MANDATORY OPTIONAL MANDATORY OPTIONAL OPTIONAL
ucm_project USE_HOOK USE_HOOK USE_HOOK USE_HOOK USE_HOOK
ucm_stream USE_HOOK USE_HOOK USE_HOOK USE_HOOK USE_HOOK
ucm_stream_o OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
bject
ucm_view USE_HOOK USE_HOOK USE_HOOK USE_HOOK USE_HOOK
ucm_vob_obje OPTIONAL OPTIONAL OPTIONAL OPTIONAL OPTIONAL
ct
42

43. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
3 Description of Stateless Record Types
3.1 ALMAdmin
3.1.1 Relations with Other Requests
Figure 14. ALMAdmin - relations with other requests
43

44. CM-Consult, Ltd.
info@cmcons.com
www.rational-tools.com
3.1.2 List of Fields
Table 26. ALMAdmin - list of fields
Name Type Size Description Default value Permission Value Changed Validation Choice List
dbid DBID 0
history JOURNAL 0
is_active INT 0
lock_version INT 0
locked_by REFERENCE 0 DEFAULT
ratl_keysite REFERENCE 0 the replica site DEFAULT
where this record
was last re-keyed
ratl_mastership REFERENCE 0 the replica site DEFAULT
where this record
can be modified
record_type RECORDTYPE 30
version INT 0
Groups REFERENCE_LI 0 PERL PERL PERL DEFAULT
ST
Label SHORT_STRING 254
Members REFERENCE_LI 0 PERL PERL DEFAULT
ST
Obsolete SHORT_STRING 254 CONSTANT: CONSTANT_LIS
NO T:
YES
NO
44