Importing Custom Data into AcclaimIP

Data may be imported into AcclaimIP's custom fields in bulk.  For example, you may wish to export some data from your IAM software platform and enter it into AcclaimIP for your searchers to leverage.  

The most common data imported into AcclaimIP include:

  1. Rating Systems:  Is the patent any good?
  2. Taxonomies:  Where does the patent apply?
  3. Legal Data:  Internal Document Numbers, Litigation Status, Abandonment Dates

Integrating your internal data into AcclaimIP is a great way to leverage past work with your IP team.

Administrators can import data to all custom fields in a single import attempt.  However, when you are learning the process, we recommend you start with a single field before you tackle importing 25 fields or more at one time.


The data used in these examples are entirely made up for demonstration purposes and do not represent any entity's custom data.

Make Sure You Have Permission to Import

Just because you are a Custom Fields Administrator, doesn't mean you have permission to import data to a specific field.  You must assign yourself the right to upload data to that field.  Otherwise the import will fail.

  1. Open the Field Admin by going to Start>Field Admin (1).
  2. Select the Field in the Left (2).
  3. Check the Permissions Tab (3).
  4. Add yourself as a user, or a group in which you are a user to the field (4).
  5. Assign BULK user rights to the field (5).

Notice (5) that the permissions model is descending in precedence meaning BULK users can Import, Read and Write; WRITE users can Read and Write; and READ users can Read only.

How NOT to Setup Your Data

Data may be imported from a spreadsheet that is saved as a CSV file.  The primary key is the Document No. column (1) which must exist on your CSV file.

Make sure the column headers in your spreadsheet MATCH the Field Codes you created EXACTLY or the import will fail.  This example will fail because I don't have permission to import data to the standard (non-custom) fields, Normalized Assignee and File Dates.  These fields must be removed before you save the CSV file for importing.

If you make a mistake in your setup, AcclaimIP's import processor will give you an error message, and you can fix the problem and re-import.  You won't break the system, the import just won't work.


Extra Field Codes Cannot Exist

When I tried importing the first spreadsheet above containing additional standard fields, the import failed.  See the error messages above (1).

Remove Additional Fields

Remove Additional Fields

The example above shows a properly prepared CSV file in Excel.  Only the primary key (Document No.) field and the custom field I created _LEGAL.DKT are present.

Custom Field Codes Use Leading Underscores

Remember that AcclaimIP appends the field codes you define with a leading underscore character.  AcclaimIP must do this to make sure your field codes do not collide with existing field field codes in the system.  The leading underscore must be present in the csv file's column headers.  For example, while TTL is the existing field code for a Patent's title field, you could define a field code _TTL for some other title you use.

Field Codes Contain Their Parent Folder Name

This field was created as simply "DKT" but AcclaimIP nested it in its parent folder, and the actual field code you use for importing (and querying) is _LEGAL.DKT, since the DKT field is inside the folder I named LEGAL.

For these reasons you should keep your folder names short!

Open the Data Importer Utility

Open the Data Importer Utility

The import utility is found in the Start menu under the Bulk Operations (1) option.

Select File to Import

The Custom Field Import Utility will open:

  1. Choose the Select Files button (1)
  2. Navigate to the CSV file you want to import (2)
  3. Choose Open (3)

Choose Upload Files

The CSV file will be Queued for Upload, but it will not import until you click the Upload Files button (1).

Custom Data is Imported

When you click the Upload Files button, AcclaimIP's importer will go through 4 steps to add the custom data to your instance of AcclaimIP.

  1. UPLOAD.  The file is transferred to AcclaimIP
  2. PROCESSING:  The file is checked for errors, and any mistakes are reported in this step.
  3. SUBMITTED:  If Processing is successful, the custom data is imported and indexed.
  4. APPLIED:  The final notification lets you know the data has been applied and is ready to use in AcclaimIP.

In this example, the data has been successfully APPLIED (1) and is ready to use in AcclaimIP.

If an error in your csv file is detected, AcclaimIP will give you an error message and the import will stop.  You then fix the error and re-import the CSV file.

Checking Results in Batch Monitor

The Batch Monitor is a simple utility that reports on the various operations that have been done in the system.  The Batch Processing Monitor is located in the Start Menu under Batch Monitor.  In this example, you can see I imported the file "google-dkt.csv" (1) on March 3rd, 2014 (2) among other process.

Checking Results in the System

Once the import process runs and I get the APPLIED notification, and the fields are ready to use.  I tested my results by running a range query on the numbers using the custom field code I defined, _LEGAL.DKT (1).

The Search Result window shows the docket numbers I imported in a column which uses the friendly Field Label, "Docket Number", and NOT the FIELD CODE _LEGAL.DKT.

The Document Details Window shows  custom data  in the Custom Fields accordion panel (4) on the right side of the window.  Users can edit custom data directly inside the Custom Fields according window if the administrator gives them WRITE or BULK permissions.


Add your comment

E-Mail me when someone replies to this comment

This site is protected by reCAPTCHA and the Google Privacy Policy and Terms of Service apply.