GPA: Plugin for Prerequisite Checks With Solution Manager 7.1

Transcription

1 GPA: Plugin fr Prerequisite Checks With Slutin Manager 7.1 Descriptin: The plugin Prerequisite checks can be used in yur wn guided prcedures. It ffers the pssibility t select at design time amng a set f pre-defined prerequisite checks. Thse checks are then perfrmed at runtime n each scpe bject f the guided prcedure. This allws t cntrl if predefined criteria are met befre executing additinal steps n the managed system. The prerequisite checks plugin allws als the integratin f simple custm checks. Availability Slutin Manager 7.1 SP10 and higher Dcument versin Versin

2 Table f Cntents Overview... 3 Use case... 3 Required Managed bjects... 3 Pre-requisites... 3 Design Time... 4 Runtime View... 5 Overview... 5 Example: Executin Flw... 6 Step 1 Trigger prerequisite check executin... 6 Step 2 Check lg if necessary... 6 Step 3 Jump t the crrespnding activity... 6 Custm Prerequisite Checks... 8 Example: Custm Check Creatin... 8 Example: Custm Check Usage Cpyright/Trademark

3 OVERVIEW Use case With GPA plugin prerequisite checks, fllwing checks can be perfrmed n managed system: Check if mnitring status f managed system Check wrk mde f managed system Check if Rt Cause Analysis r Mnitring and Alerting setup have been perfrmed successfully. Check file system remaining space Check netwrk utilizatin Here are all available prerequisite checks gruped by categry: Categry Prerequisite check Descriptin Mnitring and Alerting Wrk mde Check availability Check perfrmance Check cnfiguratin Check exceptin Check if wrk mde is ne f the fllwing: Planned Dwntime Mdified Planned Dwntime Peak Business Hurs Nn-Peak Business Hurs Nn-Business Hurs Maintenance Check will reprt red if verall mnitred bject is nt available green therwise. Check will reprt red if perfrmance f mnitred bject is pr green therwise. Check will reprt red if cnfiguratin is nt crrect n mnitred bject green therwise. Check will reprt red if at least ne exceptin is fund green therwise. Check will reprt red if the specified wrk mde is nt active green therwise. Setup Check Rt Cause Analysis Setup Check will reprt the current status f the managed system cnfiguratin Check Mnitring and Alerting Setup Check will reprt the current status f the mnitring and alerting setup. Required Managed bjects Pre-requisites The required managed bject will depend n the type f check. As an example, the managed system setup can be perfrmed n a Technical System, Database r Hst the crrespnding check will accept the same managed bject. N specific authrizatins are necessary t run prerequisite check plugin Hwever, as each check allws t jump n the specific applicatin (system mnitring, wrk mde management, managed system setup) the user running the guided prcedure shuld als have enugh authrizatins t run the crrespnding applicatin. Cpyright/Trademark

4 DESIGN TIME During design time, the cmplete list f available prerequisite checks is displayed by default all are unchecked: Mnitring and Alerting Wrk mde Setup Check Availability Check Perfrmance Check Cnfiguratin Check Exceptin Check wrk mde settings Check Rt Cause Analysis Setup Check Mnitring and Alerting Setup One r mre prerequisite checks can be selected. All selected prerequisite checks will be executed in sequence. The verall status will be based n the cmbinatin f each single status fr each check. Cpyright/Trademark

5 RUNTIME VIEW Overview At runtime, when the guided prcedure is started the selected cntext is passed t the plugin and a table tree view is built with all prerequisite checks selected at design time. The displayed view cntains fllwing infrmatin: Cntext: Main nde: name f the managed bject mre than ne managed bject can be passed t this GP plugin. Sub-nde: prerequisite check name. Captin: captin f the managed bject. Descriptin: descriptin f the prerequisite check. Navigatin: navigatin link t the crrespnding applicatin (system mnitring, wrk mde management, managed system setup, etc ) Dcumentatin: Link t the SE61 dcumentatin when available. Cpyright/Trademark

