Chief Information Officer
IC Technical Specifications
CDR: Brokered Search
Overview
This IC/DoD enterprise encoding specification defines requirements and provides guidelines for the realization of the Content Discovery and Retrieval (CDR) Brokered Search Component as a web service using both the SOAP messaging protocol and the RESTful OpenSearch [OS] standard (intended to provide minimal requirements for implementing an OpenSearch search broker), hereafter termed a Brokered Search service. The Brokered Search Component serves as the primary mechanism to 1) facilitate the distribution of queries to applicable/relevant Search Components and content collections. These Search Components expose and 2) aggregate the results returned individually into a single uniform results set. The content of this specification provides enough information for Broker Search Component providers and implementers to create CDR-compliant Brokered Search Components, the specification describes a Brokered Search Component’s behavior, interface, and other aspects in detail.
The Brokered Search Component uses the basic functionality described by the Search Component for a single search. Additional inputs and outputs are defined as needed to support the four activities that underpin Brokered Search capabilities: brokered search coordination, source identification, search component invocation, and federation results processing. A Search component’s results are resource metadata rather than actual content resources. In the context of Search, resource metadata generally refers to a subset of a resource’s available metadata, not the entire underlying record. The Search Component returns metadata about a resource, which may sometimes describe the underlying resource (e.g., an image), while other times representing a sub-set of the data that makes up a resource (e.g., a collection of attributes). In some cases, the metadata returned from an instantiation of the Search function and the Retrieve function, which returns a resource itself, may happen to be the same, though this is considered an edge condition. Some of the information contained within each Search result may provide the information necessary for a consumer to retrieve or otherwise use a resource.
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 Services Coordination Activity (SCA) and Content Discovery and Retrieval Integrated Product Team (CDR IPT).
Technical Specification Downloads
Latest Approved Public Release:
- Brokered Search (V2 - Standalone Package (Release Date: 06 Sep 2013))
- Brokered Search (V2 - Light Package (Release Date: 06 Sep 2013))
Value Proposition
This specification is 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 the Brokered Search Specification are to:
- Facilitate the distribution of queries to applicable/relevant Search Components and content collections these Search Components expose.
- Aggregate the results returned individually into a single, uniform results set which is returned to the Consumer Component.
Chief Information Officer
IC Technical Specifications
CDR: Atom Results Set
Overview
The Content Discovery & Retrieval (CDR) framework enables the use of results sets in service responses. As various service specifications leverage the Atom 1.0 feed syndications format, guidelines must be created to ensure consistent usage across CDR Search REST and SOAP specifications. In addition to the general guidelines for the use of Atom as described at http://www.atomenabled.org and in Atom 1.0 specification itself, this document extends the base specification to support information requirements in the CDR Search component. The guidance provided in this document focuses largely on the use of Atom 1.0 feed syndication format itself and the general format of commonly used extensions.
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 Services Coordination Activity (SCA) and Content Discovery and Retrieval Integrated Product Team (CDR IPT).
Technical Specification Downloads
Latest Approved Public Release:
- Atom Data Encoding Specification for Content Discovery and Retrieval Result Sets (V2 - Standalone Package (Release Date: 10 Apr 2013))
- Atom Data Encoding Specification for Content Discovery and Retrieval Result Sets (V2 - Light Package (Release Date: 10 Apr 2013))
Value Proposition
This specification is 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:
- To provide guidance on leveraging Atom 1.0 as a result set for both the CDR REST and SOAP Search specifications
- Support the implementation of both the IC/DoD Content Discovery & Retrieval SOAP [CDR-SS] and REST [CDR-RS] Interface Specifications for CDR Search.
Chief Information Officer
IC Technical Specifications
Intelligence Community Identifier
Overview
Intelligence Community Identifier is defined in two encoding specifications, the TXT and XML encodings. The Text Data Encoding Specification for Intelligence Community Identifier (IC-ID.Text) defines detailed implementation guidance for textual identifiers to be used with a variety of text-based encodings. The XML Data Encoding Specification for Intelligence Community Identifier (IC-ID.XML), defines how to incorporate those identifiers into XML structures.
This specification is applicable to the Intelligence Community (IC) and information produced by, stored, or shared within the IC. This Data Encoding Specification (DES) may have relevance outside the scope of intelligence; however, prior to applying outside of this defined scope, the DES should be closely scrutinized and differences separately documented and assessed for applicability.
This specification applies to the IC, as defined by the National Security Act of 1947, as amended; and such other elements of any other department or agency as may be designated by the President, or designated jointly by the Director of National Intelligence (DNI) and the head of the department or agency concerned, as an element of the IC. Joint and Coalition forces may use this specification but it is not required.
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 Coordination Activity (DCA) and Common Metadata Standards Tiger Team (CMSTT)
Technical Specification Downloads
Latest Approved Public Release:
- XML Data Encoding Specifications for Intelligence Community Identifier (V2021-NOV - Standalone Package)
- XML Data Encoding Specifications for Intelligence Community Identifier (V2021-NOV - Convenience Package)
- XML Data Encoding Specifications for Intelligence Community Identifier (V2021-NOV - Light Package)
Mission Requirements
Information sharing within the national intelligence enterprise will increasingly rely on unique identifiers in shared intelligence. A structured, verifiable representation of unique identifiers to the intelligence data is required in order for the enterprise to become inherently "smarter" about the information flowing in and around it. Such a representation, when implemented with other data formats, improved user interfaces, and data processing utilities, can provide part of a larger, robust information assurance infrastructure capable of automating some of the management and exchange decisions today being performed by human beings.
“Intelligent” identifiers (embedded names, dates, organizations) are fragile. - Reassignments, recalls, and reorganizations make these kind of identifiers obsolete or meaningless over time. Lack of a globally unique identifier makes certain technical challenges harder, such as search, access control, duplicate detection, citations, folder references, etc. IC-ID alleviates these problems with an identifier that can be guaranteed globally unique and can be used into the indefinite future.