esri / solutions-data-dictionary-viewer Goto Github PK

View Code? Open in Web Editor NEW

13.0 8.0 10.0 2.62 MB

An Interactive Viewer to View Feature Service Details

License: Apache License 2.0

CSS 0.45% JavaScript 1.16% TypeScript 98.34% SCSS 0.05%

feature-service data-dictionary reactjs

solutions-data-dictionary-viewer's Introduction

Data Dictionary Viewer

An application that allows viewing and searching of details of a feature Service in an user friendly way.

Features

Tree view of your feature service
Search for finding things in a service
Cards of each aspect of the service

Installation

Make sure you have ArcGIS Experience Builder (ExB) Developer Edition installed on your machine.
Fork and then clone the repo. Copy the folder "service-explorer" into the your <ExB install location>\client\your-extensions\widgets
In a command prompt, navigate to <drive letter>:\<ExB install location>\server. Type npm ci. After it completes, type npm start
Open a second command prompt, navigate to <drive letter>:\<ExB install location>\client. Type npm ci. After it completes, type npm start. Make sure you see the widget copied over in the command window.
Launch ExB in the browser (usually http://localhost:3000/). Create a new app (full screen blank preferred).
On the left hand panel in th widget list, scroll down and locate the Service Explorer widget and add it to the canvas.
On the configuration panel (right side), click the Select Data button. Add a new data source from the slide out panel.
Look up and add data by URL and paste in your feature service rest endpoint (Utility Network Service only currently). Select any one of your layers as the control. You should see the URL textbox filled out with the path.

At this point you have 2 paths to choose.

If you want to run the Data Dictionary hitting your live service, then you are finished with the configuration. Proceed to step 10. If you want to run the Data Dictionary hitting a cache of your service (so it is not dependent on it being live and running), follow these additional steps:
- Check the Use cache instead of service checkbox
- Give your cache a name
- Press the Build Cache
- This will create an item in your organization (currently org which you signed into Experience Builder). Once the cache is built, access the item in your org and share it publicly.

Optionally, if you want to be able to load other services via a url parameter check the box labeled "allowurlLookup".

On the "General" tab of the configuration panel, define the height and width as 100%.
Save the application and "Preview" or "Publish".
Since this is a custom widget you will need to deploy the application to a web server if you want to share it with your company. To do so, click the 3 ellipses next to the publish button. In the menu, click the Download button.
Extract the download zip into your web server and use a web browser to access it.

Requirements

Install Node JS
Install ArcGIS Experience Builder
Web browser with access to the Internet

Resources

Usage

To load a specific cache, add the cacheId url parameter pointing to the cache item in your AGOL/Enterprise. Make sure to share the item public.

?cacheId=<enterprise/arcgis online item id>

The application loads a default feature service defined in the configuration. You can load your own by adding a url parameter if allowed in the configuration. at the end of the url, type:

?lookup=url to your feature service

If you want a specific card to load on startup, add it as a url parameter with this pattern <name of card>:<type of card>,<name of card>:<type of card>, etc

?startup=Water Device:Layer

Issues

Find a bug or want to request a new feature? Please let us know by submitting an issue.

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

Licensing

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A copy of the license is available in the repository's license.txt file.

solutions-data-dictionary-viewer's People

Contributors

Stargazers

Watchers

Forkers

feisishui epekcan pjmclaughlin1979 stevengugis mnsr002 spdickinson isabella232 tm-ssmic jegannman omalleyandy

solutions-data-dictionary-viewer's Issues

Layer cards should have descriptions

Subtype Card - Enable hyperlink inline for domain information

With the ability to see domain details, close and open as a card

Add hover text that explains what each button is for on the left-hand side. Also increase size of button by 25%.

Change text in Attribute Rule Properties

Change text for “This rule can be:”

Expose Search on Favorites to filter or sort items in list

remove quotes on strings

First!

These quotes are not needed.

Network Attribute cards linking for field opens inncorrect card

Issue when switching from 2 to 1 pane.

When dividing the main stage into 2 panes and adding cards on both sides, all cards included in the right-hand side disappear when switching back to single pane instead of stacking into the single pane.

Support more than 1 feature service

Subtype Card - Links needs to look more like a button or something that shows they are collapse content

for instance fields, hard to see it is a collapsed pane, looks more like a link

Make CAV items in list clickable so they set the active value of the dropdown

Relationship Card update

Change from the below card

To something like

Enhancement ideas

General comments: I feel like it is easy to get lost navigating through the cards, so if there is any way to signify what is open, or jump to what is open, that would be helpful.

When I choose Anode or Filter in the Subtypes list, it would be helpful to do something to signify that these cards are open, maybe bold the subtypes in the list.
In the Filter card, When I expand the Participating Attribute rules section, and click on an Attribute rule, I don't know automatically that it has opened a card because it is out of my sight. Can you either bold or highlight this rule when the card is open or jump to the newly opened card?
If there is no option to open a card, remove the open card symbol. (Ex. Water Vault Boundary > Subnetwork name > Domain)

Change "Search Your Service" for "Add Filters

Need an option to clear or minimize all open cards

Feature Service Level Card

Need to determine what the user would like to see in a card at the highest level

Need scroll bar when card is off the edge based on resolutions

Subtype Card - Enable Field hyperlink

This would present the field details inline, with an option to close or open the field card

Subtype Card - Present domain description and code in default value column

Change icon for opening a card from within a card.

Change how these open. Also, most users recognize this symbol

as meaning “copy”.

Increase spacing between header and “Subtype Properties” text.

Should cards have a icon or someone to know the type of card you are looking at

How do I know I am looking at a subtype card

Simplify Stats information content.

Simplify Stats information content. Also, what does (11/11) mean?

Water Utility Network layer not clickable

This element is not clickable but the controller dataset element is clickable (same level)

Change card title from All Fields to Fields

Update the Rules table format

Change the header to be non-hoverable and make it look like the other table headers. Split out Rules From and Rules to header text to be outside of the tables.

Increase size of + and – symbols or replace with drop down arrow as in other ArcGIS UIs.

Increase the size of + and – symbols or replace with a drop-down arrow as in other ArcGIS UIs. ( > )
For example:

Look at ability to see all the open cards in a single view and shuffle things around

This could let me sort them and back remove cards.

Subtype Card - Show layer name on the card so you know which layer it belongs too

Subtype Card - Do we need the Subtype description in the header and display?

All TOC elements get highlight at same level

If you select the Attribute Rules in the TOC for Crossarm it highlights all Attribute Rules elements in the TOC.

Expected Behavior:
Only the card that has been opened should be highlighted in the TOC.

Look at a search or filter on the main card page

this would let me show only Subtype Cards or cards with a key value of X

Add open to card in drop down of items, such as domain

Change Diagrames name to Configurations or something that does not refer to another esri capability

Connectivity rules

Add connectivity rules to the Asset Type cards

Display - Increase text size

Increase text size, mostly for the service name. Text size could also be increased for all elements listed in the left pane (Layers, Tables, Relationships, Domains)

Subtype Properties Card Fields

In the fields table, of the subtype properties, we should split out the field name and the alias.

Subtype Card - Display Field Alias in a stack with Field Name on field

Missing underbar in the box around Domains

When you first open the data dictionary, it appears that there is a line missing below the Domains section.

Display issue - allow for text wrapping.

For example, asset types under domains are hidden in the pane.

Add instructional text to main view.

Add instructional text in the empty view pane (or Main Stage / Main View? - how should we name this/ ).
Use example from Operations Dashboard:

Layer navigation issues

Other sections disappear when the Layers section expanded. I think this would happen with any section that is expanded past the bottom of the page. No scrolling option is presented to reach those sections, you must retract the layers before you can scroll to the next section.

Expand Layers in the TOC
Scroll down, all other sections have disappeared.

Asset Type cards - also to include domain information.

Include domains information in “Fields” for each one of the fields. Ideally, full domain values are also provided here rather than the user having to find the domain in the separate Domain section. It appears that this has been added for some fields, but I notice that it is missing for assettypes.

Setup could be similar to this: