San Francisco: Final Metadata Standard
 Share
The version of the browser you are using is no longer supported. Please upgrade to a supported browser.Dismiss

View only
 
ABCDEFGHIJKLMNOPQRSTUVWXYZAA
1
No.FieldGroupConsensusConditionDiscussion/JustificationDefinitionPermitted valuesType of valueExistingComments on feedback
2
1TitleBasic DescriptiveRequiredTitle helps discover and select datasets as well as differentiate between similar datasets.Human-readable name of the asset. Should be in plain English and include sufficient detail to facilitate search and discovery. Avoid acronyms.Text with character limit.Open textYesWill provide guidance to promote consistency in naming.
3
2DescriptionBasic DescriptiveRequiredDescription helps discover and select datasets as well as differentiate between similar datasets.What the dataset describes. Provide a longer description of the data that can be readily understood by non-technical users.Text with character limit.Open textYesWill provide guidance to promote consistency and to address common questions.
4
3CategoryBasic DescriptiveRequiredCategory provides a distinct navigation method and groups similar datasets together regardless of sourceThe category of the data set identified by the list of possible values. If a data set can fall into multiple categories, select the one which is most significant. This list will be subject to change on an ongoing basis.Drop down menu:
City Infrastructure
City Management and Ethics
Culture and Recreation
Economy and Community
Energy and Environment
Geographic Locations and Boundaries
Health and Social Services
Housing and Buildings
Public Safety
Transportation
Drop downYes
5
4DepartmentBasic DescriptiveRequiredDepartment name is needed for navigation and to ensure a single responsible department.The department that collects and manages the data as the canonical source.Drop down menu. List of departments predefined.Drop downYes
6
5Data dictionaryDetailed DescriptiveRequiredData dictionaries are essential to understanding how the data can be used, whether it is to understand fields, differences in fields, and assessing whether or not the data is appropriate for the intended use. However, we want to strike a balance between making it easy to publish and providing enough information for data users. The existing means of adding data dictionaries are either burdensome or clumsy. The implementation of this requirement must be flexible and provide sufficient guidance.Data dictionary should explain the fields within the dataset in terms of their definition, type, size, and any other pertinent information that describes the datasetTBD as part of metadata rollout.OtherWill provide guidance on options to meet and complete this requirement (e.g. uploaded documents, inputs into Socrata, links to external resources/documents).
7
17Row CountDetailed DescriptiveConditionalRequired if automatically provided by platform.Row count is a useful indicator of dataset size. However it is too burdensome to manually generate and update this.Auto generated by platformAuto-generatedYes
8
19Geographic unitDetailed DescriptiveConditionalRequired if data includes a geographic columnGeographic unit indicates the geographic level at which the dataset is collected; also helps us track the need to aggregate or summarize dataAt what geographic unit is the data collected? For example, if the data is collected by address, it would be Street Address.Drop down menu:
Latitude/longitude,
Street address,
Intersection or street segment
Parcel (block/lot),
Census block,
Census block group,
Census tract,
Zoning district,
Neighborhood,
Planning District,
Supervisorial District,
Zip code,
City,
Raster,
Other,
Not applicable
Drop downWill provide guidance to address common questions regarding how to select unit; Will monitor to determine need to expand on drop down menu.
9
20Temporal coverageDetailed DescriptiveConditionalRequired if a) temporal data and b) the platform automates itTemporal coverage provides an easy way to determine the value of a dataset; however, maintaining this manually is too burdensome and prone to error.The range of temporal applicability of a dataset (i.e., a start and end date of applicability for the data).Not provided by platform; Should be start and end date interval using ISO 8601.Auto-generated
10
23TagsDetailed DescriptiveOptionalTags provide a means to include technical language, secondary categories, and acronyms. While we want to encourage the use of tags, we don't believe it should be required as implementing a rigorous approach is too burdensome.Tags (or keywords) help users discover your dataset; please include terms that would be used by technical and non-technical users.TextSimple textYesWill provide guidance on how to use approrpiately.
11
24Program LinkDetailed DescriptiveOptionalProgram links can provide more information on the origin of the dataset. Not all datasets will have this information.The URL to the program area web pagesURLSimple textYes
12
25Data notesDetailed DescriptiveOptionalData notes provide an opportunity to include information not captured in other fields. Not all datasets will have this information.Are there any concerns about overall data reliability? Are there any changes in data collection or methods that the user should be aware of? Are there any constraints with data accuracy? What levels of confidence with this dataset could the user reasonably assume?Text with character limit.Open textWill provide guidance on what to include, including data sources and citations.
13
26Related documentsDetailed DescriptiveOptionalThis provides an opportunity to include forms or other types of documents that help to understand the data. Not all datasets will have this information.Related documents such as technical information about a dataset, developer documentation, etc.AttachmentsOtherWill provide guidance on documents that may be useful.
14
12Public access levelInternal ManagementRequired - PrivateWhile most data on the platform will be public, public access level gives us a means to track protected or sensitive data and provide a means for internal users to discover and access non-public data.The degree to which this dataset could be made publicly-available, regardless of whether it has been made available.Drop down menu:
Protected
Sensitive
Public
Drop down
15
13Public access level commentInternal ManagementConditional - PrivateRequired if not publicIf the data is not public, we should provide an explanation and a means for people to access it if eligible.An explanation for the selected “accessLevel” including instructions for how to access a restricted file, if applicable, or explanation for why a “non-public” or “restricted public” data asset is not “public,” if applicable. Also note options for making the data public, where appropriate, including obfuscation, aggregation, or anonymization.Text with character limit.Open textWill provide guidance on how to complete, including what options exist (e.g. aggregation, obfuscation, and anonymization) for converting protected or sensitive data into publishable data.
16
15Data Steward nameInternal ManagementRequired - PrivateWe want to include internal contacts for each dataset to support the data coordinators and to answer dataset questions. However, we do not want this public as it limits our ability to track data questions and response times. In addition, this role contrasts with the data coordinator role, which will be the initial public contact point for department datasets.Data Steward's name. Who manages the data and is responsible for making changes to the data? Who understands what the dataset includes and can answer questions about it?String (First Last)Simple text
17
16Data Steward emailInternal ManagementRequired - PrivateSee previous field 15Data Steward's email address.Email addressSimple text
18
6Last updatedPublishing DetailsRequiredLast updated gives an indication of the recency of the data, which helps users determine if it is appropriate to useMost recent date and time when the dataset was changed, updated or modified.Auto generated by platformAuto-generatedYes
19
7Frequency - data changePublishing DetailsRequiredTogether with the publishing frequency, this gives us an indication of our timeliness; It also gives data users insight into the rate of data change for planning and use.Frequency with which dataset changes.Drop down menu:
Not updated (historical only),
As needed,
Annually,
Bi-annually
Quarterly,
Bi-monthly,
Monthly,
Bi-weekly,
Weekly,
Daily,
Hourly,
Multiple times per hour,
Streaming
Drop downWill provide guidance on the difference between field 7 and 8
20
8Frequency - publishingPublishing DetailsRequiredTogether with the data change frequency, this gives us an indication of our timeliness; Understanding the frequency of publication is valuable in terms of planning and use of the dataset.Frequency with which dataset is published.See drop down for 7Drop downYesWill provide guidance on the difference between field 7 and 8
21
14License/RightsPublishing DetailsRequiredA license reduces legal uncertainty for data consumers or usersThe license with which the dataset or API is published.TBDDrop downYesWill provide depending on how many options are available; This may be the same for all datasets.
22
9Unique IdentiferWeb & TechnicalRequiredA unique dataset identifier is required for dataset management.A unique identifier for the dataset or API as maintained within an Agency catalog or database.Auto generated by platformAuto-generatedYes
23
10Permalink/IdentifierWeb & TechnicalRequiredA permalink helps provide continuity for accessing the dataset.Persistent link to the datasetAuto generated by platformAuto-generatedYes
24
11URLWeb & TechnicalRequiredA URL provides a more user friendly link.More descriptive link to the datasetAuto generated by platformAuto-generatedYes
25
18EndpointWeb & TechnicalConditionalRequired if the dataset has an API or is an APIAn API endpoint facilitates programmatic access to the data.Endpoint of web service to access dataset.Auto generated by platformAuto-generatedYes
26
21Download URLWeb & TechnicalConditionalRequired if not natively hosted on Socrata or if future platforms do not provide a download mechanism.A download URL provides access to the data for the purpose of open data.URL providing direct access to the downloadable distribution of a dataset.URLSimple textYes
27
22FormatWeb & TechnicalConditionalRequired if not natively hosted on Socrata or if future platforms do not provide multiple download mechanisms.Knowing the format for non-hosted datasets helps users determine if they can use it, including software needs.The file format, physical medium, or dimensions of the resource. Examples of dimensions include size and duration. Recommended best practice is to use a controlled vocabulary such as the list of Internet Media Types [MIME].Drop down menu: see commentDrop down
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
Loading...