6 Example: Executin Flw Step 1 Trigger prerequisite check executin When using the buttn Execute All all prerequisite checks are executed in sequence fr all managed system part f the displayed table tree view. It is nt pssible t nly execute a single prerequisite check this is dne in purpse in rder t keep the cnsistency f the verall status result. Example: In this example we d want t check fr ABAP system SD7 that: System is available Current wrk mde is set t Peak Business Hurs After executing all prerequisite check, we are getting an verall status: Step 2 Check lg if necessary The lg view gives additinal infrmatin n the executin use the prvided Shw link in the Details clumn. Example: Step 3 Jump t the crrespnding activity If necessary the jump link t the applicatin may be used t adjust value. Cpyright/Trademark

7 Example: If fr any reasn ne f the prerequisite check is red then a specific message is reprted. Yu can display the detail within the lg windw. If fr any reasn the reprted wrk mde is nt crrect the jump-in link will direct yu t the Wrk Mde management applicatin in rder t adjust it. Cpyright/Trademark

8 CUSTOM PREREQUISITE CHECKS In sme case the prvided built-in prerequisite checks are nt enugh t cver all use cases. In rder t keep the same UI t cnfigure and t execute the prerequisite checks this GP plugin allws the creatin f custm checks. A custm prerequisite check is a custm ABAP class that extends the class CL_GPCR_CHECK_BASE. At design time, all ABAP classes implementing the superclass CL_GPCR_CHECK_BASE will be displayed and available fr selectin. At runtime time, the crrespnding execute methd f the custm check will be executed with apprpriate cntext. The new custm ABAP class shuld implement fllwing methds: GET_NAME: name f the prerequisite check GET_DESCRPTION: descriptin f the prerequisite check IS_VALID: cntext is passed t this methd the check shuld return true if the check is valid fr this cntext and false therwise. If the check if nt valid fr the defined cntext then check is nt displayed at runtime. RUN_CHECK: executin f the check. GET_HELPTEXT: return se61 bject that cntains the descriptin f the check (ptinal). GET_URL: return URL (ptinal). Example: Custm Check Creatin Open transactin SE80 Select Class/Interface in the drpdwn list Enter yur custm check class name: ZQA_CUSTOM_CHECK_<XX> and press enter Press Yes Cpyright/Trademark

9 Fllw Object creatin wizard Save class Cntinue Assign t lcal package $TMP and Save Cpyright/Trademark

10 Assign the super class CL_GPCR_CHECK_BASE t yur custm class Redefine fllwing methds and cpy and paste suggested cde GET_DESCRIPTION ========begin cde======= re_descriptin = 'Descriptin f my QA custm check <XX> (always send green)'. ======== end cde ======= GET_NAME ========begin cde======= re_name = 'my QA Custm Check <XX>'. ======== end cde ======= IS_VALID ========begin cde======= re_is_valid = abap_true. ======== end cde ======= RUN_CHECK ========begin cde======= data ls_detail type ags_sise_s_lg_ctx. ev_status = cl_sise_status=>success. ev_message = 'QA Custm Check XX - OKAY'. ls_detail-key = '01'. ls_detail-is_leaf = abap_false. ls_detail-key_msg = 'key'. ls_detail-key_status = 'E'. ls_detail-value = 'detail01'. append ls_detail t ev_details. clear ls_detail. ls_detail-key = '01-01'. ls_detail-is_leaf = abap_true. ls_detail-key_msg = 'detail1'. ls_detail-key_parent = '01'. ls_detail-key_status = 'I'. ls_detail-value = 'level01-01'. append ls_detail t ev_details. Cpyright/Trademark

11 clear ls_detail. ls_detail-is_leaf = abap_true. ls_detail-key_msg = 'detail2'. ls_detail-key_status = 'I'. ls_detail-value = 'level01-01'. append ls_detail t ev_details. ======== end cde ======= Example: Custm Check Usage Select NEWStep Plugin Step. Enter title and descriptin as fllws: Create a help text fr this step: Select Plugin Prerequisites Checks. Maintain the plugin cnfiguratin attributes as fllws in rder t nly execute the custm check: Save the guided prcedure. Cpyright/Trademark