CICS
Transaction
Server
for
z/OS
CICSPlex
SM
Web
User
Interface
Guide
Version
2
Release
3
CICS
Transaction
Server
for
z/OS
CICSPlex
SM
Web
User
Interface
Guide
Version
2
Release
3
Note!
Beforeusingthisinformationandtheproductitsupports,besuretoreadthegeneralinformationunder“Notices”onpage 183.
Sixthedition(September2006)
ThiseditionappliestoVersion 2 Release 3ofCICSTransactionServerforz/OS,programnumber5697-E93,and toallsubsequentversions,releases,andmodificationsuntilotherwiseindicatedinneweditions.Makesureyouare usingthecorrecteditionfortheleveloftheproduct.
OrderpublicationsthroughyourIBMrepresentativeortheIBMbranchofficeservingyourlocality.Publicationsare notstockedattheaddressgivenbelow.
Atthebackofthispublicationisapageentitled“SendingyourcommentstoIBM”.Ifyouwishtosendcommentsby mail,pleaseaddressthemto:
User Technologies Department Mail Point 095
IBM United Kingdom Laboratories Hursley Park
WINCHESTER Hampshire SO21 2JN United Kingdom
WhenyousendinformationtoIBM,yougrantIBManonexclusiverighttouseordistributetheinformationinany wayitbelievesappropriatewithoutincurringanyobligationtoyou.
©CopyrightInternationalBusinessMachinesCorporation1999,2006.Allrightsreserved.
Contents
Preface . . . vii
Whothisbook isfor . . . vii
Whatyouneed toknow. . . vii
CICSsystem connectivity . . . vii
TheCICSPlexSMWebUserInterfacewebbrowsers . . . viii
AdditionalCICSPlexSMinformation . . . viii
Summary ofchanges . . . ix
Changesfor CICSPlex SMfor CICSTransactionServerforz/OS Version2 Release3 . . . ix
Changesfor CICSPlex SMfor CICSTransactionServerforz/OS Version2 Release2 . . . ix
Changesfor CICSPlex SMfor CICSTransactionServerforz/OS Version2 Release1 . . . x
Chapter1.Anoverviewofthe CICSPlex SM WebUserInterface . . . 1
Functionsandfeaturesof theWebUserInterface . . . 1
WebUserInterface ViewEditor . . . 2
WebUserInterface helpfacilities . . . 2
NationalLanguageSupport. . . 2
Example interactiveprocedure. . . 2
Systemoverview. . . 3
ControllingtheWebUserInterface . . . 3
Administration. . . 3
Security . . . 3
CreatingyourcustomizedWebUserInterface . . . 4
Summary—whatarethebenefits?. . . 4
Chapter2. Themaincomponentsofthe CICSPlexSM WebUserInterface 5 TheCICSPlexSMWebUserInterfaceframes. . . 5
Icons . . . 5
Links . . . 6
Thenavigationframe . . . 7
Theworkframe . . . 7
Theassistanceframe . . . 8
View setsandviews . . . 8
Title . . . 8
Messagearea. . . 9
Selectioncriteriaandrefresharea . . . 9
Form . . . 9
Selectionlistsandentryfields . . . 13
Links . . . 13
Annotation . . . 14
Actionandconfirmbuttons . . . 14
Helplink . . . 15
Menus . . . 15
Title . . . 16
Messagearea . . . 16
Selectioncriteriaarea . . . 16
Annotations . . . 17
Menu grouptitles . . . 17
Menu choices . . . 17
Customizableviewandmenuhelp. . . 18
TheViewEditor . . . 18
Chapter3. Settingup aCICSPlexSM WebUserInterface server . . . 19
Preparinga CICSsystem toactastheWebUserInterfaceserver . . . 19
ConfigureCICSWebsupport . . . 20
Review CICSsystem initializationparameters . . . 21
Specify languageandcodepage . . . 22
Prepare codepageconversion table . . . 23
Generate theProgramLoadTable(PLT) . . . 23
CreatetheWebUserInterfaceserverrepository(EYUWREP) . . . 24
Specify thecustomizable viewandmenuhelpdataset . . . 25
Specify theWebUserInterface serverinitialization parameters . . . 25
Requiredparameters. . . 26
OptionalParameters. . . 26
Update CICSCSDdefinitions . . . 31
Transientdataqueuedefinitions . . . 32
Temporarystoragemodels . . . 33
Specify theJCLDDstatements. . . 33
Security considerations . . . 33
CICSsecurityconsiderations. . . 33
Secure SocketsLayersupport . . . 35
AuthorizingaccesstoMVS datasets. . . 35
Additionaltasks. . . 35
Submitstart-upJCL . . . 35
Check browserconnection . . . 35
Obtain viewandmenu definitions . . . 36
ShutdowntheWebUserInterfaceserver . . . 36
Chapter4. Usingthe CICSPlexSM WebUserInterface . . . 37
Accessing theCICSPlexSM WebUserInterface . . . 37
Getting help . . . 37
WebUserInterface Help . . . 37
WebUserInterface MessageHelp . . . 37
SigningOn . . . 38
Changingyour Password . . . 39
Thehome menu . . . 40
EnteringData . . . 40
Selectioncriteria . . . 43
ContextandScope . . . 43
Filtering data. . . 44
Finding yourwayaroundtheCICSPlexSM WebUserInterface . . . 47
Returningto apreviousdisplay . . . 47
Openlinks . . . 47
Expandingandcollapsingtheitemsof anavigationframe . . . 47
Accessing theView Editor. . . 47
Openinganew window. . . 48
Closinga window . . . 48
Signingoff . . . 48
Using links . . . 48
SelectingaViewor aMenu . . . 48
Sorting aview . . . 52
Summarizing aview . . . 52
Refreshing views . . . 54
Operatingonresources. . . 55
Modifyingattributesandenteringparameters. . . 56 ||
Printingaview . . . 57
Accessing thecustomizable viewandmenuhelp . . . 57
Chapter5.Administration . . . 59
TheCICSPlexSMWebUserInterfacetransaction(COVC) . . . 59
StartingandstoppingtheWebUserInterface server . . . 60
Displayingstatusdetails . . . 60
Viewing usersessions . . . 62
Importing viewsetormenudefinitions . . . 63
Exporting viewsetor menudefinitions . . . 64
Settingtraceflags. . . 66
WebUserInterface ServerRepository . . . 67
Importing andexporting. . . 67
Thestarter setofviewsetandmenudefinitions. . . 68
Theoutputlog(EYULOG). . . 68
Customizableviewandmenuhelp. . . 69
IntegratingtheWebUserInterfacewithotherweb-basedtools . . . 69
Access fromtheWebUserInterface toanexternalserver . . . 69
Access totheWebUserInterface . . . 69
SecurityConsiderations. . . 73
RunningyourWebUserInterfaceserverwithsecurityactive . . . 73
Examples . . . 75
RunningyourWebUserInterfaceserverwithsecuritynotactive . . . 76
Chapter6. Customizingthe WebUserInterface. . . 77
Customizing menusandviews . . . 77
Viewsandviewsets . . . 77
Menus . . . 81
Presentingdata . . . 84
Attributes . . . 85
Parameters . . . 86
Actionbuttons . . . 86
Customizableviewandmenuhelp. . . 86
ConsiderationswhencreatingpagestobeservedbytheWebUserInterface server . . . 87
Using theView Editor . . . 87
Accessing theView Editor. . . 88
TheWebUserInterfacestarter set . . . 88
EditorPanels . . . 88
Applying orrejectingupdates. . . 96
Example tasks . . . 97
Using viewlinksandattributefilters . . . 97
Using warninglights . . . 99
Chapter7. Clientapplicationdatainterface . . . 103
Overview . . . 103
Levelof HTTP. . . 104
Thedatainterface andHTTP . . . 104
HTTPrequestURLformat . . . 104
HTTPresponsesandcodes . . . 105
Response records . . . 106
Response headerfields . . . 106
Datarepresentation. . . 108
Thedatarecords. . . 109
Datainterfacecommandreference . . . 109
DATA/CONNECT. . . 110 || || || || || || || || || || || ||
DATA/DISCARD . . . 114 DATA/DISCONNECT . . . 115 DATA/FETCH . . . 115 DATA/GET . . . 118 DATA/GETDEF . . . 121 DATA/PASSTICKET . . . 124
Chapter8. Problemdetermination . . . 127
Using trace. . . 127
SettingtraceflagsusingtheWUITRACEparameter. . . 127
SettingtraceflagsthroughCOVC . . . 127
Theavailabletraceflags . . . 128
Exceptiontraces . . . 129
Using dumps . . . 129
Theavailabledump codes . . . 129
Server andbrowser messages . . . 129
Servermessages . . . 130
Browsermessages . . . 130
COVC statuspanel. . . 130
COVC debuggingcommands . . . 131
RunningtheCOVCtransactionfor debugging . . . 131
Typicalend-userproblems . . . 132
Chapter9. Messages. . . 135
Client messages . . . 135
Editor messages. . . 148
HTTPmessages. . . 155
Server messages . . . 156
Appendix. WebUserInterface HTML . . . 169
Bibliography . . . 171
TheCICSTransactionServerfor z/OSlibrary . . . 171
Theentitlementset . . . 171
PDF-only books . . . 171
Other CICSbooks . . . 173
Determiningif apublicationiscurrent . . . 173
Accessibility . . . 175
Index . . . 177
Notices . . . 183
ProgrammingInterfaceInformation . . . 184
Trademarks. . . 184
Sendingyour commentstoIBM . . . 185
|| || || || || || || ||
Preface
This bookdescribestheCICSPlex®SMWebUserInterface asfollows:
v
Chapter1, “Anoverviewof theCICSPlex SM WebUserInterface,”onpage1
providesanintroductionto theCICSPlex SMWebUserInterface.
v Chapter2, “Themain componentsof theCICSPlexSMWebUserInterface,”on
page5describesthefeaturesof theCICSPlex SMWebUserInterface. v Chapter3, “SettingupaCICSPlexSM WebUserInterfaceserver,”onpage19
describeshowto setuptheCICSPlex SM WebUserInterfaceserver.
v Chapter4, “UsingtheCICSPlexSMWebUserInterface,”onpage37describes
howto usetheCICSPlex SMWebUserInterface.
v Chapter5, “Administration,”onpage 59describeshow toadministorthe
CICSPlex SMWebUserInterface. v
Chapter6, “CustomizingtheWebUserInterface,”onpage77describeshowto
customizetheCICSPlex SM WebUserInterfaceusingtheView Editor.
v Chapter8, “Problemdetermination,”onpage127providesguidanceonproblem
solving.
v Chapter9, “Messages,”onpage135containsalistof CICSPlex SMmessages
andtheirmeanings,thatcanbeissuedbytheWebUserInterface.
Who
this
book
is
for
This bookisintendedfor anyonewhoneedsinformationorguidanceonusingthe CICSPlexSM WebUserInterface.Thisincludessystemdesigners,programmers andthoseresponsiblefor settingup,administeringandmaintainingtheinterface.
What
you
need
to
know
This bookassumesthatyouarefamiliarwiththeCICSPlexSM elementofCICS®
TransactionServerfor z/OS™.AknowledgeoftheCICSPlexSMoperationsviews
andresource tablesisanadvantage.Inaddition,itassumesthatoperatorsare familiar withCICSoperations,administratorsarefamiliarwithCICSPlexSM,CICS, andTCP/IPadministration,andend-usersarefamiliar withweb browsers.
CICS
system
connectivity
This releaseofCICSPlex SM canbeusedtocontrolCICSsystemsthataredirectly connectedto it.
For thisreleaseof CICSPlex SM,theconnectableCICSsystemsare: v CICSTransactionServerforz/OS 2.3
v CICSTransactionServerforz/OS 2.2
v CICSTransactionServerforOS/390
®1.3
v CICSforWindows
®componentofIBM®TXSeries® 4.3.0(withPTF 4)
v CICSforWindowscomponentofIBMTXSeries5.0
You canusethisreleaseof CICSPlex SMto controlsystemsrunningsupported releasesofCICSthatareconnectedto,andmanaged by,yourpreviousreleaseof CICSPlex SM.However, ifyouhave anydirectly-connectablereleaselevelsof CICS,aslistedabove,thatareconnectedtoapreviousreleaseofCICSPlex SM, you arestrongly recommendedto migratethemtothecurrentreleaseof
CICSPlex SM,to takefulladvantageoftheenhancedmanagementservices.See theCICSTransactionServerfor z/OSMigrationfromCICSTSVersion2.2for informationonhow todothis.
Table1 showswhichsupportedCICSsystemscan bedirectly connectedtowhich releasesofCICSPlex SM.
Table1.Directly-connectableCICSsystemsbyCICSPlex SMrelease CICSsystem CICSPlex SMcomponent
ofCICSTS2.3 CICSPlex SMcomponent ofCICSTS2.2 CICSPlex SMcomponent ofCICSTS1.3 CICSTS2.3 Yes No No
CICSTS2.2 Yes Yes No
CICSTS1.3 Yes Yes Yes
TXSeries4.3.0.4 Yes Yes No
TXSeries5.0 Yes Yes No
The
CICSPlex
SM
Web
User
Interface
web
browsers
TousetheCICSPlexSMWebUserInterface,yourwebbrowser mustsupport: v HTML3.2orlater, withframesandtables
v HTTP1.0or 1.1
v HTTPcookiesupport
Additionalfunctionalityisprovidedif yourbrowsersupports: v Java1.0.2classes
v Javascript1.1scripts
v Multiplebrowser windows
Example browsersthatoffersuitablefunctionalityincludeNetscapeNavigator4.5, Netscape Communicator4.75,Netscape6.0,andMicrosoftInternetExplorer5.0.
Additional
CICSPlex
SM
information
Additionalinformationabout CICSPlexSM isavailableontheWorldWideWebat:
Summary
of
changes
This editionoftheCICSPlexSMWebUserInterface Guideisbasedonthe CICSPlex SMforCICSTransactionServerforz/OSVersion2 Release2 edition. Theinformationinthisbook hasbeenupdatedtoincorporatechangesmadefor CICSPlex SMforCICSTransactionServerforz/OSVersion2 Release3. Changesfor thiseditionaremarkedbyvertical barsintheleftmargin.
Changes
for
CICSPlex
SM
for
CICS
Transaction
Server
for
z/OS
Version
2
Release
3
CICSTransactionServerforz/OS,Version2 Release3introducesamajor extensionof thetasksyoucancarryoutusingtheWebUserInterfacewiththe introduction oftheCreate,UpdateandRemoveactionsfor definitions.
TheWebUserInterfacestarter setofviews andmenushasbeenextendedto include anumberofnew viewsincludinga setof administrationviewsyou canuse to createandupdateCICSresourcedefinitions.You canusetheseasprovided,or asa basisfor creatingyourown usingtheWebUserInterfacevieweditor.
TheWebUserInterfacehas alsobeenimprovedtoinclude thefollowing:
v Generalusabilityandaccessibilityenhancements,suchasimprovedtabularpage
navigation,mixedcasefieldhintsandbetterdataformatting.
v Anenhancedstartersetof viewsandmenusdesignedtoprovidea default
environmentthatismorefamiliarto usersof theISPFenduserinterface. v
Bettersecurityfor WebUserInterfaceviewsandmenus,including anaudit trail.
v Supportfor webclients usingtheGB18030simplified Chinesecodepage.
v Anumberofnew messagesaddedto Chapter9, “Messages,”onpage135.
Anewappendixhasbeenaddedtodocumentprogramminginterfaceinformation for CICSPlex SMWebUserInterfaceHTML.See“Web UserInterface HTML,”on page 169.
Changes
for
CICSPlex
SM
for
CICS
Transaction
Server
for
z/OS
Version
2
Release
2
Themoresignificantchangesfor thiseditionare v
ThevisualrepresentationoftheWebUserInterfacehaschanged inorderto
improveaccessibility..
v Thereareanumberofnewinitialization parameterscontrolling thecolorsof the
WebUserInterfacescreens.See“Accessibility options”onpage30.
There hasbeenachangeinCICSPlexSMfield namingconventionsinthisrelease. DatasetnamefieldssuchasDSNAME,filenamefieldssuchasLOCFILEand REMFILE,andtransient dataqueuename fieldssuchasEXTRATDQ and
INTRATDQ arenow case-sensitive.Whenenteringdatasetandfilenamesintothe CICSPlexSM interfaces(enduserinterface,APIandtheweb userinterface), ensurethatyouenterthedatainthecorrectcase.In previousreleasesofCICSPlex SM,thedatasetnamesandfilenamesareautomatically convertedto uppercase.
Changes
for
CICSPlex
SM
for
CICS
Transaction
Server
for
z/OS
Version
2
Release
1
Thefollowingadditionsandchangeshavebeen madetothebook asa resultof changed andnewfunction atCICSPlex SM CICSTransactionServerforz/OS, Version2 Release2:
v ThesampleDCT(destination controltable)andJCT(journalcontroltable)are
definedwithasuffixofWM. v
TheWebUserInterfaceresourcegroupEYU210GWisincludedinEYU9xxG1.
v ThevisualrepresentationoftheWebUserInterfaceischanged.
v Therearenewstartersetoperationsviews forEnterpriseJavaBeanresources.
v Anumberofnew messageshavebeen addedto Chapter9,“Messages,” on
page135.
v AnewWebUserInterfaceserverinitialization parameter,TCPIPADDRESS,has
Chapter
1.
An
overview
of
the
CICSPlex
SM
Web
User
Interface
TheCICSPlex SM WebUserInterfaceisacustomizable, platform-independent interface foryourweb browser,developedasanalternativetotheCICSPlexSM ISPF EndUserInterface(EUI).Itisdesignedprimarilyfor useinoperationsand help deskenvironments.
Functions
and
features
of
the
Web
User
Interface
TheCICSPlex SM WebUserInterfaceoffersaneasy-to-useinterfacethatyou can use tocarryoutalloftheoperationaltasksnecessaryto monitorandcontrolCICS resources.Youcanalso carryoutcertainadministrativetasksallowingyouto create,updateandremoveCICSPlex SMresources.Youcanlink totheWebUser Interface fromanylocationthatcanlauncha Webbrowser.
TheWebUserInterfaceissuppliedwithastartersetof linkedmenusandviewsbut isdesignedtobecustomizedtoreflectyourbusinessproceduresandtosuit the needsof individualusers.You can,ineffect,usetheWebUserInterfacemenu and viewfacilities tocreateyourownon-lineproceduresmanual.
TheCICSPlex SM WebUserInterfaceallowsyouto:
v Createclear,unclutteredmenusanddisplays(called views),thatpresentonlythe
informationthatyouwishtheusertosee.
v Structureyourdataina task-orientedway.Youcan:
– Organizetheuserinterface byresource category,byusertask,orby
application.
– Definethelinksbetweenviews.
– Definethebuttonsthatwillappearonadisplayandwhattheywilldo.
v Customizethelayoutof data.Youcan:
– Haveasmanyviewsof thesameobjectasyoulike,eachoneshowinga
differentselectionof datadependingontheusertask. – Ifyouhave aJava
™
-enabledbrowser,youcanusegraphicalpresentationsof yourdata:youcanhave eitherabargaugethatshows,for example,the numberof tasksactiveina CICSregion,or awarninglight thatcanbe configuredtochangecoloror flash,dependingonthethresholdvalues you definefor thefield.
v
Customizethepanelsto yourbusinessneeds.Youcan:
– Useterminology appropriateto yourbusiness.
– Useyournational languagefor annotationsandcustomizedhelp.
– Limitthedatathatisdisplayedusingfilters,sothatusersseeonly thedata
relevanttotheirtask.
– Includeinformationfortheuser’sguidance,forexample,contactnamesand
telephonenumbers.
– Definetextthatiswrittenonactionbuttons.
– Foreach menuchoice,addexplanatory texttohelptheuserinthetask.
– Foreach view,providebuttonsthataccomplishthetask,for example,a
shutdownbuttononaCICSregionsview.
v Presentthedatatheuserswantto seeinorderto completeatask.Youcan:
– Displayonlytheinformationyouwanttheuser tosee.
| | | | | | | | | | | | | | |
– Controlwhatinformationcanbeamended,andwhereandhow these
amendmentsaremade.For example,youcanmakesurethattheuserhasto confirmthatanoperation isrequired, orthatdatahastobechanged.You can restrictentryfieldstodisplay-onlyor topresetvalues.
– Addsafetybyprovidingaconfirmationpanelaskingtheuserto confirmthat
anactionistobeperformed. v
Developmenusthatguidetheuserthroughatask.Foreach ofthetasksbeing
performedinyourenterprise,youknowwhichCICSPlex SMobjects areinvolved inthetask,andsoyoucancreatea menufor thetask thatcontainsthose objects.In thisway,youcancreatemenusthatreflectyourbusinessprocedures. v Provideyourowncustomizedhelpinformationfor eachviewandmenuinyour
nationallanguage.Forexample,youcoulddescribethetask tobeperformed,or providecontactnamesandtelephonenumbersthatarespecificto yourlocation. ThehelpdocumentsmaybelocatedontheCICSsystem thatyouhaveselected toactasyourWebUserInterfaceserver,or eachmenu andviewcouldbelinked toanexistingWeb-basedproceduresmanualonanexternalserver.
v ProtecttheViewEditorandspecificmenus,views andhelppanelsfrom
unauthorizedaccess.
Web
User
Interface
View
Editor
Thecustomization oftheWebUserInterfaceisachievedusingtheWebUser Interface ViewEditor.TheViewEditorisanon-line,web-based toolthatleadsyou step-by-step throughtheprocess ofcreatingandpreviewingyourviewsandmenus without requiringanyknowledgeofHTML.Youcandesignviews andmenusfrom scratch orstartwithoneoftheincludedstartersetviews.See“Customizingmenus andviews” onpage 77for guidanceonusingtheViewEditor.
TheWebUserInterface incorporatessecurityfeaturesenablingyouto restrictuse of theViewEditortonominatedusers.
Web
User
Interface
help
facilities
HelpisprovidedaspartoftheWebUserInterface:
v On-linehelpexplaining theWebUserInterfaceandhowto useit
v Messagehelpexplainingmessagesissued bytheWebUserInterface
You canusetheWebUserInterfacetoprovide customizedhelpfor individualviews andmenus.Thishelp canbeservedbytheWebUserInterfaceserverorbyan external server.
National
Language
Support
TheCICSPlexSM WebUserInterfaceprovidesnational languagesupportfor the following languages:
v
Japanese
v SimplifiedChinese
v USEnglish
Example
interactive
procedure
An exampleof aninteractive proceduremayconsistofa menuthatcontainsthe stepsintheproceduretoshut downa targetregioninanactiveworkload: 1. View theactivetarget regionfor aworkload.
Fromthis view,selectatargetregionandquiesceit. |
|
| |
2. View affinitiesfor theselectedworkload.
Check thattherearenoactiveaffinitiesthatwillbeaffectedbyshuttingdown thetargetregion.
3. View activetasksintheregion.
Check activetasksinthetargetregion. 4. View CICStarget regions.
Shutdownthetargetregion.
System
overview
TheWebUserInterfaceisaccessedusingstandardweb browsersoftwarethat contactsaWebUserInterfaceserver,whichisadedicatedCICSregion.Youcan have morethanoneWebUserInterfaceserveractive;for example,youmay have a requirementfordifferentlanguagestobeusedor differentsystemsavailableto differentservers.Thewebbrowser clientcontactsthewebserverbyanHTTP requestviatheCICSWebInterface.
TheWebUserInterfaceserverrunsasaCICSPlexSM localMAS and
communicates withthemanaged resourcesviatheCMASto whichit isconnected. Allthemenuandviewdefinitionsarestoredona serverrepository.Thereisone repositoryfor eachWebUserInterfaceserver.Themenuandviewdefinitionscan beexportedfor backuppurposes,fordistributingdefinitions tootherservers, andfor migratingmenusandviewsbetweenproductreleases.
Controlling
the
Web
User
Interface
You shouldconsiderthefollowingwhendecidingonhow tocontroltheWebUser Interface:
v Administration
v Security
v
Creatingyour customizedWebUserInterface
Administration
TheWebUserInterfaceprovidesanadministrationtransactionCOVCthatallows you to:
v StartandshutdowntheWebUserInterface server
v Viewtheserverstatus
v Viewcurrentuseractivityandterminate activeusersessions
v Importandexportrepositorydefinitions
v Settrace flags
Security
TheWebUserInterfaceusesyourexistingRACF®(orotherExternalSecurity Manager)securityprofilesfor CICSPlexSM.Access totheWebUserInterfaceis controlledbyuserIDandpasswordat signontime.
You cansetupadditionalsecuritytocontrolaccesstospecificWebUserInterface menus,views andhelppanels,andto theViewEditor.
| |
Optionally,if youarerunningCICSTransactionServerfor OS/390,Version1 Release3 orlater,youcan usetheSecure SocketsLayer (SSL)supporttoprovide encryptionontheconnection.
See“SecurityConsiderations”onpage73for guidanceonsettingupthesesecurity features.
Creating
your
customized
Web
User
Interface
Thecreationof yourcustomizedinterfacecovers:
v Analysisofyourbusinesstasksandtherelationshipsbetweenthetasks.
v Tailoringthemenusandviews,andaddinganyadditionaldocumentation.
As theWebUserInterfaceisdesignedtoaccompanyyour existingprocedures,the main taskinthecreationofyour interfaceisthetailoring ofthemenusandviews, andaddinganyadditionaldocumentation yourequire.Tohelpinthistask,astarter setof menusandviewsisprovided.
Summary
—
what
are
the
benefits?
TheWebUserInterface offers:
v Aneasy-to-useinterface foroperationalandsomeadministrativetasks.
v Accessfromanylocationthatcanlaunchaweb browser.
v Flexibleandpowerfulsecurityfeatures.
v Customizedtaskmenusthatreflecttheprocedurescarriedoutinyourenterprise.
v Theabilitytoprovideadditionalhelp textandviewannotationsinasupported
nationallanguage.
v Lowadditionaloverhead forinstallationandsetup.
v Theabilitytorestrictdatafor clearerdisplays.
v Theabilitytoaddlevels ofconfirmationforadditionalprotection.
v
Thepossibilityofmultipleserversactiveatanyonetime, supportingdifferent
languagesandprovidingavailabilityshouldaproblemrenderoneof theservers inaccessible.
| | |
Chapter
2.
The
main
components
of
the
CICSPlex
SM
Web
User
Interface
This chapterprovidesabrief overviewofthemaincomponentsoftheCICSPlex WebUserInterface. Thesearethe:
v “TheCICSPlexSM WebUserInterfaceframes”
v “Viewsetsandviews” onpage 8
v “Menus”onpage 15
v “Context,CMAScontextandscope”onpage17
v “Customizableviewandmenu help”onpage18
v “TheViewEditor”onpage 18
The
CICSPlex
SM
Web
User
Interface
frames
TheCICSPlexSMWebUserInterfaceexploitsa frame-basedinterfaceas demonstratedinFigure1.
TheCICSPlexSMWebUserInterfacedisplayconsistsof threeframes: v TheNavigationFrame
v TheWorkFrame
v
TheAssistanceFrame
TheCICSPlexWebUserInterfaceframesmaycontain iconsandlinkstoallow you tonavigatearoundtheWebUserInterface,accessWebUserInterfacefacilities suchasHelp,andmanageWebUserInterfacesessions.
Icons
Iconsmaybe:
v Graphicsymbolsthatausercan pointtowithadevice suchasamouse,to
selectaparticularfunction.Selectingagraphicsymbol iconresultsinanaction beingperformed. Forexample,selectingtheGobackicon resultsintheprevious menuor viewbeingdisplayed.TheiconsshowninTable2 onpage 6are
examplesofgraphicsymbols.
v Graphicalrepresentationsof anobject(forexample,afile orfield)thatconsists
ofanimage.Selectingthis typeoficon hasnoeffectbuttheicon mayconvey extrainformation.
TheWebUserInterface usesthefollowingicons: Table2.Graphicsymboliconsandtheirdescriptions
Icons Description Meaning
Backtostarticon
Gobacktostart Returntothefirstpageyousawinthis window
Backtolastmenu icon
Gobacktolastmenu Returntothelastmenuthatwas displayedinthiswindow
Gobackicon
Goback Returntothepreviousmenuorview. ThereisaGobackicononboththe workframeandtheassistanceframe.
Sortascendingicon
Sortascending Sortthedatainthecolumninascending order
Sortdescendingicon
Sortdescending Sortthedatainthecolumnin descendingorder
Summarizeicon
Summarize Summarizethedataintheviewbased ontheselectedcolumn
Printpreviewicon
Printpreview Displayaprintableversionoftheviewin anewwindow
Expandicon
Expand Expandagrouponthenavigationframe
Collapseicon
Collapse Collapseagrouponthenavigation frame
Helpicon
Help Fromtheassistanceframe,theHelp iconopenstheWebUserInterfaceHelp ContentsPage.Fromthemessagearea intheworkframe,theHelpiconopens theWebUserInterfaceMessageHelp forthedisplayedmessage
Casesensitivefield icon
Casesensitivefield Marksanentryfieldthatiscase sensitive.
Requiredparameter orattribute
Requiredparameteror attribute
Marksafieldthatmustbecompleted
Links
Alinkallowsyoutonavigatebetweendifferentmenusandviews.Thestyleofa link depends onthebrowseryou areusing,butitisusuallyindicatedbywordsthatare | | | | || | | | | | | | |
highlighted insomeway,possiblybya differentcolorandunderlined.For informationabout usinglinks,see“Usinglinks”onpage48.
The
navigation
frame
Thenavigationframe appearsontheleftof thedisplayandcontainsitemsthat allow youtodisplayamenuor viewortoperformanaction.Theitemsthatare displayed dependonyourconfigurationandauthority.For example,if youdonot have authorityto customizethedisplay,you willnothave alinkto theViewEditor. For informationabouttheViewEditor, see“TheViewEditor”onpage 18.
Thetypesoflinksinthenavigationframeare:
Menus andviews
Linksthatwhenselectedcansetthecontentsof theworkframeto another menu orview.
Externallinks
Linksto externalURLsthatlauncha newweb browserinstance.
Standardlinks
Theseappearautomaticallyandcannotbecustomized.
Open links Home
Opensyourhome menuusingthecurrentcontext andscope.You may returnto thecurrentdisplayusingtheGobackicon.
RepeatLastMenu
Openthelastmenuthatwasdisplayedusingthecurrentcontextand scope.Youmay returntothecurrentdisplayusingtheGobackicon.
Special links ViewEditorlink
Openanew windowcontaining theWebUserInterfacecustomization tool, theViewEditor. Thisisavailableonlyto userswiththeappropriate authority.
NewWindowlink
Openanew webbrowserwindowcontaininganindependentWebUser Interfacedisplayofthecurrentviewormenuusingthecurrentselection criteria.
CloseWindowlink
Closea webbrowserwindow.
Sign offlink
Signoff yourWebUserInterfacesession.
Some itemsinthenavigationframemaybeingroups,thatcan beexpandedor collapsed independentlyofothergroups,usingtheexpandandcollapseicons shown inTable2onpage6.
The
work
frame
Theworkframeistheareainwhichdata ispresentedtotheuserfor interaction. Theworkframecandisplay:
v Atitlefor theinformationbeingdisplayed.
v Alinkto yourcustomizableviewandmenu helpforthedisplay.
| |
v Amessagearea,containingoneormoremessages andlinksto theexplanation
ofthemessageormessagesbeingdisplayed.
v Aselectioncriteriaandrefreshareathatallowsyouto setthecontext, scopeand
filtersandrefreshthemenuor viewcurrentlybeingdisplayed. v Theresultsofyourworkrequests,inoneofthefollowingformats:
– Menu,thatis,alist ofrelatedtopicsfromwhichyoucanselect oneor more
links.
– Tabularview,showingformattedinformationabout multiplerecordsfora
resourcetype.
– Detailview,showinginformationabout asingleresourceinstance.
– Confirmationpanel,allowingtheoptionofcommitting orcancellinganaction,
orprovidingadditionalinput.
– Asignonpanel,thatis,aninteractivepanelaskingyoufor yoursignon
information.
– Asimplemessagedisplaythatcontainsatitle andaninformationmessage,
withnoadditionaldata.
The
assistance
frame
Theassistanceframecontainstheproductname,aniconlinking totheWebUser Interface Help,theIBMlogo,andtheGobacktostart,Gobacktolast menu,and Gobackicons.
View
sets
and
views
Aviewsetisa numberof relatedviewsthatareusedtogethertomanagethe samemanagedobject.
Aviewisadisplayformatthatisusedto interactina particularwaywiththe specified managedobject.Aviewexistswithin aviewset.
Thedifferenttypesofviews are: v
Tabular,containing datafrommultiplerecords.
v Detail,containing datafromonerecord.
v Confirmationpanel,requestingconfirmationofanaction.
Viewsconsistofanumberof possiblecomponents: v Title
v MessageArea
v SelectionCriteria andRefreshArea
v Form
v
Links
v Annotation
v
Actionandconfirmbuttons
v Helplink
Title
This isdisplayedatthetopofthepageandisthetitleof theview.This area includesthelink tothecustomizablehelpif available,printpreviewicon,anda resource icon.
This areaisalwayspresent.
Message
area
This areadisplaysmessagesandcontainsahelpicon totherightoftheareathat linksyouto theexplanationof themessagebeingdisplayed.
This areaappearsautomaticallywhenrequired.
Selection
criteria
and
refresh
area
This areaallowsyouto setthecontext andscopeandrefreshtheviewcurrently displayed. Youcanrefreshviews intwo ways:
v Refreshondemand
v Automaticrefresh
For informationaboutsettingtheselectioncriteria,see“Selectioncriteria”onpage 43.
This areaappearsautomatically,asapplicable,butthecontentsmaybecustomized usingtheViewEditor. ForinformationabouttheViewEditor, seeChapter6,
“Customizing theWebUserInterface,”onpage77.
Refresh
on
demand
You canrefreshtheviewdisplayedat anytimebyselectingtheRefreshbuttonin theselectioncriteriaandrefresharea,whenavailable.
Automatic
Refresh
Theautomaticrefreshfunctionisavailableonlyif youareusinga
Javascript-enabledbrowser.Theautomaticrefreshfunction allowsyou tocontrol how frequentlythedatainaviewisupdated.For informationaboutautomatic refresh,see“Refreshing views”onpage54.
Form
This istheinformationthatisdisplayedintheworkframe.Aformisalwayspresent if thereisdata.
Thecontentsoftheformdependsonthetypeofviewbeingdisplayed:
Tabular
Adisplaythatshowsselectedattributesfrommultipleinstancesof the resource type,orsummarized records.Theviewmayconsistofa number of pages.You canjumpto anyoftheavailablepagesbyenteringthe requiredpagenumberoruse NextandPreviousbuttonsto stepthrough theavailablepagesoneata time.
Eachattributeinatabularviewisdisplayedinaseparatecolumn.The checkboxesnext totherecordnumberintheRecord columnallowyouto select oneormorerecordsfor anaction.Youcan usetheSelectall and Deselectall buttonsto selector deselectallof therecordsthatmatched your selectioncriteria.Youcan alsocombinetheSelectall buttonandthe checkboxesintheRecordcolumnto selectall,thendeselectafew. Ona summarizeddisplay,whichisaspecialformof thetabularview, the numberintheRecord countcolumnindicates thenumberof records combinedintothesinglelineof summaryinformation.Thetotalnumberof recordsandthenumberofdisplaypagesinthesummaryisindicatedabove | | | | | | | | | | | | | | |
andbelowthesummarytable.Youcanperformactionsonalltheitemsina summarylinebyselectingthecheckboxintheleft-hand column.
Theupanddownarrow icons(seeTable2onpage 6)inacolumntitlebox indicatethatthecontentsof thecolumnscanbesortedineither ascending or descendingorder.For informationaboutsortinga tabularview, see “Sorting aview”onpage52.
Thesummarizeicon (seeTable2 onpage 6)inacolumntitlebox indicates thatthecolumncanbeusedto summarizethedataintheview.
Thefieldsto beused forsortingandsummarizingatabularvieware definedwhentheviewiscreatedusingtheWebUserInterfaceView Editor. See“Summarizinga view”onpage52fordetails.
Someattributevalues mayappearaslinksto otherviews.Selectingalink displaysrelatedinformation.
Detail Adisplayshowingaselectionof detailedattributeinformationfor a
particularinstanceofaresource, withoptional annotationforeachattribute. Attributes maybedisplayed ininput fieldssothatthefieldscanbealtered. In adetaildisplaytheinformationisshowninthreecolumns;attributelabel, attributevalue,andoptional annotation.
Figure2.Atabularview | | | | | | | | | | | | | | | | | |
Attributelabelscanbelinkstootherviews.
Attributevaluescanbemodifiableto allowyoutoenteryour ownvalues. SeeFigure3 foranexampleof adetailview.
Confirmation Panel
This displayissimilarto adetaildisplayandasksyouto confirmthatyou wanttheactionyourequestedto beapplied totheselectedresources. Theconfirmationpanelmaycontain thefollowing buttons:
Table3.Confirmationpanelbuttons
Button Meaning
Yeston
remaining
Performtheactionforthisandalltheremainingresourcesinthe selectionlist;wherenisthenumberofrecordsremaining.
Yes Performtheactionforthisresourceonlyanddisplaythedetailsofthe nextresourceintheselectionlist
Notonremaining Canceltheoperationforthisandforallremainingresourcesinthe selectionlist;wherenisthenumberofrecordsremaining.
No Donotperformtheactionforthisresourceanddisplaythedetailsofthe nextresourceintheselectionlist
Aconfirmationpanelmayincludeparametersforsomeactions.Itmaybe possibleto selectcheckboxesorradiobuttons, ortypeavalueintoan input fieldto specifyparametersforanaction.Requiredparametersare markedwiththeicon
.Figure4shows anexampleofaconfirmation panel.
Figure4.Aconfirmationpanel | | | | | | | | | |
Attributes
Thevarioustypesof formsmaycontain attributesthatappearmainlyasasimple textual representationof theinformationcontainedinaninstanceof aCICSPlexSM resource.Attributesmayalso appearasgraphicalpresentations,forexample,as warning lightsorbargauges.
Alltheattributesontabulardisplaysaredisplayonly,butdetailformscan contain interactive controlsthatallowyouto enteryourownvalues.
For example,youmaywanttochangethepriorityofa localtransaction.You could select thetransactionname fromyourviewoflocaltransactions.Thismaytakeyou to thedetailviewof thetransaction.Youcannowenter thepriorityinthePriority entry fieldif available,selectthecheckboxnextto theentry field,thenselectthe Set buttonor thebuttonthatyouuseto applyyourchanges,to changethevalue. For moreinformationsee“Modifyingattributesandenteringparameters”onpage 56.
Parameters
Parameters mayappearonlyonconfirmationpanelsandmaybespecifiedfor an action. Forexample,ona CICSregionshutdownconfirmationpanel,seeFigure4 onpage12,youmayhave theopportunitytospecifythenormal,immediateor takeover parametersfor theshutdownaction.Formoreinformationsee“Modifying attributesandenteringparameters”onpage 56.
Selection
lists
and
entry
fields
Attributeandparametervalues areenteredonviewsusingselectionlistsandentry fieldsasfollows:
Selectionlists
Selectionlistscontainacompletelistof valuesavailabletotheuserfor a givenattributeorparameter,onaview.Aselection listenablesyouto select theappropriateattributeorparametervaluefromalist.
Entry fields
Entryfieldsallowtheuserto typeinanattributeorparameter value.Fields thatarecasesensitive aremarkedwiththeicon
.
Links
Alinkallowsyoutoconnect afieldinoneviewwithrelatedinformationinanother view. Linkscanoriginatefromthefollowinglocations:
v Attributevaluesontabularformdisplays
v Attributelabelsondetailformdisplays
v Statictextondetailformdisplays
There aretwotypesof links:
v Linkstoalternativedetails foraspecificresourcewithin thesameviewset.The
datadisplayedisnotupdated.
v Linkstorelatedresources,forexample,fromtaskto transaction,inanotherview
set.Theseresultinnew databeingcollected.Thistypeof linkismarkedwithan iconrepresentingthetarget resource.
Link fieldsarehighlighted inthenormalmannerforyourweb browser. | | | | | | |
Annotation
At variousplacesonadisplay,extrainformationcanbeshownintheformof a fixedannotation.Annotationsmay beused toshowanybriefnotesyourequire.
Viewandmenuannotations
Theseareapplicableonanyviewormenuandappearbelowthedata displayforviews orabovetheitemsof amenu.
For example,inthemenushown inFigure5onpage16themenu
annotationis,’Welcome toyourHomemenu.Pleaseselecta taskfromthe following list.Usethe’Help’ linkfor furtherinformation.’.
Attribute annotation
Ondetailviewsandconfirmpanels theremaybeabriefnoteabouteach individual attributeorparameter.Theattributeannotationappearsto the rightof theattributeconcerned.
Menu choiceannotation
Amenu choiceannotationappearsbelowthemenuchoice.
For example,inthemenushown inFigure5onpage16thesentence ’Display listofactive CICSregions.’undermenuchoice ’CICSregions’,is themenu choiceannotation.
Action
and
confirm
buttons
Actionbuttonsareoftendisplayedonviewsat thebottomof theworkarea.These include:
v Buttonstoperformactionsonresources,suchas’Disable’.Thesearedisplayed
onbothdetailandtabularforms.
v Buttonstoconfirmorcancel thecompletion ofa task(forexample,’No ton
remaining’,’No’,’Yes’,and’Yeston remaining’).Theseareconfirmbuttonsand arediplayedonconfirmationpanels.
Action
buttons
Actionbuttonscaneither: v
Issueanappropriatecommandandredisplaytheview.This isinthecaseof a
directactionwhich requiresnoconfirmation,or
v Displayapaneltoconfirmtheaction,withperhapsfieldsforfurtherinput.These
actionbuttonsautomaticallyhave anellipsis(...) appendedto theendof their label.
For detailviews,theactionisperformedontheresource displayedontheview. However, fortabularviews,youcanmarkmultiplerecordsfor anaction,by
selecting thecheckboxesdisplayedinthefirstcolumn.If youprefertoperformthe actiononalltherecords,youcanusethe’Selectall’button.Youcanalsousethe ’Deselectall’buttontoclear yourselection.Thenumberof recordsselectedon tabularandsummaryviewsisdisplayedabovethetabularinformationas’n
recordsonnpages’.
If youmarkmorethanonerecord foranaction,thebehaviordependsonthetype of actionasfollows:
Direct actionrequiringnoconfirmation
Theactioniscarriedoutfor allmarkedrecords.Whentheoperationis complete,theviewisredisplayedwithallthecheckmarksreset.
Actionsrequiringconfirmationpanel
Theconfirmationpanelisdisplayedfor thefirst markedrecord,containing | | | | | | | | | |
at leastoneof the’Yes’,’No’,’Yesto nremaining’, and’No ton remaining’ buttons. Ifthe’Yes’or’No’buttonsareselectedtheactionisperformedor not,asappropriate,andtheconfirmationpanelisdisplayedforthenext markedrecord,andsoon.If the’Yesto nremaining’actionisselectedthe actioniscarriedoutforallremainingmarkedrecords.
Whentheoperation iscomplete,allcheckmarksarereset.
Help
link
This isa linkto specialon-linehelpdocuments andisoptional.Thishelpiscalled thecustomizable viewandmenu help.For informationaboutthecustomizableview andmenu helpsee“Customizableviewandmenuhelp”onpage18.
Menus
Amenuisalistof relatedtopicsfromwhichyoucanselectanitem.
Itemscanbeoptionallyorganizedintogroups.Foranexampleof amenusee Figure5onpage16,whichshows theWebUserInterface startersetmainmenu. This isthedefaultmenu displayedaftersuccessfullylogging onto theWebUser Interface. Youcangetbackto itbyselectingHomeonthenavigationframe.
Amenuhasseveralcomponents:
Title
This isdisplayedatthetopofthepageandisthetitleof themenu.Thisarea includesa linkto thecustomizable viewandmenuhelp,if available.
This areaisalwayspresent.
Message
area
This areadisplaysmessagesandcontainsalinkto theexplanationof themessage beingdisplayed.
This areaappearsautomaticallyasrequired.
Selection
criteria
area
This areaallowsyouto setthecontextandscopetobeusedwhenyounavigate fromthecurrentmenu.
This areaappearsautomatically,asapplicable,butthecontentsmaybe customized.
Annotations
If defined,thisareamaycontain instructionsonhowto usethemenuand commentsexplaining themenu.
Menu
group
titles
Grouptitlescanbeused toorganize thechoicesinamenu intoseparategroups.
Menu
choices
Thedifferenttypesofchoicesare: v Menulinks
Thesearelinkstoother menus. v Viewlinks
Thesearelinkstoviews ofdata, possiblysettingspecificselectioncriteria. v Externallinks
Thesearelinkstopagesservedbyanexternalwebserver(thecontentsof whicharedisplayedinaseparatebrowserwindow).
In additionto thetypeanddestinationof alink,there mayalsobeselectioncriteria defined. Forexample,youcould:
v Buildamenu ofCICSplexes(each itemgoingtothesamemenu butwitha
differenthard-codedcontext).
v Buildamenu ofapplications(again,eachitem goingto thesamemenu butwith
differentlogicalscopes).
v Buildalink toanactivetargetregionviewfora specificworkload.
Context,
CMAS
context
and
scope
You cansetthecontext,CMAScontextandscopeto beused whenyounavigate fromthecurrentmenuintheselectioncriteriaareaof amenu andtheselection criteriaandrefreshareaofa view.EitherthecontextortheCMAScontextisused for alloperations.Context,CMAScontextandscopeare:
v Context
ThisistheCICSplexnameandisusedfor almostallviews. v CMAScontext
ThisistheCMASname.Thisisused onlywhenyouareviewingCMASlevel configurationdatasuchasCMASstatusandtheCICSplexesconnectedtoa CMAS.
v
Scope
ThisisaCICSplex, CICSgroup MASorlogical scopename.Thescopeisa subsetofthecontext, andlimitstheeffectsof CICSPlexSMcommandsto particularCICSsystemsorresources.IftheCMAScontext isbeingused,the scopeisignored.Thescopeisonlyused forcertainresourcetypes.
Customizable
view
and
menu
help
TheWebUserInterface allowsasite toprovideitsown customizedhelp
informationfor eachviewandmenu.Thehelp documentscanbelocatedonthe CICSsystem thatyouhaveselectedtoactasyourWebUserInterfaceserver,or each menuandviewcouldbelinkedtoanexistingWeb-based proceduresmanual onanexternalserver.
If servedbytheWebUserInterface, thecustomizable viewandmenuhelpconsists of asetof arbitraryHTMLpagesstoredasmembersinapartitioneddataset.The CICSWebInterfacetemplatemanagerisused toservemembersofthis partitioned data setfordeliverytothebrowser.
For moreinformationaboutthecustomizable viewandmenu help,see “Customizableviewandmenuhelp” onpage 86.
The
View
Editor
TheCICSPlexSM WebUserInterfaceViewEditorallowsyoutocreatecustomized views andmenus.Youcancreateyourownversionusingasuppliedviewormenu asa model,or youcanstartanew.For example,youmightwanttocreateviews thatapplyto aspecifictaskor setof data.
If yourWebUserInterfaceserverisrunningwithsecurityactive,theViewEditor can berestrictedtonominatedusers.Youonlyseethelink totheViewEditorinthe NavigationFrameif youhavetherelevantauthority.
Each viewthatyou createhasto bebasedonasingleCICSPlexSMmanaged object.You canchoosewhichattributesyouwantto display,andtheformat in which theyaretobedisplayed.
TheCICSPlexSM WebUserInterfaceincludesastartersetof viewsthatyoucan use eitherassuppliedorasthebasisfromwhichto createyour owncustomized views.
For moreinformationabouttheViewEditor, seeChapter6, “CustomizingtheWeb UserInterface,”onpage77.
Chapter
3.
Setting
up
a
CICSPlex
SM
Web
User
Interface
server
This chapterdescribesthestepsyoumust performto usetheCICSPlexSM Web UserInterface.Thesestepsconsistof:
v “PreparingaCICSsystemto actastheWebUserInterfaceserver”
v “ConfigureCICSWebsupport”onpage 20
v “ReviewCICSsysteminitializationparameters”onpage21
v “Specifylanguageandcodepage”onpage22
v “Preparecodepageconversiontable” onpage23
v “GeneratetheProgramLoadTable(PLT)”onpage23
v “CreatetheWebUserInterfaceserverrepository(EYUWREP)”onpage 24
v “Specifythecustomizableviewandmenuhelp dataset”onpage 25
v “SpecifytheWebUserInterfaceserverinitializationparameters”onpage25
v
“UpdateCICSCSDdefinitions” onpage 31
v “SpecifytheJCLDDstatements” onpage33
v “Securityconsiderations”onpage33
v “Additionaltasks”onpage35
Preparing
a
CICS
system
to
act
as
the
Web
User
Interface
server
You shouldconsiderthefollowingbefore yousetupyourCICSsystem toactas your WebUserInterfaceserver:
v TheCICSsystem thatyouselecttoactasyourWebUserInterfaceservermust
bea dedicatedCICSTransactionServerforz/OS, Version2Release3CICSPlex SMlocalMASconnected toaCICSTransactionServerfor z/OS,Version2 Release3CMAS.For informationabouthow tosetupalocalMAS,see the
CICSTransactionServerforz/OSInstallationGuide.
v Decidehow manyWebUserInterfaceserversyouneed.For example:
– Ifyouintendtosupportmorethanonenational languageyouneed aWeb
UserInterfaceserverforeverylanguageyouwantto support. – Youmaywanttohave WebUserInterfaceserversonmultipleMVS
™
images. – Youmaywanttohave morethanoneWebUserInterfaceserverfor
availabilityreasons.
v TheWebUserInterfaceservercreates andmaintainsstatedatawhenauser
signsonvia awebbrowser(or whenanapplicationusingthedatainterface DATA/CONNECTs).Becauseofthis statedata,anaffinitybetweentheweb browser(orapplicationusingthedata interface)andserveriscreated.
Theuseoftechniques likedynamicvirtualIPaddresses (DVIPA)or distributed DVIPAmaynotbeabletohonor thisaffinity.Ifthisaffinityisnothonored,the usualresultisforweb browserstoredisplaythesignonscreenorfordata interfaceapplicationsto receiveaBADSTUBstatus.
v IfatheWebUserInterface serverhasa differentlocalIPaddressorname tothe
oneusedbyusersintheirweb browsers,forexampleduetoafirewalloranother reasonthatcausesnetworkaddress translation(NAT),theTCPIPHTTPHOST WebUserInterfaceserverinitializationparametermay beused tocontrolthe waytheWebUserInterface servergeneratesURLssentto webbrowsers.See 26for details. | | | | | # # # # # # # # # # # # # #
TosetupyourCICSsystemyoushould:
1. CreatetheCICSsystemandconfirmthatit isoperationalusingthe
CICS-supplied installationverificationprocedures(IVPs).Forinformationabout theCICSIVPs,seetheCICSTransactionServerfor z/OSInstallationGuide.
“Typicalend-userproblems”onpage132offers possiblesolutionsto some typical problemsthatyoumay encounter.
2. ConfigureCICSplexesfor yourWebUserInterfaceservers.Wesuggest that
you configureaseparate CICSplexforyourWebUserInterface servers.For information, seetheCICSTransactionServerfor z/OSInstallationGuide.
3. Ensure thattheCMAStowhichtheWebUserInterface connectsismanaging
allCICSplexesthattheWebUserInterfaceserverneedsaccessto.Thisis becausetheWebUserInterfaceserveractsasanCICSPlexSMAPI
application.However,it isnotnecessaryfortheCMAS,to whichtheWebUser Interface connects,tobemanagingany oftheMASsintheseCICSplexes.For information, seetheCICSTransactionServerfor z/OSInstallationGuide.
If thereismorethanoneCMASontheMVS image,thattheWebUserInterface serverwillrunon,youneed toconsiderwhichCMAStheWebUserInterface shouldconnect todependingonwhichCICSplexestheCMASismanaging.To controlthis connectionyoucaneither:
v EnsuretheCICSplexto whichtheWebUserInterfaceserverlocalMAS
belongsisonlymanaged bytheCMAS orCMASsthattheWebUser Interfaceshouldconnect to,or
v EnsurethattheWebUserInterfaceserverconnectstoa specificCMAS by
specifyingtheCMASSYSIDEYUPARMfor theserverlocalMAS.
4. Define theWebUserInterfaceserverCICSsystemto CICSPlexSMasalocal
MAS (forinformation,see theCICSTransactionServerfor z/OSInstallation Guide)andensurethattheCICSsystem hasbeensetupcorrectlyusingthe CICSPlexSM installationverificationprocedures(IVPs).
“Typicalend-userproblems”onpage132offers possiblesolutionsto some typical problemsthatyoumay encounter.
5. Considerbasicmonitoringof yourWebUserInterfaceservers.Youcanuse
standard CICSPlexSM monitoringbecausetheWebUserInterfaceserveris definedasa localMAS.
Configure
CICS
Web
support
You shouldalwaysuseaCICSTransactionServerfor z/OS,Version2Release3 system toactasyourWebUserInterfaceserver.In ordertoconfigureCICSweb supportyoushould:
v IncludetheCICSresourcedefinitiongroup,DFHWEB,inthegrouplist
referencedbytheGRPLISTsysteminitializationparameter ofyourCICSsystem. v RuntheCICSWebsupportsampleapplication,DFH$WB1A,toensurethatCICS
Websupporthasbeen setupcorrectly.
“Typicalend-userproblems”onpage132offerspossiblesolutionstosome typicalproblemsthatyoumayencounter.
For moreinformationaboutspecifyingCICSsysteminitializationparametersand defining resourcestoCICSforCICSWebsupport, seetheCICSInternetGuide.
If youwishtousethesecuresocketslayer(SSL)you shouldalso: v Createakeydatabasecontainingacertificate
v Specifytheappropriatesystem initializationparameters
| | | | | | | | |
v Installtheappropriateresource definitions
For moreinformationaboutSSL, seetheCICSInternetGuide.
Notes:
1. You donotneedto writeyourownAnalyzeror Converterprogramsastheseare
provided withtheWebUserInterface.
2. OntheWebUserInterfaceinitialization theTCPIPSERVICEiscreatedand
openedfor youbytheWebUserInterface. Youdo,however,needtocreatea temporaryTCPIPSERVICEdefinitiontoruntheCICSWebsupportsample application.ThistemporaryTCPIPSERVICEdefinitionshouldbediscardedafter CICSWebsupporthasbeentestedandbeforeWebUserInterfaceinitialization hasbegun.
3. TheWebUserInterfacecan eitherusethedefaultcertificateinthekey
databaseora namedcertificate.However, itcanonly useanamedcertificate provided thatthelabelcontainsonlyalphanumericcharactersandisa maximumof 32characters.
4. Theuseof pre-CICSTransactionServer forz/OS,Version2 Release3 systems
asWebUserInterfaceservers isnotsupported.
Review
CICS
system
initialization
parameters
You needtospecifythestoragekeyfortheCICScommonworkarea(CWA),and theamountof storagerequiredfor theCWAontheCWAKEYandWRKAREACICS system initializationparametersasfollows:
CWAKEY=CICS WRKAREA=2048
ToensurethatWebUserInterfaceexceptiontraceentriesarewrittento theCICS auxtrace dataset,asrequiredtoachievefirstfailuredatacapture,youshould specifytheUSERTR,SYSTR,andAUXTRCICSsysteminitialization parametersas follows:
USERTR=ON SYSTR=OFF AUXTR=ON
Note: IfyousetAUXTR=OFF,this willbeoverriddenatstartup.TheWebUser
Interfacesets auxiliarytrace oninordertorecord exceptiontraceentriesin theeventof aproblemthatdoes notresultinaSVCDUMP.
SpecifytheCPSMCONN CICSsystem initializationparameterto invokeCICSPlex SM codeautomatically duringCICSinitializationandinitializetheregionasa CICSPlexSM WebUserInterfaceserver.Thisistherecommendedalternativeto specifyingtheCICSPlexSMWUIinitializationandshutdownprograms in
initialization andshutdownprogramlist tables(PLTPIandPLTSD).
CPSMCONN=WUI
APARPK10236
SpecifiestheactionCICSshouldtakeif,atthenextlocalmidnight,theCICS time-of-daydiffers fromthesystem time-of-daybymore than30minutes (for example,aftersettingclocksforwardorbackto adjustforSummerandWinter time). AUTORESETTIME=YES | | # # # | | | | | | |
ClientsshouldcontinuetoissuetheCEMTPERFORMRESETcommand. In additionto specifyingthenecessaryCICSsysteminitialization parametersfor CICSPlexSM localMASexecution,specifytheappropriateCICSsystem
initialization parametersto enableCICSWebInterfacesupport,for yourreleaseof CICS.For example,TCPIP=YESforCICSTransactionServerforOS/390version 1.3or later.
For informationabouttheseparametersseetheCICSSystemDefinition Guide.
Specify
language
and
codepage
In additionto specifyingCICSsysteminitialization parametersfor theCICSWeb Interface andCICSPlexSM localMASexecution,theWebUserInterfacerequires anINITPARMsystem initializationparameterto specifytheserverlanguageandthe clientcodepage.Youneed tocodeEYU9VKECto representthelanguageof the WebUserInterfaceserverandEYU9VWAN torepresentthecodepageoftheclient ontheINITPARMparameter.
You canselecttheserverlanguageandtheclientcodepagefromTable4and specifythemontheINITPARMparameterasfollows:
INITPARM=(EYU9VKEC=’xxx’,EYU9VWAN=’yyyy’)
wherexxx isthelanguageidentifierof theWebUserInterfaceserverandyyyyis thecodepageidentifieroftheclient.
Table4.LanguageandcodepageidentifiersforINITPARM
Language Languageidentifier (EYU9VKEC)
Clientcodepage Defaultclient codepageidentifier (EYU9VWAN) USEnglish ENU ISO-8859-1(819) ENU1 Japanese JPN Shift-JIS(943) JPN1 SimplifiedChinese CHS GB2312(1381) CHS1 SimplifiedChinese CHS GB18030(05488) CHS2
For example,ifyourchosenlanguagewasEnglishyouwouldcodetheINITPARM parameter asfollows:
INITPARM=(EYU9VKEC=’ENU’,EYU9VWAN=’ENU1’)
Notes:
1. Thecodepageidentifiercan beoverriddenforindividual userrequestsby
placing itintheURLusedto accesstheWebUserInterface. Forexample:
http://hostname:port/CICSPlexSM/codepage
wherehostnameisthename specifiedontheTCPIPHOSTNAMEWebUser Interface serverinitialization parameterandportisthevaluespecifiedonthe TCPIPPORT WebUserInterfaceserverinitialization parameter.For information about theWebUserInterfaceserverinitialization parameterssee “Specifythe WebUserInterface serverinitialization parameters”onpage25.
2. If theINITPARMsysteminitialization parameterisnotspecifiedor ifa valueis
notspecifiedfor EYU9VKECorEYU9VWAN,thedefaultvalueswillbeENUfor thelanguageandENU1forthecodepage.However,operatormessagesare issued everytimedefaultvalues areused.
3. AsimplifiedChinesewebuserinterface servercansupportclientbrowsers
usingeither GB2312(CHS1)or GB18030(CHS2).ForGB2312clients,the serverusestheEBCDICcodepage,935.ForGB18030clients,theserver assumesa secondEBCDICcodepage,1388, whichisasupersetof codepage 935.View setsandmenuseditedusinga GB2312clientbrowserarestoredin 935andcanbeusedineitherclientcodepage.However, ifaviewsetor menu iseditedusingaGB18030clientandcharactersnotavailablein935areused, theresultingviewssetormenu arenotdisplayedcorrectlyonGB2312clients. Notethatallsuppliedmessagesandstartersetviewsandmenus,andview sets andmenuscustomizedusingCICSTS2.2or earlier,usethe935 codepageandcanbedisplayedoneitherclientcodepage.
4. Someweb browsersdonotsupportalltheavailableclientcodepages.For
example,manyolderbrowsersdonotsupportGB18030.
Prepare
codepage
conversion
table
You needtocreateormodifytheDFHCNVtable fordataconversion toallowthe WebUserInterface todealwithincomingrequests.
AsamplecopybookisprovidedinCICSTS23.CPSM.SEYUSAMPcalled EYU$CNV1.This containsanentryfor everylanguageandclientcodepage combinationthatissupportedasfollows:
EYUENU1
Entryfor English
EYUJPN1
Entryfor Japanese
EYUCHS1
Entryfor simplifiedChinese(GB2312clients).
EYUCHS2
Entryfor simplifiedChinese(GB18030clients)
You shouldincludeacopystatementforEYU$CNV1intheDFHCNVsource,for example,theCICSWebInterfacesample, DFHCNVW$.Forinformationabout the definitions requiredfortheCICSWebInterface, seetheCICSInternetGuide.
Onceyouhave updatedyourDFHCNVsourcemodule,youshould assembleand link-edititusingtheCICSproceduresformaintainingconversiontableload modules.
Theprocess usedtoassemble andlink-edittheCICSconversiontableload modulesmusthave libraryCICSTS23.CPSM.SEYUSAMPintheSYSLIB
concatenation oftheassemblerstep,or thecopybookmembermust beinserted into thetable sourcememberinplaceoftheCOPYstatement.
Generate
the
Program
Load
Table
(PLT)
ThefollowingparagraphscontaininstructionsforgeneratingthePLT.Howeverfor CICSTSsystemsthereisnoneed tospecifytheWUI initializationandshutdown programs ininitialization andshutdownprogramlist tables(PLTPI andPLTSD).The recommendedalternativeistospecifytheCPSMCONN=WUICICSsystem
initialization parameterwhichwillinvokeCICSPlexSMcode automaticallyduring CICSinitialization toinitializetheregionasa CICSPlexSM WebUserInterface server.. | | | | | | | | | | | | | | | | | | | | | | |
Update yourPLTCICSresourcedefinitiontableto referencethecopybook, EYU$PLT4,thatcontainsanentryforEYU9VKIT.Whenyouhave updatedyour PLT,assembleandlink-edititusingtheCICSproceduresfor maintainingresource definitiontable loadmodules.
Theprocess usedto assembleandlink-editthePLTloadmodulesmusthave library CICSTS23.CPSM.SEYUSAMPintheSYSLIBconcatenationof theassemblerstep, or thecopybook membermust beinserted intothetablesourcememberinplace of theCOPYstatement.
AsamplePLTPIisprovidedcalled EYUPLT1$.EYUPLT1$containsthecopybook EYU$PLT1,which hasanentry forEYU9NXLM.EYUPLT1$alsocontainsthecopy book EYU$PLT4,whichhasanentryforEYU9VKIT,theWebUserInterface initialization andterminationmodule.
EYU9VKIT mustbeinvokedduringthesecondphaseofPLTPIexecution, thatis afterthePROGRAM=DFHDELIMentry,for WebUserInterfaceinitialization.For example: DFHPLT TYPE=ENTRY, PROGRAM=DFHDELIM | COPY EYU$PLT4
AsamplePLTSDisprovidedcalledEYUPLT2$.EYUPLT2$containsthecopybook EYU$PLT4,which hasanentry forEYU9VKIT,theWebUserInterfaceinitialization andterminationmodule. EYU9VKITmustbeinvokedduringthefirstphaseof PLTSD execution,thatisbeforethePROGRAM=DFHDELIMentry, forWebUser Interface termination.
Create
the
Web
User
Interface
server
repository
(EYUWREP)
TheWebUserInterface serverrepository(EYUWREP)containstheWebUser Interface server’sviewandmenudefinitions.YoucanusetheIDCAMSutilityto createaVSAM fileforthesedefinitionsasfollows:
Each WebUserInterfaceservermust haveitsown WebUserInterfaceserver repositorythatcannotbesharedwithanyotherWebUserInterfaceserver. You cancopytheWebUserInterfaceserverrepositoryfromoneWebUser Interface serverto anotherusingIDCAMS, DFSMSdss™orequivalentutility. For example,youmay wishto copytheWebUserInterface serverrepositoryfromyour test systemtoyour productionsystem.
DEFINE CLUSTER ( NAME( dsname ) VOLUMES( dsvol ) RECORDS( 5000 5000 ) RECORDSIZE( 8192 32000 ) CONTROLINTERVALSIZE( 8192 ) SPANNED INDEXED KEYS( 20 20 ) SHAREOPTIONS( 2 ) )
You shouldmigratedefinitionsusingtheimportandexportfunctions.For information, seeChapter5, “Administration,”onpage59.
It isrecommendthatyou backuptheWebUserInterfaceserverrepositorydataas therepositoryisupdatedwheneverchangesaremadeusingtheViewEditoror whendefinitions areimportedusingtheCOVCtransaction.Youcan backupthe WebUserInterface repositorybyusingIDCAMS,DFSMSdssorequivalentutility. SampleJCLto createtheWebUserInterfacerepositoryisprovided,called EYUJWREP, inSEYUINST.
Specify
the
customizable
view
and
menu
help
data
set
TheWebUserInterfaceallowsasite toprovidecustomizedhelpfor individual views andmenus.ThishelptakestheformofHTMLdocumentsthatcanbeserved bytheWebUserInterfaceserverorbyanexternalserver.IftheWebUser
Interface isto servetheHTMLdocuments, youmustprovidea partitioneddataset to containtheHTMLdocuments.
You canusetheViewEditortocustomize yourviewsandmenusto includealink to thecustomizable viewandmenu helpdataset.TheViewEditorgivesyouthe optionof specifying:
v Nohelpto beavailablefor thisviewormenu
v Membernameof ahelppageto beservedbytheWebUserInterfacefrom
DFHHTML
v URLof anexternal helppageto beservedbyanotherHTTPserver
For informationabouttheViewEditor, seeChapter6, “CustomizingtheWebUser Interface,” onpage 77.
TheWebUserInterfaceserverusestheCICSWebInterfacetemplatemanagerto servethecustomizedviewandmenu help.For moreinformation,seetheCICS InternetGuide.
Note: Thecustomizableviewandmenuhelp dataset(DFHHTML)must bea
singledatasetandshouldnotbeconcatenatedwithanyotherdataset.
Specify
the
Web
User
Interface
server
initialization
parameters
You canspecifytheWebUserInterfaceserverinitializationparametersinthe start-upjoborinafixedblock80data set.See“SpecifytheJCLDDstatements”on page 33for theDDname.Alloftheseparametersaresubjectto thefollowing conditions unlessotherwisestated:
v Lineswithanasteriskincolumn1 arecommentsandareignored.
v
Valuesmustnotcontainlowercasecharacters.
v Valuesmustbespecifiedinparenthesis immediatelyfollowing theparameter.
v Valuesmustnotbegreater than32characters.
For example:
* An EYUWUI parameter data set DEFAULTMENU(OURHOME)
TCPIPHOSTNAME(MVSXX.COMPANY.COM) TCPIPPORT(4445)
AdescriptionoftheWebUserInterface serverinitializationparametersfollowswith defaultvalues fortheparametersunderlined.
Required
parameters
TheWebUserInterface serverhassomerequiredinitializationparameters.Ifyou donotspecifya requiredparametertheWebUserInterfaceserverinitialization fails.TheWebUserInterfaceserverinitializationalsofailsifany ofthespecified parametersareinvalid.
TherequiredWebUserInterfaceserverinitializationparametersare:
TCPIPHOSTNAME(name)
SpecifytheTCP/IPhostname ofthisWebUserInterface server.This is normallythehostnameanddomainname oftheMVS system(thatis,a fully-qualified name).Thishost nameisnormallyused bytheWebUser Interface toconstructURLs,dependingontheclient’sHTTPversionandthe valueof theTCPIPHTTPHOSTWebUserInterfaceserverparameter. This valueisalwaysreturnedintheTCPIPHOSTNAMEheaderof a DATA/CONNECTWebUserInterfaceDataInterfacerequest.
TheWebUserInterfacedoes notsupportnameslongerthan32characters.If required,you mayusetheaddressoftheserverusingthedotteddecimal notation. Forexample,’127.0.0.1’.
TCPIPPORT(value)
SpecifytheTCP/IPportnumberof theportthatyou haveallocatedfortheWeb UserInterfaceto runon.
Thevaluespecifiedinthisparametermustcorrespondto theportnumbergiven ontheCWBCtransaction,ifyouareusingapre-CICSTransactionforOS/390 version 1.3CICSsystem.
Optional
Parameters
You mayalsowanttoconsiderthefollowingWebUserInterfaceserverinitialization parameters:
Additional
TCP/IP
parameters
You canspecifythefollowingTCP/IPparametersonlyif youareusingaCICS TransactionServerfor OS/390version 1.3or laterCICSsystem.
TCPIPADDRESS(name |INADDR_ANY)
SpecifythedotteddecimalIPaddressonwhichtheWebUserInterfacewill listenfor incomingrequests.Ifname isspecified,itmust beof theform
nnn.nnn.nnn.nnn wherennnis0 through255.If INADDR_ANYisspecified(the default),theWebUserInterface willlistenonanyoftheaddressesknownto theTCP/IPforOS/390host.
You donotnormallyneedtospecifytheTCPIPADDRESS optionunless the OS/390hosthas multipleTCP/IPaddresses.
TCPIPHTTPHOST(NO|YES)
Indicate whetheryourequiretheTCP/IPhostname usedto constructURLs to begeneratedbasedontheincomingHTTPrequestfor HTTPversion 1.1 requests orlater.
This optionhas noeffectonpreHTTP1.1requests senttotheWebUser Interface server.TheWebUserInterfaceserverwillalwaysconstructURLs usingthehostname specifiedintheTCPIPHOSTNAMEWebUserInterface serverparameterfor HTTP1.0(andearlier)requests.
# # # # # # # # # #