Repository tools command to archive inactive users

Use the archiveUser command to archive users.

Purpose

The archiveUser command can be used to archive inactive users.
Important: The server must be running when you run the command.

Parameters

Attribute Description Required Default
userId The ID of the user to be archived. Yes N/A
repositoryURL The connection URL for the server. No https://localhost:9443/application

where application is jts, ccm, rm, qm, gc, dcc, or relm.

adminUserId Administrator user ID to login to the repository. No ADMIN
adminPassword Administrator password to login to the repository. No ADMIN
credentialsFile The file containing the administrator user's login credentials. No credentials.properties
certificateFile The file containing the administrator user's login certificate. No None
smartCard The alias to login using a smart card, or ? to list available aliases. No None
logFile Path to the log file. No repotools-application_archiveUser.log

where application is jts, ccm, rm, qm, gc, dcc, or relm.

kerberos Authenticate with Windows user credentials using Kerberos/SPNEGO by setting to true. Or authenticate with Windows Integrated Authentication by setting to windows. No None

Example

The following example is for Jazz® Team Server. To use this command for other applications, run these options from the server directory:
  • IBM® Engineering Workflow Management (Change and Configuration Management application): repotools-ccm
  • IBM Engineering Requirements Management DOORS® Next (Requirements Management application): repotools-rm
  • IBM Engineering Test Management (Quality Management application): repotools-qm
  • Global Configuration Management: repotools-gc
  • Data Collection Component: repotools-dcc
  • IBM Engineering Lifecycle Optimization - Engineering Insights: repotools-relm

For Windows
operating system Open a command prompt and enter this command:

cd C:\Program Files\IBM\JazzTeamServer\server\
repotools-jts.bat -archiveUser userId=archivedUser repositoryURL=https://hostname.example.com:9443/jts kerberos=true

For Unix
operating systems Open a command line and enter this command:

cd opt/IBM/JazzTeamServer/server
./repotools-jts.sh -archiveUser userId=archivedUser repositoryURL=https://hostname.example.com:9443/jts