SmartImpact_ChaRM

This workflow performs a Smart Impact analysis in response to a ChaRM document moving into a particular state, for example, ‘Implemented’. The workflow should be registered as a REST API, which will be called automatically in response to the appropriate changes in a ChaRM document. The workflow generates a report URL which is stored in the Attachments section of the ChaRM document that triggered the impact analysis.

The depth used by the workflow to search for referenced objects may be set by an Administrator in the Configuration - Impact Analysis screen’s ImpactAnalysisDepth field. If you don't set this field, the workflow uses 10 as the default value.

Parallel impact analysis

You can run the SmartImpact_ChaRM workflow in parallel with other impact analysis apps and workflows.

Prerequisites

We recommend that you configure the Daily FOL workflow to run each night. This workflow maintains a database of SAP object dependencies for your Analysis system.

The SmartImpact_ChaRM workflow has the same prerequisites as the Smart Impact Analysis workflow. Additionally:
The Create Object Links Cache workflow should be scheduled to run weekly.
The Create Test Repository Cache workflow should be scheduled to run weekly.
The Cache IDoc Impact Data workflow should be scheduled to run weekly (if required).
Performance history data for the Usage system should be retrieved weekly using a schedule.

Prepare the workflow

To prepare the SmartImpact_ChaRM workflow, follow these steps:

Copy the template to a workspace

Drag the SmartImpact_ChaRM template from the Impact Analysis templates folder a new workspace. Its dependent workflows will also be copied. The workspace name should use alphanumeric characters only, and no spaces.

Create a Pipeline

The SmartImpact_ChaRM workflow uses a Pipeline to identify:

The Analysis, Comparison, Usage and SAP Solution Manager systems to be used in the analysis.
One or more Most-at-risk Search Test Repositories that will be searched to find test assets that match the most-at-risk executables.
A Most-at-Risk Gaps Test Repository, in which test requirements are to be created for most-at-risk objects that don't have matching test assets in the specified search Test Repositories.
One or more Most-at-risk Hits Execution Test Repositories, in which tests that match most-at-risk objects are to be created and executed.

Tester Business Critical

If the Pipeline’s Tester Business Critical checkbox is checked, the Pipeline’s Search Test Repositories are searched to find used objects that have associated tests. These objects are treated as business critical, so that impacted objects that have associated tests will be identified as most-at-risk.

Disable Table Content Analysis

If the Pipeline’s Disable Table Content Analysis checkbox is checked, table content changes will be excluded from the changing objects used in this app. If it is unchecked, table content changes will be included.

Before the SmartImpact_ChaRM workflow is run, you must create a Pipeline that includes the appropriate systems. In the Pipeline:

The Analysis System field stores the RFC Destination for your Analysis system.
The Comparison System field stores the RFC Destination for the system on which to compare the most-at-risk executables.
The Usage System field stores the RFC Destination for the system from which performance history data has been obtained.
The SAP Solution Manager System field stores the RFC Destination to the RFC Destination from which to retrieve the ChaRM IDs associated with each transportable task.
The Most-at-risk Search Test Repositories fields store the Test Repositories in which the most-at-risk objects are searched to find hits and gaps. Each Most-at-risk Search Test Repository may have one or more search paths to limit the folders that are searched. Each path should begin with the Subject folder, and a backslash (\) should be used to separate path components, for example Subject\Release1.
The Most-at-risk Gaps Test Repository field stores the Test Repository in which to create requirements for most-at for most-at-risk objects that don't already have requirements in the Tosca, qTest or ALM most-at-risk search Test Repository. Requirement names have the format LiveCompare_Most-at-risk_Gaps <YYYY-MM-DD HH:MM:SS> <Object Name - Object Description>.
The Requirements Path field the name of the root requirements folder to be used in the specified Tosca most-at-risk-search Test Repository. If you don't set this field, the workflow uses Requirements as the default value.
The Most-at-risk Hits Execution Test Repositories fields store the Test Repositories in which execution lists are to be created. For each most-at-risk hits execution Test Repository:
- Set the Execution Name field to the name of the test execution folder in which execution lists are to be created.
- Set the Execution Path field to the to the path of an existing Test Repository folder in which to store the test executions, for example Execution/TestExecutions. If you don't set this field, LiveCompare creates the test execution in the default Executions folder.
- Set the Execution List Path field to the path of an execution list to reuse when creating Tosca test executions, for example, Execution/MyTests/LiveCompare_2023-01-31 09:47:17/MyExecutionList.
- Set the Options field as appropriate to either create test runs, or to create and run test runs. Executing Tosca Tests requires Tosca to be configured using DEX.

Set the workflow parameters

In the SmartImpact_ChaRM workflow, follow these steps:

Set the Pipeline parameter to the Pipeline that includes your Analysis, Comparison, Usage and SAP Solution Manager systems, and the Test Repositories to be used in the Analysis.
Set the Request parameter to a ChaRM request to be analyzed.

Test the workflow

Before setting up the integration with ChaRM, test the workflow by running it directly in LiveCompare.

Register the workflow as a REST API

follow these steps to register the SmartImpact_ChaRM workflow as a REST API.

Select the workflow in the LiveCompare hierarchy and choose Register as REST API from the context menu to start the Register Workflow as REST API Wizard.
In the Choose Input Parameters dialog, select the Request parameter, and click Next.
In the Choose Output Parameter dialog, confirm that the Report parameter is selected, and click Next.
In the Properties dialog, enter ‘SmartImpact_ChaRM Rest API’ in the Description field, and click Next.
In the Finish - Confirm Register REST API dialog, check your settings, and click Finish.

Create an API token

To create an API token for the REST API, follow these steps:

Sign in to LiveCompare as an Administrator and click to go to the studio.
Select the Data > Rest APIs folder in the LiveCompare hierarchy.
In the REST APIs screen, locate the SmartImpact_ChaRM REST API and click Make API Token.
In the Create API Token screen, select an expiration period and click Create API Token.
In the API Tokens screen, copy the API token and paste it into a text document for later use.

Integrate the workflow with ChaRM

Follow the steps in this topic to allow the SmartImpact_ChaRM Rest API to be called from ChaRM.

Express and Standard modes

The SmartImpact_ChaRM workflow runs in either Express or Standard mode, depending on whether its changing objects all exist in the database of SAP object dependencies you created here.

If the SmartImpact_ChaRM workflow’s changing objects are all in the dependencies database, it runs in Express mode. The workflow’s Find Object Links (Read Only) action reads the dependencies database directly and doesn’t need to connect to SAP to find any object dependencies.
If the SmartImpact_ChaRM workflow’s changing objects aren’t all in the dependencies database, it runs in Standard mode. The workflow’s Find Object Links (Read Only) action connects to SAP to find the missing dependencies.

The SmartImpact_ChaRM workflow typically runs much faster in Express mode.

Run the workflow

The SmartImpact_ChaRM workflow is called automatically from the REST API in response to the change request status change that has been configured in ChaRM, for example, a ChaRM change request is moved into the ‘Implemented’ state. The REST API may be invoked manually from ChaRM by editing a change request and choosing LiveCompare ChaRM Impact Analysis (Manual) from the Actions menu.

Workflow results

The SmartImpact_ChaRM workflow generates the same results as the Smart Impact Analysis workflow.