...
aext is a tool used to extract full XML documents out of CLAIMS Direct. It is installed as part of the CLAIMS Direct repository. Please see the Client Tools Installation Instructions for more information about how to install this tool.
...
Detailed Description of the Parameters
Connectivity
Parameter | Description |
|---|---|
pgdbname | As configured in /etc/alexandria.xml, the database entry pointing to the on-site CLAIMS Direct PostgreSQL instance. The default value is alexandria as this value is pre-configured in /etc/alexandria.xml. |
solrurl | Available with optional SOLR on-site installation only, this is the URL of the standalone CLAIMS Direct SOLR instance or, if used, the URL of the load balancer. Although there is a default value, if you specify --solrq, this parameter is mandatory. |
Source
The following parameters determine the source criteria for extracting CLAIMS Direct XML. Only one may be specified.
| Parameter | Description |
|---|---|
loadid | The modified_load_id of the table xml.t_patent_document_values. Please see the documentation on content updates describing the various load-ids. |
table | The name of a user-created table with a minimum required column publication_id. |
sqlq | Any raw SQL that returns one or more publication_id values. |
solrq | Any raw SOLR query. |
Extract Naming and Destination
| Parameter | Description |
|---|---|
root | The output location of either the batches or, if --archive is specified, the root directory for files in the predictable path structure. The default is the current working directory. |
prefix | The standard extract is run in batches. This parameter specifies the prefix for each output file. The default is batch. |
archive | Archive the XML into a predictable path structure. The structure is as follows: <root>/<country>/kind/nnnnnn/nn/nn/nn/ucid.xmlWhere: For example: |
Process Options
| Parameter | Description |
|---|---|
nthreads | For increased speed, the extraction of data by default is done using parallel processes. This parameter specifies exactly how many parallel processes will be used. A general rule of thumb is to set this parameter to the number of CPU cores the machine has. |
batchsize | This parameter specifies the number of documents to extract per thread. If you know the content you are extracting, this parameter can be used to increase speed, e.g., bibliographic content only would benefit from a larger value while full-text content would benefit from a lower value. |
Output XML Filtering
| Parameter | Description |
|---|---|
dbfunc | By default, aext uses the internal PostgreSQL function xml.f_patent_document_s to extract full XML documents. This parameter allows you to specify a custom extract function. |
Examples
Extracting Using a Specific load-id
...
| Warning |
|---|
By manipulating the content of the XML, there is a risk that invalid XML can be produced. If you are validating the XML using the CLAIMS Direct DTD, beware of required elements. |
...
First, we create the function that extracts only publication information and classification information.
...
| Code Block | ||
|---|---|---|
| ||
aext --loadid=261358 --dbfunc=mySchema.f_cpc_only |
...