Rational® Programming
Patterns is now installed on top of IBM® Rational Team Concert™.
You must configure Rational
Team Concert to integrate Rational Programming
Patterns with it.
About this task
The purpose of this integration is to prepare the building
of indexes in the Rational Programming
Patterns server. You must complete the following actions:
- From the Rational
Team Concert web client, ensure that the user has the required
permissions for the configuration,
- From the Rational
Team Concert Eclipse client, create a project area (if it has
not already been done),
- From the Rational
Team Concert Eclipse client, create four language definitions
and associate indexing scanners to them,
- From the Rational
Team Concert Eclipse client, select the data streams that will
be scanned.
For an optimum integration, you are advised to modify some
default parameters.
Note: After successive installations of reinstallations,
the server cache might be desynchronized with the actual server configuration.
For example, the Rational Programming
Patterns scanners might not be displayed. So, the language definitions
that are related to Rational Programming
Patterns cannot be correctly specified. You must then reset the cache.
- Log in as an administrator to https://[fully-qualified
hostname]:9443/ccm/admin?internal.
- In the Internal tools entry, click Provision
status. All the contributors to the Rational Team Concert server
are displayed. If the Rational Programming
Patterns plug-ins are displayed among these contributors, you must
reset the cache.
- To reset the cache, click Reset server that
is located after Provision status.
- Click Request server reset. The cache will
then be reset the next time that the server is started.
- Stop and start the server again. The server start takes longer
than a standard start because the cache is reset.
Procedure
- Create a user and assign permissions to this user:
- Start the Jazz™ Team
Server and open its setup wizard
(https://[fully-qualified
hostname]:9443/jts/setup)
Follow all the steps explained
in the Rational
Team Concert documentation: Running the setup wizard
- Create a user, if it has not already been done.
- Assign this new user a Developer for IBM
Enterprise Platforms Client Access License.
- Verify that the created user has all the repository
permissions and the Developer for IBM Enterprise Platforms Client
Access License.
- Create a project area:
- Start Rational Programming
Patterns.
- Open the Work Items perspective.
- In the Team Artifacts view, create
a repository connection at:
https://[fully-qualified
hostname]:9443/ccm
with the administrator user already
created.
- Create a project area.
Note: Explanations
about project areas can be found in the Rational solution for Collaborative Lifecycle
Management documentation.
- Verify the access permissions:
As an administrator,
you must verify that the user who is to create the language definitions
for the Rational Programming
Patterns artifacts has the appropriate access permissions.
- From the Work Items perspective
of the Eclipse workspace, open the project area by right-clicking
it and selecting Open.
- On the Overview tab of the project
area, verify the role that is assigned to the user who is to create
the language definitions.
- Open the Process Configuration tab.
Expand Project Configuration in the Configuration tree
and select Permissions. In the list of Roles,
select the role of the user who is to create the language definitions.
In the Permitted actions tree, verify that
the lines Language Definitions and Source
Code Data are selected.
Figure 1. The Process
Configuration tab
- Save.
- Create the language definitions and select the associated
scanners:
You can now create four language definitions:
- RPP Design
- RPP Design Path
- RPP Generated
- RPP Macro
- Expand the project area in the Team Artifacts view.
Then, expand . Right-click Language Definitions and
select New Language Definition. The Language
Definition editor opens. It contains a General tab
and a Scanners tab.
Figure 2. The Language
Definition editor
- Create the language definition for the design artifacts.
- In the General tab:
- Enter RPP Design in the Name field.
- Enter an optional description, such as RPP Design File
Scanner, in the Description field.
- Select COBOL in the Language field.
- Enter the following file extensions in the File Extensions field.
Only these file extensions are used by Rational Programming Patterns. Wildcards
cannot be used. Since all these file extensions must be indicated,
you are advised to copy and paste the following lines:
- If you use the entities of the Pacbase facet, copy the
lines:
dataaggregate,dataelement,dataunit,pacblockbase,pacdialog,pacscreen,
pacdialogserver,pacserver,paclibrary,pacprogram,pacreport,pacinputaid,
pactext,metaentity,userentity,metadataaggregate,metaentitytype,
pacerrorlabel,paccopybook,pacvolume
Attention: Up
until version V9.1, the pacmacro extension was one
of the design artifact extensions. A specific language definition
is now dedicated to it. You must then remove it from the language
definition for the design artifacts and create a language definition
for the Macros.
- If you use the entities of the COBOL facet, copy the lines:
metaentity,userentity,metadataaggregate,metaentitytype,
copy,program,skeleton,micropatterncode,sourcecode
- In the Scanners tab, remove the default
scanner and add the RPP Design Scanner for
this language definition.
- Save.
- Create the language definition for the design path artifacts.
- Select New Language Definition again.
- In the General tab:
- In the Scanners tab, remove the default
scanner and add the RPP DesignPath Scanner for
this language definition.
- Save.
- Create the language definition for the generated artifacts.
- Select New Language Definition again.
- In the General tab:
- Enter RPP Generated in the Name field.
- Enter an optional description, such as RPP Generated
File Scanner, in the Description field.
- Select COBOL in the Language field.
- Enter the following file extensions in the File Extensions field.
Only these file extensions are used by Rational Programming Patterns. Wildcards
cannot be used. Since all these file extensions must be indicated,
you are advised to copy and paste the following lines:
- If you use the entities of the Pacbase facet, copy the
line:
cblpdp,bmspdp,mappdp,mfspdp,ddlpdp,txtpdp,cpypdp
- If you use the entities of the COBOL facet, copy the line:
cpypdp
Moreover,
to trigger the analysis of the sources that are generated from the
Source Code instances, you must also add the name of each extension,
followed by pdp. The extension name is the value
that is indicated in the Source code generated file extension in
the Definition tab of the generic Skeleton
that is referenced in the Source Code. If this value is not indicated,
the extension name is the name of the generic Skeleton. For example,
for the txt extension, you must indicate txtpdp for
the scanner.
- In the Scanners tab, remove the default
scanner and add the RPP Generated File Scanner for
this language definition.
- Save.
- Create the language definition for the Macros.
- Select New Language Definition again.
- In the General tab:
- Associate data streams with the language definitions:
Specify which streams are to be scanned. In the Team
Artifacts view, under Enterprise Extensions,
right-click Source Code Data. Then, click Select
streams for scanning. Specify the stream.
If you
cannot see any stream, you must create one before you select it. Follow
the instructions in the Rational
Team Concert documentation.
Figure 3. How to access the
stream selection wizard
- Modify parameters
- Memory parameters of the client workstation:
- eclipse.ini
You must modify the memory
parameter of the Software Delivery Platform. Its maximum value varies
according to the operating system and the memory available. You must
then find the maximum value for your configuration.
To do so,
edit the eclipse.ini file that is located directly
under the root of your Software Delivery Platform.
The Java™ heap size is set to 1024 by
default (in
-Xmx1024m). You can increase this
value to adapt it to your configuration.
Note: For an installation
in 32-bit mode, the maximum value is 1.5 gigabyte.
- scm.ini
The migration of data from Pacbase
to Rational Programming
Patterns uses the scmtools to save the migrated data in Rational Team Concert
You
must modify the scm.ini file like the eclipse.ini file.
The scm.ini file
is in ...\scmtools\eclipse. The Java heap size is set to 512 by default (in -Xmx512m).
- Memory parameter of the server:
You can adapt the server.startup.bat file
that is in the ...\server directory. In a 64-bit
environment, and if the server allows it, you can modify the line set
JAVA_OPTS=%JAVA_OPTS% -Xmx4G to increase the maximum memory
in use to 8G.
- Properties of the Rational Team Concert server:
- No creation of duplicate components:
By default, the component
names are not unique in the Rational Team Concert repository.
To avoid inconsistencies, an administrator is then advised to prevent
users from creating components whose names are not unique.
- Log in as an administrator to https://[fully-qualified
hostname]:9443/ccm/admin.
- In the Configuration entry, click Advanced
properties.
- Scroll the properties down to the SCM category.
Scroll the category down to com.ibm.team.scm.service.internal.tasks.InternalScmService.
- Find the property Encourage component names to be unique.
- Click its current value (false by default)
and change it to true.
- Click the Save button that is at the beginning
of the properties page.
- Maximum number of files in source code data resource:
With this
modification, you avoid a too large memory consumption.
- Log in as an administrator to https://[fully-qualified
hostname]:9443/ccm/admin.
- In the Configuration entry, click Advanced
properties.
- Scroll the properties down to the Source code data
collection category. This category contains the line com.ibm.team.enterprise.internal.metadata.collection.service.Metadata
CollectionService.
- Change the value of the property Max. number of files
in source code data resource. Click its current value
and enter 100 instead.
- DB2® parameter:
To
run Rational Team
Concert with a DB2 database,
you can see the jazz.net site for information about the DB2 tuning. To import large DB2 databases, you must increase the following
values:
db2 UPDATE DB CFG FOR CCM using LOGPRIMARY 100
db2 UPDATE DB CFG FOR CCM using LOGSECOND 100
where
100 is
the increased value. To see the values, use the following command:
:
db2 GET DB CFG FOR sample |grep '(LOG[FPS]'
You
obtain the following values:
Size of journal files (4 Kb) (LOGFILSIZ) = 1000
Number of primary journal files (LOGPRIMARY) = 3
Number of secondary journal files (LOGSECOND) = 2
Results
The configuration steps are now finished.
When you
deliver a project that contains Rational Programming
Patterns artifacts, the artifacts will be indexed after the indexing
process has been manually or automatically activated. You will then
be able to perform searches on the server repository.