OpenSpan Server 5.2 Admin and User Guide

OpenSpanServer5.
2
AdministrationandUserGuide
April17,2012
ThismanualfocusesonuseofOpenSpanStudio5.2andOpenSpanRuntime
5.2inconjunctionwithOpenSpanServer5.2inaconnectedarchitecture.
Developersshouldseehelp.openspan.comforreferenceinformationon
creatingsolutionswithOpenSpanStudio.SelectHelpforOpenSpan5.2
UsersfromthedropdownlistboxlocatedwiththeContentsIndexSearch
menu.
Copyright2012OpenSpanInc.AllRightsReserved.
Nopartofthispublicationmaybereproducedordistributedinanyformorby
anymeans,electronicorotherwise,nowknownorhereafterdeveloped,
including,butnotlimitedto,theInternet,withoutexplicitpriorwrittenconsent
fromOpenSpanInc.Requestsforpermissiontoreproduceordistributeto
individualsnotemployedbyOpenSpananypartof,orallof,thispublication
shouldbemailedto:
OpenSpanInc.
Suite140
4501NorthPointParkway
Alpharetta,Georgia30022
Phone(International)+1(678)5275400
Phone(USandCanada)(877)7331136
Sales:+1(678)5275455
Phone,UnitedKingdom(EMEA):+44(0)2070433573
Email:sales@openspan.com
OpenSpanisaregisteredtrademarkofOpenSpanInc.,aGeorgiaCorporation.
Microsoft,VisualStudio,MSDN,andWindowsareeitherregistered
trademarksortrademarksofMicrosoftCorporationintheUnitedStatesand/or
othercountries.
PortionsofOpenSpansoftwareutilize:Automapper,Copyright(c)2010Jimmy
Bogard;LinqtoADz,CopyrightBartDeSmet(C)2007;Log4Net:Apachelog4net,
Copyright20042011TheApacheSoftwareFoundation;NHibernate;Silverlight
ToolKit;StructureMap;Copyright20042009JeremyD.Miller.Moreinformation
canbefoundintheTHIRDPARTYLICENSES.TXTfilesdeliveredwiththesoftware.
RevisedApril17,2012 OpenSpanServer5.2
ii AdministrationandUserGuide
CONTENTS
Chapter1 OpenSpanServer5.2Overview.................................................. 11
InthisChapter ................................................................................................................. 11
General ............................................................................................................................ 11
OpenSpanServer5.2Architecture ........................................................................................ 13
General ............................................................................................................................ 13
OpenSpanServer5.2EventsFeatures ............................................................................. 13
EventCollectionLogic............................................................................................................ 13
EventsFlow............................................................................................................................ 13
TwoDatabases:OS_ServerandOS_Events ........................................................................... 13
DeploymentExamples ..................................................................................................... 14
Basic....................................................................................................................................... 14
ScalingOptions ...................................................................................................................... 15
RunParallelEventServiceLogic ............................................................................................................15
AddEventProcessorServices ................................................................................................................16
AddOS_EventsDatabases.....................................................................................................................17
HybridCombinations.............................................................................................................................18
DeploymentandScalingSummary.................................................................................. 19
WhereDoIStart? ................................................................................................................ 110
Chapter2 OpenSpanServer5.2InstallationandStructure ......................... 21

InthisChapter ................................................................................................................. 21
Foundations ..................................................................................................................... 21
RecommendedSystemConfiguration ................................................................................... 22
ApplicationServerMinimum....................................................................................... 22
ApplicationServerRecommended .............................................................................. 22
DatabaseServerMinimum ......................................................................................... 23
DatabaseServerRecommended ................................................................................. 24
OpenSpanServer5.2InstallationConcepts .......................................................................... 25
EventMessageQueue ..................................................................................................... 25
OpenSpanServer ............................................................................................................. 26
EventCollectionService ................................................................................................... 27
EventProcessor................................................................................................................ 27
IISRollup .......................................................................................................................... 28
OpenSpanServerDiagnostics................................................................................................ 29
OpenSpanServer5.2 RevisedApril17,2012
AdministrationandUserGuide iii
Contents
Log4NetLogs ................................................................................................................... 29
.NETTracing..................................................................................................................... 29
OpenSpanServerConfigurationConsole ............................................................................ 210
ServerConfiguration...................................................................................................... 210
Logging .......................................................................................................................... 215
STSFederation ............................................................................................................... 217
SignontoOpenSpanServer................................................................................................ 218
SigningOn ..................................................................................................................... 218
Chapter3 OpenSpanStudio5.2Configuration........................................... 31
InthisChapter ................................................................................................................. 31
Note ................................................................................................................................. 31
ConfiguringOpenSpanStudioforOpenSpanServer ............................................................. 32
UserSteps ........................................................................................................................ 32
Certificates....................................................................................................................... 35
MatchingConfigurationandPromotionLevelstoRuntimePackagesforDebugging ........... 36
ProjectConfigurations..................................................................................................... 36
RunasGroup ................................................................................................................... 37
PromotionLevel............................................................................................................... 38
ProducingProcessAutomations............................................................................................ 39
General ............................................................................................................................ 39
ProcessAutomationCreation .......................................................................................... 39
NewProcess .......................................................................................................................... 39
MetadataCreation .............................................................................................................. 310
ProcessPublisher.................................................................................................................. 310
ExampleAutomation ........................................................................................................... 311
UploadtoServerandRuntimeDownload ..................................................................... 312
Chapter4 OpenSpanServer5.2AdministrationandManagement ............ 41

InthisChapter ................................................................................................................. 41
General ............................................................................................................................ 41
Dependencies .................................................................................................................. 42
MasterTipFindSearchableContent........................................................................... 42
SignontoOpenSpanServer.................................................................................................. 44
SigningOn ....................................................................................................................... 44
iv AdministrationandUserGuide
Contents
WelcomeScreen .............................................................................................................. 45
GroupsandUsers .................................................................................................................. 46
SomeFactsaboutGroupsunderOpenSpanServer ......................................................... 46
AboutUsers ..................................................................................................................... 46
AddingUsers.................................................................................................................... 47
ManuallyAddNewUser ........................................................................................................ 47
ImportActiveDirectoryUsers ............................................................................................. 410
ResetPassword.............................................................................................................. 412
Delete,Deactivate,andReactivateUsers ...................................................................... 413
AddingGroups ............................................................................................................... 414
CreateNewManuallyAddNewGroup ........................................................................... 415
CreateNewImportActiveDirectoryGroup.................................................................... 416
Delete,Deactivate,andReactivateGroups ................................................................... 416
AssigningUserstoGroups ............................................................................................. 417
ManagingDeploymentPackages......................................................................................... 420
Tip:UsetheSearchbox .......................................................................................................................420
Adding,Editing,DeletingFeatures ................................................................................ 421
General ................................................................................................................................ 421
AddingPopupHelp............................................................................................................. 424
Tip:ViewScreenshot ...........................................................................................................................425
AddingDefaultValues ......................................................................................................... 427
BoxesandButtons...............................................................................................................................427
TextControls .......................................................................................................................................427
AssigningFeatureSetstoGroups .................................................................................. 429
General ................................................................................................................................ 429
Steps .................................................................................................................................... 429
AssigningConfigurationstoGroups .............................................................................. 431
AssigningFeatureSetLevels.......................................................................................... 433
NotesonFeatureSetPromotion ......................................................................................... 433
AssigningGroupstoPackages ....................................................................................... 434
ManagingProcesses ............................................................................................................ 436
CreatingaNewProcess ................................................................................................. 436
Editing,DeletingaProcess ............................................................................................ 438
ManagingGroupRuntimeSettings ..................................................................................... 439
General .......................................................................................................................... 439
CreateGroupRuntimeSettings ..................................................................................... 439
EditandDeleteGroupRuntimeSettings ....................................................................... 442
Edit....................................................................................................................................... 442
AdministrationandUserGuide v
Contents
Delete .................................................................................................................................. 443

SiteSettings ......................................................................................................................... 444
General .......................................................................................................................... 444
UserSteps ...................................................................................................................... 444
Chapter5 OpenSpanRuntime5.2Configuration ....................................... 51

InthisChapter ................................................................................................................. 51
General ............................................................................................................................ 51
OpenSpanRuntimeandOpenSpanServer............................................................................ 52
Certificates....................................................................................................................... 52
RuntimeConfig.xml .......................................................................................................... 52
ConnectingOpenSpanRuntimewithOpenSpanServer................................................... 53
UserSteps.............................................................................................................................. 53
RuntimeMenu ................................................................................................................. 54
MenuItemsandDefinitions .................................................................................................. 55
About .................................................................................................................................................... 55
DiagnosticsConfiguration .................................................................................................................... 55
TestConnection .................................................................................................................................... 55
OpenSpanServerConfiguration ........................................................................................................... 55
Default|(Package) .............................................................................................................................. 56
Exit........................................................................................................................................................ 56
Events ................................................................................................................................................... 56
ProcessToolbar................................................................................................................ 57
ServersideSettings ............................................................................................................... 58
Chapter6 OpenSpanServer5.2ReportsandGraphs ................................. 61

InthisChapter ................................................................................................................. 61
General ............................................................................................................................ 61
ReportDisplayTypes ............................................................................................................. 63
HeatMaps ....................................................................................................................... 63
HeatMapVisualRelationships .............................................................................................. 64
Histograms ...................................................................................................................... 65
AccessingReportsandGraphs .............................................................................................. 66
Selection .......................................................................................................................... 66
ReportControlsandOptions ........................................................................................... 67
SingleReports........................................................................................................................ 68
ApplicationActivityReports ............................................................................................ 68
vi AdministrationandUserGuide
Contents
ReportCriteria ....................................................................................................................... 68
TochooseGroupsorUsers.................................................................................................... 68
ApplicationActivityReportHeatMapsandHistograms ..................................................... 610
ApplicationUserPerformanceReports.......................................................................... 612
ProcessActivityReports................................................................................................. 613
ProcessActivityReportHeatMaps ..................................................................................... 613
ProcessUserPerformanceReports ................................................................................ 615
ComparativeReports........................................................................................................... 616
ComparativeApplicationActivityReport....................................................................... 616
ComparativeApplicationUserPerformanceReport ...................................................... 616
ComparativeProcessActivityReport............................................................................. 616
ComparativeProcessUserPerformanceReport ............................................................ 617
AdministrationandUserGuide vii
Contents
viii AdministrationandUserGuide
Chapter 1 OPENSPAN SERVER 5.2
OVERVIEW
InthisChapter
WelcometotheOverviewchapteroftheOpenSpanServer5.2AdministrationandUserGuide.Thischapter:
DescribestherelationshipbetweenOpenSpanStudio5.2,OpenSpanServer5.2,andOpenSpanRuntime5.2.
ShowshowOpenSpanServer5.2canbedeployedandscaledtoprovideenterprisewideefficiencyin
administeringdesktopruntimepackagesandprocessingEventsinformationcomingtotheserverfromuser
desktops.
Definesbroadcategoriesofpeoplewhousethethreeproducts,andprovidesaguidedsetofreferencestohelp
findthepartsofthismanualthatwillbeofthemostinitialuse.Youmaywanttoreadthroughallofthematerial,
becauselikemanyenterprisesoftwaresuites,itsusefultounderstandhowfeaturesandfunctionsrelatetoeach
other.
General
TherearethreemainapplicationcomponentsinafullOpenSpan5.2architecture:OpenSpanStudio,OpenSpan
Server,andOpenSpanRuntime.
OpenSpanStudioisthedevelopmentenvironment,basedonMicrosoftVisualStudio,fordeveloping,testing,
andconfiguringOpenSpansolutionsintheformofRuntimedesktoppackages.Thesepackagescanbedeployed
directlytouserdesktopsalongwithmanifeststhekeepversionscurrent.WhenusedwithOpenSpanServer5.2,
OpenSpanStudiocanuploadtheseruntimesolutionpackagesdirectlytoOpenSpanServerformodificationand
downloadtotheuserdesktop.Additionally,OpenSpanStudioisusedtoenableruntimesolutionstocollectand
transmitcertaintypesofeventsinformationonspecificprocessesasdeterminedbybusinessrequirementand
dataparameters.
Note:AwideassortmentofcoreandelectivetrainingisavailableforOpenSpanStudio.Classesareboth
instructorledandnonresident,andafulllibraryoflessons,solutions,andsupportmaterialsisavailable.Contact
OpenSpanSupportformoreinformation.
OpenSpanpublishesversionspecificonlinehelpforOpenSpanStudioviatheInternet.Itisavailablefrom
help.openspan.com.
OpenSpanServeristhemiddlelinkbetweenOpenSpanStudio,wheresolutionsaredeveloped,andOpenSpan
Runtime,whichexecutespackagesontheuserdesktop.OpenSpanServerreceivesruntimesolutionpackages
directlyfromOpenSpanStudio,andcanfurthermodifythemcodelesslytoassigndefaultvaluesandtooltipsto
theinterrogatedapplicationcontrolsinthesolutions.OpenSpanServerperformspackagemanagementto
deliverbothpackagesandmodificationfeaturesetstoeachdesktopbasedontheusersloginandadministrative
groupassignment.OpenSpanServeralsoinstallsservicesandqueuesthatcollectapplicationandprocessevents
fromuserdesktops,writesthemtotheOS_Eventsdatabase,andhasareportpackagefordisplayingbasic
visualizationofthedata.TheEventsarchitectureisscalableandcanbedeployedindifferentconfigurations.
Severaldiagramsfollowinthischapterthatillustratesomecommonsolutions.
OpenSpanRuntimeisasmall,licensedapplicationthatrunsontheendusersworkstation.Itexecutes
OpenSpansolutionruntimepackages.TheruntimepackagescancomefromOpenSpanServeroranyother
AdministrationandUserGuide 11
OpenSpan Server 5.2 Overview |
deploymentmethod.UsingOpenSpanRuntimeinconjunctionwithOpenSpanServerhasanumberof
advantages.
First,OpenSpanServersendsaruntimesolutionpackagetoeachdesktopbasedontheuserslogin
credentials.Differentuserscanaccessthesameworkstationatdifferenttimesbutreceivedifferentsolution
packagesbasedonjobtasks,role,orsimilarcriteria.
Second,OpenSpanRuntimecommunicatesbacktoOpenSpanserverwithconfigurableeventsdata,reporting
onapplicationandprocessmetricsfromtheuserdesktop.Theeventsdataisusefultodeterminetimespent
inapplications,errors,applicationchurn,andprocessadherence,tonameafew.OpenSpanRuntimecanbe
enabledtosendhighleveleventsdataevenifnosolutionpackageisdownloaded,andcanrunsilentlyasa
backgroundprocesssoastonotinterferewithuserperformance.
Additionally,eachinstanceofOpenSpanRuntimecandisplay(ifenabled)amodalProcessToolbarthat
desktopuserscanusetoselectparticularpredefinedprocesses,collecteventsdata,andsendthatdatato
OpenSpanServertohelpmeasurebusinessprocessefficiency.
12 AdministrationandUserGuide
OpenSpan Server 5.2 Overview | OpenSpan Server 5.2 Architecture
OpenSpanServer5.2Architecture
General
InOpenSpanServer5.1,eventcollectionlogicwasconsolidatedwiththeSite,UserManagement,andSTS
(authentication)services.However,forrelease5.2,Eventcollectionisaseparatelogicpiece,becauseitiswhere
OpenSpanServerusuallyincursthehighestbandwidth.SplittingtheOpenSpanServer5.2Eventsarchitectureinto
componentsmeansthattherearenowanumberofalternativesforscalingandloadbalancing.
OpenSpanServer5.2EventsFeatures
InOpenSpanServer5.2,theEventCollectionservicehasbeenseparatedfromtheOSSservice,whichinpast
releasescontrolledeventinputandtransfertothedatabasetables.TheSite,OSS,UserManagement,andSTSlogic
staytogetherandcontroltheapplicationserver,buttheeventcollectionandprocessingcanbedeployed
independently.
EventCollectionLogic
TheOpenSpanServer5.2eventcollectionlogicconsistsof:
AnEventCollectionWebservice
AneventsqueuerunningunderMSMQ
AWindowsservicecalledtheEventProcessor
EventsFlow
1. TheOpenSpanruntimeclientsendsaneventtotheEventCollectionWebservice.
2. TheEventCollectionservicedoesnoprocessingormetadatavalidation.Itsimplyputstheeventinaqueueand
returnssuccessorfailure.
3. TheEventProcessor,aWindowsservice,hasthemissionofreadingEventsoffthequeue,validatingthemeta
data(matchingthedimensionsofincomingEventswithdimensionsdefinedinthedatabase),andwritesthe
eventtotheEventstablesintheOS_Eventsdatabase.
TwoDatabases:OS_ServerandOS_Events
Additionally,theOS_ServerandOS_Eventsdatabaseshavebeenseparated.Toeliminateread/writecollisionswithin
asingleserverdatabase,inrelease5.2theraweventtablesarenowwrittentotheirowndatabase.Atspecified
intervals,eventsarereplicatedfromtheOS_EventsdatabasetotheOS_Serverdatabase,wheretheyare
aggregated.Thismeansthatthetwodatabasescanbeputonseparatemachines,eliminatingcontentionbetween
eventsprocessingandapplicationoverhead.
DeploymentExamples
Basic
TheillustrationbelowshowsanexampleofanOpenSpan5.2server.Thisarchitecturenormallysupportsaround50
runtimeusersorless.Theeventsprocessingservicesandmessagequeue(s)aredeployedonthesamemachine.This
isthemostfundamentalinstallationvariant.Inthisdiagram:
Clientapplications,OpenSpanStudio,andRuntimepackagesonuserdesktopsinteractwiththeApplicationand
UserManagementservicessupportedbytheOS_Serverdatabase.
RuntimepackagessendeventsdatafromuserdesktopstotheEventsCollectionservice,whichputstheeventsin
themessagequeue.TheEventProcessorpickstheEventsupfromthemessagequeueandsendsthemtothe
OS_Eventsdatabase.
OS_SERVER
User
Site STS
Management Application Tables,
Browser Agg Tables,
Raw Events
App & User
OSS
Mgmt
Events Replicate Event Table

