CDWS Schema and User-Defined Functions

The cdws schema is used for on-site citation and family functionality. It houses tables and functions that interact with the data-store, index, and attachment repositories through the web services. Several of the tables in the cdws schema are described below. Note that if your initial load occurred before May 13, 2020, these tables will need to be added as described in Leveraging On-Site Citation and Family Functionality.

cdws.t_applications

Column

Type

Modifiers

Comment

application_idserialprimary keyTable primary key
application_ucidvarchar(32)not null

Concatenation of country-doc_number-kind based on application record

fileddatenot nullDate of filing

cdws.t_cited_documents 

Column

Type

Modifiers

Comment

idserialprimary keyTable primary key
publication_idintegernot null

Integer representation of the publication

cited_document_idintegernot nullDocument identifier of the cited record
sourcevarchar(8)not nullCitation origin
is_appbooleannot nullIndicates that record is an application (true) or publication (false)
load_idintegernot nullLoad_id of last modification

cdws.t_priority_documents​

Column

Type

Modifiers

Comment

priority_idserialprimary keyTable primary key
publication_idintegernot null

Integer representation of the publication

application_idintegernot nullConcatenation of country-doc_number-kind based on application record
app_typechar(1)not nullXML origin of record: 'A' indicates application, 'P' indicates priority
linkchar(1)
Value of priority-claim/linkage-type attribute in XML
load_idintegernot nullLoad_id of last modification

User-Defined Functions

The following examples illustrate the active functions in the cdws schema. Any functions not documented here are for internal use by IFI CLAIMS only. See Leveraging On-Site Citation and Family Functionality for more information.

Note: Initial loads which occurred prior to May 13, 2020 need to have loaded the citations and family tables for the cdws functions to work (see instructions here). If your initial load occurred after May 13, those tables were included in the initial load.


cdws.f_citations_backward(publication_id integer)

This function returns cited ucids and their citation sources.

SELECT * 
FROM cdws.f_citations_backward( xml.f_ucid2id('US-5551212-A') )


cdws.f_citations_forward(publication_id integer)

This function returns ucids and citation sources of documents citing the given ucid.

SELECT *
FROM cdws.f_citations_forward( xml.f_ucid2id('US-5551212-A') )


cdws.f_family_citations_backward(family_id integer)

This function returns the unique backward citations of a given family.

SELECT *
FROM cdws.f_family_citations_backward(6413406);


cdws.f_family_citations_forward(family_id integer)

This function returns the unique forward citations of a given family.

SELECT *
FROM cdws.f_family_citations_forward(6413406)


cdws.f_family_extended(publication_id integer)

This function returns all extended family members. This family is comparable to the EPO INPADOC family.

SELECT *
FROM cdws.f_family_extended( xml.f_ucid2id('US-5551212-A') )


cdws.f_family_meta(family_id integer)

This function returns meta data for an entire family, including:

  • family_id
  • published
  • application ucid
  • filing date
  • title (in EN if available, language of publication otherwise)
  • IFI status as well as anticipated and adjusted expiration dates
  • EPO legal status as XML
SELECT *
FROM cdws.f_family_meta( 6413406 )


cdws.f_family_simple(publication_id integer)

This function returns all simple family members.

SELECT *
FROM cdws.f_family_simple( xml.f_ucid2id('US-5551212-A') )


cdws.f_ifi_names(publication_id integer)

This function returns both the original and current IFI standardized name and country.

SELECT *
FROM cdws.f_ifi_names( xml.f_ucid2id('US-5551212-A') )


cdws.f_text_bibliographic_data(publication_id integer, text)

This function returns XML bibliographic data. This is a subset of information returned from xml.t_patent_document_values.

SELECT *
FROM cdws.f_text_bibliographic_data( xml.f_ucid2id('US-5551212-A'), ‘’ )


cdws.f_text_tac(publication_id integer, text)

This function returns the XML for titles, abstracts, and claims. This is a subset of information returned from xml.t_patent_document_values.

SELECT *
FROM cdws.f_text_tac( xml.f_ucid2id('US-5551212-A'), ‘’ )