TRAINING GUIDE Overview f Lucity Spatial
Overview f Lucity Spatial In this sessin, we ll cver the key cmpnents f Lucity Spatial. Table f Cntents Lucity Spatial... 2 Requirements... 2 Setup... 3 Assign default map services... 3 Cnfigure System Settings... 4 Cnfigure Default Gecding Service... 4 Hw it wrks... 5 Behind-the-scenes... 5 Trubleshting... 6 Generating Live Wrk Layers... 7 Publishing Live Wrk Layers... 12 Data Quality Tl... 14 Overview f Lucity Spatial (v2016 & 2016r2) 1
Lucity Spatial Since versin 2014 Lucity ffers the ability t stre wrk rder and wrk request spatial cmpnents directly in the Lucity database. String the spatial cmpnent (gemetry) in the Lucity database allws fr faster analysis, better efficiency, and mre flexibility when shwing these lcatins in a map. Requirements A few requirements must be met befre implementing Lucity Spatial: The Lucity Wrk database must be ne f the fllwing: SQL Server 2008 r higher Oracle with MDSYS.SDO_GEOMETRY data type enabled The Lucity Services must be installed Each Lucity linked feature class must be assigned t a default map service Lucity linked feature classes must be ne f the fllwing gemetry types: Pint Line (including multi-line features) Plygn (including multi-plygn features) System Settings in UI Admin must be cnfigured: The Enable Lucity Spatial system setting must be set t TRUE The Max amunt f days t prcess spatial histry must be set t a value greater than 0 A default Gecding Service must be defined With versin 2016r2 this is set in UI Admin s GIS Services The gecding service must be n versin 10.2 r higher (supprting single line input) Ntes: Overview f Lucity Spatial (v2016 & 2016r2) 2
Setup Assign default map services The Lucity Spatial Updater service interacts with map services in rder t btain an asset s gemetry t stre in the Lucity database. T btain the gemetry fr an asset the fllwing prcess is fllwed: 1. Determine the list f feature classes linked t a given asset type 2. D the fllwing fr each feature class until the asset gemetry is returned: a. Determine the map service i. If a map service is defined at the feature class level then that ne will be used. ii. If a map service isn t defined at the feature class level then the ne defined at the gedatabase level will be used. b. Query the map service fr the asset i. If it exists, return the gemetry ii. If it desn t exist, mve t the next feature class The gedatabase map service is defined in the Gedatabase Cnfiguratin Tl in ArcCatalg. It is listed under the Cnnectin Prperties tab when yu have a gedatabase nde selected. A service defined at the feature class level will be listed under the Edit Map Service tab when yu have the feature class nde selected. Overview f Lucity Spatial (v2016 & 2016r2) 3
Cnfigure System Settings In UI Admin, system settings the fllwing must be cnfigured: 1. On the General tab, set the Enable Lucity Spatial t TRUE 2. On the General tab, adjust the Max amunt f days t prcess spatial histry (must be greater than 0). a. Example: If yu enter 180, the Lucity Spatial Updater will prcess all wrk rders/requests mdified tday and within the last 180 days. b. Nte: The Lucity Spatial Updater service is reliant n back end cnfiguratin that was added t the Lucity database in 7.4. Therefre, depending n yur upgrade histry there culd be a few years wrth f lcatins that have the ptential t be prcessed. Cnfigure Default Gecding Service In UI Admin s GIS Services, the fllwing must be cnfigured: 1. On the Utility Services tab, cnfigure a gecding service with Lucity and make sure t set a default as shwn in the red utline belw: Overview f Lucity Spatial (v2016 & 2016r2) 4
Hw it wrks Behind-the-scenes The fllwing Lucity tables and views are used with Lucity Spatial: WKSPATIALCHANGE This table is updated autmatically by the Lucity applicatin with any change made t Wrk Requests and Wrk Orders that deal with lcatin infrmatin. The Lucity Spatial Updater service prcesses these recrds by btaining their crrespnding gemetries WKGEOMPT- This table stres all pint gemetries ppulated by the Lucity Spatial Updater service retrieved when prcessing WKSPATIALCHANGE WKGEOMLN- This table stres all linear gemetries ppulated by the Lucity Spatial Updater service retrieved when prcessing WKSPATIALCHANGE WKGEOMPG- This table stres all plygn gemetries ppulated by the Lucity Spatial Updater service retrieved when prcessing WKSPATIALCHANGE Overview f Lucity Spatial (v2016 & 2016r2) 5
GIS_WKGEOMLNRQ- View shwing all linear Request lcatins GIS_WKGEOMPGRQ- View shwing all plygn Request lcatins GIS_WKGEOMPTRQ- View shwing pint Request lcatins (asset nly) GIS_WKGEOMPTRQLOC- View shwing pint Request lcatins (address and x/y) GIS_WKGEOMLNWO- View shwing all linear Wrk Order lcatins GIS_WKGEOMPGWO- View shwing all plygn Wrk Order lcatins GIS_WKGEOMPTWO- View shwing pint Wrk Order lcatins (asset nly) GIS_WKGEOMPTWOLOC- View shwing pint Wrk Order lcatins (address and x/y) Trubleshting Smetimes there may be recrds that fail t prcess. When a spatial change recrd cannt be prcessed it is kept in the Spatial Change table (Lucity.WKSPATIALCHANGE) and marked with an errr cde. These recrds are kept in the Spatial Change table fr 30 days after they were initially prcessed. After 30 days they are deleted. The errr cdes are fund in the SPCH_SU_ERROR clumn: MissingData Usually means that there was an issue with the data in WKSPATIALCHANGE like the mduleid is invalid; ParentRecID is invalid, invalid x/y data, etc. ServiceIssue This ccurs if there isn t a map service assciated with the feature class r the feature class related t the asset type is nt in the service NGemetry Returned if a recrd's gemetry was fund but was empty, if the indexer was unable t gecde an address, r if there was an issue with the REST call t retrieve the gemetry. NLucityRecrd Returned if the assciated recrd n lnger exists in Lucity Hw t Prcess Recrds that have failed: 1. In the WKSPATIALCHANGE table find the recrd that failed 2. Review the errr cde fr the recrd and reslve the prblem 3. Delete the cntents f the SPCH_GUID and SPCH_SU_ERROR fields fr the recrd 4. The next time the Lucity Spatial Updater service runs it will attempt t prcess the skipped recrd again. Overview f Lucity Spatial (v2016 & 2016r2) 6
Generating Live Wrk Layers After yu setup the Lucity Spatial Updater and the service has begun prcessing wrk lcatins yu are ready t display and interact with the results. The Lucity GIS extensin in ArcMap prvides sme utf-the-bx tls t facilitate the generatin f layers that can be used t shw the wrk lcatins. 1. In ArcMap n the Lucity tlbar, click n the buttn. The fllwing pp-up will appear: 2. Select the type f wrk lcatin yu wuld like t create frm the drp dwn list and Click OK. 3. The assciated tl will appear allwing yu t prvide further details specific t the type f wrk. Overview f Lucity Spatial (v2016 & 2016r2) 7
4. Fill ut the frm based upn the varius settings and ptins that are available. a. Nte: All request and wrk rder fields are available fr use in the resulting layer. T adjust which fields shuld be included in the results yu will want t check the Select which fields shuld be included in the resulting layer(s). Overview f Lucity Spatial (v2016 & 2016r2) 8
5. Click Display nce yu are ready t generate the layers. Once the tl has cmpleted prcessing, the resulting gruped layer will be added t the map. Examining the resulting layers: The tl will generate 4 layers: Pint layer fr address and x/y data Pint layer fr asset data Plyline layer fr asset data Plygn layer fr asset data General- The resulting layer name and descriptin is determined by the user specified settings that were defined n the Lucity Spatial Views frm. Nte: The Descriptin will start with LucitySpatialWrk: r LucitySpatialRequest:. Yu can mdify the descriptin, but the descriptin must start with these key wrds. This is a requirement if these layers are t be used in the Lucity Web Map. Overview f Lucity Spatial (v2016 & 2016r2) 9
Surce- The surce used fr the wrk layers is the GBAWrk database. The tl cnnects t the GBAWrk database as Lucity_User. Yu will need t knw this infrmatin if yu wish t publish the layer as a service later. Symblgy- The default fr the tl is t symblize based upn the Wrk Categry Text (RQ_CAT_TY, WO_CAT_TY). The symblgy can be altered by ging t the layer s symblgy tab. Nte: The symblgy is nt dynamic. In ther wrds, if a new wrk rder/request is created that as is assigned t a categry that hasn t been used yet- it will nt shw in the layer. T accunt fr this situatin: Adjust the symblgy t include the <All ther values>. Even thugh yu visually wn t be able t tell what wrk categry the wrk item has been assigned, at least it will be visible in the layer. Occasinally yu will want t update the symblgy f the layer by using Add All Values. Overview f Lucity Spatial (v2016 & 2016r2) 10
Definitin Query- A definitin query was applied t the layer if the ptin t use an existing filter r an advanced filter was specified n the Lucity Spatial Views Frm. Time- If the ptin t enable time n the generated layer was set, then the Time tab n the resulting layer will have sme additinal settings that can be cnfigured. Custmizatins t the layer settings (symblgy, labelling, etc) can be saved and used as the default fr future runs f the Lucity Spatial View tl. Fr mre infrmatin n hw t save these settings refer t the Lucity Symblgy default tl: http://help.lucity.cm/webhelp/v140/gis/index.htm#25859.htm The Lucity extensin tries t handle all the situatins needed with generating query layers; hwever, there may be sme additinal requirements needed based upn the underlying database platfrm. Refer t http://resurces.arcgis.cm/en/help/main/10.2/index.html#/preparing_t_use_query_layers/ 00s500000032000000/ fr mre infrmatin. Overview f Lucity Spatial (v2016 & 2016r2) 11
Publishing Live Wrk Layers After yu have created the live wrk layers, yu can distribute access t thse layers fr users n the ArcGIS Desktp platfrm. If yu wish t prvide access t thse layers in the Lucity web map, r any f the Lucity mbile applicatins then yu will need t create a map service that cntains these layers. There is mre than ne way t publish a map service; the fllwing is an example f hw yu can create the service frm within an ArcMap dcument (.mxd). In ArcMap add the live wrk layers t the map and custmize prperties s the map is displaying the data as yu like. In ArcMap, click File>>Share As>>Service. Befre yu publish the service, yu will want t analyze. The fllwing are sme cmmn warnings/errrs fund when publishing the Lucity Live Wrk Layers and hw they can be reslved: Layer s data surce is nt registered with the server and data will be cpied t the server i. This must be fixed; therwise, the layer will nt be refreshed with updates. ii. T reslve, right-click n the errr and select the Register Data Surce With Server ptin. Overview f Lucity Spatial (v2016 & 2016r2) 12
iii. If needed, yu may need t manually create a db cnnectin t GBAWrk using Lucity_User. Shape field is nt visible i. This must be reslved befre publishing ii. T reslve, right-click and select Make Shape Field Visible Once yu reslved all the issues, yu can publish the service. Once published, yu can add this service t the Lucity web map r mbile applicatins. The Lucity Live Wrk layers are essentially query layers. They are pinting t varius spatial views in the Lucity database. These layers are live meaning if a wrk lcatin is added/updated/deleted this infrmatin autmatically refreshed in the live wrk layer. Ntes: Overview f Lucity Spatial (v2016 & 2016r2) 13
Data Quality Tl The Lucity Data Quality Services Tl (DQS) was mdified in 2016r2 s there is nw an ptin t run queries n the wrk spatial tables. In additin, there is an ptin t fix the issues fund. Nte: This functinality is currently nly available fr SQL Server database clients. The DQS tl queries the Lucity spatial tables (WKGEOMPT, WKGEOMLN, WKGEOMPG) fr the fllwing data prblems: Features f a different gemetry type than what is suppsed t be in the table (i.i. pints in the plygn table). This is marked as an errr because this will cause prblems with functinality. Features where the spatial reference des nt match that f the Operatinal WKID as listed in Lucity system settings. This is marked as a warning because this may impact certain functinality. Features that have invalid gemetry (i.e. lines that intersect themselves, incmplete plygns, multiple vertices n tp f each ther, etc.). This is marked as an errr because this will cause prblems with functinality. The queries are in a new query suite titled Spatial and wrk the same way as ther queries in the prgram: Overview f Lucity Spatial (v2016 & 2016r2) 14
Once the query has been ran, if it is a query fr incrrect gemetry types, then a buttn appears t fix the selected recrds in the bttm grid: 1. When yu click the Fix Selected (Spatial) buttn, the fllwing prmpt will appear cnfirming that the user wants t prceed t crrect the data. 2. After clicking Yes, the invalid gemetry recrd is inserted int the crrect gemetry table and will be deleted frm the current gemetry table. After the fix is cmplete, a prmpt similar t the fllwing will appear infrming the user f the results f the crrectin: Ntes: Overview f Lucity Spatial (v2016 & 2016r2) 15