White Paper

RTC and UCD terminology

Print

Cover page of white paper about RTC and UCD terms

Here’s a list of terms that we put together for a customer who was learning how to use Rational Team Concert (RTC) with IBM UrbanCode Deploy (UCD). The list covers some terms that come up when you’re building applications in RTC and using UCD to deploy them. For details on how to set up that sort of build and deployment process, see the Rational Team Concert – SCM plugin.

Contents

Automation (UCD)

Application

UCD applications are collections of UCD components that work together to provide a business function. Applications include application processes, which deploy the components. Applications also contain environments, which represent the target systems that the application components are deployed on.

UCD components are assigned to applications. However, components are separate from applications; each component can be used in any number of applications.

IBM Knowledge Center: Applications

Compliance

Compliance refers to the number of UCD component versions that were successfully deployed to an environment. For example, if an application process attempted to deploy 3 component versions to an environment and only 2 deployed successfully, the compliance for the environment is 2/3.

IBM Knowledge Center: Environment inventory and compliance

Deployment

In UCD, the general term “deployment” usually refers to deploying an application by running an application process.

IBM Knowledge Center: Deploying

Environment

UCD environments are groups of UCD resources (mainly, target systems and the agents on those systems) that host application components. Environments are contained by applications.

IBM Knowledge Center: Environments

Inventory

Primarily, an inventory is a list of UCD component versions that were deployed to an environment, whether or not those component versions deployed successfully. The idea of inventory is closely related to the idea of compliance.

Each UCD component also has an inventory that lists every place that the component is deployed. Environments and resources have inventories that list every UCD component in that environment or resource.

IBM Knowledge Center: Environment inventory and compliance

Process

Component processes deploy UCD components, application processes deploy collections of UCD components, and generic processes run automated tasks on target systems.

IBM Knowledge Center: Processes

Resource

UCR resources are representations of external objects on the UCD server. For example, agents are represented by agent resources on the server.

IBM Knowledge Center: Resources

Source configuration

The source configuration is the collection of settings that describe how the UCD server imports build output into UCD component versions. Source configuration plugins provide connectivity from the UCD server to build and SCM systems such as Git and Subversion so the server can retrieve build output from those systems.

IBM Knowledge Center: Creating components

SCM (RTC)

Accept

To load RTC change sets that other people delivered to a stream. Similar to “pull” or “update” in other source code management systems.

IBM Knowledge Center: Change sets and change flow

Baseline

A permanent copy of an RTC component in a particular workspace or stream. Baselines are a known initial state from which teams can start work.

IBM Knowledge Center: Component baselines

Change set

One or more changes to RTC component files that can be delivered to streams.

IBM Knowledge Center: Change sets and change flow

Check in

To add file changes to a change set.

IBM Knowledge Center: Change sets and change flow

Component

RTC components are collections of related artifacts such as source files that have the same life cycle. Components are added to streams to store the source files that are being worked on in that stream.

IBM Knowledge Center: Streams and components

Deliver

The process of sending change sets from a repository workspace to one or more streams. Similar to “push” or “commit” in other source control systems.

IBM Knowledge Center: Change sets and change flow

Flow target

The stream to which change sets are delivered.

IBM Knowledge Center: Flow targets

Load

To check out RTC components so you can work with them in a local workspace.

IBM Knowledge Center: Change sets and change flow

Repository workspace

In RTC source control, a repository workspace (or sometimes just “workspace”) is a user’s collection of components that the user is working with. Users deliver changes from their repository workspace to one or more streams.

IBM Knowledge Center: Workspaces and sandboxes

Sandbox

An isolated reflection of a repository workspace where a developer can modify and test items away from other people.

IBM Knowledge Center: Workspaces and sandboxes

Snapshot

RTC snapshots capture the state of a stream or repository at a point in time. Technically, RTC snapshots are a collection of all baselines in a stream or repository. RTC snapshots can be imported into UCD as component versions.

IBM Knowledge Center: Workplace snapshots

Stream

In RTC source control, streams contain components and store the changes to the component artifacts while developers work to a new version or release of a piece of work.

IBM Knowledge Center: Creating streams

