Pre-Con Ed: CA Workload Automation DE and ESP Edition: Some Novel Uses for the ESPmgr Utility

World®’16

CAWorkloadAutomationDE&ESPEdition:SomeNovelUsesfortheESPmgr UtilityJohnRooney,CATechnologies,Sr.PrincipalConsultant

MFX32E

MAINFRAMEANDWORKLOADAUTOMATIONCONTENTAREA

2 ©2016CA.ALLRIGHTSRESERVED.@CAWORLD#CAWORLD

©2016CA.Allrightsreserved.Alltrademarksreferencedhereinbelongtotheirrespectivecompanies.

Thecontentprovidedinthis CAWorld2016presentationisintendedforinformationalpurposesonlyanddoesnotformanytypeofwarranty. The informationprovidedbyaCApartnerand/orCAcustomerhasnotbeenreviewedforaccuracybyCA.

ForInformationalPurposesOnlyTermsofthisPresentation


Abstract

ESPmgr isacommand-lineAPIsuppliedwithanagent.YouuseESPmgr tosenda

messagetoeitherCAWorkloadAutomationESP(CAWLAESP)orCAWorkload

AutomationDE(CAWLADE)fromtheagentplatform.Themessagecantellthe

servertoperformanactiononajoborApplication,suchasreleasingan

ApplicationorinsertingajobintoanApplicationoreventosetthestateofa

workloadobject.ThissessionwillgothroughsomeexamplesofusingESPmgr to

docommonthingslikecontrollingworkloadaswellastouseESPmgr tocreate

yourown3rd partyintegrationtoothersoftwarelikefiletransferproducts.

JohnP.RooneyCATechnologiesSr.PrincipalConsultant


Agenda

SYNTAXOFTHEESPMGR COMMAND

SECURINGTHEUSEOFESPMGR

CREATINGYOUROWNAGENTINTEGRATION

SUMMARY

1

2

3

4


ESPmgris…

§ BundledinwithallCAWorkloadAutomationSystemAgents

§ ESPmgr.exemustberunusingexecutableinpathoftherunningAgentthattheAutomationFrameworkMessage(AFM)istobesentthrough

§ UsedtosendmessagestotheWorkloadManagerbycreatinganAFM

§ TheAFMcaninstructaWorkloadManagerto:– Performanaction

§ ActonaWorkloadObject(WOB)inanapplication:Complete,Bypass,Insert

§ NotifytheWorkloadManagertochangetheStateofaWOB

§ Canberunfromthecommandlineorembeddedinscriptsbeingrunbytheagentorrunningoutsidethescopeoftheagent


ScriptingESPmgr

§ Theseenvars aremadeavailabletoWOBsrunningbyaCAWLASystemAGENT:– ESPAPPLMGR:theCAWLAESPorCAWLADEservername– ESPAGENTDIR:pathtoagentandESPmgr executable– ESPAGENT:nameofAgent– ESPAGENTPORT:Agentreceiverport– ESPAPGENGenerationnumberoftheApplication– ESPAPPLNameoftheApplication– ESPOBJECTFullyqualifiedpathnameofthejob– ESPWOBNameofthejob


ExampleofexecutionfromwithinanAgentSpawnedscript"%ESPAGENTDIR%\ESPmgr""Windowsjob.1/%ESPAPPL%.%ESPAPGEN%/MAINACTIONINSERT

Userid(user.roojo02)Type(NT)Rununit(JPRR1134)Container(%ESPAPPL%~~)

Command('c:\scripts\dseriesr113\sleep.bat')Args('10')"


WhenExecutingoutsideofanAgentspawnedscript

Youneedtosettwoenvironmentvariables:

§ setESPAPPLMGR=CM_CAESP21– TellstheAgentwhichWorkloadManagertosendthemessage

§ setESPAGENTDIR=C:\ProgramFiles\CA\WAAgentR11.3.4– IdentifiestheAgentdirectory

NOTE:Bothoftheseparametersareautomaticallysetwhenexecutingascriptthroughanagent


ExampleWindowsscripttoexecutefromoutsidetheAgentREMChangethefollowingservicenametotheappropriateManager

setESPAPPLMGR=DSERIES113

REMChangethefollowingdirectorytotheagentdirectory

setESPAGENTDIR=C:\ProgramFiles\CA\WorkloadAutomation_R12\ESPSystemAgent

