Documentation PUBLIC Document Version: 1.2 – Final Date: November 29, 2016 Documentation for Custom Code Infrastructure Check Documentation PUBLIC Document History Version Status Date 0.9 Draft 2016/11/01 1.0 Final 2016/11/25 1.1 Final 2016/11/26 Add changes regarding changed infrastructure 1.2 Final 2016/11/28 Add information regarding MAI integration Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final Change November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 2 Documentation PUBLIC Table of Contents 1 1.1 1.2 Organizational Aspects ........................................................................................... 4 Authors ............................................................................................................................................. 4 Scope ............................................................................................................................................... 4 2 2.1 General Information ................................................................................................ 5 Prerequisites and Deployment.......................................................................................................... 5 3 3.1 3.2 3.3 3.4 3.5 Check Report Documentation ................................................................................7 Usage ............................................................................................................................................... 7 Selection Screen .............................................................................................................................. 7 Additional Customizing ..................................................................................................................... 9 Check Execution............................................................................................................................. 10 3.4.1 Central Infrastructure Checks ......................................................................................... 10 3.4.2 Managed System Checks ............................................................................................... 12 Output ............................................................................................................................................. 13 4 4.1 4.2 Additional Information .......................................................................................... 16 Infrastructure Check Report Design ............................................................................................... 16 Additional Features......................................................................................................................... 16 Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 3 Documentation 1 PUBLIC Organizational Aspects 1.1 Authors The following table lists the authors who were involved in documentation. Name Version Version Date Steffen Henning, Fabian Vetter Draft 2016/11/16 Steffen Henning, Fabian Vetter Final 2016/11/25 1.2 Scope This documentation describes the usage of the ABAP report AGS_CC_INFRASTRUC_CHECK (or transaction CC_INFRA_CHECK) delivered with SAP Solution Manager 7.2 as of SPS 3. Please implement SAP Note 2380152 to have the most current checks in place. Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 4 Documentation 2 PUBLIC General Information Based on customer requests, the existing Custom Code Infrastructure Check report was reworked and several improvements and additional checks were included. The new check tool is able to run for a selected list of systems (according to properties of the landscape management database (LMDB): system ID, lifecycle status and IT ADMIN role) and executes a selectable list of checks. It is also possible to influence the execution of a few checks via customizing. An ALV table view is used to visualize the check result of different checks for all systems. Each check has a description of the checked context, a result status and a result text containing details and facts that might direct to a possible root causes of the issue. The report supports a short response time although the runtime of some of the checks is quite long, the report is able to run online and in the background, storing the check results for later display and analysis. As much as possible, centrally existing data are used for checks. For example the release requirements are checked against data available in LMDB instead of calling in managed system. It is important to have required data in LMDB and keep these data up-to-date. 2.1 Prerequisites and Deployment The tool is available in SAP Solution Manager 7.2 as of SPS 3. Please implement the note 2380152 to have the most current checks in place. Landscape information in LMDB must be up-to-date. Note For more information about SAP kernel, see SAP Community Network at http://scn.sap.com/docs/DOC54525 (Finding Kernel Information for Technical Systems) that describes the prerequisites on how to get the SAP kernel information into LMDB. In the managed system, the following SAP Notes can be applied to improve the results delivered by the report: SAP Note Number SAP Note Description 2230589 ST-PI Backend functions for CCM The following profiles need to be assigned to the related RFC users: Managed System Read RFC User (for example SM_<SID of SolMan>) o Object S_RFC o ACTVT = 16 (Execute), o RFC_NAME = /SDF/CCM_AGS_CC_DEL_OBJ_EXTR, /SDF/CCM_AGS_CC_DEVC_PDEV_EXTR /SDF/CCM_AGS_CC_GET_JOBS Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 5 Documentation PUBLIC /SDF/CCM_AGS_CC_GET_JOBLOG /SDF/CC_CHECK_JOB o RFC_TYPE = FUNC (Function Module) Solution Manager BW User (e.g. SMD_BI_RFC) o o Object S_RFC o ACTVT = 16 (Execute), o RFC_NAME = /SDF/CCM_AGS_CC_GET_JOBS /SDF/CCM_AGS_CC_GET_JOBLOG /SDF/CC_CHECK_JOB o RFC_TYPE = FUNC (Function Module) Object S_ADMI_FCD o S_ADMI_FCD = ST0R Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 6 Documentation 3 PUBLIC Check Report Documentation 3.1 Usage In the following sections the report is described in detail. Starting in first chapter with selection screen and possible input it is also described, how to influence the check execution with additional customizing. Then all checks are described in detail and furthermore the output of the check results is documented. In the following, the status of the features delivered with version 3 of SAP Note 2380152 is described. The most recent versions of this SAP Note might include additional new features among bug fixes. 3.2 Selection Screen The selection screen of the report AGS_CC_INFRASTRUC_CHECK (or transaction CC_INFRA_CHECK) report looks as follows: Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 7 Documentation PUBLIC The selection screen is divided into four main sections: 1. Execution Mode The checks are executed and the check results are displayed in an ad-hoc mode. Additionally, the check results can be saved for further analysis. This is also relevant in case the check report is executed in the background. Per default, you can save up to five check results. To facilitate finding of the check results, you can use an execution name. If you choose the Display Saved Check Results radio button, a drop down list offers all saved check results with timestamp, user and execution names: In this mode, all further input fields on the selection screen are read only and it shows the settings from the selected check run. 2. Central Infrastructure This section offers several checks which are mainly executed on the central SAP Solution Manager system locally and/ or on the connected BW system which can be local in the same or a different client or it can be connected remotely. Note For more information about check types and their execution, see 3.4 Check Execution. 3. Managed System Infrastructure This section offers several checks (see 3.4 Check Execution) which are mainly executed on the managed system or on the central system in relation to a managed system, for example, if a central extractor is started per managed system. Therefore, it is possible to select the managed systems that are supposed to be included in this check run (in general only ABAP Systems are relevant). This can be done by specifying System IDs, by using the Lifecycle Status (if maintained in LMDB) and/ or by using the IT Admin Role (if maintained in LMDB). For the fields Lifecycle Status and IT Admin Role an input help is offered, that allows for example that you select only active and productive systems. In case the Determine Systems Automatically checkbox is selected, all systems, for which at least one custom code extractor (CCM setup type) is scheduled, are taken into account. 4. Scenario Selection It is possible to filter checks regarding custom code scenarios. Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 8 Documentation PUBLIC 3.3 Additional Customizing With the help of the report AGS_CC_INFRASTRUC_CHECK_SETUP, it is possible to influence the check execution in certain boundaries. If the report is executed, the following parameters can be used. The following entries can be made: Automatically Include Central System If you select this checkbox, the SAP Solution Manager system, on which the central checks are executed, is also included as managed system and the Managed System Checks are also executed in the SAP Solution Manager system. Check UPL status on all Servers If you select this checkbox, the check for UPL activation is executed on all server (if SAP note "2281774 - Check UPL Status on all Servers of the system (optional)" or related ST-PI is applied in Managed system). Usually the status should be the same on all instances, but due to errors, it might happen, that UPL could not be started properly on one of the instances. Number of Saved Results The check report allows to save results. This is limited to five results which are saved automatically and next save will automatically delete the oldest saved result and store the new results. If the limit of five results is not sufficient, you can increase it here. Hide Results With Status The results of the check report are rated according to the following status: o (S)uccess and (I)nfo messages are rated green o (W)arning messages are rated yellow o (E)rror messages are rated red If you do not like to see certain messages, for example, if green messages are not interesting because no action is necessary, you can globally suppress these messages here by entering a comma separated list of the status. It is also possible to filter status in the result output (in the ALV table). Define minimal SP or Patch Level for SW Component Version – Check Active: This is a special check for managed systems that is evaluating, if a system fulfills a SP level or patch level requirement. If you select this checkbox, you have to make additional entries as follows: Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 9 Documentation PUBLIC You can check support package levels for different Software Component Versions of software component SAP Basis, ST-PI and SAP KERNEL. Use the drop down list to enter the combination of SW Component, SW Component Version and required Minimum SP Level. The SP level can be defined explicitly or relatively to the latest version (up to five levels below the latest version). All data offered here are based on the LMDB content. It is possible to enter up to ten combinations here. Check for Namespaces in Managed System – Check Active: This is a special check for managed systems that is evaluating, if a namespace is defined as customer namespace in this system. If you select this checkbox, you have to make additional entries as follows: You can enter one or several namespaces that should be checked. It is also possible to use F4 help, but keep in mind, the F4 help shows the namespaces as defined locally in Solution Manager (table TRNSPACET) and not the values from managed system. The execution of the report will persist the settings made and confirm this activity with a popup showing save time and user. This information is also shown on the screen, once the report is opened again. 3.4 Check Execution There are two different types of checks, one is executed for the central system only and the others are executed for different selected managed systems. At the beginning the number of checks to be executed is calculated and during execution the progress is displayed in the status bar. 3.4.1 Central Infrastructure Checks The Central Infrastructure Checks are checking the technical configuration and prerequisites of the SAP Solution Manager (central system). In a first step the RFC destination to the BW system is determined. Check Prerequisites (BW Content) checkbox (CI_BW) Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 10 Documentation PUBLIC Depending on the selected scenario the BW content activation is checked, that is, whether the required BW InfoCubes are active or not. Scenario BW InfoCube CC Objects No Cube, only tables CC References 0SM_CCREF Usage Logging (UPL/SCMON) 0SM_UPL, 0SM_UPL_W, 0SM_UPL_M, 0SM_UPL_Y WLA (Workload Analysis) 0CCMAW ABAP Test Cockpit (ATC) 0SM_ATC ATC Exemptions 0SM_ATCEX Similarity No Cube, only Table AGS_CC_SIMILARIT CCLM 0SM_CCLM, 0SM_CCITY, 0SM_ESRSG SQLM 0SM_SQLM In addition to the activation status, it is also checked, if the InfoCube is activated with its latest version in ST-BCO content. In case that the InfoCube is not active (or the latest version is not active), it can be activated in the configuration for Custom Code Management under SAP Solution Manager Configuration → Custom Code Management → Step 1- ManagingSystem Preparation. Check Notes on Central System checkbox (CI_NOTES): Based on the central definition, the recommended notes are checked in the central system. This check is very similar to the Prerequisites Check in Custom Code Management Configuration. Check Housekeeping Jobs (and Aggregation) checkbox (CI_HK): Depending on the selected scenario the housekeeping and aggregations are checked. Scenario Housekeeping Job CC Gen, CC References SM:RAGS_CCM_HK_TRIGGER CC References SM:AGS_CCM_CCREF_HK UPL, ATC, ATC Exemptions, SQLM E2E BI HOUSEKEEPING (local) (SM_BW) Check Background Jobs checkbox (CI_InJ): For the scenario WLA the background job SM:AGS_CC_BUSI_CRIT_AVAIL is checked centrally in SAP Solution Manager. Check MDX Parser checkbox (CI_MDX): The status of TPC/IP destination MDX PARSER parser is checked via RFC ping. Check ICF Services checkbox(CI_ICF): The activation status of several ICF services is checked in SAP Solution Manager. These services are usually relevant to run different custom code applications. Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 11 Documentation 3.4.2 PUBLIC Managed System Checks The following checks are executed per managed system either on the managed system itself or centrally in relation to a managed system. Check Extractors (Active & Status) checkbox (MS_EXT_A and MS_EXT_S): For the following list of extractors the activation and the status is checked. Scenario Extractor FM CC Objects AGS_CC_OBJ_CORE_EXTRACTOR CC References /SDF/CC_REF_EXTRACT_EFWK Usage Logging (UPL/SCMON) AGS_CC_SCMON_EXTRACTOR WLA (Workload Analysis) E2E_LUW_SECONDAR_EXTRACTOR_SSR ABAP Test Cockpit (ATC) AGS_EXTRACT_ATC_RESULT_EFWK ATC Exemptions AGS_EXTRACT_ATC_EXEMPTION_EFWK Similarity AGS_CC_EXTRACT_SIMILARITY CCLM AGS_CC_CCLM_EXTRACT, AGS_CC_EXTRACT_CITY, E2E_ICIDB_EXT_CCLM SQLM AGS_CC_SQLM_EXTRACTOR Additional the status of last execution is checked (regarding return code and message and frequency). Check Relevant SAP Notes checkbox (MS_NOTES): Based on central definition the recommended notes are checked in the managed system. This check is very similar to the Prerequisites Check in Custom Code Management Configuration. Check Data Availability (BW API/Queries) checkbox (MS_API): For different scenarios the data availability and also the consistency is checked. Therefore the query interface is executed and the results are checked (for example in case of weekly results, it is checked, if all weeks have a result). Tool Prerequisites and Jobs checkbox (MS_PREREQ): Based on the scenario, several prerequisites are checked for the managed system: o For ATC the following requirements are checked: SAP BASIS 7.40 SP05 or 7.31 SP05 or 7.02 SP05 or 7.01 SP15. Also Last central run is checked. o For ATC Exemptions it is checked, if exemptions are defined. o For UPL the system status is checked (for entire system or on all instances, according to setup and ST-PI version in managed system). o For SCMON the system status is checked. o For SQLM the availability is checked. o For CC References the jobs /SDF/CC_REFENRENCES and /SDF/SAP_CLONE_FINDER are checked. Housekeeping for UPL checkbox (MS_HKS): For scenario UPL the housekeeping settings for all InfoCubes (0SM_UPL, 0SM_UPL_W, 0SM_UPL_M, 0SM_UPL_Y) are checked. Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 12 Documentation PUBLIC Check Collector Jobs checkbox (MS_CJ): For some scenarios there are collector jobs that need to run centrally per system. The following jobs are checked: Scenario Collector Job Name CC Objects SM_CCLM:CUST_<SID>_<InstNo> SM_CCLM:MODS_<SID>_<InstNo> 'SM_CCLM:ENHS_<SID>_<InstNo> Similarity EFWK JOB FOR SIMILARITY: <SID> EFWK ANALYSIS JOB FOR SIMILARITY (checked remotely) SM_CCL:SIMIL_<SID>_<InstNo> UPL, WLA SM_CCL:LUSG_<SID>_<InstNo> ATC, ATC Exemptions SM_CCL:QUAL%_<SID>_<InstNo> References SM_CCLM:CCREF_<SID>_<InstNo> Check Patch Level checkbox (MS_PLVL): This check is only available, if you have selected the Check Active checkbox under Define minimal SP or Patch Level for SW Component Version in the setup report (see 3.3 Additional Customizing). If customizing is completed, the systems are checked with regard to the minimum required SP or patch level per SW component SAP BASIS or ST-PI or SAP kernel. This check is performed based on available data in LMDB. Check Namespaces checkbox (MS_NMSP): This check is only available, if you have selected the Check Active checkbox under Check for namespaces in Managed System in the setup report (see 3.3 Additional Customizing). If customizing is completed, the systems are checked with regard to the defined namespaces and it definition as customer namespace. 3.5 Output The results for all checks are represented in a tabular form. Therefore an ALV grid is used to offer functions like sorting, filtering and download (for example as Microsoft Excel spreadsheet) in an easy and standard-compliant way. In the header area general data are shown. Each check execution gets a timestamp and user ID information attached also used to create a run ID. Additionally the execution name, as maintained on the selection screen is shown. These data (timestamp, user ID and execution name) are also used to describe a check run and make it easily accessible when you search it in the saved check runs. Furthermore the list of included systems is displayed. Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 13 Documentation PUBLIC The ALV table with the results contains the following columns: Scenario This column displays the custom code scenario related to the check. In case several or all scenarios are related, wildcards can be used. Counter This column shows the counter for each check. It is restarted per system and can be used when sorting the result list Check This column shows an ID for each check. If the check ID starts with CI, it is a Central Infrastructure Check. If it starts with MS, the check is related to the Managed System. System ID This column displays the extended system ID, as available in LMDB. You can click this column. Then the system shows a few software component versions and patch levels the related system: Installation Number This column displays the installation number related to the system, as maintained in LMDB IT Admin Role This column displays the IT admin role related to the system, as maintained in LMDB Lifecycle Status This column displays the lifecycle status related to the system, as maintained in LMDB Check Description This column shows a short description of the check. Result Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 14 Documentation PUBLIC This column shows the check result as icon in green, yellow or red. A grey icon means that the check could not be executed, and the error is shown in the result message. Result ID This column shows the result as ID. S means Successful, I means Info. Both are represented with a green icon in the Result column. W stands for warning, represented by a yellow icon and E means Error, represented by a red icon. If no result ID could be set, for example in case the check could not be executed due to an error, this column stays empty and a grey icon is shown. Result Message The result message contains the check result as text. In case of a grey icon, the error that occurred during check execution is shown. Resolution In some cases, if a single short hint for error resolution can be determined, it is shown in this column. Example In case of recommended SAP Notes, you can click on this text and navigate to the related SAP Note: Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 15 Documentation 4 PUBLIC Additional Information 4.1 Infrastructure Check Report Design The following picture provides a high level overview of the report architecture: The checks are executed as defined and delivered by SAP. The entries in the selection screen and the additional check configuration can influence the check execution. The additional check configuration can be maintained via report AGS_CC_INFRASTRUC_CHECK_SETUP (see related chapter 3.33.3 Additional Customizing). If the report is not used, standard values will be used. All data (results and also the check configuration) is stored in the central SAP Solution Manager table /SDF/BTAB in a non-readable form. Data can be accessed only via report AGS_CC_INFRASTRUC_CHECK and AGS_CC_INFRASTRUC_CHECK_SETUP. Checks can be executed ad-hoc and the results can be displayed only or saved and displayed. It is also possible to execute the checks in the background and only save the results. The saved results can be read upon saving and displayed in the ABAP List Viewer (ALV) grid display. 4.2 Additional Features Saved check result can be used to create central alerts in SAP solution Manager Inbox and use the MAI infrastructure features to send email notifications or create auto incident tickets. Further details regarding this feature can be found in document: How to create MAI Custom Metric for CCM Infrastructure Check report attached to SAP Note 2244874. Documentation for Custom Code Infrastructure Check Documentation – Version: 1.2 – Final November 29, 2016 © 2016 SAP SE or an SAP affiliate company. All rights reserved. 16 www.sap.com/contactsap © 2016 SAP SE or an SAP affiliate company. All rights reserved.