Version

In RTC, the term “version” is usually used in a more general sense to refer to a specific state of an artifact. The version of source artifacts in RTC are not directly connected to UCD component versions unless the RTC-UCD integration uses the RTC source version name as the UCD component version name.

IBM Knowledge Center: Workplace snapshots

Work item

Work items represent tasks, plan items, or defects to assign to people to complete or resolve.

IBM Knowledge Center: Work items

SCM (UCD)

CodeStation

The UCD artifact repository is called CodeStation, and it stores UCD component version artifacts and provides them at deployment time.

IBM Knowledge Center: Component versions

Component

UCD components represent deployable artifacts, usually not source code. UCD components include component processes, which automate deployment of the artifacts, and component versions, which are discrete collections of artifacts that represent a version of that component.

IBM Knowledge Center: Components

Snapshot

A UCD snapshot is a collection of UCD component versions that are known to work together. Snapshots are useful for storing working deployments and for promoting working deployments out of a development environment into a testing or production environment.

IBM Knowledge Center: Snapshots

Version

In UCD, the term “version” usually refers to component versions, which are discrete instances of the artifacts in a component. Component versions are usually imported from build systems such as RTC. Components can have full versions, which provide a complete copy of all artifacts, or incremental versions, which provide only the changed files from the prior version.

IBM Knowledge Center: Component versions

Work item

UCD refers to pending approvals as “work items.”

IBM Knowledge Center: Work items

Build (RTC)

Agent (Jazz Build Engine, Build Forge Agent)

Agents run on target systems and allow the RTC server to automate tasks, such as build processes. For RTC, these agents include the Jazz Build Engine and the Build Forge agent.

IBM Knowledge Center: Rational Build Agent

Build engine

The build engine is a virtual representation of a build agent on the RTC server. One build engine on RTC can map to one or more instances of the Build System Toolkit.

IBM Knowledge Center: Jazz Build Engines

Build System Toolkit

A set of command-line tools that processes build requests from RTC. It includes the Jazz Build Engine, a collection of Ant tasks, and the build agent that handles builds on z/OS and IBM i. Each instance of the Build System Toolkit is connected to a build engine on an RTC server.

IBM Knowledge Center: Rational Team Concert Build

Engine

In RTC, “engine” can refer to the Jazz Build Engine or to build engines.

IBM Knowledge Center: Jazz Build Engines

Jazz Build Engine

The Jazz Build Engine is a command-line tool that processes build requests on distributed platforms.

IBM Knowledge Center: Jazz Build Engines

Package

A group of deployable artifacts.

IBM Knowledge Center: Packaging and deploying with Enterprise Extensions

Security (RTC)

Permissions

In RTC, user permissions are mostly related to the team areas that the user is a member of. Users have a role on the team, and the role controls what permissions the user has on the team area’s assets.

IBM Knowledge Center: Understanding licenses, permissions, and access control

Project

Eclipse projects are containers for source artifacts on the local user’s Eclipse workspace. In many cases, RTC components include one or more Eclipse projects. Not directly related to RTC project areas.

IBM Knowledge Center: Sharing Eclipse projects with your team

Project area

A project area is a major organizational area on an RTC server. It contains things like streams and team areas.

IBM Knowledge Center: Creating and modifying project areas

Role

Each RTC user has a role on each project area or team area, and that role provides access to that area. RTC security roles do not currently connect to UCD security roles.

IBM Knowledge Center: Understanding licenses, permissions, and access control

Team/team area

An RTC team area is a smaller organizational area within a project area. It contains users that are working together on tasks and the roles that they have for that team’s artifacts.

IBM Knowledge Center: Creating a team area

Security (UCD)

Permissions

Elements such as UCD components and applications are assigned to teams, and users have access to the elements that are in the same team.

IBM Knowledge Center: Managing security

Role

UCD users have a role on a team. The role specifies what type of access the user has on the team’s components, applications, and other resources. Some roles provide read-only access and others provide read/write access.

IBM Knowledge Center: Roles and permissions

Team

UCD teams are a collection of users and the components, applications, and environments that those users can access.

IBM Knowledge Center: Teams