Supported actions

Edit online

The SCLM sample RAM employs the core functions of ISPF and SCLM in CARMA's User Interface. This functionality enables users to send requests to the SCLM RAM on the z/OS® host and then display the results at their workstation. The following is a list of SCLM functions that can be invoked from a member’s selection in the CARMA UI.

Table 1. Basic Functions
Function Name	Description
`LOCK`	This is a stand-alone function that enables a user to lock a member or add an access key to limit or restrict access to it by other users. This function can be enabled by right-clicking an SCLM member in the CARMA UI and selecting Lock from the menu.
`UNLOCK`	This function will unlock a member that has been locked by removing the access key. It can be accessed by right-clicking the locked member in the CARMA UI and selecting Unlock from the menu.
`DELETE`	This function will delete all traces of an SCLM member, including all text and any metadata, from an SCLM project. This function can be accessed by right-clicking an SCLM member in the CARMA UI and selecting Delete from the menu.

The following functions are custom actions that are specific to SCLM RAM content. They can be accessed by right-clicking an SCLM member from the CARMA UI and selecting Custom from the menu.

Note: The custom commands below will prompt users for additional parameters.

Table 2. Custom Actions
Service Name	Description
`MIGRATE`	The `MIGRATE` service creates or updates the SCLM accounting information for members in a development library. Pattern matching is not provided at this time.
`BUILD`	The `BUILD` service compiles, links, and integrates software components according to the project’s architecture definition. Before a member is built however, the member’s dependency information must exist in the project database. For this reason, either the `STORE` or `SAVE` services for a member must be completed successfully before the `BUILD` service can be preformed.
`PROMOTE`	The `PROMOTE` service moves data, or promotes data through the project database according to the project’s architecture definition and project definition. Before SCLM can promote a member, it must have a blank access key in addition to having successfully completed the `BUILD` service. If a member has an access key, you must call the `UNLOCK` service to reset the access key before you can promote the member.
`DELETE`	The `DELETE` service deletes database components. You can delete an entire member, its associated accounting records, and build map, just the accounting records and the build map, or simply the member’s build map.
`EDIT`	The `EDIT` service is not like SCLM's edit. This service is instead used to announce the intent of an edit. The user will be prompted for the development group to move the member to. A refresh is required so the user can select the member at development level by double-clicking on member. At is point; the source code will appear in the UI’s edit panel.

The following are services of the SCLM API that the SCLM RAM uses to provide functionality.

Table 3. Integrated SCLM Services
Service Name	Description
`SCLMINFO`	The `SCLMINFO` service is used by CARMA’s `getmembers` function to retrieve all SCLM groups and types stored in ISPF variables for later retrieval from `getContainer`.
`SAVE`	The `SAVE` service locks and parses a member then proceeds to store that member’s statistical, dependency, and historical information all in one service call. The `SAVE` service called within CARMA’s `putMember` function calls the `LOCK`, `PARSE`, and `STORE` SCLM services.

The following SCLM services maintain session integrity within existing CARMA functions.

Table 4. SCLM services
Service Name	Description
`INIT`	The `INIT` service initializes an SCLM ID. During this process, it also initializes the specified project definition.
`START`	The `START` service initializes an SCLM services session. It generates an application ID that identifies the services session.
`END`	The `END` service stops an SCLM service session and frees an application ID generated by the `START` service. Each `START` service invocation needs a matching `END` service invocation. This service also calls the `FREE` service to free any SCLM IDs associated with the given application ID that have not been explicitly freed.
`FREE`	The `FREE` service frees an SCLM ID generated by the `INIT` service. Each `INIT` service invocation needs a matching `FREE` service invocation. After freeing the SCLM ID, SCLM closes all project data sets and frees the project definition specified on the `INIT` service.