Eidr System Version 2.0 Command-Line Tools Overview

EIDR SYSTEM VERSION 2.0 COMMAND-LINE TOOLS OVERVIEW 2013 August 19 Copyright © 2012-2013 by the Entertainment ID Registry Association (EIDR). Copyrights in this work are licensed under the Creative Commons Attribution – No Derivative Works 3.0 United States License. See http://creativecommons.org/licenses/by-nd/3.0/ for full details. In addition, the operation and use of EIDR is protected by covenants as described in the EIDR Intellectual Property Rights Policy, a copy of which can be found at www.eidr.org. EIDR Command-Line Tools Overview. The content of this manual is furnished for information use only and is subject to change without notice and should not be construed as a commitment by the Entertainment ID Registry Association. The Entertainment ID Registry Association assumes no responsibility or liability for any errors or inaccuracies that may appear in this document. Products and company names mentioned may be trademarks of their respective owners. Feedback on this document can be sent to [email protected] Table of Contents 1. Introduction .................................................................................................................................... 5 Configuration File ......................................................................................................................................... 5 Windows Executables ................................................................................................................................... 6 Tools ............................................................................................................................................................. 6 General Notes ................................................................................................................................................ 7 Common Flags .......................................................................................................................................... 7 File Encoding ............................................................................................................................................ 7 ID File Input ............................................................................................................................................. 8 ID Output .................................................................................................................................................. 8 Multiple XML Records .............................................................................................................................. 8 Query Construction ................................................................................................................................... 8 Batch Files ................................................................................................................................................ 9 Deduplication Mode ................................................................................................................................ 10 Single vs. Multiple Input When Writing to the Registry .......................................................................... 10 Logging and Debugging ......................................................................................................................... 12 Namespaces ............................................................................................................................................. 13 Schema Locations ................................................................................................................................... 14 2. Tools that Read the Registry ................................................................................................... 15 ResolveTool ................................................................................................................................................ 15 QueryTool ................................................................................................................................................... 16 Example Queries ..................................................................................................................................... 18 FlattenTool .................................................................................................................................................. 20 Flat mode ................................................................................................................................................ 20 Tree mode................................................................................................................................................ 20 Output format .......................................................................................................................................... 21 PartyTool .................................................................................................................................................... 23 GraphTool ................................................................................................................................................... 25 StatusTool ................................................................................................................................................... 27 3. Creating and Modifying Objects ............................................................................................. 28 RegisterTool ................................................................................................................................................ 29 Examples ................................................................................................................................................. 30 GetModBaseTool/ApplyModBaseTool ...................................................................................................... 34 Get ........................................................................................................................................................... 35 Apply ....................................................................................................................................................... 36 Example................................................................................................................................................... 37 Notes ....................................................................................................................................................... 38 AltIDTool .................................................................................................................................................... 38 Gchange ...................................................................................................................................................... 40 4. Matching Against the EIDR Database ................................................................................... 42 MatchTool ................................................................................................................................................... 42 ResolveMatches .......................................................................................................................................... 44 ProcessStrongMatches ................................................................................................................................ 45 Example Workflow for Match/Register ...................................................................................................... 46 5. Managing Relationships ............................................................................................................ 49 RemoveRelTool .......................................................................................................................................... 49 AddLWTool ................................................................................................................................................ 49 6. Reversible Administration....................................................................................................... 52 PromoteTool ............................................................................................................................................... 52 7. Irreversible Administration .................................................................................................... 53 DeleteTool .................................................................................................................................................. 53 AliasTool .................................................................................................................................................... 53 1. Introduction This document describes the command-line tools that are available as part of the EIDR SDK package. These tools are found in the Tools subdirectory of the SDK installation path. Configuration File The EIDR SDK and Tools obtain their Registry credentials from a configuration file found on the local workstation. The important fields in an EIDR configuration file are: • <user> This is your user ID, provided by EIDR operations. It looks something like 10.5238/your- name. The prefix will always be 10.5238 • <party> This is the party name for you user ID. All users are associated with a party. It is of the form 10.5237/9DD9-E249. The prefix is always 10.5237. • <url> This is the URL for the

Load more