SirLib

From m204wiki
Revision as of 17:44, 22 May 2017 by JAL (talk | contribs) (minor formatting)
Jump to navigation Jump to search

SirLib is a change management system for User Language procedures residing in Model 204 procedure files. It is a companion product to SirPro, with SirPro providing change-creation functions, and SirLib providing the functions that apply and back out changes.

SirLib is part of the RKTools family of products from Rocket Software. Prior to version 7.5 of Model 204, the RKTools family was known as UL/SPF and required the installation of the Sirius Mods, with a version equal to or higher than the SirLib version. As of Model 204 V7.5, the functions and facilities necessary to run RKTools are built into the Model 204 Online load module.

SirLib and configuration management

SirLib runs as an application subsystem inside a Model 204 Online, as does SirPro, a package of productivity tools. Together they provide a complete, integrated SOUL developers' environment. SirPro provides the programmers' environment, and SirLib provides the management environment for applying and backing out updates.

There is some overlap in programmer and management activity in managed environments, and there is no reason why programmers cannot be responsible for performing SirLib functions. This document covers briefly the SirPro functions related to managed changes. These functions are also covered in the SirPro pages.

Configuration management functions typically fall into four categories:

  • Identifying, grouping, and documenting system changes.
  • Providing an environment for controlling change and programmer activity.
  • Backing out changes.
  • Reporting on system configurations.

SirLib provides specific functions for each facet of change control. Furthermore, SirLib reduces the complexities of procedure distribution to such an extent that only a single, small procedure file needs to be distributed to production environment(s), no matter how many applications run in that environment.

In addition, SirLib is designed to provide specific mechanisms to automate and simplify programmers' tasks:

  • SirLib prevents programmers overwriting each others' changes. In typical change management systems, this involves a procedure lock. SirLib performs this function without locking procedures.
  • SirLib allows developers to continue working in the manner they're used to. SirLib does not dictate a development method.
  • SirLib allows for quick fixes and fast backout of changes when introduced changes cause production problems.
  • Reporting capabilities are integrated, and the data for reporting does not have to be manually entered — reporting data is generated to the internal dataset SIRLIBD when system activity occurs.
  • Verification of change level (or status, release number, etc.) is available in all environments where SirLib runs, via both reports and optional internal procedure comments.

Most change management systems will not work in Model 204, because:

  • They cannot be integrated with developer tools.
  • They cannot handle the long procedure names permitted in Model 204.
  • They don't understand the concept of Model 204 GROUPs.

SirLib was designed to deal with all these change management issues and to work under a wide range of Model 204 configurations. SirLib provides primarily a means to achieve a well-managed SOUL environment: it doesn't dictate procedure promotion schemes, and it doesn't force any project to manage its changes the same way as other projects in the same shop. A shop can standardize on a single mechanism, while allowing each project to promote changes via a path that is as simple and straightforward as possible.

In addition, SirLib allows multiple users to make updates to the same procedure at the same time, and it eliminates the risk of programmers overwriting each others' changes. Essentially the granularity of an update is reduced to a section of a program, and possible update collisions are detected and handled unambiguously and early in the development process.

A managed update refers to any change to a Model 204 procedure which is managed by the change management system. In this document, that means any change generated using SirPro and applied using SirLib. Managed updates may be small bug fixes, major application enhancements, or additions and deletions of whole procedures. Managed and unmanaged updates are made with the 3270 full-screen interface to the Model 204 SirPro editors, or with the RKWeb Build > Edit option.

A managed file is a file that is being managed by a change management system, in this case, SirLib. In managed files, only managed updates should occur. If unmanaged updates are allowed to occur to procedures in managed files, the entire change management scheme can be compromised. This is why it is recommended that you:

  1. Convert your managed files to PUBLIC with low (X'0221') privileges.
  2. Allocate the files to the SIRLIB subsystem.

Then anyone can read the file, but only the change management system can update procedures in it.

Getting started

If this is your first time using SirLib, read SirLib "getting started" steps for SirLib and SirPro environment configuration tips, before you continue with the detailed portions of the SirLib topics.

SirLib topics

The SirLib documentation consists of the pages listed below. This list is also available as a "See also" link from each of the pages.

For information about product changes and Model 204 feature support per SirLib version, see the release notes.

For information about product error messages, see MSIR. messages.

See also