Processing
Event
OpenSpan Event
Collection
Processor
Studio Service
Event Queue
OS_EVENTS
Raw Event Tables
OpenSpan
Runtime
FIGURE 1. OpenSpanServer5.2BasicArchitecture
ScalingOptions
OpenSpanServer5.2allowsyoutoincreaseeventprocessingcapacityindifferentways:
RunParallelEventServiceLogic
AddEventProcessorServices
AddOS_EventsDatabases
Deployhybridsoftheseelements
RunParallelEventServiceLogic
Asimplewaytoincreaseeventsthroughputistoinstallmultiplesoftheeventprocessinglogicchain.
AloadbalancercanbedeployedasatrafficcoptooptimizeflowtotheEventCollectionservices.
TheEventProcessorservicescanbeconfiguredtowritetoasingle(shownhere)orseparateOS_Events
databases.
User
Site STS
Management
OS_SERVER
Browser
Application Tables,
OSS Agg Tables,
Raw Events
OpenSpan Event
Event
Studio Collection
Processor
Service
Event Queue
OS_EVENTS
Event
OpenSpan Event
Collection
Processor
Runtime Service
Load Balancer
Event Queue
OpenSpan
Runtime
FIGURE 2. AddEventServicesChains
AddEventProcessorServices
TypicallytheEventProcessorWindowsserviceincursaheavierprocessingloadthantheEventCollectionWeb
serviceandqueue.DeployingEventProcessorsinahigherratiotothenumberofEventCollectionservicesisan
optiontodistributetheworkofvalidatingmetadataandmovingeventstotheOS_Eventsdatabase.
DeployoneEventProcessorforapproximately2000runtimeinstances.
ConsiderhostingtheEventProcessorsonaserverwithmultipleprocessorcores;morethreadswillbeavailable
andmaketheeventsflowevenmoreefficient.
User
Site STS
Management
OS_SERVER
Browser
Application Tables,
OSS Agg Tables,
Raw Events
OpenSpan Event
Processor
Studio
Event Event
Collection Processor OS_EVENTS
Service
OpenSpan Event Queue

Runtime Event
Processor
OpenSpan
Runtime
FIGURE 3. AddEventProcessorWindowsServices
AddOS_EventsDatabases
ThisdiagramisthesameasFigure 3,AddEventProcessorWindowsServices,onpage 16exceptthatitshows

anotheroption:additionalOS_Eventsdatabaseinstances.Thesearecommonlylocatedonseparatemachines.In
somesituations,suchaswidelydispersedgeography(anincreasingconsiderationforglobalenterprises),dedicated
databasesforeachenterpriselocationarehighlyrecommended.OtherrequirementsdrivingmultipleOS_Events
databasesincludesegmentationwithinorganizations,security,etc.
Note:BestpracticesshowthatitsimportanttophysicallylocatetheEventProcessorsclosetotheirassociated
databasessothatnetworklatencyorotherinfrastructurefactorsdontcreateissueswiththroughput.
User
Site STS
Management
OS_SERVER
Browser
Application Tables,
OSS Agg Tables,
Raw Events
OpenSpan Event
Processor
Studio
OS_EVENTS
Event Event
Collection Processor
Service
OpenSpan Event Queue

OS_EVENTS
Runtime Event
Processor
OS_EVENTS
OpenSpan
Runtime
FIGURE 4. AddEventDatabases
HybridCombinations
Thisfinaldiagramshowsahypotheticalcombinationofallthesolutionsofferedpreviously.UseofInternet
InformationServices(IIS)andWindowsCommunicationFoundation(WCF)basedcomponentsmeansthatscaling
canbedoneconsistentlyandreliably.
User OS_SERVER
Browser Site STS
Management
Application Tables,
Agg Tables,
Raw Events
OpenSpan Event
Event
Collection
Studio Service
Processor
Event Queue
OS_EVENTS
Event
Event
Collection
Processor
Service
OpenSpan
Runtime Event Queue
Load Balancer OS_EVENTS
Event
Processor
OS_EVENTS
Event
OpenSpan Collection Event
Runtime Service Processor
Event Queue
OS_EVENTS
Event
Processor
FIGURE 5. CombinedSolution
DeploymentandScalingSummary
AlargeorganizationmayhaveOpenSpanRuntimesolutionsdeployedonthousandsofdesktops,activeatthesame
time,sendingasteadystreamofeventsdata.ThecomponentsofOpenSpanServer5.2allowanumberofwaysto
flexiblyaccommodatedifferentvolumesoftraffic,including:
RunningparallelEventCollectionservices,messagequeues,andEventProcessors,withloadbalancersmanaging
inputtotheEventCollectionservices.
AddingEventProcessorservicesinstancestovalidateeventmetadataandwritemultiplestreamstothe
OS_Eventsdatabase.
AddingmultipleOS_Eventsdatabaseinstances.
Combiningthesetacticsintoacohesiveoptimizationstrategydependentontheneedsoftheenterprise.
OpenSpanProfessionalServicesengineersareexperiencedinassessingcustomerinfrastructureandbusiness
needsandmakingrecommendationsforoptimaleventsprocessing.
OpenSpan Server 5.2 Overview | Where Do I Start?
WhereDoIStart?
Herearesomerecommendedpathsthroughthemanual,basedoncommoncategoriesofOpenSpanusers.When
readingalong,itsusefultohaveaccesstothereferencedproducts:OpenSpanStudio,Server,orRuntime.Having
accesstoanenvironmentwithtestdataorothersandboxarrangementswillalsoreinforceormakeclearwaysto
takethebasicfactsandinstructionsinthismanualandtheOpenSpanonlinehelpandfitthemtoyourorganizations
needsandtasks.
TABLE 1. FindingInformationBasedonYourRole
Ifyouare... Thencheckout... Andpayparticularattentionto...

AnAdministratorinstallingand OpenSpanServer5.2Installation Allparts
configuringOpenSpanServer andStructureon 21
SiteSettingson 444
ASoftwareDeveloperof ConfiguringOpenSpanStudiofor
solutionsusingOpenSpanStudio OpenSpanServeron 32
MatchingConfigurationand
PromotionLevelstoRuntime
PackagesforDebuggingon 36
ProducingProcessAutomations
on 39
OpenSpanRuntime5.2 RuntimeConfig.xmlon 52
Configurationon 51
ABusinessAnalystmanaging GroupsandUserson 46 AddingGroupson 414

processimprovements AddingUserson 47
ManagingDeploymentPackages Adding,Editing,DeletingFeatureson 4
on 420 21
AssigningFeatureSetstoGroupson 429
AssigningConfigurationstoGroupson 4
31
AssigningFeatureSetLevelson 433
AssigningConfigurationstoGroupson 4
31
AssigningGroupstoPackageson 434
on 39
ManagingGroupRuntime
Settingson 439
OpenSpanRuntime5.2 Allparts
Configurationon 51
Chapter6,OpenSpanServer5.2 Allparts
ReportsandGraphs
TABLE 1. FindingInformationBasedonYourRole(Continued)
Ifyouare... Thencheckout... Andpayparticularattentionto...
ARuntimeuserofdesktop RuntimeMenuon 54;Process