"%ESPAGENTDIR%\ESPMgr""Windowsjob.1/ADHOC.0/MAINACTIONINSERTUserid(user.JPR)Type(NT)Rununit(JPRR1134)Container(ADHOC~~)Command('c:\scripts\dseriesr113\sleep.bat')Args('10')"


ESPmgr “objectname verbsubverb[(keyword)]”

§ objectname– FullyqualifiednameoftheWOBtowhichtheAFMitdirectedto

§ verb– Indicatesactiontobetaken:ACTIONorSTATE

§ subverb– Furtherdefinesactiontobetaken

§ keyword– Modifiesverb/subverb combination


objectname

jobname[.qualifier]/applname.applgen/MAIN

§ jobname[.qualifier]– nameofWOBinapplicationthatistargetAFM

§ applname.applgen– Applicationnameandapplicationgenerationnumberthatistargetof

AFM

§ MAIN– fixed


CAWLAESPandCAWLADE

§ VerbsandSubverbsMAYBEdifferentforAFMsdirectedtodifferentWorkloadManagers

§ Comprehensivedocumentationandsamplesexistforeachinthesebooks:– DE12.0:

§ https://docops.ca.com/ca-wla-de/12-0/en/reference/espmgr-utility– CAWLAESP11.4:

§ https://docops.ca.com/ca-workload-automation-esp-edition/11-4/reference/commands/espmgr-command-send-a-message-from-an-agent-version-2-0-or-higher


verbs

§ Twochoices:– ACTION

§ Beginsdescriptionofchangestobemadetoobjectname– STATE

§ Beginsdescriptonofchangestobemadetostateofobjectname


ACTIONsubverbexamples

§ BYPASS|UNBYPASS§ DROPDEP§ HOLD§ INSERT§ READY§ RELEASE§ REQUEST|UNREQUEST§ RESET§ RESUB§ SET§ UNWAIT


STATEsubverb examples

§ Activate§ Alert§ COMPLETE§ Cmpc(code)§ EXEC§ FAILED§ Intvrq§ Jobid(id)§ …manyothers(exampleslater…)


keywords

§ Therearefartoomanytotalkaboutinthetimeallowedustoday

§ Keywordsare:– TargetServerdependent– CaseSensitive!

§ Keepcopiesofthedocumentationlistedafewscreensagohandy!


ExampleswherethesyntaxisexactlythesameforCAWLAESPandCAWLADEESPMgr "Win_test1/WINTEST.0/MAINSTATERUNNING

UserStatus(Someusefulinformation)“

ESPMgr "Win_test2/WINTEST.0/MAINACTIONHOLD“

ESPMgr "Win_test2/WINTEST.0/MAINACTIONRELEASE“

ESPMgr "Win_test2/WINTEST.0/MAINACTIONRESUB“

ESPMgr "Win_test2/WINTEST.0/MAINACTIONDROPDEPPRED(Win_test1)“

ESPMgr "Win_test1/WINTEST.0/MAINACTIONCOMPLETE"


Examplesofwherethesyntaxisdifferent

§ CAWLAESP

ESPMgr "Windowsjob.2/ADHOC.0/MAINACTIONINSERTType(NT)Statements(AGENTJPRR1134;CMDNAME

C:\Scripts\sleep.bat;ARGS10)"

§ CAWLADE

ESPMgr "Windowsjob.1/ADHOC.0/MAINACTIONINSERTUserid(user.JPR)Type(NT)Rununit(JPRR1134)

Container(ADHOC~~)Command('c:\scripts\dseriesr113\sleep.bat')Args('10')"


Troubleshooting§ Codekeywordsastheyaredocumented– CASEMATTERS

– Iftheactionyouinitiateddidnotoccurthiswilllikelybethecause!

§ Keepthedocumentationhandy

§ FollowtheAFMthroughthe:– AgentTransmitterlog– CAWLAESPAuditlog– CAWLADEtracelog

§ Alwaysuseabsolutegenerationnumbersinthetargetname

§ Ifscriptedlookinspoolfileforerrormessages– Checkyourenvironmentvariables


CAWLAESP- MAPUSERCommandMapAgentSystemUserIDtoMainframeUserID

TheMAPUSERcommandmapsanagentsystemuserIDtoamainframeuserID.ThismappingisusedforauthorizingmessagessenttoCAWLAESPEditionusingtheESPmgrcommandusingthemainframesecurityrules.

Type

Sub-commandtotheLOADAGDFcommand.CodetheMAPUSERcommandintheAGENTDEFdatasetonthemasterandissueLOADAGDF.


CAWLAESP- MAPUSERCommandMapAgentSystemUserIDtoMainframeUserID

