ArcGIS Living Atlas Content Validator

This package provides validation and scoring rules for curating content in the ArcGIS Living Atlas.

Background

The ArcGIS Living Atlas is a collection of curated GIS content. This content is submitted for inclusion in the Living Atlas by Esri Cartographers and Data Scientists from around the world.

The Living Atlas consists of items in ArcGIS Online. Users can nominate items for inclusion in the Living Atlas. During the nomination process, items are validated and scored based on the completeness of the item and its metadata. The score helps to identify key characteristics of your item that will ensure others can find and understand the item.

The details page of an item in ArcGIS Online provides information about the item being shared, along with additional information to help others find and use the item. The goal is to create a well-documented item description page so that others will understand what they have found, where the data is from, and what they can expect to see when opening the item.

Installation

To install this Package, simply run:

npm install @vannizhang/living-atlas-content-validator

Example

Here is an example of how to validate an item and the item owner's user profile in ArcGIS Online:

import { validate } from ' @vannizhang/living-atlas-content-validator';

const validationResult = validate(
    // ArcGIS Online Item
    {
        id: 'fd61b9e0c69c4e14bebd50a9a968348c',
        owner: 'esri',
        title: 'Sentinel-2 Views',
        snippet: 'Sentinel-2, 10m Multispectral, Multitemporal, 13-band images with visual renderings and indices...',
        type: 'Imagery Layer ',
        thumbnail: 'thumbnail/thumbnail1577152707660.jpeg',
        access: 'shared',
        description: 'Sentinel-2, 10, 20, and 60m Multispectral, Multitemporal, 13-band imagery is rendered on-the-fly and available for visualization and analytics...',
        // this is a custom property that provides the dimension of the thumbnail image
        dimension: {
            width: 400,
            height: 240
        }
    },
    // ArcGIS Online User Profile
    { 
        fullName: 'Esri Inc.',
        description: 'Esri develops geographic information systems (GIS) solutions that function as an integral component in nearly every type of organization....',
        thumbnail: 'esri_150.jpg',
    }
);

Here is an example of output returned by validate:

{
    "id": "12345",
    "totalScore": 60,
    "validatedItem": {
        "access": {
            "property": "access",
            "label": "Must be public",
            "maxScore": 9,
            "score": 2,
            "messages": [
                {
                    "code": "",
                    "message": "Must be public"
                }
            ],
            "weight": 4,
            "critical": true
        },
        "accessInformation": {
            "property": "accessInformation",
            "label": "Add credits",
            "maxScore": 8,
            "score": 0,
            "messages": [
                {
                    "code": "",
                    "message": "Add credits"
                }
            ],
            "weight": 7,
            "critical": false
        },
        "description": {
            "property": "description",
            "label": "Improve description",
            "maxScore": 8,
            "score": 1,
            "messages": [
                {
                    "code": "",
                    "message": "Description has no links"
                },
                {
                    "code": "",
                    "message": "Description too short"
                }
            ],
            "weight": 3,
            "critical": true
        },
        "layerCount": {
            "property": "layers",
            "label": "Reduce the number of layers",
            //...
        },
        "licenseInfo": {
            "property": "licenseInfo",
            "label": "Improve access and use constraints",
            //...
        },
        "snippet": {
            "property": "snippet",
            "label": "Improve summary",
            //...
        },
        "ssl": {
            "property": "ssl",
            "label": "Use HTTPS in the URL",
            //...
        },
        "tags": {
            "property": "tags",
            "label": "Improve tags",
            //...
        },
        "thumbnail": {
            "property": "thumbnail",
            "label": "Improve thumbnail",
            //...
        },
        "title": {
            "property": "title",
            "label": "Improve title",
            //...
        }
    },
    "validatedProfile": {
        "userProfileDescription": {
            "property": "userProfileDescription",
            "label": "Improve profile description",
            "maxScore": 7,
            "score": 1,
            "messages": [
                {
                    "code": "",
                    "message": "Profile description does not contain an email"
                },
                {
                    "code": "",
                    "message": "Profile description does not contain a link"
                },
                //...
            ],
            "weight": 12,
            "critical": true
        },
        "userProfileFullName": {
            "property": "userProfileName",
            "label": "Improve profile full name",
            //...
        },
        "userProfileThumbnail": {
            "property": "userProfileThumbnail",
            "label": "Improve profile thumbnail",
            //...
        }
    },
}

Configuration

You can set the language to be used in the output validation messages with the setStrings function. Here is an example:

import { setStrings } from `@vannizhang/living-atlas-content-validator`

// You can choose any of these six languages: 'en', 'de', 'es', 'fr', 'ja', 'pt-br'
setStrings('de'); // use German 

License

Copyright © 2022 Esri

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 file.