OpenSpandeploymentpackages Toolbaron 57.
INSTALLATION AND STRUCTURE
InthisChapter
WelcometotheInstallationandConfigurationChapteroftheOpenSpanServer5.2AdministrationandUserGuide.
Afterreading,youwillbefamiliarwiththesetopics:
RecommendedSystemConfigurationonpage 22
OpenSpanServer5.2InstallationConceptsonpage 25
EventMessageQueueonpage 25
OpenSpanServeronpage 26
EventCollectionServiceonpage 27
EventProcessoronpage 27
IISRolluponpage 28
OpenSpanServerDiagnosticsonpage 29
OpenSpanServerConfigurationConsoleonpage 210
ServerConfigurationonpage 210
Loggingonpage 215
STSFederationonpage 217
SigningOnonpage 218
Foundations
EachenterprisethatimplementsOpenSpanprojects,includingOpenSpanServer,hasadifferentsetofrequirements
andhostinfrastructure.SuccessfuloutcomeshaveshownthatitisessentialthatspecialistsfromOpenSpans
ServicesorganizationpartnerwithcustomerITstaffstonegotiatethemyriadofserverrequirements,configuration
options,andspecialrequirementssuchassecurity.
OpenSpan Server 5.2 Installation and Structure | Recommended System Configuration
RecommendedSystemConfiguration
OpenSpanServerisdeployedwithanApplicationServercomponentaswellasaDatabaseServercomponent.
Notes:
GBcapacitynetworkbetweenapplicationserversanddatabaseserversisrecommended.
WerecommenddeployingaLoadBalancerinfrontoftheApplicationServersanddeployinganApplication
Serverforevery1000users,withaminimumof2ApplicationServers.
ApplicationServerMinimum
TABLE 1. MinimumApplicationServerRequirements
Component Details
OperatingSystem WindowsServer2008
Microsoft.NETFramework3.5SP1
MicrosoftWindowsInstallerversion3.0orlater
MSMQfeatureinstalled
Processor 1Quadcore3+GHzCPU
RAM 6GBRAMorhigher
Storage 2LUNs(SCSIorSSD)
OperatingSystem
MSMQ100GBSSD
Networking GBNICwithTOE(TCP/IPOffloadEngine)
ApplicationServerRecommended
TABLE 2. RecommendedApplicationServerRequirements(1of2)
Component Details
OperatingSystem WindowsServer2008R2
MSMQfeatureinstalled
Processor 2Quadcore3+GHzCPUs
RAM 16GBRAMorhigher
TABLE 2. RecommendedApplicationServerRequirements(2of2)
Component Details
Storage 2LUNs(SCSIorSSD)
OperatingSystem
MSMQ100GBSSD
DatabaseServerMinimum
TABLE 3. MinimumDatabaseServerRequirements
Component Details
OperatingSystem WindowsServer2008
MicrosoftSQLServer2008EnterpriseEditionorhigher
RAM 16GBRAMorhigher
Storage Databasesizevariesbasedonnumberofusers,eventsmonitoredand
retentionperiod.
4LUNs(SCSIorSSD)
OperatingSystem
OpenSpanServerDatabase1TB(ifonSAN,thisshouldbezoned)
SQLTransactionLogFiles256GBSSD
SQLBackup
Miscellaneous NoscheduledjobsduringnormalbusinesshoursotherthanOpenSpan
specified
VirusprotectionOnAccessscansdisabledforMDF,LDFandNDFfiles
DatabaseServerRecommended
TABLE 4. RecommendedDatabaseServerRequirements
Component Details
OperatingSystem WindowsServer2008R2
MicrosoftSQLServer2008EnterpriseEditionorhigher
RAM 32GBRAMorhigher
Storage Databasesizevariesbasedonnumberofusers,eventsmonitoredand
retentionperiod.
6LUNs(SCSIorSSD)
OperatingSystem
OpenSpanServerDatabase1TB(ifonSANthisshouldbezoned)
SQLTransactionLogFiles256GBSSD
SQLBackup
TempDB100GBSSD
TempDBTransactionLogFiles25GBSSD
Miscellaneous NoscheduledjobsduringnormalbusinesshoursotherthanOpenSpan
specified
VirusprotectionOnAccessscansdisabledforMDF,LDFandNDFfiles
OpenSpan Server 5.2 Installation and Structure | OpenSpan Server 5.2 Installation Concepts
OpenSpanServer5.2InstallationConcepts
OpenSpanServer5.2runsunderMicrosoftInternetInformationServices(IIS).KnowledgeofIISiskeyfor
understandingofhowOpenSpanServer5.2functions.
Ingeneral,theOpenSpanServer5.2installationprocessautomaticallyconfiguresIISforproperoperation,andthen
createsnecessarydirectoriesandsupportfiles.
Thefollowingitemsareconfiguredorinstalledinthefollowingsequence.Configurationwillvaryaccordingto
requirements.OpenSpanServicesrepresentativeswillexecutetheconfigurationandenablement.
1. EventMessageQueue(below).CreateinMSMQ.
2. OpenSpanServer(includesdatabasecreationscripts)(page 26).Getandruntheinstaller.
3. EventCollectionService(page 27).Getandruntheinstaller.
4. EventProcessor(page 27).Getandruntheinstaller.
EventMessageQueue
ThehostservermustbeconfiguredforMicrosoftMessageQueuing(MSMQ).Thencreateaprivatequeue,called
eventqueue.Ensurethattheproperpermissionsareset,asneeded,foraccessby:
System
NetworkService
IIS_IUSRS
Othersasrequired
Note:TheEventPluginQueue,osstatechange,iscreatedbytheEventCollectionservice(page 27)installer.
OpenSpanServer
OpenSpanServerusesasingleinstallerforsinglesitedeploymentofappserverfunctions.Thedefaultinstallation
directoryis:
C:\Program Files\OpenSpan\OpenSpan Server
NoteDatabaseCreation:AfterinstallationofOpenSpanServer5.2,runtheappropriateinstallationscripts.The
scriptsneededforOS_EventsorOS_Serverdatabasecreationorupgradesareinstalledin:
C:\Program Files\OpenSpan\OpenSpan Server\Database\Scripts\MSSQL\
ThisillustrationshowsatypicalsetofOpenSpanServer5.2directoriesandtheircontents.
Basedonrequirements,somedirectoriesmaybedeployedelsewhere,inwhichcaseitsnecessarytousethe
configurationconsoletoreferencethem.Formoreinformation,seeOpenSpanServerConfigurationConsoleon
page 210.Thechiefdirectoriesare:
OpenSpanServerRootdirectory;configurationconsole,RuntimeConfig.xml,relatedDLLs
DatabaseContainsrequiredscriptsforreportgenerationandadministrativefunctions
SitesThedefaultinstallstheMainsite,containingbusinesslogicandpresentationlayersupport,aswellasSTS
metadata
ServicesRequiredservicesfortheserveritself,STS,WindowsAuthenticationSTS,andUserManagement
SSLCertificatesProvidedasrequiredforinstallationonthehostserverlatertoensureSSLconnections
EventCollectionService
TheEventsCollectionWebservicerunsunderIIS.TheservicereceivesraweventdataandputsitintheEvents
messagequeue.ItcreatesitsownapplicationpoolcalledOpenSpanEventCollectionAppPool.
EventProcessor
TheEventProcessorWindowsservicerouteseventsfromthemessagequeuetotheraweventstablesinthe
OS_Eventsdatabase.
IISRollup
Whenfullyinstalled,thehostserversIISdirectorylookssimilartotheonebelow.NotethattheEventCollection
Webservice(andtheEventProcessingWindowsservice)canbelocatedonothermachinestodistributeEventsdata
toseparateOS_Eventsdatabases.
OpenSpan Server 5.2 Installation and Structure | OpenSpan Server Diagnostics
OpenSpanServerDiagnostics
TheOpenSpanServerprovidestwobasicmeansofobtainingdiagnosticinformation:
Log4NetLogs
TheLog4NetlogsarealoggingfacilitybuiltintotheOSScodesimilartohowthemainOpenSpandiagnosticswork,
wherebothexceptionsandkeyoperationalactivitiesareloggedtoafile.EachofthefourOSSsites(main,services/
oss,services/sts,services/usermanagement)providethistypeoflogging.Theloggingcanbecontrolledbyediting
theweb.configfileforagivensiteandmodifyingtheinformationinthe<log4net>sectionofthedocument.The
factoryshippedconfigurationforeachsiteisthattheloggingwillbedonetoalocalfoldertothesitecalled
"OpenSpanServerLogs\somefilename.txt"andwilluseanappendingschemewherethefileisappendedtountilit
reaches10MBinsize.Afterthatoccursthefilewillberenamedtoincludeasequencenumberontheendofthelog
filename.Amaximumof10filesismaintained,afterwhichthe11thfilewillbedeletedtoconservediskspace.
Thesetypesoflogsareingeneralveryusefulforexceptiontracing.
.NETTracing
Theothertypeofdiagnosticinformationcanbeobtainedviatheuserofthebuiltin.NETdiagnostictracing..NET
providestheabilitytouseconfigurationbaseddiagnosticsthroughthedefinitionoflistenersandsourcesinthe
<system.diagnostics>sectionoftheweb.configfiles.Thefactoryconfiguredweb.configsfortheOSSsiteshavethese
diagnosticspresentlyenabledhoweverthiswilllikelyberevisedtobedisabledasbuiltin.NETdiagnosticsdonot
providetheabilitytodologtruncationorrollinglogswithoutimplementingyourownloggerassembly/class,which
isnotpresentlyimplemented.Therearetwotypesofinformationlogged:
WindowsIdentityFoundationactivity(WIF)forsecuritytracing.Thisisonlyenabledfortheservices/STSsite.The
sourceforthisinformationisMicrosoft.IdentityModel.
WCFactivityforservicecalldiagnostics.Thisisenabledonallsites.Thesourceforthisinformationis
System.ServiceModel.
Todisablediagnosticlogging,the<system.diagnostics>sectionofweb.configcanbecommentedbyenclosingthe
<system.diagnostics>...</system.diagnostics>sectioninXMLcomments.
OpenSpan Server 5.2 Installation and Structure | OpenSpan Server Configuration Console
OpenSpanServerConfigurationConsole
TheOpenSpanServerConfigurationConsoleisusedtoenterinitialsettingsandestablishcommunicationswiththe
database.
Note:OpentheConfigurationConsoleastheAdministrator.
Caution:OncesettingsareenteredandverifiedintheServerConfigurationConsole,changingthemwillchange
baseconfigurationfilesformanyinterrelatedserverproperties.Theeffectscouldbeadverse.
ServerConfiguration
1. OpentheOpenSpanServerConfigurationConsoletocompletetheconfigurationoftheOpenSpanServerafter
installation.
2. NavigatetotheDirectoriesnodeandverifythedirectorystructure.Bydefaulttheseshouldbelocatedunderthe
OpenSpanServerinstallationfolderundertheSitessubdirectoryasfollows:
MainSiteDirectory:Sites\Main
STSSiteDirectory:Sites\Services\STS
WindowsAuthenticationSTSDirectory:Sites\Services\WASTS
OSSServicesSiteDirectory:Sites\Services\Oss
UserManagementServicesSiteDirectory:Sites\Services\UserManagement
3. NavigatetotheSiteURLsnodeandverifythattheURLsforeachwebsitearecorrect.
Note:Thedefaultsettingsenabledforhttpsorunencryptedhttpareshownhere.
BaseServerURL:TheURLtothephysicalserveronwhichtheOSSisinstalled,typicallyastringlikehttps://
hostname.
WebServicesURL:TheURLtotheOSSservicesbaseaddress,typicallyastringlikehttps://hostname/Services.
MainSiteURL:TheURLtothemainOSSwebsite,typicallyastringlikehttps://hostname/OpenSpanServer/.
STSURL:TheURLtothesecuritytokenservicewebsite,typicallyastringlikehttp://localhost/ServicesSTS/.
WASTSURL:TheURLtotheWindowsAuthenticationSTSsite,astringlikehttp://localhost/Services/STS.
4. NavigatetotheSTSnodeandselecttheappropriatecertificatesfortheSTS.
STSSignInCertificate:ThecertificateusedbytheSTSforsigninverification.
STSServiceFederationCertificate:ThecertificateusedforSSL/STSmachinebinding.
5. (EnsurefirstthattheproperdatabasesarecreatedorupdatedwiththescriptslocatedinC:\Program
Files\OpenSpan\OpenSpanServer\Database\Scripts\MSSQL.)NavigatetotheDatabaseConnectionnodeand
configuretheconnectiontotheRDBMSusedbytheOSSservices:
DatabaseTypedropdownNote:SupporteddatabasesforOpenSpanServer5.2arelimitedtoMSSQL.
ClickthebuttonadjacenttotheDatabaseConnectionfield.ThiswilldisplaytheDataLinkPropertiesdialogas
shownabovefortheappropriatedatabasetype.EntertheconnectivityinformationandclickOK.Checkthe
AllowSavingPasswordbuttonifstoringthelogincredentialsinthedatabaseconnectionstring.
Testtheconnectiontoensurethedatabasecanbecontactedsuccessfully.
Logging
NavigatetothevariousLoggingnodestoconfiguretheloggingfeaturesfortheindividualwebsiteseachpageis
identical,butoperatesontheloggingconfigurationfortheindicatedsitebythenodename.
TheEnabledcheckboxwillenableordisablefilebasedloggingforthewebsite.
TheLogLeveldropdownlistboxallowsforfilteringofloggingbasedupontheseverityoftheitemsbeinglogged.
Debugisthemostverbose,whereasFatalistheleastverbose.
Levelnamesareappendedtothelogreports,asshowsintheexampleshere.
InfoLogging
DebugLogging
STSFederation
1. NavigatetotheSTSFederationMetadatanodeandverifythefollowing:
NotethelocationoftheFederationMetadata.xmlfilefortheSTSintheLocationfieldabove,verifyingthatthe
folderlocationexists.Thisfilewillbewrittenwithrevisedfederationmetadatawhentheconfigurationissaved
viatheFile|Savemenu.
TheUpdateSTSFederationMetadatabuttonprovidestheabilitytoimmediatelygeneratethe
FederationMetadata.xmlfileinthelocationindicatedusingthesuppliedparameters.Notethattheparameters
areobtainedfromtheotherpagesinthisutility.
TokensecurityisconfigurableuponinstallationandafterwiththeassistanceofanOpenSpanconsultant.
2. SelectFile|Save.Thiswillsavetheconfigurationinformationintheweb.configfilesofthefourOSSwebsites,
updatetheSTSFederationMetadata.xmlfile,andthenexecutefederationbetweenthemainOSSwebsiteand
theSTS.Aprogresswindowisdisplayedshowingthestepsintheprocess.
3. ExittheOpenSpanServerConfigurationConsole.
OpenSpan Server 5.2 Installation and Structure | Sign-on to OpenSpan Server
SignontoOpenSpanServer
SigningOn
1. OpenaWebbrowserInternetExplorerisrecommended.NavigatetotheOpenSpanServerUniformResource
Locator(URL)specifiedbyyourOpenSpanServerinstallationteam.Thesignondialogboxappears.
2. Administratorstypicallyhaveanadministratorsetoflogoncredentials.
DefaultTenantAdministratorlogin:
Username:admin@openspanserver.com
Password:password(alllowercase)
3. Otherusershavedifferentlevelsofaccess,dependingonhowtheuseraccountissetup.SeeGroupsandUsers
onpage 46.
4. ClickSignIn.
5. Ifprompted,Changeyourpassword.Continue.TheWelcomeScreenDisplays.
Chapter 3 OPENSPAN STUDIO 5.2
CONFIGURATION
InthisChapter
ThischapteroftheOpenSpanServer5.2AdministrationandUserGuidedescribeshowOpenSpanStudio5.2is
configuredtoworkwithOpenSpanServer5.2toproduceanduploadOpenSpansolutionprojects.Thischapteris
organizedintothefollowingtopics:
ConfiguringOpenSpanStudioforOpenSpanServeronpage 32
MatchingConfigurationandPromotionLevelstoRuntimePackagesforDebuggingonpage 36
ProducingProcessAutomationsonpage 39
Note
OpenSpanStudio5.2isaprerequisiteforOpenSpanServer5.2.
OpenSpan Studio 5.2 Configuration | Configuring OpenSpan Studio for OpenSpan Server
ConfiguringOpenSpanStudioforOpenSpanServer
ThissectionexplainshowtoconfigureOpenSpanStudiotocommunicatewithOpenSpanServertoallowuploadof
OpenSpansolutionruntimepackages.
Notes
IfworkingremotelyanddisconnectedfromanetworkconnectiontoOpenSpanServer,i.e.inaVirtualMachine
orotherisolatedenvironment,youmaywishtodisableServerConnectivitywhenworkinginOpenSpanStudio.
ThisisbecausetheconfigurationautomaticallyseeksanetworkpathtoOpenSpanServerandcancausedelays,
timeouts,andsluggishbehaviorwhiletryingtoconnect.Reenablewhenanetworkconnectionisvalid.
ConnectionsbetweenOpenSpanStudioandOpenSpanServeraredomainsensitive.Ensureyouareconnected
toaninstanceofOpenSpanServerwithinthesamedomain.
UserSteps
1. FromOpenSpanStudio,accesstheconfigurationpanelthroughthemenuTools|Options.Thefollowingwindow
displays.SelectOpenSpan|OpenSpanServertoexpandtheconfigurationchoices.
2. Thefollowingfieldsareusedtospecifytheconnectivityinformationfortheserveraswellastheclientsecurity
credentials:
TABLE 1. OpenSpanServerOptions
Property Description
ServerAddress TheURLtothebaseservicessite.Autofillsotherrequiredserver
sideentriessuchasSTS.Enteradomainaddresssuchas
www.servername.comoranIPaddress.Defaultislocalhost;
enteringprotocolssuchashttp://orhttps://willgenerateanerror
message.ServerinformationiswrittentotheStudioConfig.xmlfile.
Additionsorchangesmaybenecessarytomatchparticularserver
configurations.OpenSpanconsultantscanprovidetheexact
settings.
UseWindowscredentials TheuserorworkstationsWindowsAuthenticationlogin.
Useaspecificusername OtherloginsmanuallyaddedviaOpenSpanServer.SeeManually
andpassword AddNewUseronpage 47.
OpenSpanServer5.2 April17,2012
3. FromtheOptions|OpenSpanServerpanel,chooseAdvancedConfiguration|General.Thefollowingdialog
boxdisplays.
TABLE 2. OpenSpanServerGeneralConfiguration
CloseTimeout Timeelapsedforaconnectionisdirectedtoclosebeforean
exceptionmessageisgenerated.
Expect100Continue DefaultstoFalse.Sets100Continuebehaviorforputandpost
commandssuchasauthenticationchallenges.
OpenTimeout Timeelapsedforaconnectionisdirectedtoopenbeforean
exceptionmessageisgenerated.
ReceiveTimeout Timeinsecondsanapplicationwaitsforarequesttocomplete.
SendTimeout Timeinsecondsanapplicationwaitsforaresponsetocomplete.
SSL True/False.EnableSecureSocketsLayer.Servermustbeconfigured
forSSLaswell(addresspreamble:https://).
BypassProxyonLocal DefaultisFalse.Ifaproxyisconfigured,allowsconnectionsto
bypassforlocaladdresses.
ProxyAddress UniformResourceIdentifieroftheproxy.
ProxyAuthenticationScheme DefaultisAnonymous.Thereisarangeofselectablevalues.Contact
yourserveradministratorforyourparameter.
UseDefaultWebProxy DefaultisFalse;setsuseoflocalautoconfiguredHTTPproxy.
4. FromtheOptions|OpenSpanServerpanel,chooseAdvancedConfiguration|EventServices.Thefollowing
dialogboxdisplays.
TABLE 3. OpenSpanServerEventServicesConfiguration
BatchMaximumDuration Theamountoftimeinsecondsthebatchprocessorwaitsbetween
batchesbeforesendingtotheserver.
BatchSize Numberofmessagesperbatch.Specialnote:ForHighLevelEvents,
batchingisoftenrequiredbecauseofthehighvolumesofevents
recordsgenerated.Itquiteoftenhappens,however,thatwhen
batchingisinvokedit'sforgottentemporarilywhentesting
throughput.AdministratorswhoarewaitingfortheOS_Events
tableintheOS_Serverdatabasetobepopulatedcanthinkthatno
eventsarebeingreported,wheninfactthereislatencydueto
batchesbeingassembledbeforebeingwrittentothetable.
Compression DefaultisTrue.Enablescompressionforbatchessenttotheserver.
Certificates
CertificatesaregenerallynotrequiredforOpenSpanStudio5.2toconnecttoOpenSpanServer5.2,unlessrequired
tosignruntimepackagesuponupload.Inthatcase,acertificatematchingtheserverscertificateauthorityshould
beimportedtotheworkstationscertificatestoreunderTrustedRootCertificationAuthorities.
OpenSpan Studio 5.2 Configuration | Matching Configuration and Promotion Levels to Runtime Packages for Debugging
MatchingConfigurationandPromotionLevelsto
RuntimePackagesforDebugging
BecauseOpenSpanServer5.2allowsBusinessAnalystsandpeoplewithsimilarrolestofurthermodifyRuntime
deploymentpackages,OpenSpanStudio5.2hasanadditionaltoolbarfordeveloperstoselectdifferentversionsof
thesamesolutionsothatdebuggingandchangesmadeinOpenSpanStudioaretothecorrectvariant.
Thevariablesare:
ProjectConfigurationAssignedconfiguration(s)fromOpenSpanStudio
RunasGroupReflectstheGroupassignment(s)madetothepackageonOpenSpanServer
FeatureSetLevelDevelopmentorProduction,asdesignatedonOpenSpanServer
Technicaladvisory:SolutionsaregivenauniquepackageIDinOpenSpanStudio.TheuseofthetoolbarinOpenSpan
StudiodescribedinthissectioninconjunctionwithruntimepackageadministrationonOpenSpanServerassumes
thatasolutionspackageIDisunchanged.BeawarethatifyouperformaSaveAsforasolutioninOpenSpan
Studio,thepackagewillreceiveacompletelynewpackageIDandversionfeaturessuchasthistoolbarwillbe
ineffective.Additionally,ofcourse,OpenSpanServerwillnotrecognizethenewpackageIDandchangessuchas
featuresetswouldbelost.
ProjectConfigurations
DeveloperscanaddprojectitemscalledConfigurationsinOpenSpanStudiothatcaptureandenforcecertaindefault
propertiesfrominterrogatedapplicationcontrols.ForafullexplanationofConfigurationcomponents,seethe
OpenSpanonlinehelp;themainpointinthispublicationistoshowthatwhenworkingjointlybetweenOpenSpan
StudioandOpenSpanServeronasolutionthathasmultipleconfigurationsassigned,thedevelopernowcanensure
thatanydebuggingorchangestothesolutionarebeingdonetothecorrectvariant.
TheProjectConfigurationdefaultisNone.Anyavailableconfigurationsareaccessiblefromthedropdownlistboxas
shownhere.
SeealsoAssigningConfigurationstoGroupsonpage 431.
Note:WhendeployingconfigurationsfromOpenSpanStudiotoOpenSpanServer,ensureyouselectDeployAll
Configurationsfromthesolutionmenuchoices.
RunasGroup
Andfinally,developersmakingchangestodeployedsolutionsinOpenSpanStudiocanalsoselectthecorrectGroup
assignedparametersforasolutionasshownhere.TheServersideexplanationisavailablehere:AssigningGroups
toPackagesonpage 434
PromotionLevel
OpenSpanStudionowallowsthesameflexibilityinselectingappropriatePromotionlevelsforasolution/
deploymentpackage.ToreadmoreabouthowOpenSpanServerassignsthesesettings,seeAssigningFeatureSet
Levelsonpage 433.WhendebuggingsolutionsinOpenSpanStudio,ensurethatyouselectthecorrectPromotion
Levelforthepackagesfeaturesets.
OpenSpan Studio 5.2 Configuration | Producing Process Automations
General
Andfinally,ProcessautomationscreatedinOpenSpanStudiocansendspecificEventstotheEventstableinthe
OS_ServerdatabasethatdontchangetheprocessstatefromdesktopRuntimesolutionpackages.Thereareinfinite
waystobuildtheseautomationsbasedondifferentbusinesscases,buttheyuseanewOpenSpanStudio5.2
componentcalledtheProcessPublisher,whichwritesitsowncategoryofdatatotheEventstable.
ProcessAutomationCreation
ProcessesandmetadataaredefinedonOpenSpanServer5.2,asexplainedinManagingProcessesonpage 436.
NewProcess
Firstaprocessiscreated.AServerusercreatesanewprocess...
...andsavestoserver.ThislistofprocesseswillbeavailabletoOpenSpanStudio,ifconnectedtotheserver.The
individualprocessescanbeassignedtoRuntimeusersviaOpenSpanServer,withorwithoutaruntimepackage.The
assignedprocesseswillappearinthedropdownlistboxontheProcessToolbar(seeProcessToolbaronpage 57).
MetadataCreation
ThenmetadatadimensionsorfactsisaddedtotheProcess.
OncethemetadataisassociatedwithaProcessonOpenSpanServer,thenProcessesandassociatedmetadataare
readyforinclusioninprocessautomations.
ProcessPublisher
AProcessPublishercomponentisaddedtothesolutioninOpenSpanStudio,andaprocessbindpropertyconnects
theProcessPublishertothemetadataforanydefinedprocessresidingonOpenSpanServer.
1. AccessthePropertiesfortheProcessPublisher.
SetErrorOnConsecutiveStartstoTruetodisplayanerrorifSendStarthappensmorethanoncebeforeacorre
spondingSendStopinthesameautomation.
IfsettoTrue,configureexceptionhandlingsuchasTryCatchblocksbetweencomponents.Additionally,set
theSuppressErrorspropertytoTruefortheautomation
SetErrorOnConsecutiveStartstoFalse(default)toacceptSendStartswithoutterminatingSendStopsinthe
automation.
TheProcessPublisherhasamethod,Abort,tobeemployedinautoma
tionstorefreshcomponentsstatetobrandnew.Itistheequivalentofthe
AbortbuttonintheProcessToolbar(seeProcessToolbaronpage 57),
andinterruptsandresetstheprocessstate.
2. BindtheautomationtoaProcessexistingonOpenSpanServer.ChoosetheProcessproperty,andtheSelect
Processdialogboxdisplays.Choosethecorrectprocessfortheautomation.
3. SetUseKeystoTruetoenablekeystoaccountforeachinstanceoftheautomationasadifferentprocess.(The
defaultisFalse.)
ExampleAutomation
Thendependingonbusinessandreportingobjectives,theSendStartandSendStopProcessPublishermethodscan
beusedtotagoridentifyimportantdesktopuseractionsforanalysis.ProcessEventsaresenttotheEventstable
ofthewithapropertyof4.Thisexampleattachesmetadatatobuttoncontrolsandsendsitwhenthecontrolsare
clickedaspartofapredefinedprocess.Amiddleeventhasbeeninsertedinthisexample,justtoshowthat
intermediateeventsofinterestcanbeplacedintheautomationandevenintermixedwithProcessPublisher
methods,dependingontheneed.ProcessPublisherisaveryflexiblecomponent.
UploadtoServerandRuntimeDownload
ProcessautomationsareuploadedtoOpenSpanServeralongwiththeirparentsolutions.Upondownloadtothe
enduserdesktop,theycanfunctionindependentlyofotherautomationoraddedFeaturelogic,butcontinue
workingatalltimeswhentriggeredtosendcustommetadatatotheOS_Eventsdatabase.
ADMINISTRATION AND
MANAGEMENT
InthisChapter
WelcometotheServerAdministrationandManagementChapteroftheOpenSpanServer5.2Administrationand
UserGuide.Thischapterisorganizedintothefollowingtopics:
SignontoOpenSpanServeronpage 44
GroupsandUsersonpage 46
ManagingDeploymentPackagesonpage 420
ManagingGroupRuntimeSettingsonpage 439
Adding,Editing,DeletingFeaturesonpage 421
AssigningFeatureSetstoGroupsonpage 429
AssigningConfigurationstoGroupsonpage 431
AssigningFeatureSetLevelsonpage 433
AssigningGroupstoPackagesonpage 434
SiteSettingsonpage 444
General
OpenSpanServer5.2isaWebbasedapplicationenvironmentthatallowsusersofOpenSpansoftwareto:
SetupGroupsofUsers,andimportUsers
ReceiveuploadsofruntimedeploymentpackagesfromOpenSpanStudio
AddfeaturessuchastooltipsanddefaultvaluestoenduserdesktopapplicationsreferencedbyOpenSpanRun
timesolutions
AssignthefollowingtoGroups:
Runtimedeploymentpackages
Featuresets
Differentruntimedeploymentpackageconfigurations
AProcessToolbarforinstrumentinguserprocesses
SendHighLevelandCustomeventsdatafromuserdesktopstotheEventsdatabaseandgeneratevisualizations
andreports
OpenSpanServer5.2servesasacrucialmiddlepieceinanarchitectureconsistingofOpenSpanStudio,OpenSpan
Server,andOpenSpanRuntime.Whileitisstillpossible,asinearlierOpenSpanreleasestodevelopsolutionsin
OpenSpanStudioanddeploythemdirectlytothedesktop,OpenSpanServerprovidesareadymadeadministration
tool.
OpenSpan Server 5.2 Administration and Management |
Dependencies
OpenSpanStudio5.2isaprerequisiteforOpenSpanServer5.2.Itcreatestheruntimesolutionsthatareuploadedto
theserverfordistributiontouserdesktops.
MasterTipFindSearchableContent
AbriefwordononeofOpenSpanServerscommonmenufeatures,theSearchbox.Onscreenshavingsearchable
lists,suchasUsers,Groups,andinotherselectionscreens,usetheSearchboxtoquicklyfindyourselections.
TheexamplebelowshowsasearchforthenameKareninUserAccounts.
1. Enterthedesiredsearchtermstring.
2. TheSearchboxexpandsdownwardwithanyitemslocatedmeetingthecriteria.
3. Choosearesultfromthedropdownlistandclick;thechoicedisplays.
OpenSpan Server 5.2 Administration and Management |
Note:TheSearchboxisapowerfultool.Itacceptsbasictextstrings,andalsocontextualwildcards,suchasthe%
sign.Addinga%signindicatesthatthetextprecedingorfollowingthepatterncanbeignored.Forexample,%Bob
willincludeitemsthathaveBobsomewhereinthestring,notjustatthebeginning.
OpenSpan Server 5.2 Administration and Management | Sign-on to OpenSpan Server
SignontoOpenSpanServer
SigningOn
1. OpenaWebbrowserInternetExplorerisrecommended.NavigatetotheOpenSpanServerUniformResource
Locator(URL)specifiedbyyourOpenSpanServerinstallationteam.Thesignondialogboxappears.
2. Administratorstypicallyhaveanadministratorsetoflogoncredentials.
DefaultTenantAdministratorlogin:
Username:admin@openspanserver.com
Password:password(alllowercase)
3. Otherusershavedifferentlevelsofaccess,dependingonhowtheuseraccountissetup.SeeGroupsandUsers
onpage 46.
4. ClickSignIn.
5. Ifprompted,Changeyourpassword.Continue.TheWelcomeScreenDisplays.
OpenSpan Server 5.2 Administration and Management | Sign-on to OpenSpan Server
WelcomeScreen
TheOpenSpanServerWelcomeScreenhasanumberofelements.
ThetopmenuofactionsandfunctionscontainsReportsandGraphs,Management,andSetuptasks.
Thegeneralinformationareaexplainsbasicfactsabouttheapplication.
Helptopiclinksonthebottomassistinbasictasks.
OpenSpan Server 5.2 Administration and Management | Groups and Users
GroupsandUsers
AkeyorganizingprincipleofthearchitecturebetweenOpenSpanStudio,Server,andRuntimeistheuseofGroups
andUserswhomakeupthoseGroups.GroupsandUsersareadministeredviaOpenSpanServer.Therearenopre
loadedGroups,forreasonsthatwillbecomeclearaswelookcloser,andusersareaddedbasedonyourenterprises
userpopulation.
SomeFactsaboutGroupsunderOpenSpanServer
GroupsareacentralconceptintheOpenSpanServerarchitecture.Groupmembershipdefineswhatauserdoes
anddoesntdo.Forexample,adesktopOpenSpanRuntimeusermightautomaticallydownloadandruna
processimprovementautomationthatiscompletelydifferentfromonethatisdesignatedattheserverlevelfor
anotheruserwhoisassignedtoadifferentgroup.Or,thesamedesktopautomationmaybeassignedwith
differenttooltipstotwosimilarendusersbasedonnativelanguageorskilllevel.Thisispossibleifthetwousers
areassignedtodifferentGroupsonOpenSpanServer.
GroupsaremanagedinOpenSpanServerbychoosingSetup|Groups.
AboutUsers
UsersarethepeoplewhomakeupGroups.TheyaregivenlogoncredentialstoaccessOpenSpanServer.Theway
theylogonandwhattheydodependsontheirjoborsource.Herearesomeexamples.
UserscreatedonOpenSpanServerhavefourroles:
ServeradministratorsareusuallyskilledITspecialistswhoinstall,configure,maintain,andupdatethe
OpenSpanServersoftware,theserveroperatingsystem(suchasWindowsServer2008),anddatabase
operations.Theyhavefullaccesstoallfunctions.
SoftwaredevelopersusingOpenSpanStudio5.2canautomaticallyconnecttoOpenSpanServerandupload
Runtimedeploymentpackagesdestinedforotheruserdesktops,butdontnecessarilyhavetouseother
serverfunctionsforadministeringormodifyingthepackages.DeveloperscannotsetupnewUsersand
Groups,oraccesssitesettingssuchasEventsenablingforGroups.
BusinessAnalystsmayaccessOpenSpanServertomodifyRuntimedesktoppackagesandassignthemto
Groupsofusers.BusinessAnalystscannotsetupnewUsersandGroups,oraccesssitesettingssuchasEvents
enablingforGroups.
ReportUsersreceiveaccesstothereportsmenusandfunctions.
RuntimeusersnormallyconnectautomaticallyfromtheirdesktopstoOpenSpanServerusingOpenSpan
Runtime,whichsendseventsdata,downloadsruntimesolutionspackages,andhandlesotherfunctionsto
improveenduseprocesses.
Note:Youcannotchangeyourownuserroleoncesetup.Anadministratormustchangeyourrole.Andan
administratorsrolemustbechangedbyadifferentadministrator.
UsersfromActiveDirectory(AD)Importmaybedividedpriorintodifferentcriteriaandgroupsdependingon
theirADstatus.
AddingUsers
Userscancomefromtwosources:
ManuallyAddNewUser(below)
ImportActiveDirectoryUser,page 410.Note:InitialimportingofActiveDirectoryUsersandGroupsisper
formedbyOpenSpanServicesconsultantsusingspecialutilitiestoensureproperconfiguration.
ManuallyAddNewUser
1. FromtheSetup|Usersmenu,chooseCreateNew.TheNewUsersProfileScreendisplays.EnterauserFirst
Name,LastName,andemailaddress.Note:Theemailaddresswillbeusedtosendpasswordresetnoticesand
otherusercommunications.
Youhavetheoptionofdesignatingauseras:
Runtimeuser
Administrator
Developer
ReportUser
BusinessAnalyst
Additionally,youcansetpasswordexpirationinthisscreen.
2. ClickSave.ANewUseriscreated.TheStatusdefaultstoActive.ForType,Yellow=nonActiveDirectory,Red=
UserisfromActiveDirectorybutnolongerexists,Green=UserisfromActiveDirectoryandisvalid.
3. Next,clicktheGroupstabtoassigntheusertoaGroup.
IftherearenoGroupstoassignaUserto,seeAddingGroupsonpage 414below.
IfatleastoneGroupexists,seeAssigningUserstoGroupsonpage 417.
ImportActiveDirectoryUsers
Note:SomeActiveDirectoryimportfunctionswillbedeprecatedafterthereleaseofOpenSpanServer5.2from
theuserinterfacebelowinfavorofotherimportutilities.TheOpenSpanServicesspecialistwhoenablesyour
deploymenthasthelatestconsoleutilitiesforyourdeployment.
ImportingActiveDirectoryUsersfirstrequirescommunicationbetweenOpenSpanServerandtheActiveDirectory
server.SeeSiteSettingsonpage 444.
TheimportprocedurefollowsthesamepatternasotherstepsthatmoveUsersfromtheAvailablecolumntothe
Selectedcolumn.
1. FromManage|Users,chooseCreateNew|ImportActiveDirectoryUser.
Note:Onlyuserswithanemailaddressenteredintheimporteddatabasearepopulatedinthegrid.Thisis
becauseemailisarequiredfieldinOSS.
2. Thegridallowsthreeoptions.
Members.Thisoptionshowsthealreadyimportedusers.
AllUsers.ThisoptionshowsallavailableusersinActiveDIrectory.Userspreviouslyimporteddonthavethe
AddlinkintheActioncolumnnexttotheirnames,butshowasImported.ClickingAddimportsauserto
OpenSpanServerandiftheuserisamemberofapreviouslyimportedActiveDirectoryGroup,theUser/
GrouprelationshipisautomaticallymadeinOpenSpanServer.
Importallusers.UsethisoptiontoimportallavailableADuserstoOpenSpanServer.Groupaffiliationsare
automaticallyassignediftheuserisamemberofapreviouslyimportedActiveDirectoryGroup.
3. Iftherearenoerrorsonimport,thegreenUserssuccessfullyimportedmessagedisplays,withaShow
importantdetailslink.
4. ClickingShowimportdetailsprovidesinformationontheimportresults.ClickReturntoSelection.
5. However,iftherewereimporterrors,theSomeerrorswerereportedmessagedisplays.ClickShowImport
Detailstoaccessinformationontheerrors.
Inthiscase,thenumberofsuccessfulversusfailedimportsdisplays,aswellasinformationonhowtofixthe
errors.ReturntoSelectiontakesyoubacktothegrid.
ResetPassword
UsethestepsbelowtoresetaUserspassword.Note:ThesestepsrequireanaccurateemailaddressfortheUser,
whetherornottheUseraccountismanuallycreatedorimportedfromActiveDirectory.
1. AccessSetup|Users.
2. Selecttheuserwhosepasswordyouwishtoresetbyclickingtheusersrowintheuseraccountlist.
3. ClickResetPassword.Thissendsaresetemailtotheaddressintheuseraccountlist.
4. Aconfirmationdialogdisplaysnotifyingyouthataresetemailwassenttotheuser.
Delete,Deactivate,andReactivateUsers
TwooptionsexistforremovingUsers:Delete,whichispermanent,andDeactivate,whichretainstheUseraccount
butremovesitfromactiveprocessesonOpenSpanServer.Thestepsbelowexplainhowtoperformdeletions,
deactivations,andhowtoreactivateaUser.
1. ChoosingDeletefromtheUserviewallowsthreepossibilities:
DeactivateKeeptheUser,butremovefromactiveservice.
DeleteRemovetheUserandallattributesfromtheOpenSpanServerdatabase.
CancelReturntotheUsersscreen.
IfyouchooseDeactivateandwishreactivatetheUser:
1. ChooseMoreOptions|ShowInactive.
2. ThelistofinactiveUsersdisplays.
3. SelecttheUseryouwishtoreactivate,andchooseMoreOptions|ActivateUser.
4. TheUserisnowactive.
AddingGroups
OncebusinessrequirementshavedefinedthetypesandgeneralcompositionoftheGroupsofenduserswhowill
ultimatelyuserOpenSpanRuntimeonworkstationdesktops,addthoseGroupstoOpenSpanServer.
GetstartedaddingGroupsbyfollowingthesesteps:
1. FromtheSetupmenu,chooseGroups.
2. TheGroupsadministrationscreendisplays.Note:IftherearenoGroupscreated,thisscreenwillbeempty.
Note:Fromthisscreen,youcanalwaysclicktohighlightaGroup,andthenselectEdittochangeinformationor
Delete.SeeDelete,Deactivate,andReactivateGroupsonpage 416.
Therearetwosetsofoptions:
CreateNew
MoreOptions
CreateNewManuallyAddNewGroup
1. Tocreateanewgroup,selectCreateNew.
Therearetwofurtheroptions:
ManuallyAddNewGroup
a. SelectManuallyAddNewGroup.TheNewGroupWindowDisplays.
b. EnteraGroupnameandadescription.
c. ClickSave.ThecreatedGroupscreendisplays.
Title:NameoftheGroup(editable).
Type:Yellow=Locallycreated(notimportedfromOpenDirectory);Red=FromActiveDirectory,Status
Unknown;Green=ActiveDirectory/Valid.SeeAddingUsersonpage 47.
Status:Green=Active.Red=Inactive.
d. TheGroupisnowavailableforassigningUsers.SelecttheMemberstab.CurrentUsersassignedtotheGroup
display.Or,toaddtheUsertoaGroup,followtheproceduresunderAssigningUserstoGroupsonpage 417.
CreateNewImportActiveDirectoryGroup
ToimportGroupsfromActiveDirectory,firstestablishaconnectionbetweenOpenSpanServerandtheActive
Directorysource.SeeSiteSettingsonpage 444.Theprocedureforimportisverysimilartothatofimporting
Users.Seepage 410.
Delete,Deactivate,andReactivateGroups
TwooptionsexistforremovingGroups:Delete,whichispermanent,andDeactivate,whichretainstheUseraccount
butremovesitfromactiveprocessesonOpenSpanServer.Thestepsbelowexplainhowtoperformdeletions,
deactivations,andhowtoreactivateaUser.
1. ChoosingDeletefromtheGroupviewallowsthreepossibilities:
DeactivateKeeptheGroup,butremoveitfromactiveservice.
DeleteRemovetheGroupandallitsattributesfromtheOpenSpanServerdatabase.
CancelReturntotheGroupscreen.
2. IfyouDeactivate,andwishtoReactivatetheGroup,thenusetheMoreOptionsmenuandselectShowInactive.
TheInactiveGroupsareindicatedundertheStatuscolumn.
3. ToActivatetheGroup,clicktheGroupinthedisplaytoselect,thenfromMoreOptionschooseActivateGroup.
4. TheGroupsStatusisnowActive.
AssigningUserstoGroups
OnceatleastoneUserandoneGrouparecreated,thenextstepistoassignanewUsertoaGroup.
1. IfyoujustaddedaUser,thenyouaredisplayingtheUsersProfile.IfyouhaveexitedtheProfilescreenreturnby
choosingSetup|Users.TheUserAccountsscreendisplays.SelecttheUser,andEdit.
2. FromtheUsersProfilescreen,selecttheGroupstab,andclickAddorRemoveGroups.
3. TheAssignGroupswindowdisplays.
ClickAddtoaddtheusertoaspecificGroup.
QuicklyassigntoallGroups,orRemovewithoneclick.
SetsofGroupscanbeselectedfromthiswindowforassignment.
4. TheUserisnowassignedtothenewGroup(CustomerServiceAgents[Inbound]).Toremovethisuserfromthe
Group,simplyclickthelinked(X).
5. ClickOK.ThisreturnsyoutotheUsersProfilescreen.NotethattheUserisnowassignedontheProfilescreento
theCustomerServiceAgents(Inbound)Group.TheGroupsdescriptionalsodisplaysforreference.Aprominent
icondisplaysconfirmingthattheGroupisactive.Ifinactive,seeDelete,Deactivate,andReactivateGroupson
page 416.
OpenSpan Server 5.2 Administration and Management | Managing Deployment Packages
ManagingDeploymentPackages
OpenSpansolutionsdevelopedinOpenSpanStudio5.2areconfigured(withspecificruntimeparameters),if
appropriate,anddeployedviadirectuploadtoOpenSpanServer.There,theycanbeaccessedbyregistered
OpenSpanServerusersandmodified,promoted,andassignedtoGroupsthatweresetupinthesectionAdding
Groupsonpage 414.
UsersassignedtothoseGroups(seeAssigningUserstoGroupsonpage 417)havelogincredentialstodesktop
workstationsequippedwithOpenSpanRuntime5.2,alicensedsmallclientapplication.Dependingonhow
OpenSpanRuntimeisconfigured,aUserloggingintoaRuntimeequippedworkstationautomaticallydownloadsa
runtimepackageoftheoriginalOpenSpansolutionthathasmadeitswayfromOpenSpanStudiotoOpenSpan
ServerwhereithaslikelybeencustomizedforeachUserGroup.Note:RuntimeUsersmayonlybeassignedevents
reportingoruseortheProcessToolbar.SeeChapter5,OpenSpanRuntime5.2Configurationformoreinformation.
Tip:UsetheSearchbox
FindthePackageyourelookingforinlessthanasecondusingastringpromptintheSearchbox,thenclickthe
appropriateresult.
Yougothroughthedatabasetableofavailablepackagestothecorrectone.
Adding,Editing,DeletingFeatures
AfteradeploymentpackageisuploadedtoOpenSpanServerfromOpenSpanStudio,aserveruserwithappropriate
credentialscanassignFeaturesthatfollowthepackagethroughdownloadtoindividualuserdesktopsbasedonUser
andGroupassignments.
TherearetwocategoriesofFeaturesavailableinOpenSpanServer5.2:
DefaultValues.Certaincategoriesofinterrogatedcontrolscanbesetwithdefaultvalues.Examplesincludetext
fieldsthatcanbesettocontainspecifictext,maskingproperties,orareautomaticallyblankonapplicationopen.
Otherexamplesmightbepropertieswithbooleanradiobuttons(On/Off,Yes/No)orsimilarselectablevalues.
PopupHelp.Thisfeatureallowsyoutosetpopupballoonswithtitles,text,ainformationalorcustomicons.
Whenauserselectsacontrolthataccommodatespopuphelp,theFeaturedisplays.Examplesincludeitems
requiringspecificprocessguidance,especiallywhenthesamecontrolmustbeexplainedindifferentlanguages.
General
1. AccessthemainpackagedirectoryviaManage|DeploymentPackages.TheDeploymentPackageswindow
displays.ExpandapackagebyclickingthePlus(+)icontotheleftofthepackagename.
ThisdisplaystheFeatureSetLevelsforthatpackagealongwiththeabilitytoEditorDeleteFeatures.
2. SelectEdit.Inthisexample,wellmodifytheFeatureSetLevelassignedtoDevelopment.Youcanalsomodify
Production,ifthepackagehasbeenpromoted,thoughthisisnotrecommendedassavingmaycauseunwanted
replacementsofpackagefeatures.Formore,readaboutpackagepromotionunderthesectionAssigning
FeatureSetLevelsonpage 433.
3. TheFeatureSetswindowdisplays.Themainpartsare:
DropdownlistboxofadaptersincludedintheOpenSpanruntimedeploymentpackage
Anexpandablehierarchy(treeview)ofinterrogatedcontrolsforeachadapter.
TabsforaddingorchangingtheDefaultValues,ifappropriate,oraddingPopupHelptoacontrol
4. Selectanadapter,anditsinterrogatedcontrolsdisplayinahierarchy.
5. Selectacontrolfromthehierarchy,thenselectatabtoaddaDefaultValueorPopupHelp.IftheFeatureisnt
appropriateforthecontrol,aninformationmessageappearswithalinktoexplainwhy.Forexample,aclickable
buttonwontnormallyacceptaDefaultValuethevalueiswhateverstringresourcecomeswiththecontrol,
suchasanumberedcalculatorbutton.
AddingPopupHelp
Selectingabuttonorsimilarcontroldoes,however,allowyoutoaddPopupHelp.
1. Selectacontrolfromthehierarchy.
2. SelectthePopupHelptab.
3. ClickAddNewFeaturetocontinue.
IfthereareexistingPopupHelpFeatures,thenewfeatureworkingareadisplaysunderthem.
4. AssignthefollowingpropertiesforPopupHelp:
TitleAppearsatthetopofthePopup
MessageTextfortheuser
IconChooseNone,Info,Warning,orError,dependingonthecontextofthemessage
PositionLocationinthePopupHelpdialogbubble:TopRight,BottomLeft,BottomRight
5. ClickSave.ThenewFeatureappearsintheFeatureslist.
HowwillthisfeatureappearontheRuntimeUsersdesktop?TheUserclicksthebuttonandthePopupdisplays.
Tip:ViewScreenshot
OpenSpanprovidesvisualconfirmationofthecontrolsyouuseasFeatureSetattachmentpointsforaninterrogated
application.Withthecontrolselected,clickScreenshotintheupperrighttoseeanimageoftheinterrogated
control.
TheimagecapturefollowsthepackagefromOpenSpanStudiotoOpenSpanServerandisahandyreferencewhen
addingfeaturestopotentiallyhundredsofcontrolsacrossanenterprise.
ThisillustrationshowsthescreenshotaccompanyingtheClearbuttoncontrolinthedeploymentpackagefrom
OpenSpanStudiotoOpenSpanServer.
AddingDefaultValues
Next,letsseeanexampleofaddingadefaultvaluetoacontrol.
BoxesandButtons
BeginwiththesamestepsasinAddingPopupHelponpage 424.
1. Selectacontrolfromthehierarchy.
2. Thistime,selecttheDefaultValuestab.
3. ClickAddNewFeaturetocontinue.Adifferentwindowdisplaysforaddingdefaultvalues.
4. CheckorradioboxcontrolsallowCheckedorUnchecked.
TextControls
Textcontrolsareadifferentstoryandautomaticallyareavailableifthecontrolyouchooseisatextfield.Theseallow
flexibilityofdefaultvaluesforbusinesspurposessuchas:
Clearingafield(makingitblank)
Automaticallypopulatingafieldwithconditionalinformation
Maskingsensitivedata
Completelyblankingsensitivedata
Note:SelectingthetextUsedifferentdefaultvaluesforpopulatedandblankfieldstogglesthetextoptions.
1. Fortextcontrols,theNewFeaturewindowautomaticallyopensaDefaultValuewindowforfreeentry.Ifyou
checkMakedefaultvalueablank,theplaceholder[Blank]populatestheentryarea.
2. Toexerciseotheroptions,selectUsedifferentdefaultvaluesforpopulatedandblankfields.
3. Checkoneofthese:
a. Defaultvaluewhentargetfieldisblank.Thenaddthetextyouwishtodisplay.
b. Defaultvaluewhentargetfieldispopulated.Thetextyouenterherewillreplacewhateverisinthefieldwhen
thecontrolisinitiallypopulatedwithanyvalue.
c. OrSelection(b)aboveenablestheMakedefaultvalueablankcheckbox.Selectingthisinsertsthat[Blank]
placeholder.
AssigningFeatureSetstoGroups
General
Note:IfyouattempttoSaveafeaturewithoutassigningaGroup,youwillseeapromptsayingAtleastonegroup
mustbeassigned.
Steps
Thebeginningstateforthesestepsis:
AFeaturehasbeenadded
ThereisnoGroupassignedtotheFeature
1. ClickthehighlightedGroups:textontheFeaturewindow.TheAssignGroupspanelappears.
2. SelectaGroupfromtheAvailableGroupslist.Tip:ControlclickorShiftclickallowsyoutoselectmultipleGroups
fromtheAvailableGroupscolumn.
3. ClicktherightarrowmovecontroltotransfertheGroup(s)totheSelectedGroupscolumn.
TheGroupnamenowappearsunderSelectedGroups.TheFeatureisnowassignedtoallinstancesoftheparent
runtimepackagebeingdownloadedbyUsersassignedtothisGroup.
Note:ItispossibletoassigntheFeaturetomultipleGroups.
4. ClickOK.ThisreturnsyoutotheNewFeaturescreen.
5. ClickSavetocreatethenewFeature.SelectthehighlightedscreentexttoReturntoDeploymentPackages.
AssigningConfigurationstoGroups
OpenSpansolutionssometimescontaincomponentscalledConfigurations.Thesearecustomsetsofpropertiesfor
specificadapters.OpenSpanStudio5.2nowhastheabilitytosynchronizedifferentattributessuchasConfigurations
withtheassignmentsmadeonOpenSpanServer.Formoreinformationonthat,seeProjectConfigurationson
page 36ofChapter3,OpenSpanStudio5.2Configuration.
1. ChooseAssign|ConfigurationstoGroups.
2. AdialogboxdisplaysallowingyoutoselectaconfigurationforeachPackage/Groupassignmentfromthesetof
availableConfigurationsaddedinOpenSpanStudio.
3. AssigntheappropriateConfigurationstoGroups,thenclickOK.
4. TheConfigurationsarenowavailablewhentheirRuntimepackagesaredownloadedbytherespectiveUserswho
aremembersoftheGroupsassigned.
AssigningFeatureSetLevels
OpenSpanServer5.2letsyouworkonapackageinsandboxmodeintheDevelopmentlevel,thenpromoteitto
Productionstatus.ThismakesittheversionthatisdownloadedwhenRuntimeUsersassignedtotheappropriate
Groupsconnectfromthedesktop.
1. FromManage|DeploymentPackages,expandthedetailsofadeploymentpackagebyclickingthePlus(+)icon.
2. WhenyouhavefinishedalldevelopmentworkonthepackageandwishtopromotetoProduction,clickthe
highlightedscreentextPromote.
OpenSpanStudio5.2allowsdeveloperstoworkonthepackageineitherDevelopmentorProductionstatusby
makingatoolbarselection.SeePromotionLevelonpage 38ofChapter3,OpenSpanStudio5.2Configuration.
NotesonFeatureSetPromotion
ExercisecautionwhenpromotingFeatureSetsfromDevelopmenttoProduction,orchangingFeatureSetsin
Production.Doingthiswithoutcarefulplanningcancausegreatconfusionandpossiblyderailanotherwiseexcellent
matrixofdownloadedRuntime,userfocusedpackages.
PromotionImmediatelyreplacestheFeatureSetinProductionwiththeFeatureSetinDevelopment.Thiscan
notbeundone.Adialogboxasksyoutoconfirmthechoice.
Likewise,however,ifyoudeleteFeaturesfromProduction,theDevelopmentversionofthepackagewillsync
upandtheFeaturewillalsobelostfromDevelopment.Adialogboxasksyouforconfirmation.
AssigningGroupstoPackages
Groupassignmentforpackagesworksinasimilarsamemannerastheprevioustopics.
1. FromManage|DeploymentPackages,selectapackagebyclickingtohighlight.
2. ChooseAssign|PackagestoGroups.
3. AdialogboxappearswithGroupnamessimilartotheoneinAssigningFeatureSetstoGroupsonpage 429.
4. AssigntheappropriateGroups,usingtheinwindowcontrols.Add,(X)toremove.OtherGroupcontrolsfunction
thesameasinotherGroupselectionwindows.
OpenSpanStudio5.2alsoallowsdeveloperstochoosethesameGrouppackageassignmenttoensuretheproper
variantofthesolutionisbeingchanged.SeeRunasGrouponpage 37inChapter3,OpenSpanStudio5.2
Configuration.
OpenSpan Server 5.2 Administration and Management | Managing Processes
ManagingProcesses
ProcessesarenamedandgivenmetadatatosupplyanotherlevelofEventsreportingtotheOS_Serverdatabases
Eventstable.OncecreatedonOpenSpanServer,themetadatacanbeusedinOpenSpanStudiowithbindingsfrom
theProcessPublishertomovedatafromOpenSpanRuntimedesktopsolutionstothedatabase.SeeProducing
ProcessAutomationsonpage 39ofChapter3,OpenSpanStudio5.2Configuration.
Additionally,basedonassignments,theprocessespopulatethedropdownmenuontheRuntimeProcessToolbar.
SeeProcessToolbaronpage 57ofChapter5,OpenSpanRuntime5.2Configuration.
CreateNew.
Edit.AccessedunderManage|ProcessesintheActionscolumn.
Delete.DeletionofferstheoptionstopermanentlydeleteorDeactivate.IfyouchoosetoDeactivate,thesame
menucontrolsallowyoutoActivateatalaterdate.UseManage|Processes|MoreOptions.
CreatingaNewProcess
1. CreateaNewProcess.FromManage|Processes,chooseCreateNew.
2. TheNewProcesses|Generaltabdisplays.EnteraTitleandDescription.
3. ClickSave.
4. SelecttheMetadatatab.ClickAddMetadata.
5. IntheAddMetadatawindow,namethemetadata(nospacesallowed)andselectasDimensionorFact.
6. Whenfinished,clickOK.
7. ThenewProcessdisplaysinthelist.
Ifmetadataisdeleted,OtherOptionsinclude:
Refresh
Reactivate
ShowInactive
...forpreviouslydeletedMetadata.
Editing,DeletingaProcess
EditingandDeletingworkthesamewaythatothermajoritemsaremanagedinOpenSpanServer5.2.Editaccesses
thedataforchanges.DeleteallowsfulldeleteorDeactivation.UseMoreOptionstoActivate.
OpenSpan Server 5.2 Administration and Management | Managing Group Runtime Settings
ManagingGroupRuntimeSettings
General
Whenyouhave:
CreatedUsers
CreatedGroups
AssignedUserstoGroups
MadePackage/FeatureotherGroupassignments
...itstimetoconfigureGroupRuntimeSettings.
CreateGroupRuntimeSettings
ThissetofinstructionsassumesyouhavecreatedatleastoneGroupinOpenSpanServer5.2.Ifnot,seeAdding
Groupsonpage 414.
1. SelectManage|GroupRuntimeSettings.TheGroupRuntimeSettingsscreendisplays.
2. ClickCreateGroupSetting.
TheCreateGroupSettingscreendisplays.
GroupSettingsaredisplayedintableformwithdropdownlistboxesforeachsetting.Selectthefollowingvalues:
Setting Value
EnableHighLevelEvents DefaultisTrue.Enablesthelistof
HighLevelEventsinthecategories
below.
SendApplicationFocusEvents DefaultisFalse.
SendFormFocusEvents DefaultisFalse.
SendPageFocusEvents DefaultisFalse.
SendIdleEvents DefaultisTrue.
SendSystemLockEvents DefaultisFalse.
SendScreenSaverEvents DefaultisFalse.
SendTopLevelWindowEvents DefaultisFalse.
SendUrlChangedEvents DefaultisFalse.
SendProcessCreated/DestroyedEvents DefaultisFalse.
ProcessToolbarEnabled DefaultisFalse.However,many
Runtimeuserswillneedthis
componentassigned.SeeProcess
Toolbaronpage 57inChapter5,
OpenSpanRuntime5.2Configuration.
MoreindepthinformationonHighLevelEventsisavailableintheOpenSpanonlinehelp.
3. AfterselectingsettingsontheGroupRuntimeSettingsscreen,clickSave.
4. Next,attachthelistofsettingstoaGroup.ClicktheGroupshighlightedtextontheCreateGroupSettingscreen.
5. TheAssignGroupswindowdisplays.SelectoneormoreoftheAvailableGroupsandassignbyclickingAdd.
Removebyclickingthe(X).YoucanalsoAssignorRemoveallgroups.
Thename(s)oftheassignedGroup(s)nowdisplaysontheCreateGroupSettingscreen.Youcanchangethisat
anytimebyclickingtheGroupstextandrepeatingthestepsabove.
EditandDeleteGroupRuntimeSettings
Edit
1. FromtheGroupRuntimeSettingsscreen,clickEdit.
2. TheEditGroupSettingscreendisplays.ThisisacopyofCreateGroupSetting.Resetpropertiesasappropriate,
thenclickSave.
3. ItspossibletoaddorchangetheassignedGroupsatthispoint.SeeCreateGroupRuntimeSettingsonpage 4
39.
Delete
DeletingGroupRuntimeSettingsispermanent.UnlikeUsersandGroups,thereisnosoftdeleteorDeactivate
option.
1. AccessManage|GroupRuntimeSettings.
2. SelectanAssignedGroupbysingleclickingtherow.
3. ClickDelete.
4. TheDeletedialogdisplays.
5. ClickDeletetopermanentlyremovetheGroupSettings,orCancel.
OpenSpan Server 5.2 Administration and Management | Site Settings
SiteSettings
General
InitialsetupandconfigurationofOpenSpanServer5.2requiresseveralmorepropertiestobesetbytheserver
Administrator.ThesepropertiesaffectinteractionwithActiveDirectory(usedforsomeUserandGroupsourcingand
administration)andactivationofHighLevelEventsforcollectionbydesktopRuntimepackagesandstorageand
reportingonOpenSpanServer.
UserSteps
1. AccessManage|SiteSettings.TheSiteSettingswindowdisplays.
Mostofthevaluesaremanuallyentered,exceptfortwodropdownlistboxes.
TABLE 1. SiteSettings
Setting Value
ActiveDirectoryServerAddress(NameorIP) ThenameorIPaddressofthesource
ActiveDirectoryserversupplyingUser
orGroupnames,ifapplicable.
ActiveDirectoryDomainName DomainnameofthesameActive
Directoryserverfromtheprevious
step.
ActiveDirectoryBaseDN LDAP(lightweightdirectoryprotocol)
connectionstringforconnectingwith
ADtoreadADusers/groups.dc
standsfordomaincontroller.Will
varydependingonActiveDirectory
source.
ActiveDirectoryUserName SuppliedbyActiveDirectory
administrator.
ActiveDirectoryUserPassword SuppliedbyActiveDirectory
administrator.
ActiveDirectoryServerPort SuppliedbyActiveDirectory
administrator.
(HighLevelEvents)Secondsforidletime Defaultis120seconds.Canbesetto
anyvalue.Note:Ifsettooshort,the
resultingidletimedetectionsacross
multipledesktopscouldcreatedata
volumeproblemsandmakereports
lessvaluable.
IgnoreOpenSpanRuntimeProcesses DefaultisTrue.Settingthisvalueto
Truepreventsselfreferential
reportingoftheRuntimeapplication
itselfontheuserdesktop.
GenerateHighLevelEventsOnlyforUserInterfaceProcesses DefaultisTrue.SettingtoTrue
ensuresthatenduserdesktopsystem
messagesandeventsarenotsentto
theEventstableintheOS_Server
databaseorprocessedforreports.
Chapter 5 OPENSPAN RUNTIME 5.2
CONFIGURATION
InthisChapter
ThischapteroftheOpenSpanServer5.2AdministrationandUserGuidedescribeshowOpenSpanRuntime5.2is
configuredtoworkwithOpenSpanServer5.2todownloadandrunOpenSpansolutionprojects.Thischapteris
organizedintothefollowingtopics:
RuntimeConfig.xmlonpage 52
ConnectingOpenSpanRuntimewithOpenSpanServeronpage 53
RuntimeMenuonpage 54
General
DesktopusersoftendontseeorinteractmuchwiththeOpenSpanRuntimeexecutableapplication,butratheruse
theruntimedeploymentpackagesthatrunonthedesktop.OpenSpanRuntimeisdesignedtofunctionas
unobtrusivelyaspossible,behindthescenes,toautomateapplicationsandsendeventstoOpenSpanServerfor
analysis.Theinformationinthispublicationismeantmostlyfordevelopersandbusinessanalystsunderstandhow
solutionsareexecutedandeventscollectedfromthedesktop.
OpenSpanRuntime5.2hasaninstallationdialogtopresettheaddressforOpenSpanServer;mostotheractionsor
settingsforOpenSpanRuntime5.2areeitherwrittentotheruntimesolutionpackageanddynamicallyenforcedor
areimplementedviaanumberofserversidesettings,suchasenablingEventscollection,FeatureSets,etc.
OpenSpan Runtime 5.2 Configuration | OpenSpan Runtime and OpenSpan Server
OpenSpanRuntimeandOpenSpanServer
ThissectionexplainstheconfigurationofOpenSpanRuntime5.2andhowitssettingsinteractwithOpenSpan
Server,includingHighLevelEventsandruntimepackages.
Certificates
Formostdeployments,workstationcertificatesarenotneededtodownloadandconsumeruntimesolution
packagesfromOpenSpanServer5.2.
RuntimeConfig.xml
Generallyspeaking,changestoindividualdesktopRuntimepropertiesarewrittentothelocalRuntimeConfig.xml
file,locatedintheProgramFiles|OpenSpan|OpenSpanRuntimedirectory.Note:OpenSpanStudiowritestoa
localversionoftheRuntimeConfig.xmlfilefordevelopmentanddebugging,locatedinthelocaluser|My
Documents|OpenSpanStudioforVS2010directory.ForafullexplanationoftheRuntimeConfig.xmlfilesettings,
refertoOpenSpansonlinehelp.
ConnectingOpenSpanRuntimewithOpenSpanServer
WheninstallingOpenSpanRuntime,adialogboxletsyouentertheServerconnectinformation.Ifyouchoosenotto
entertheServerconnectioninformationatthistime,thedesktopuserwillbepresentedaConnectiondialogbox
wheninitiallyrunningOpenSpanRuntime.ThisinformationmustbeenteredorOpenSpanRuntimecannot
communicatewithitsServercounterpart.
UserSteps
1. Duringinstallation,theOpenSpanRuntimeEnterpriseSetupdialogboxdisplays.
2. SelectYesforDoyouplantoaccesstheOpenSpanServerfromthisworkstation?
3. EntertheIPorotherformofaddressfortheOpenSpanServerinstancethatOpenSpanRuntimewillcommuni
catewith.
Note:OnlyusetheaddressorHostName;donotincludeprefixesorsuffixessuchashttp://or/.Doingso
willdoublewritethesyntaxtoOpenSpanRuntimesRuntimeConfig.xmlfileandconnectionwillnotbepossible.
ExamplesoftheRuntimeConfig.xmlserverconnectivityentriesaredisplayedhereforyourreference.Youcan
modifyserveraddressesinthisformataswell.TheserveraddresscorrespondstothetestIPaddressshownin
theinstallationdialogboxabove.Thebooleanvaluesareinitialdefaults.NotethattheServeraddressiswritten
totheURL,baseURL,stsBaseURLentries.OtherpropertiesmayvarydependingontheWindowsCommunication
Foundation(WCF)settingsenabledserverside;seetheOpenSpanonlinehelp.
<ServerConfiguration ServerConnectivityEnabled="True">
<Server serverName="DEFAULT" serverAddress="10.0.3.9" serverURL="http://

10.0.3.9/OpenSpanServer/" serverBaseURL="http://10.0.3.9/"
eventCollectionServerBaseURL="" wastsBaseURL="https://10.0.3.9/Services/
WASTS/" stsBaseURL="https://10.0.3.9/Services/STS/" dnsIdentity="www.QA-
Preprod" useWindowsCredentials="False" authenticateByUserNameOnly="False">
4. Next,settheauthenticationmethod.IfthedesktopuserwillconnecttoOpenSpanServerusingcredentialscre
atedlocallyontheserverinstance,selectOpenSpanServerusercredentials.ForActiveDirectory,selectWin
dows(ActiveDirectory)credentials.
RuntimeMenu
WhenOpenSpanRuntimeloadsontheuserdesktop,bydefaultitdisplaysasmallOpenSpanicon inthe
applicationportionofthedesktoptaskbar.Rightclickthisicontodisplaythedefaultsystemtraymenu.
Note:YoucanedittheRuntimeConfig.xmltocompletelyhidetheRuntimemenu.Resetthedefaultsasshownhere
inbold italic.
<AppSettings>

<add key="ShowSystemTrayIcon" value="false" />
MenuItemsandDefinitions
About
SelectthismenuitemtochecktheversionnumberofOpenSpanRuntime.
DiagnosticsConfiguration
OpenSpanRuntimesharesthesamerichdiagnostictoolsetwithOpenSpanStudio.Typically,theseareonly
activatedandlogsgeneratedonadviceandguidancefromOpenSpanSupport,astheycanquicklygenerate
overwhelmingamountsofdata.Forsetupanddetails,pleasereferenceOpenSpanonlinehelp.
TestConnection
TestscommunicationswiththeinstanceofOpenSpanServerspecifiedintheServerConfigurationsectionof
OpenSpanRuntimesRuntimeConfig.xml.
OpenSpanServerConfiguration
ThetopicConnectingOpenSpanRuntimewithOpenSpanServeronpage 53abovereferencestheServeraddress
installationdialog.Ifthisisleftblank,thefirsttimeyoustartOpenSpanRuntimeonadesktop,theOpenSpanServer
Connectiondialogboxdisplays.EnterthecredentialsforaregistereduserinyourOpenSpanServerhierarchy.
Loggingofffromaworkstationandloggingadifferentuseronwillgeneratethesameprocessagain.
Ifyouwishtochangecredentialsduringthesameworkstationlogonsession,selectOpenSpanServerConfiguration
fromtheRuntimemenutraytodisplaytheServerConnectiondialogbox.Entertheappropriatecredentialsfora
registereduseronOpenSpanServer.ClickTestConnection.Whenconnected,clickOKtoacceptorCancel.
Default|(Package)
IfnopackagesareassignedtotheRuntimeuser,nonedownloads.Runtimewill,ifconfiguredto,runnormally.An
examplecouldbeusingRuntimetoonlysendHighLevelEventsdatatoOpenSpanServer.However:
Ifasinglepackageisassignedtotheuser,itdownloadsonsignon.
Iftheuserisamemberofmultiplegroups,agroupselectiondialogboxdisplays.Theuserselectstheappropriate
groupandclicksOK.
Ifmultiplepackagesareassignedtotheuser,adialogboxdisplaystochoosethepackagetorun.Anexampleis
shownbelow.SelecttheappropriateRuntimepackageandclickOKorCancel.
IftheRuntimeuserisassignedtomultiplegroups,aSelectGroupdialogboxdisplays.
SelecttheappropriateGroupandclickOKorCancel.
Exit
SelectExittocloseOpenSpanRuntime.
Events
ThetopicDefault|(Package)onpage 56mentionsthatproperlyconfiguredRuntimeinstancescansendHigh
LevelEventsfromtheuserdesktoptoOpenSpanServerforanalysis.ForinformationontheServerside
configurationofthisoption,seeManagingGroupRuntimeSettingsonpage 439.
ProcessToolbar
Ifenabled,theProcessToolbardisplaysonRuntimestart.TheProcessToolbarisaninstrumentationoptionthatlets
ausersend,stop,orresetprocesseventstotheEventstableinthedatabaseinawaythatmimicstheSendStart/
SendStop/Abortmethodsfromprocessautomations(formoreinformationonprocessautomations,seeProducing
ProcessAutomationsonpage 39).Theideaistobracketusereventsfromdiscretebusinessprocedureswith
distinctmetadatathatallowstheeventsbetweenStartandStoptobemeasuredbytimeelapsed,numberof
keystrokes,etc.,andtoinjectcustomdimensionorfactmetadatainthestreamasabonus.Reportsmodulesin
OpenSpanServerdisplaythedata.SeeProcessActivityReportsonpage 613,ProcessUserPerformanceReports
onpage 615,ComparativeProcessActivityReportonpage 616,andComparativeProcessUserPerformance
Reportonpage 617.,
1. FromtheProcessToolbar,selectfromamenuofavailableProcesses.IfnoprocessesaredefinedonOpenSpan
Server,nonewillbevisibleinthisdropdown.
2. ClickStarttosendaStartEventthatistiedtotheselectedprocesstotheEventstableofthedatabase,
3. Performtheuserdesktopstepsthatcorrespondtotheselectedprocess.Whencomplete,clickStop.Thissendsa
StopEventtotheEventstableofthedatabase.
4. AthirdoptionisavailabletostoptheprocesswithoutreportingtotheEventstableofthedatabase;clickAbort,
andtheProcessToolbarstateresetstoready.NoStartorStopEventsforthatprocessinstancearerecorded.It
letsauserstartoverwithoutleavingorphanedprocessesawaitingaStop.
ServersideSettings
ForinformationonenablingdisplayoftheProcessToolbarviaServersideconfiguration,seeManagingGroup
RuntimeSettingsonpage 439.
REPORTS AND GRAPHS
InthisChapter
WelcometotheReportsandGraphsChapteroftheOpenSpanServer5.2AdministrationandUserGuide.Whenyou
havefinishedreadingthischapter,youwillbefamiliarwiththesetopics:
ReportDisplayTypesonpage 63
AccessingReportsandGraphsonpage 66
SingleReportsonpage 68
ComparativeReportsonpage 616
General
TheReportsandGraphsfeaturesofOpenSpanServerprovidereportingonthehighleveleventscollectedfrom
Runtimeusers.
OpenSpanServeradministratorshavetheoptionofenablinghighleveleventsreportingfromeverydesktoprunning
OpenSpanRuntime.Reportingisntnecessarilytiedto,ordoesntrequire,theactualdownloadofaRuntime
package.Rather,ifenabledwithorwithoutapackagedownload,eachdesktopcanreportthefollowinginformation
totheEventsdatabase:
TABLE 1. HighLevelEventsMonitoredbyOpenSpanServer
Event Notes
KeystrokeCount
ErrorKeystrokes
MouseClickCount
MouseWheelCount
CopyCount Limitedtokeystrokecommands,notrightclick
copiestotheclipboard.
PasteCount Limitedtokeystrokecommands,notrightclick
pastesfromtotheclipboard.
CutCount Limitedtokeystrokecommands,notrightclick
cutstotheclipboard.
WindowMove/Resize
Count
ScrollCount Windowscrolls.
OpenSpan Server 5.2 Reports and Graphs |
TABLE 1. HighLevelEventsMonitoredbyOpenSpanServer(Continued)
Event Notes
KeyStrokeErrorRatio Keysdividedbybackspace/delete.
TotalCut/Copy/Paste Keyboardinputonly,notrightmouseclicks.
ApplicationChurn Countofmonitoredapplicationsgaining/losing
focus.
ApplicationDuration Timemonitoredapplicationsinfocus.
Inastandardinstallation,thisdataaccumulatesaccordingtodefinedschemasintheEventstableoftheOpenSpan
Serverdatabase.OpenSpanServerisequippedwithstandardreportsandvisualizationstohelpbusinessanalysts
refinedevelopmentanddeploymentofOpenSpanRuntimepackagestouserdesktopsacrossanenterprise.
OpenSpan Server 5.2 Reports and Graphs | Report Display Types
ReportDisplayTypes
HeatMaps
HeatMapsuserectangle(cell)sizeandcolortocorrespondtotwovariables:DurationandMetric.Thesizeofthe
rectanglesillustratesduration(i.e.,timespentinanapplicationorperformingaprocess).Thecolorrepresentsthe
HighlevelEventmetriccount.
Larger:Moretimespentinanapplicationorperformingaprocess
Smaller:Lesstimespentinanapplicationorperformingaprocess
Red(brighter,hotter):Highmetriccount;theuserorusersperformedtheeventmanytimes
Blue(darker,cooler):Lowmetriccount;theuserorusersperformedtheeventlesstimes
Seethenextpageforanexample.
HeatMapVisualRelationships
Inthissimplecomparison,imaginethatdesktopusersAandBareusingInternetExplorerandNotepad.Events
reportingisturnedon.Aftera6hourperiod,abusinessanalystgeneratesaheatmapofusersAandBs
reportedevents.Withoutevendrillingdownintothemetrics,somethingsstandoutfromtheheatmap.
UserAspendssignificantlymoretimeinInternetExplorerthaninNotepad.WeknowthisbecausetheInternet
ExplorerrectangleisbiggerthantheNotepadrectangle,reflectingamuchlongercumulativetimethatInternet
ExplorerwasinfocusonUserAsdesktop.
UserAalsoseemstobemuchbusierinInternetExplorerthaninNotepad.ThisisindicatedbythecolorofUser
AsInternetExplorerrectangle.Theredder,brightercolorreflectsalargenumberofrecordedkeystrokeevents,
roughly120perminute.
Incontrast,UserBsheatmapshowscompletelydifferentuseofthesameapplications.Weknowfromthesize
oftherectanglesthatUserBspentmuchmoretimeinNotepadthanInternetExplorer.However,UserB
recordedonly1.5keystrokesperminuteinNotepad,versus300perminuteinInternetExplorerforamuch
shorterperiodoftime.
Clickingaheatmapcellopensthecorrespondinguserperformancehistogram.Seethenextsection.
Heat Map Color and Size Relationships Simplified

Application in focus: 35 minutes Smaller
rectangle, less time in focus
Notepad
Keystrokes: 200 Darker color, less
Desktop User keystrokes
Internet Explorer
A
Application in focus: 300 minutes Large rectangle, longer time in focus

Keystrokes: 36,000 Redder, brighter color, more keystrokes
Application in focus: 35 minutes Smaller

Internet rectangle, less time in focus
Explorer Keystrokes: 10,500 Redder, brighter
color, more keystrokes
Desktop User
Notepad
B
Application in focus: 300 minutes Large rectangle, longer time in focus

Keystrokes: 200 Darker color, less keystrokes
Histograms
HistogramsareverticalbarchartsthatrepresentthedistributionofRuntimeuserperformanceforaselectedhigh
levelevent(i.e.,reportmetric).ExamplesareshowunderApplicationActivityReportHeatMapsandHistograms
onpage 610,ApplicationUserPerformanceReportsonpage 612,andProcessUserPerformanceReportson
page 615.
Individualuserperformanceforthereportmetricfallsintoranges(orbins).Achartbarisdrawnforeachrange.
Thebarheightcorrespondstothenumberofusersinthatbin/class;theyaxisindicatestheusercount,andthe
percentageofreportingusersisshownasaboxsuperimposedoverthetopofagivenbar.OpenSpanServerreports
usetwotypesofhistograms,ApplicationUserPerformanceandProcessUserPerformance.
OpenSpan Server 5.2 Reports and Graphs | Accessing Reports and Graphs
AccessingReportsandGraphs
Selection
TheOpenSpanServerReportsandGraphsfacilityisavailableviathemainReportsandGraphsmenu.
1. SelectReportsandGraphs.Thedropdownmenudisplays.
2. Selectareport.
Singlereportsdisplayreportresultsforonecaseatatime.
Comparativereportstakethesinglereportsandstacktwoofthemsidebyside.
OpenSpan Server 5.2 Reports and Graphs | Accessing Reports and Graphs
ReportControlsandOptions
Anumberofthestandardreportshaveadditionalonscreenchoices.
Exportlink:Exportgraphordetail(grid)datatoacommaseparatedvaluefile.Graphdatadoesnotincludedetail
onspecificruntimeuserperformance.
ShowDetails(togglestoHideDetails)link:DisplaysadatagridunderthereportlistingeachRuntimeuserwith
theirperformanceonthereportmetricandapplication/processdurationsuchasthisexample.
OpenSpan Server 5.2 Reports and Graphs | Single Reports
SingleReports
SinglereportsprovidearichdatareturnagainsttheselectionofaGrouporspecificUseroveraday,week,ormonth.
ApplicationActivityReports
ReportCriteria
TheApplicationActivityreportletsyouselectthefollowingcriteria.
TABLE 2. ApplicationActivityReportsCriteria
Selection Details
Metrics KeystrokeCount
ErrorKeystrokes
MouseClickCount
MouseWheelCount
CopyCount
PasteCount
CutCount
WindowMove/ResizeCount
ScrollCount
KeystrokeErrorRatio
TotalCut/Copy/Paste
ApplicationChurn
ActivityPeriod Day
Week
Month
GrouporUser(seeTo AllUsers
chooseGroupsorUsers SelectedGroup
onpage 68)
SelectedUser
TochooseGroupsorUsers
ThissteplistdescribestheassignmentofGroupsorUsersforthereport:
1. SelectSelectedGrouporSelectedUserfromthedropdownlistbox.ThedefaultisAllUsers.
2. UsetheSearchboxasaquickshortcutifthelistislong.
3. ClicktheGrouporUserofyourchoice.
4. ClickOK.
ApplicationActivityReportHeatMapsandHistograms
ForApplicationActivityHeatMapseachrectangle,orcell,representsanindividualapplicationusedduringthe
selectedreportingperiod.Thesizeofeachcellcorrespondstothetotaltimetheapplicationwasinfocusforall
reportinguserscombined.Cellcolorandpositioncorrespondstothereportmetric.Thedeeper(brighter)thered
color,andthecloserthecellistothetopleftofthereport,thegreaterthemetricvalue.
Eachheatmaprectanglecanbeclickedandexpandedforfurtheranalysis.
Note:Thedrillthroughreportincludesbreadcrumbstoreturntotheparentheatmap.
ApplicationUserPerformanceReports
TheApplicationUserPerformancereportfunctionsthesameasComparativeApplicationActivityReporton
page 616,exceptitaddsApplicationDurationundermetrics.Thisdisplaysthelengthoftimethatuserapplications
wereinfocusonthedesktop.
Thisreporthistogramexamplerepresentsuserperformanceforahighleveleventmetric(e.g.,keystrokes)inall
applicationsduringtheselectedreportingperiod.TheYaxis(vertical)showsthenumberofuserswithineachbin
(i.e.,frequency)andthexaxis(horizontal)showshowusersperformedontheselectedmetric.
ProcessActivityReports
TheProcessActivityreportusesthesamecriteriaastheApplicationUserActivityreport,exceptitconcernsthe
processesdefinedintheOpenSpanServerProcessesgrid.Withthisreportitspossibletodisplayandcomparethe
samemetricsforthebusinessprocessesinuse.
Processeventsaccumulateontheclientsidestartingwhenanapplicationcomesintofocusandthenaresentasa
groupwhentheapplicationlosesfocus,insteadofeventbyeventasinpreviousreleases.Thismakesreporting
comparisonsfasterandmoreefficient.
ProcessActivityReportHeatMaps
EachcellofaProcessActivityHeatMaprepresentsanindividualprocesscompleted(i.e.,startedandstoppednot
abandoned)byoneormoreOpenSpanRuntimeuserssubmittingprocessstartandstopeventstotheOpenSpan
Serverduringtheselectedreportingperiod.
ProcessesareboundedbystartandstopeventsidentifiedeitherinOpenSpansolutionautomationsormanually
usingtheOpenSpanRuntimeProcessToolbar(seeProcessToolbaronpage 57).Aprocesswillgenerallyuseone
moreapplicationsandthecombinedapplicationactivityforallreportingRuntimeusers,withintheboundsofa
specificprocess,determinesthesize,colorandpositionofaheatmapcell.
Thesizeofeachcellcorrespondstotheduration(i.e.,totaltimetheprocesstooktocompleteforallreportingusers
combined).Cellcolorandpositioncorrespondstothereportmetric.Thedeeper(brighter)redincolorthecell,and
thecloserthecellistothetopleftofthereport,thegreater(higher)themetricvalue.
UsetheDrillthrulinktoexpandthereportandshowtheapplicationsusedbythespecificprocess.
Thedrillthroughreportinheritsthemetricandreportingperiodfromtheparentheatmap.Thiscannotbechanged
inthedrillthroughreport.
Note:Thedrillthroughreportincludesbreadcrumbstoreturntotheparentheatmap.
ProcessUserPerformanceReports
Andfinally,theProcessUserPerformancereportusesthesamecriteriaastheApplicationUserPerformancereport
addingApplicationDurationbutappliestotheactiveProcesses.TheProcessUserPerformancehistogram
representsuserperformanceforahighleveleventmetric(e.g.,keystrokes)foraspecificprocessduringtheselected
reportingperiod.TheYaxis(vertical)showsthenumberofuserswithineachbin(i.e.,frequency)andthexaxis
(horizontal)showshowusersperformedontheselectedmetric.
OpenSpan Server 5.2 Reports and Graphs | Comparative Reports
ComparativeReports
Comparativereportsletyoubuildtworeportsforsidebysidecomparisonusingthecriteriafromthesinglereports
describedinSingleReportsonpage 68.
ComparativeApplicationActivityReport
Thisreportallowsacomparisonofeventsforapplicationsbyuserorgroup.Fordetails,seethesimilarApplication
ActivityReportsonpage 68.Theexamplebelowshowshowametric(ApplicationChurn)foroneuser(left)canbe
comparedwiththesamemetricforaGroup(Users,right)overagiventimeperiod.
ComparativeApplicationUserPerformanceReport
ThisreportaddstheApplicationDurationmetricreportingtotheComparativeApplicationActivityReport.
ComparativeProcessActivityReport
BasicallythesamereportastheComparativeReportsonpage 616,butallowscomparisonsofGroupsandUsers.
ComparativeProcessUserPerformanceReport
ThisreportcomparestwosetsofvaluesinthesamefashionastheComparativeApplicationUserreport,butaddsa
ProcessdropdownselectionoftheProcessesdefinedintheOpenSpanServerProcessesgrid.

OpenSpan Server 5.2 Admin and User Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

OpenSpan Server 5.2 Admin and User Guide

Uploaded by

Copyright:

Available Formats

OpenSpanServer5.

Chapter2 OpenSpanServer5.2InstallationandStructure ......................... 21

Chapter4 OpenSpanServer5.2AdministrationandManagement ............ 41

Delete .................................................................................................................................. 443

Chapter5 OpenSpanRuntime5.2Configuration ....................................... 51

Chapter6 OpenSpanServer5.2ReportsandGraphs ................................. 61

Events Replicate Event Table

Raw Event Tables

OpenSpan Event Queue

ThisdiagramisthesameasFigure 3,AddEventProcessorWindowsServices,onpage 16exceptthatitshows

OpenSpan Event Queue

Ifyouare... Thencheckout... Andpayparticularattentionto...

ABusinessAnalystmanaging GroupsandUserson 46 AddingGroupson 414

Ifyouare... Thencheckout... Andpayparticularattentionto...

ARuntimeuserofdesktop RuntimeMenuon 54;Process

<Server serverName="DEFAULT" serverAddress="10.0.3.9" serverURL="http://

Heat Map Color and Size Relationships Simplified

Application in focus: 300 minutes Large rectangle, longer time in focus

Application in focus: 35 minutes Smaller

Application in focus: 300 minutes Large rectangle, longer time in focus

You might also like