SyntaxMAPUSER agentid TO(mainframeid)|SAFUSER(mainframeid) AGENT(agentname)

§ agentidSpecifiestheidentificationofauserloggingontoanAgent.Thisoperandiscasesensitiveandsupportswildcards.Ithasamaximumlengthof32alphanumericcharacters.

§ TO(mainframeid)|SAFUSER(mainframeid)TSOuserIDtobeusedforsecuritychecks.TOisequivalenttoSAFUSER

§ AGENT(agentname)NameoftheAgenttowhichthismappingapplies.

§ Example:MAPUSERCommandInthefollowingexample,CAWLAESPEditionisinstructedtouseCYBJD01forsecuritycheckswhenitseestheuserJDOElogonfromAgentTORSUN1:

MAPUSER JDOE SAFUSER(CYBJD01) AGENT(TORSUN1)


SpecifyingtheMAPUSERparameterinAGENTDEF


SpecifyingaseparatemappedUSERID


BeforeandaftermessagesonaJobInsert

Before:

JPRR1134 JOB5.8/ADHOC.0/MAIN ACTION INSERT Type(NT) Statements(AGENT JPRR1134; CMDNAMEC:\Scripts\sleep.bat; ARGS 10) LocalUser(roojo02) User(JPRR1134) Host(ROOJO02W7)APPL ADHOC.2260 JOB JOB5.8 INSERTED BY ROOJO02

After:

JPRR1134 JOB5.9/ADHOC.0/MAIN ACTION INSERT Type(NT) Statements(AGENT JPRR1134; CMDNAME C:\Scripts\sleep.bat; ARGS 10) LocalUser(roojo02) User(JPRR1134) Host(ROOJO02W7)APPL ADHOC.2260 JOB JOB5.9 INSERTED BY CAWAPS


CAWLADEsecurityforESPmgr

§ Thelocaluser executingthescriptmustbedefinedtoCAWLADEsecurityandhavetheauthoritytodotheaction

2016100523:05:58.863[dm:controlobject][INFO]DM.InputProcessor_110:[2016-10-05_23:05:58.862]ReceivedresponsefromAgentAGENT forwob "/MAIN/ADHOC.0/WINDOWSJOB.2"response:2016100523055885+0400DSERIES113AGENTWINDOWSJOB.2/ADHOC.0/MAINACTIONINSERTUserid(user.JPR)Type(NT)Rununit(JPRR1134)Container(ADHOC~~)Command('c:\scripts\dseriesr113\sleep.bat')Args('10')LocalUser(roojo02)User(AGENT)Host(ROOJO02W7)


CreateyourownApplicationIntegrationusingESPmgr

§ ESPmgr enablesyoutosetaStateforaWOB

§ Youcancreateyourown“States”ifyouwant– Critical,Transfer,ON_ICE,etc…

§ OnceaWOBisplacedintoa“COMPLETE”State,itcan’tbechanged


Examplesofsettingstatusanduserstatus

"%ESPAGENTDIR%\ESPmgr""DUMMY/%ESPAPPL%.%ESPAPGEN%/MAINStateRUNNINGStatus(RUNNING)UserStatus('RUNNINGalongwithsomelonguserstatus message')"

"%ESPAGENTDIR%\ESPmgr""DUMMY/%ESPAPPL%.%ESPAPGEN%/MAINStateCRITICALStatus(CRITICAL)UserStatus(CRITICAL)"

"%ESPAGENTDIR%\ESPmgr""DUMMY/%ESPAPPL%.%ESPAPGEN%/MAINStateON_ICEStatus(ON_ICE)UserStatus(ON_ICE)"

"%ESPAGENTDIR%\ESPmgr""DUMMY/%ESPAPPL%.%ESPAPGEN%/MAINStateCOMPLETEStatus(COMPLETE)UserStatus(COMPLETE)"


SubtledifferencewhensettinganWOBtoFAIL(ed)

CAWLADE-

"%ESPAGENTDIR%\ESPmgr""DUMMY/%ESPAPPL%.%ESPAPGEN%/MAINStateFAILED Status(FAILED)UserStatus(FAILED)Reason(Failed)“

CAWLAESP–"%ESPAGENTDIR%\ESPmgr""DOBJ1/%ESPAPPL%.%ESPAPGEN%/MAINStateFAILStatus(FAIL)UserStatus(FAIL)"


ConsidercreatingyourownAgentIntegration

