Chief Information Officer
Chief Information Officer
IC Technical Specifications
CDR: Describe
Overview
The Describe specifications define requirements and provide guidelines for the realization of the CDR Describe Component as a RESTful and SOAP web service and SOAP protocol. The content of these specifications specifies the Describe Service’s behavior, interface and other aspects in detail, providing enough information for Describe Service providers and consumers to create and use CDR-conformant Describe Services.
The Describe Service exposes one required Describe Function for exposing information that describes a content collection. The exposed information, referred to as a Description, is a collection of metadata that refers to the entire content collection rather than individual content resources in the content collection. The Description can be used by Describe consumers to make smart decisions regarding the applicability of a content collection, for example, this type of information can be used by Brokered Search providers to perform type, coverage and/or content-based search query routing.
This specification supports Intelligence Community Directive 501 (ICD 501), Discovery, Dissemination or Retrieval of Information within the Intelligence Community, which establishes policies for (1) discovery, and (2) dissemination or retrieval of intelligence and intelligence-related information collected, or analysis produced by the Intelligence Community.
Compliance with this specification is measured against all aspects of the technical and documentary artifacts contained within the specification release package. This specification is maintained by the IC Chief Information Officer via the Data Standards Coordination Activity (DSCA) and Common Metadata Standards Tiger Team (CMSTT).
Value Proposition
These specifications are designed to fulfill a number of requirements in support of the transformational efforts of the Intelligence Community and Department of Defense Enterprise (IC/DoD). Features of this specification are:
-
To provide common service interfaces and a behavioral model to enable Describe consumers, such as Brokered Search providers, to discover relevant content collections from disparate collections across the IC/DoD enterprise.
-
To support the implementation of both the IC/DoD Content Discovery & Retrieval SOAP and REST Interface Specifications for CDR Brokered Search 1.1.]
Latest Approved Version
-
IC/DoD REST Interface Encoding Specification for CDR Describe, Version 1 (14 Jan 13), [13-1 Baseline]
-
IC/DoD SOAP Interface Encoding Specification for CDR Describe, Version 1 (14 Jan 13), [13-1 Baseline])
CONTENT TO COME
Chief Information Officer
IC Technical Specifications
XML Data Encoding Specification for Body Of Evidence
Overview
This XML Data Encoding Specification for Body of Evidence (BOE.XML) defines detailed implementation guidance for the XML-encoding of elements to convey a system's body of evidence, where body of evidence is the set of data that documents the information system’s adherence to the security controls applied as defined in National Information Assurance (IA) Glossary (CNSSI 4009).
This specification is intended to provide the data fields necessary to capture and convey the relevant information that would be used to facilitate the acceptance and reciprocity of established systems and their security authorizations. To facilitate this exchange, this specification has been closely aligned with Risk Management Framework Documentation, Data Element Standards, and Reciprocity Process for National Security Systems (CNSSI 1254), associated policies, and the concepts and terminology within. It seeks to encourage an exchange of CNSSI compliant system security information and authorization to promote reciprocity between agencies/organizations in XML.
This specification is maintained by the IC Chief Information Officer via the Data Standards Coordination Activity (DSCA) and Common Metadata Standards Tiger Team (CMSTT).
Technical Specification Downloads
Latest Approved Public Release:
- XML Data Encoding Specifications for Body of Evidence (V2018-APR - Standalone Package)
- XML Data Encoding Specifications for Body of Evidence (V2018-APR - Convenience Package)
- XML Data Encoding Specifications for Body of Evidence (V2018-APR - Light Package)
Mission Requirements
Information sharing with the national intelligence enterprise is increasingly dependent on the exchange of information about an exchange format. Systems, users, and developers all need a more consistent machine processable format for exchanging information describing data. This specification is a reaction to that need.
Chief Information Officer
IC Technical Specifications
XML Data Encoding Specification for Intelligence Community Docbook
Overview
This XML Data Encoding Specification for Intelligence Community Docbook (IC-Docbook.XML) defines detailed implementation guidance for xml-encoding of elements within the Intelligence Community (IC) Docbook.
The purpose of IC-Docbook.XML is to create a tailored version of the Docbook template suitable for Intelligence Community (IC) use. This specification creates a customization of Docbook that uses ISM. In doing so, the specification enables systems to explore Docbook for various documentation needs outside of PUBS.XML required uses. For example, the documents within the IC specifications are maintained. By using IC-Docbook for documentation purposes the maintenance of the content and the formatting are separated providing less distraction in producing documentation. The content is maintained in IC-Docbook, and then rendered into various output formats (e.g., PDF) in a consistent manner always. IC-Docbook is a customization of the Docbook Stylesheets to support ISM and a basic rendering.
This specification is maintained by the IC Chief Information Officer via the Data Standards Coordination Activity (DSCA) and Common Metadata Standards Tiger Team (CMSTT).
Technical Specification Downloads
Latest Approved Public Release:
- XML Data Encoding Specifications for Intelligence Community Docbook (V2018-APR - Standalone Package)
- XML Data Encoding Specifications for Intelligence Community Docbook (V2018-APR - Convenience Package)
- XML Data Encoding Specifications for Intelligence Community Docbook (V2018-APR - Light Package)
Mission Requirements
This DES is designed to fulfill a number of requirements in support of the transformational efforts of the IC. These requirements include:
- Improving publication and dissemination efficiency by reducing the cost and time for performing manual and complex rendering, manipulation, and content transformation of information resource metadata in context of an intelligence publication.
- Facilitating discovery and exchange of content consisting of mostly text supplemented by interspersed non-textual content (i.e., multi-media) information between collectors, all-source analysts, and consumers.
- Capturing an intelligence publication's overall security marking metadata in order to support attribute and clearance-based information management practices, such as secure collaboration, content management, content and portion-level filtering of discovery results, and content transfers across security domains.
- Capturing source reference citations to provide intelligence collectors the ability to systematically analyze how and how often the data they gather or produce is being used in order to facilitate better management of collection and production resources.
- Capturing source reference citations to enhance the analytic integrity of formally disseminated intelligence information and improving the traceability of collected information to analytic judgments and conclusions.
- Capturing and retaining a greater understanding of an intelligence publication's meaning, purpose, genesis, and characteristics as identified by a human or service.
Chief Information Officer
IC Technical Specifications
XML Data Encoding Specification for Contextual Entity Markup
Overview
This XML Data Encoding Specification for Contextual Entity Markup (CEM.XML) defines detailed implementation guidance for XML-encoding of Contextual Entity Markup elements (e.g., country, drug, compound). CEM.XML is used to curate textual content adding information such as a pseudonym for the string “Mary Jane” to be marijuana.
This specification is intended to supplement other specifications, such as PUBS.XML, by enhancing the in-line metadata tagging with contextual meaning that is not part of normal document or metadata markup. The use of such enhancements facilitates search, discovery, and many other enterprise tasks by more clearly tagging intent and disambiguating terms.
CEM.XML has a set of Entity tags that may grow over time as the requirements are presented. The starting set of Entities was extracted from PUBS.XML 2016-SEP, and versions of PUBS.XML starting with 2018-APR, use CEM.XML to replace the inline markup that it had since inception. The Schema Guide lists all the currently defined entities, their attributes, and definitions.
This specification is maintained by the IC Chief Information Officer via the Data Standards Coordination Activity (DSCA) and Common Metadata Standards Tiger Team (CMSTT).
Technical Specification Downloads
Latest Approved Public Release:
- XML Data Encoding Specifications for Contextual Entity Markup (V2018-APR - Standalone Package)
- XML Data Encoding Specifications for Contextual Entity Markup (V2018-APR - Convenience Package)
- XML Data Encoding Specifications for Contextual Entity Markup (V2018-APR - Light Package)
Mission Requirements
This DES is designed to fulfill a number of requirements in support of the transformational efforts of the IC. These requirements include:
- Capturing descriptive metadata markup
- Supplementing other specifications with descriptive metadata markup.
Both enterprise needs and requirements for this specification can be found in the following policies and implementation guidance:
- 500 Series:
- Intelligence Community Directive (ICD) 500, Director Of National Intelligence Chief Information Officer
- Intelligence Community Standard (ICS) 500-21, Tagging of Intelligence and Intelligence-Related Information
Chief Information Officer
IC Technical Specifications
XML Data Encoding Specification for Data Element Definition
Overview
This XML Data Encoding Specification for Data Element Definition (DED.XML) defines detailed implementation guidance for using XML to encode Data Element Definitions (DED) data. This Data Encoding Specification (DES) defines the XML elements and attributes, associated structures and relationships, mandatory and cardinality requirements, and permissible values for representing DED data concepts using XML. The exchange of DED across the Enterprise is critical to creating a common understanding of data fields and structures.
This specification is maintained by the IC Chief Information Officer via the Data Standards Coordination Activity (DSCA) and Common Metadata Standards Tiger Team (CMSTT).
Technical Specification Downloads
Latest Approved Public Release:
- XML Data Encoding Specification for Data Element Definition (V2019-MAR - Standalone Package)
- XML Data Encoding Specification for Data Element Definition (V2019-MAR - Convenience Package)
- XML Data Encoding Specification for Data Element Definition (V2019-MAR - Light Package)
Mission Requirements
Information sharing with the national intelligence enterprise is increasingly dependent on the exchange of information about an exchange format. Systems, users, and developers all need a more consistent machine processable format for exchanging information describing data. This specification is a reaction to that need. Both enterprise needs and requirements for this specification can be found in the following policies and implementation guidance:
- 500 Series:
- Intelligence Community Directive (ICD) 500, Director Of National Intelligence Chief Information Officer
- Intelligence Community Standard (ICS) 500-20, IC Enterprise Standards Compliance