This article explains how to use Equinox's UPC Opt-out functionality.

TABLE OF CONTENTS

Functionality overview 

Equinox's UPC Opt-out functionality has the following features:

  • New default system fields
  • A CSV importer to import opt-out information in bulk from spreadsheets
  • Optional retrieval and storage of official opt-out receipt documents via the CSV importer, if the URL is included

How to enable the UPC Opt-out functionality

To enable the functionality: 

  1. Go to System > System Preferences  (user permissions dependent)
  2. Go to section Nationalisation, Validation, UPC and National Rights 
  3. Go to option 'Use UPC Opt-out functionality'
  4. Tick the box next to 'Use UPC Opt-out functionality' to enable it 
  5. Click the green 'Update' button to apply the changes to your Equinox system

Fields created when you enable the UPC opt-out functionality 

Date Fields

Enabling the UPC opt-out functionality creates the following history date fields:

  • UPC Opt-Out
  • UPC Withdrawal of Opt-Out

You can access these fields in the report generator and output their content via merge codes in templates in the same way as other system date fields.

Enabling the UPC opt-out functionality also creates a dropdown field UPC Opt-Out Status. This has two values:   

  • Opt-out 
  • Opt-out Withdrawn

Accessing the UPC Opt-out Import tool

A new menu item has been added in the System section called UPC Opt-out Import. This can be found at the bottom left of the screen.

Requirements for using the UPC Opt-out importer

The table below shows the required format for the CSV file:

Column Headers
Where multiple headers are listed, all are supported but only one is required
Required Value
Where multiple values are listed, all are supported but only one is required
Where's Equinox storing this information
case
irn
matter
case client reference
The Equinox case code, e.g. P123456EP

statusprocessed
success
complete
Custom field 'UPC Opt-Out Status' is set to Opt-out

Note: Without a required status value, no information will be imported

upc application number
upc number
application number		The UPC Opt-out application number, e.g., 11141/2022
UPC Opt-Out code field
upc date
application date
lodging date		The UPC Opt-out application date 

Note: The date must be in format MM-DD-YYYY

UPC Opt-Out date field
URL
receipt
Official Opt-Out Receipt
The URL for the public receipt - in format https://netservice-prod.apigee.net/upc/public/api/v4/documents/download/The receipt will be saved to the case documents (optional)

Importing receipts

The importer contains a checkbox that allows you to select whether or not you want the official opt-out application receipts to be imported. If they are imported, the receipt document for each opt-out application is saved to the case documents. The URL for each receipt must be included in the CSV file.

Note: The receipt URL should be in the following format, followed by the unique receipt identifier: https://netservice-prod.apigee.net/upc/public/api/v4/documents/download/

Example - Using the UPC Opt-out Import

To use the UPC opt-out import functionality:

  1. Go to System > System Tools > UPC Opt-out import

  2. Choose the CSV you want to open

  3. If you want to import receipts, tick the Import Receipts field

  4. Click the green Import button 

  5. After the import is run, the relevant cases are updated, and logging appears on the screen