§ ThesefourfieldsareeasilyupdatedbyusingESPmgr– State– Status– Tag– Userstatus

§ CanbeusedforMonitoringandDisplaypurposes


TheLengthsofthefourfieldsincharactersandothernotes§ CAWLADE

– State:64– Status:1024– HistorywillshowTextbeforeCompleteAction– Tag:128– HistorywillshowTextbeforeCompleteAction– User_status:128– HistorywillshowTextbeforeCompleteAction

§ CAWLAESP– State:8– Status:28– DoesnotshowupinHistoryFile– Tag:16– TextcanbeupdatedonsamecommandtoComplete– Userstatus:28– TextcanbeupdatedonsamecommandtoComplete


ESPmgr enablesupdatinganyWorkloadObjectandsettingtheStateforthatObject§ UseCAWLAESPandCAWLADEasa“STATEMACHINE”

§ SuggestionistouseaTASK– Itisamanualtypeofworkloadobject– Don’thavetoworryaboutitexecuting

§ CAWLAESPalsohasaDataobj thatcanbeusedforupdates– Thedataobj actsasthejobexecutionhistoryrepository


CAWLAESPExampleofcreatinga“StateMachine”


AnexampleofdisplayingthecontentsofanCAWLAESPDataobjecho.echoUpdatetheWOBdataobjecttostarttrackingactivitiesecho."%ESPAGENTDIR%\ESPmgr""RUNTEPMFTLOG/%ESPAPPL%.%ESPAPGEN%/MAINACTIONSETMFTBEGINlOG('MFTOutboundbeginninglog')""%ESPAGENTDIR%\ESPmgr""RUNTEPMFTLOG/%ESPAPPL%.%ESPAPGEN%/MAINACTIONSETMFTWOBAPGEN('%ESPAPPL%.%ESPAPGEN%')""%ESPAGENTDIR%\ESPmgr""RUNTEPMFTLOG/%ESPAPPL%.%ESPAPGEN%/MAINACTIONSETMFTWOBAPPL('%ESPWOB%')""%ESPAGENTDIR%\ESPmgr""RUNTEPMFTLOG/%ESPAPPL%.%ESPAPGEN%/MAINACTIONSETMFTtask0('listofprocessingstateforoutboundMFT')"


CAWLAESPdisplayingFileTransferProgress


CAWLAESPdisplayingaFileTransferthatfailed


CAWLAESPdisplayingtheFileTransferhistoryintheDataobj


CAWLAESPdisplayingtheCompletedFileTransfer


CAWLADEExampleofcreatinga“StateMachine”


CAWLADEdisplayingFileTransferProgress


CAWLADEdisplayingaFileTransferthatfailed


CAWLAESPdisplayingtheCompletedFileTransfer


Summary

§ Atooltobeusedtoinsertworkload

§ Atooltobeusedtocontrolworkload

§ UsesCAWLAESPmainframesecurityforuserauthorization

§ UsesCAWLADEusersecurityforuserauthorization

§ CanbeusedtocreatecustomApplicationIntegrations


Questions?


RecommendedSessionsSESSION# TITLE DATE/TIME

MFX31EBetterBigDataAnalyticswithCAWorkloadAutomationforHadoop

11/14/2016at3:00pm

JasmineB

MFX24EWobtrigs andFileTriggerswithCAWorkloadAutomationESPEdition

11/15/2016at11:00am

JasmineB

MFX33EBestPracticesforsettingupCAWorkloadAutomationESPApplicationProcedures

11/15/2016at1:00pm

JasmineB

MFX129SVisionandRoadmap:CAWorkloadAutomationESPEdition

11/16/2016at12:45pm

JasmineC


MustSeeDemos

ModernWorkloadAutomation

CAWLADEMFandWorkloadAutomation

SeamlessApplicationAutomationAgents&AdvancedIntegrationsMFandWorkloadAutomation

CAConversionasaService

CAWorkloadAutomationMFandWorkloadAutomation

Innovations:MainframeWorkloadAutomationCAWLAESPEditionMFandWorkloadAutomation

@CAWORLD#CAWORLD ©2016CA.AllRIGHTSRESERVED.46 @CAWORLD#CAWORLD

MainframeandWorkloadAutomation

FormoreinformationonMainframeandWorkloadAutomation,pleasevisit:http://cainc.to/9GQ2JI


Thankyou

Stayconnectedatcommunities.ca.com

Technology

Pre-Con Ed: CA Workload Automation DE and ESP Edition: Some Novel Uses for the ESPmgr Utility