UniData UniData 7.3 New Features Version 7.3 August 2013 UDT-730-NF-2 Notices Edition Publication date: August 2013 Book number: UDT-730-NF-2 Product version: UniData V7.3 Copyright © Rocket Software, Inc. 1985-2013. All Rights Reserved. Trademarks Rocket is a registered trademark of Rocket Software, Inc. For a list of Rocket registered trademarks go to: www.rocketsoftware.com/about/legal. All other products or services mentioned in this document may be covered by the trademarks, service marks, or product names of their respective owners. Examples This information might contain examples of data and reports. The examples include the names of individuals, companies, brands, and products. All of these names are fictitious and any similarity to the names and addresses used by an actual business enterprise is entirely coincidental. License agreement This software and the associated documentation are proprietary and confidential to Rocket Software, Inc., are furnished under license, and may be used and copied only in accordance with the terms of such license. Note: This product may contain encryption technology. Many countries prohibit or restrict the use, import, or export of encryption technologies, and current use, import, and export regulations should be followed when exporting this product. Contact information Website: www.rocketsoftware.com Rocket Software, Inc. Headquarters 77 4th Avenue, Suite 100 Waltham, MA 02451-1468 USA Tel: +1 781 577 4321 Fax: +1 617 630 7100 ii Contacting Global Technical Support If you have current support and maintenance agreements with Rocket Software, you can access the Rocket Customer Portal to report and track a problem, to submit an enhancement request or question, or to find answers in the U2 Knowledgebase. The Rocket Customer Portal is the primary method of obtaining support. To log in to the Rocket Customer Portal, go to: www.rocketsoftware.com/support If you do not already have a Rocket Customer Portal account, you can request one by clicking Need an account? on the Rocket Customer Portal login page. Alternatively, you can contact Global Technical Support by email or by telephone: Email: [email protected] Telephone: North America +1 800 729 3553 United Kingdom/France +44 (0) 800 773 771 or +44 (0) 20 8867 3691 Europe/Africa +44 (0) 20 8867 3692 Australia +1 800 707 703 or +61 (0) 29412 5450 New Zealand +0800 505 515 iii Beta Beta Beta Beta Beta Beta Beta Beta Beta Beta Beta Beta Beta Beta Beta Beta Beta Beta Table of Contents Table of Contents Chapter 1 U2 Dynamic Object U2 Dynamic Object . 1-2 U2 Dynamic Object API . 1-4 UDO Definitions . 1-4 UDO Functions . 1-6 UDORead . 1-6 UDOWrite . 1-7 UDOSetOption . 1-7 UDOGetOption . 1-8 UDOClone . 1-8 UDOFree . 1-9 UDOGetProperty . 1-10 UDOSetProperty . 1-10 UDODeleteProperty . 1-11 UDOGetPropertyNames . 1-12 UDOGetNextProperty . 1-12 UDOCreate . 1-14 UDOGetType . 1-14 UDOIsTypeOf . 1-15 UDOArrayGetSize . 1-15 UDOArrayGetItem . 1-16 UDOArraySetItem . 1-17 UDOArrayInsertItem . 1-18 UDOArrayAppendItem. 1-19 UDOArrayDeleteItem . 1-20 UDOArrayGetNextItem. 1-20 UDOGetLastError . 1-21 Chapter 2 Data Type Enforcement Data Type Enforcement . 2-2 C:\Program Files (x86)\Adobe\AdobeFrameMaker10\UniData 7.3.4\NEWFEATURES\NEWFEATTOC.fm (bookTOC.template) Selecting an Attribute for Data Type Enforcement . 2-2 Creating and Deleting Metadata List . 2-4 Data Type Enforcement (DTENF) Commands . 2-7 Deploying Data Type Enforcement . 2-11 Chapter 3 EDA Replication EDA Replication . 3-2 Setting Up a Server . 3-3 Create a New UniData Server Connection . 3-4 Defining a Data Source. 3-10 Defining EDA Replication Parameters . 3-15 Chapter 4 HTTP Digest Authentication HTTP Digest Authentication . 4-2 How Digest Authentication Works. 4-2 WWW-Authenticate Response/Proxy-Authenticate Header Parameters . 4-4 Authorization Request Header Parameters . 4-5 Using Digest Authentication with Microsoft IIS Web Servers . 4-6 Secure HTTP Authentication through Proxy . 4-7 Multiple Same-Name Headers in Response Messages. 4-8 Chapter 5 Disabling U2 Data Replication Disabling U2 Data Replication . 5-2 Replication DISABLE Mode . 5-4 Replication ENABLE Mode . 5-6 Runtime Error Handling . 5-7 Recovering the System . 5-8 Enabling or Disabling U2 Data Replication . 5-10 Enabling or Disabling U2 Data Replication through XAdmin . 5-10 Exception Action Script . 5-12 Error Messaging . 5-13 Chapter 6 U2 Metadata Manager U2 Metadata Manager . 6-2 U2 MDM Editor . 6-2 Schema Tool . 6-2 Generating Data in U2 MDM . 6-3 Schemas in U2 MDM . 6-3 vi UniData 7.2 New Features Chapter 7 Miscellaneous Enhancements Changes to FILEINFO() . 7-2 New U2 Data Replication File . 7-3 UniData Upgrades and Replication . 7-5 U2 Extensible Administration Tool Help. 7-6 Table of Contents vii Chapter U2 Dynamic Object 1 U2 Dynamic Object . 1-2 U2 Dynamic Object API . 1-4 UDO Definitions . 1-4 UDO Functions. 1-6 UDORead . 1-6 UDOWrite . 1-7 UDOSetOption . 1-7 UDOGetOption . 1-8 UDOClone . 1-8 UDOFree . 1-9 UDOGetProperty. 1-10 UDOSetProperty . 1-10 UDODeleteProperty. 1-11 UDOGetPropertyNames . 1-12 UDOGetNextProperty . 1-12 UDOCreate. 1-14 UDOGetType . 1-14 UDOIsTypeOf . 1-15 UDOArrayGetSize . 1-15 UDOArrayGetItem . 1-16 UDOArraySetItem . 1-17 UDOArrayInsertItem . 1-17 UDOArrayAppendItem . 1-18 UDOArrayDeleteItem . 1-19 UDOArrayGetNextItem . 1-19 UDOGetLastError . 1-20 U2 Dynamic Object U2 Dynamic Object provides an object structure in UniData. It is based on JSON. JSON is based on a subset of the JavaScript Programming Language, Standard ECMA-262 3rd Edition - December 1999 (www.json.org). It is a text format that is completely language independent, but uses conventions that are familiar to programmers of the C-family of languages. These are the characteristics of U2 Dynamic Object: Strictly follows the JSON specification Is not persistent; in memory only Purely data object; no method support Dynamic; properties can be added or removed on the fly No class definition No inheritance support Unlimited nesting levels Can create objects from JSON data Can be serialized into JSON JSON is built on the following two structures: A collection of name/value pairs. This is realized as an object, record, structure, dictionary, hash table, keyed list, or associated array. An ordered list of values. In most languages, this is realized as an array, vector, list, or sequence. In JSON, these structures take on the following forms: An object is an unordered set of name/value pairs. An object begins with a left brace (“{“) and ends with a right brace (“}”). Each name is followed by a colon (“:”) and the name/value pairs are separated by a comma (“,”). An array is an ordered collection of values. An array begins with a left bracket (“[“) and ends with a right bracket (“]”). Values are separated by a comma (“,”). U2 Dynamic Object 1-2 A value can be a string in double quotation marks, a number, a true, false, or null, an object or an array. These structures can be nested. A string is a sequence of zero or more Unicode characters wrapped in double quotation marks, using backslash escapes. A character is represented as a single character string. A string is like a C or Java string. A number is like a C or Java number, except that the octal and hexadecimal formats are not used. 1-3 UniData 7.3 New Features U2 Dynamic Object API A U2 Dynamic Object (UDO) object contains a collection of properties, that is, name/value pairs. UDO uses the name in the pair to identify the property. The value in the pair can be a string, a number, true, false, null, an array, or another object. An array is an ordered list of values, and can be easily serialized into and deserialized from JSON data. A UDO object can be viewed as a tree structure with each object and array a node in the tree. Each node can have a number of child nodes. A child node is an object or an array that is either a property value or an array item. The top-most object or array is the root node. A stand-alone UDO object or array is not a property value on another UDO object and is not a UDO array element. A root node of a UDO tree is stand- alone. UDO Definitions A UDO type UniBasic variable can be passed to subroutines as a parameter. These definitions are defined in the UDO.H file. UDO Status Codes: UDO_SUCCESS UDO_ERROR UDO_INVALIDHANDLE UDO Value Types UDO_FALSE UDO_TRUE UDO_NULL UDO_STRING UDO_NUMBER UDO_OBJECT U2 Dynamic Object API 1-4 UDO_ARRAY A UDO object property or a UDO array item can be any one of the above types. UDO Error Codes UDOERROR_OUTOFMEMORY UDOERROR_INVALIDJSON UDOERROR_NOTSTANDALONE UDOERROR_NOTFOUND UDOERROR_INVALIDNAME UDOERROR_NOTANOBJECT UDOERROR_NOTANARRAY UDOERROR_INVALIDINDEX UDOERROR_OUTOFBOUND UDOERROR_INVALIDOPTION UDOERROR_INVALIDOPTIONVALUE UDOERROR_OPTIONNOTSET UDOERROR_INVALIDFORMAT UDOERROR_INVALIDVALUE UDOERROR_INVALIDTYPE UDO Flags UDOFORMAT_JSON UDO Options UDOOPTION_OUTPUTMODE UDO_OUTPUT_COMPACT UDO_OUTPUT_FORMATTED 1-5 UniData 7.3 New Features UDO Functions A UDO function always returns UDO_SUCCESS when it completes with no errors. Otherwise, it returns UDO_FAILURE or UDO_INVALIDHANDLE. If a UDO functions fails, UDO leaves the output variables, if any, unchanged. UDORead The UDORead function creates a UDO object from a JSON string. Syntax UDORead(inputString, inputType, udoHandle[out]) Parameters The following table describes each parameter of the syntax. Parameter Description inputString A JSON string. inputype UDOFORMAT_JSON. udoHandle The UniBasic variable that holds a reference to the UDO object [out] upon successful return of the function. UDORead Parameters UDO Functions 1-6 UDOWrite Writes a UDO object in JSON format. Syntax UDOWrite(udoHandle, outputType, outputString[out]) Parameters The following table describes each parameter of the syntax. Parameter Description udoHandle Must be a UDO type variable. outputType UDOFORMAT_JSON. outputString [out] The string that holds the serialized output. UDOWrite Parameters UDOSetOption Sets the options for the UDO API.