Updating a Database with XML File Data

Mobius allows you to update local and remote databases by importing and exporting data.

•

For information on updating a local database, see Importing and Exporting XML Data in a Local Database

•

For information on importing XML data into a remote database, see Importing XML Data into a Remote Mobius Database

•

For information on exporting XML data from a remote database, see Exporting XML Data from a Remote Mobius Database

•

For information on the format of the XML file used in importing and exporting data for local and remote databases, see Format of the XML File

Importing and Exporting XML Data in a Local Database

The vdrdbxml command lets you import data from an XML file to a local database, and export data from a database into an XML file. You can issue this command from Windows or UNIX.

The syntax for the command is:

vdrdbxml parameter list

The parameter list must contain all required parameters. Optionally, instead of specifying parameters in a command, you can code the –ARGS parameter to specify a file that contains parameters.

Valid parameters are described in this table:

Parameter	Description		Required or Optional
-F filename	Path and filename of the XML file. The content of this file specifies which information will be imported or exported.		Required
-U recipient ID	Recipient that is issuing this command. This recipient must have permission to perform the updates specified in the XML file.		Required
-P password	Password for the recipient.		Required if the recipient has a password
-DSL datalink	Document server link that identifies the database and credentials being used. If auditing is enabled for the document server, all auditable operations are audited, according to the message filters set for the audit server. Auditing is not applied if this parameter is omitted. If a user has mandatory auditing and this parameter is not supplied, the client application produces an error and exits.		Required
-X	Deletes the XML file after the command is processed.		Optional
-LOG filename messagetype	Changes the default path and filename of log file and lets you control the type of messages that are recorded in the file. Without this parameter, the log file contains summary and error messages and is created in the temporary directory specified by the system environment variable. You can specify the path and filename and you can change the type of message recorded to one of these types:		Optional
	A	All messages.
	I	Informational, summary, and error messages.
	S	Summary and error messages.
	N	No messages.
-NEX	Specifies that the command does not require exclusive use of the database. With this parameter, multiple transactions can access the database simultaneously, but processing is slower. Without this parameter, this transaction has exclusive use of the database and processing is faster.		Optional
-ARGS filename	Specifies a file that contains the parameters you want to use with this command. You can use this parameter to: Increase security by ensuring that parameters such as passwords are not visible. Eliminate repetitive typing when you frequently issue the same command. You can also specify some parameters in the command and others in the file. If parameters are duplicated, Mobius processes the parameter that is declared last.		Optional
-OUT filename	Specifies the path and filename of the file that will contain exported data. If you do not add this parameter, the output is sent to a file named DBXMLResults.XML in the temporary directory specified by the system environment variable.		Optional
-SRI	Specifies to skip the retention information during exporting. If you wish to export additional XML record, see Isolating Topic Values to be Exported.		Optional
-HELP	Displays the command syntax and the available parameters.		Optional

Example

An example of the command:

vdrdbxml -DSL documentserverlink1 –f C:\XML\update1.xml –x

This command:

•

Authenticates databases and users associated with documentserverlink1.

•

Updates the Accounting data source with information from the update1.xml file

•

Deletes the XML file when processing is complete

Isolating Topic Values to be Exported

For both Independent and Topic Group Topic Values, Mobius processes each unique document collected and then exports the retention information that matches the unique document.

While exporting retention information for topic values that have held sections, you can receive varied results depending on whether the SRI (Skip exporting the Retention Information) parameter is included in the vdrdbxml command.

The following table shows what XML records are exported when the SRI parameter is NOT specified.

XML Export Request	Results when SRI is NOT Specified
Explicit Independent Topic Value	Explicit Independent Topic Value AND Retention Entry for Held Document
ALL Independent Topic Values	ALL Independent Topic Values AND ALL Retention Entries for Held Documents
Explicit Wide Topic Entry (NOT Retention Entry)	Explicit Wide Topic Entry AND Retention Entry for Held Document
Explicit Retention Entry	Explicit Retention Entry
ALL Retention Entries (RET_CHG Topic Group)	ALL Retention Entries
ALL Wide Topic Entries	ALL Wide Topic Entries (Including Retention Entries)

The following table shows what XML records are exported when the SRI parameter is specified.

XML Export Request	Results when SRI is Specified
Explicit Independent Topic Value	Explicit Independent Topic Value
ALL Independent Topic Values	ALL Independent Topic Values
Explicit Wide Topic Entry (NOT Retention Entry)	Explicit Wide Topic Entry
Explicit Retention Entry	Error "N542E- Invalid request when exporting retention information" occurs.
ALL Retention Entries (RET_CHG Topic Group)	Error "N542E- Invalid request when exporting retention information" occurs.
ALL Wide Topic Entries	ALL Wide Topic Entries

Importing XML Data into a Remote Mobius Database

To import XML data into a remote Mobius database

>

Create and run a batch file or a custom application.

See Importing XML Data into a Remote Mobius Database Using a Batch File or Importing XML Data into a Remote Mobius Database Using a Custom Application

Importing XML Data into a Remote Mobius Database Using a Batch File

To import XML data into a remote Mobius database using a batch file

1.

Start the RMI server on the Mobius host.

To start the RMI server, run vdrrmisrv.bat for Windows or vdrrmisrv.sh for UNIX located in the Mobius installation directory. The default port number for the RMI server is 1099. If you need to change the port number, open the vdrrmisrv.bat file in any text editor and change the ‑rmiRegistryPort parameter.

2.

Create a batch file with this content:

@echo off

set DOC_SERVER_ID=%1

set XML_FILE_NAME=%2

set USER_ID=%3

set USER_PASSWORD=%4

 

if "%USER_PASSWORD%"=="" set USER_PASSWORD=""

 

rem XMLImporter arguments [DEFAULTS]:

rem -h RMI Server Host [LOCALHOST]

rem -r RMI Server Port [1099]

rem -s Document ServerID [%DOC_SERVER_ID%]

rem -u UserID [%USER_ID%]

rem -p Password [""]

rem -f XML Filename [%XML_FILE_NAME%]

rem -? Help (this message)

 

java -classpath %CLASSPATH%;log4j.jar;xmlimporter.jar com..vdrnet.xmlimporter.XMLImporter -s %DOC_SERVER_ID%
-f %XML_FILE_NAME% -u %USER_ID% -p %USER_PASSWORD%

3.

Name the batch file RemoteXMLImporter.bat and save the file to your Mobius installation directory.

4.

Open a command prompt and run the batch file by issuing this command:

RemoteXMLImporter <DocServer> <XML_file> <UserID> <Password>

where:

<DocServer>	Document server connection name
<XML_File>	Path and filename of the XML file. The content of this file specifies what information is imported.
<UserID>	Recipient that is issuing this command. This recipient must have permission to perform the updates specified in the XML file.
<Password>	Password for the recipient (if required).

Importing XML Data into a Remote Mobius Database Using a Custom Application

To import XML data into a remote Mobius database using a custom application

>

Create the application with this code and modify it to call the Remote XML Importer via RMI.

String rmiHost = "LOCALHOST";

 

int rmiPort = 1099;

String serverId = "<DocumentServerID>";

String userId = "<UserID>";char[] password = "<Password>";

 

StringBuffer xmlDataIn = new StringBuffer("");

// Should contain actual XML request

 

StringBuffer xmlDataOut = new StringBuffer("");

XMLImporterStatus status = new XMLImporterStatus();

// Setup RMI request

 

XMLImporter xmlImporter = new XMLImporter( serverId, userId, password, rmiHost, rmiPort );

 

boolean success = false;

try { success = xmlImporter.processXML( xmlDataIn, xmlDataOut, status ); // RMI request}

 

catch(XMLImporterException e) {}

catch(Exception e) {}

Exporting XML Data from a Remote Mobius Database

To export XML data from a remote Mobius database, use the Remote XML Importer

1.

Start the RMI server on the Mobius host.

2.

Open a command prompt and issue this command:

RemoteXMLImporter <DocServer> ExportAll.xml ADMIN “” <rmiHost> <rmiport> “OutAll.xml” –m b

where:

<DocServer>	Document server connection name
ExportAll.xml	Input XML file found in project directory that contains export requests
<rmiHost>	RMI host name
<rmiport>	RMI port number
OutAll.xml	Output XML file

Format of the XML File

If you are creating an XML file to add, modify, delete, or export data in your database, use the format described in this topic. When Mobius exports data into an XML file, the file is created in this format:

•

The root tag of the XML file must be:

<VDRNET_DB_MASS_UPDATE VDRNET_VERSION=”n.n”>

where n.n is the version of Mobius, such as 5.1.

•

The high-level node specifies the Mobius table you want to act on, and the type of action. For example, to add information to the Recipient table, specify:

<RECIPIENT action=”add”>

•

The valid action attributes are listed in this table:

Action Attributes	Description
add	Adds a Mobius entity if it does not exist. If the entity already exists, it is not added and an error is reported.
modify	Modifies a Mobius entity if it already exists. If the entity does not exist, an error is reported.
add/modify	Adds a Mobius entity if it does not already exist. If the entity already exists, it is modified.
delete	Deletes an existing Mobius entity.
get	Exports all Mobius entities from the specified table.

•

The lower level nodes specify the field in the table that will be updated and the value for that field. For example, if you want the added recipient to have a Recipient ID of JSMITH, specify:

<RECIPIENT_ID>JSMITH</RECIPIENT_ID>

This table lists the nodes that correspond to database records and the nodes that correspond to fields in the table:

The following XML tags describe the properties of recipients:

XML Nodes that Correspond to Tables	XML Nodes that Correspond to Fields
RECIPIENT	RECIPIENT_ID
	NAME
	TITLE
	ADDRESS_LINE_1
	ADDRESS_LINE_2
	ADDRESS_LINE_3
	ADDRESS_LINE_4
	EMAIL_ADDRESS
	PASSWORD
	GLOBAL_REPORT_ACCESS
	GLOBAL_TOPIC_ACCESS
	DEFINE_RECIPIENTS
	DEFINE_REPORTS
	DEFINE_POLICIES
	CREATE_ARCHIVES
	DELETE_ARCHIVES
	DISTRIBUTION_ACCESS
	VIEW_ANNOTATIONS
	CREATE_ANNOTATIONS
	MODIFY_ANNOTATIONS
	DELETE_ANNOTATIONS
	CREATE_OVERLAYS
	MODIFY_OVERLAYS
	DELETE_OVERLAYS
	MANIPULATE_DOCUMENT_TOPIC_ITEM_ VALUES
	MANIPULATE_PROCESS_TOPIC_ITEM_VALUES
	ADD_RETENTION_TOPIC_ITEM_VALUES
	MODIFY_RETENTION_TOPIC_ITEM_VALUES
	DELETE_RETENTION_TOPIC_ITEM_VALUES
	MANIPULATE_TOPIC_ITEM_VALUES_FOR_HELD_DOCUMENTS
	RECIPIENT_DISTRIBUTION_SEQUENCE
	VIEW_NON_REDACTED_DOCUMENTS
GROUP	GROUP_ID
	GROUP_NAME
GROUP_MEMBERSHIP	RECIPIENT_OR_GROUP_ID
	GROUP_ID
REPORT	REPORT_ID
	REPORT_NAME
	DESCRIPTION_LINE_1
	DESCRIPTION_LINE_2
	DESCRIPTION_LINE_3
	DESCRIPTION_LINE_4
	REPORT_DATA_SUBTYPE
	REPORT_SECTION_CODE_LOCATIONS
	ARCHIVE_MODEL_FILE_NAME
	ARCHIVE_RETENTION_PERIOD Values: Number of Days Event-based
	INITIAL_FIXED_RETENTION_PERIOD Values: Retention, 30 or greater 0
	ARCHIVE_RETENTION_BASE Values: Report version ID Archive creation time
	ARCHIVE_GENERATIONS_KEPT
	INTERMEDIATE_INDEFINITE_RETENTION Values: If the report is set to Event-based Retention, 30 or greater 0
	AUTOMATIC_RM_PROCESSING Values: True False
	POLICY_NAME
	PAGESET_DEFINING_TOPIC
	COMPRESS_DATA Values: Yes Y No N
	ENCRYPT_DATA Values: Yes Y No N
	DISABLE_CONTENT_INDEXING Values: True, T, Yes, or Y False, F, No, or N
	REDACTION_TYPE Values: NONE SERVER CLIENT
	REDACTION_POLICY_NAME
REPORT_VERSION	REPORT_ID
	REPORT_VERSION_ID
	FILE_NAME
	RECORD_STATUS
	FILE_DATE
	FILE_SIZE
	DISTRIBUTION_TIMESTAMP
	DISTRIBUTION_TYPE VDR_BUILD_VERSION Formats: • #.# • #.#.# • #.#.#.#
	VDR_BUILD_DATE Format: MMM DD, YYYY
	ENCRYPTION_KEY_NAME
REPORT_ACCESS_RIGHTS	RECIPIENT_OR_GROUP_ID
	REPORT_ID
	SECTION_CODE
	VIEW_ACCESS
	COMMENTS
	E-MAIL_DISTRIBUTION_GROUP
TOPIC	TOPIC_ID
	TOPIC_NAME
	DESCRIPTION
	TOPIC_GLOBAL_ACCESS
	DATA_TYPE
	DATA_FORMAT
	TOPIC_ITEM_MAX_LENGTH Values: 30 255
	CURRENT_TOPIC_VERSION
	TOPIC_VERSION_GRANULARITY
	TOPIC_IS_PROTECTED
	TOPIC_CATEGORY Values: Document Process Retention
TOPIC_ACCESS_RIGHTS	RECIPIENT_OR_GROUP_ID
	TOPIC_ID
	COMMENTS
TOPIC_ITEM	TOPIC_ID
	TOPIC_VERSION_ID
	TOPIC_VALUE Attribute: TYPE=”raw” TYPE=”raw” when the data is in a numeric format.
	NEW_TOPIC_VALUE
	REPORT_ID
	REPORT_VERSION_ID
	SECTION_CODE
	PAGE_OF_DOCUMENT
	DOCUMENT_STARTING_PAGE_RBA
	DOCUMENT_STARTING_PAGE_NUMBER
	DOCUMENT_PAGE_COUNT
	LOCATION
DEVICE	DEVICE_ID
	CONNECTION_TYPE
	DEVICE_NAME
	DEVICE_LANGUAGES
PRINT_DISTRIBUTION_GROUP	PRINT_DISTRIBUTION_GROUP_ID
	NUMBER_OF_PACKET_COPIES
	PACKET_SEQUENCE
	DISTRIBUTION_GROUP_NAME
	PACKET_COMPOSITION_ID
	SEPARATE_REPORT_OUTPUT
	COVER_PAGE_NAME
	TRAILER_PAGE_NAME
	SEPARATOR_PAGE_NAME
PRINT_COPY	RECIPIENT_ID
	REPORT_ID
	SECTION_CODE
	NUMBER_OF_COPIES
	SEQUENCE_WITHIN_PACKET
	PRINT_CONTROL_DATA_STREAM
	PRINT_DISTRIBUTION_GROUP_ID
	DEVICE_ID
EMAIL_DISTRIBUTION_GROUP	EMAIL_DISTRIBUTION_GROUP_ID
	EMAIL_SERVER_TYPE
	DISTRIBUTION_GROUP_NAME
	PACKET_COMPOSITION_ID
	SEPARATE_ATTACHMENT_PER REPORT
	ATTACHMENT_TYPE
EMAIL_COPY	RECIPIENT_ID
	REPORT_ID
	SECTION_CODE
	EMAIL_DISTRIBUTION_GROUP_ID
POLICY_SELECTION_RULE	RULE_NAME
	APPLICATION
	REPORT_ID
	INPUT_FILENAME
	POLICY_NAME
POLICY	POLICY_NAME
	POLICY_DATA
	POLICY_TYPE Values: ARCHIVING REDACTION The POLICY XML node corresponds to a table in the database that cannot be accessed through AdminCentral. The POLICY_DATA tag contains the format of the data that is described in the specified policy.
ENCRYPTION_KEY	KEY_NAME DESCRIPTION KEY_VALUE Attribute: encrypt=”Yes, No, Y, or N” encrypt=”Yes|Y” to encrypt the provided key value. encrypt=”No|N” when the provided key value is already encrypted with the HEX-encoded key value. KEY_ACTIVE Values: Yes or Y No or N You can only add or modify an active key when there isn’t an existing active key in the database. Otherwise, the new encryption key is added, but is inactive. CREATED Format: YYYYMMDDHHMMSS LAST_USED Format: YYYYMMDDHHMMSS If you want to delete an encryption key, you must first delete all report versions using that encryption key before it can be deleted.
	KEY_ENCRYPTION_KEY Values: Default - if ‘Use internal encryption key for encryption keys stored in the database and used for encrypting archives’ option is selected in the Enterprise Administrator to which the encryption key is imported. It should have the path and filename that contains AES 256-bit key, encoded as HEX string. It must match the exact same path that is currently set. OpenSSL can be used (or any other key generation tool) to generate a HEX encoded AES 256-bit key. KEY_ENCRYPTION_KEY_HASH Value: Should be set to Sha-1 hash of the key pointed to by KEY_ENCRYPTION_KEY. The Sha-1 hash can be generated through tools online, however when generating the Sha-1 hash, use the HEX encoded encryption key as it appears in KEY_ENCRYPTION_KEY file path as Shal-1 hash computation is case sensitive. KEY_ENCRYPTION_KEY_HASH has to be specified only if Use external encryption key for encrypting keys stored in the database and used for encrypting archives option is specified in Enterprise Administrator.

.

The following tables define Mobius entities for databases with topic groups.

Topic Group Tags. A topic group is a set of related topics. Each topic group must have at least one MEMBER_TOPIC. For example, to combine topics related to a checking account, such as account number, check number, amount, and memo into a single topic group, add the topic group and add member topics for each related topic.

You must plan your topic groups carefully, because you cannot add or delete the member topics within a topic group after you add the group.

The following XML tags describe the properties of a topic group:

XML Tags	Description	Required or Optional	Values
TOPIC_GROUP	Identifies the beginning of a topic group entity.	Required	None
TOPIC_GROUP_ID	Unique identifier of the topic group.	Required	Up to 255 characters
TOPIC_GROUP_NAME	Descriptive name for the topic group.	Optional	Up to 255 characters
TOPIC_GROUP_SCOPE	Indicates the scope of the instances within the topic group. Only topic group instances that match the defined topic group scope can exist within this topic group.	Optional	Any, Page, Pageset, or Line The default is Any.
TOPIC_GROUP_IS_PROTECTED	Indicates if the topic group information and the topic group members in the topic group can be modified. No or N Indicates the group is a regular topic group and can be modified. Yes or Y Indicates that no operations are allowed against the topic group. This setting applies to AdminCentral. XML Importer ignores this setting.	Optional	Yes, Y, No, or N The default is No.
TOPIC_GROUP_CLASS	Indicates the topic group class. Regular indicates a regular topic group. Retention flags a retention related topic group. CheckInOut indicates a checkin/checkout related topic group.	Optional	Regular, Retention, or CheckInOut The default is Regular.

Member Topic Tags. A member topic is a topic within a topic group. For example, the topic group "checking account" can consist of related topics “account number,” “check number,” “amount,” and “memo.”

The following XML tags describe the properties of a member topic:

XML Tags	Description	Required or Optional	Values
MEMBER_TOPIC	Identifies the beginning of the member topic entity.	Required	None
TOPIC_ID	Identifier unique to a member topic. You cannot use the following special characters in this field: ' (apostrophe), " (quote), ? (question mark), { (left brace), or } (right brace).	Required	Up to 10 characters
TOPIC_NAME	Descriptive name for the member topic that is displayed in viewing clients, such as Mobius View.	Optional	Up to 60 characters
DESCRIPTION	Descriptive information about this member topic.	Optional	Up to 240 characters
TOPIC_GLOBAL_ACCESS	Indicates whether all recipients are allowed to access this member topic. If enabled, all recipients can access the report from this member topic. If you do not enable this option, you can assign access to this member topic to select recipients in the Topic Item Access Rights section.	Required	Yes, Y, No, or N The default is N.
DATA_TYPE	Specifies the type of data required in the field.	Required	Character, Date, or Number
DATA_FORMAT	Identifies the display format for the type of data imported into or extracted from the database. Character—If the DATA_TYPE is Character, a value is not required. Specified values are ignored. Date—Date in one of the date formats recognized by Mobius, for example, MM/DD/YYYY or YYMMDD. Number—Numeric data, including monetary amounts and binary numbers. Number fields can contain commas and decimal points. Currency fields can contain a currency symbol, commas, and decimals. Negative numbers, or credits, can be indicated in one of three ways: -, (), or CR.	Required when DATA_TYPE is Date or Number
TOPIC_ITEM_MAX_LENGTH	Identifies the string length for the type of data imported into or extracted from the database. Character—If the DATA_TYPE is Character, a value is 30 or 255. Date—If the DATA_TYPE is Date, the value is 0. Number—If the DATA_TYPE is Number, the value is 0.	Required
CURRENT_TOPIC_VERSION	Timestamp that associates the current topic version with the topic ID.	Optional	YYYYMMDDHHMMSS
TOPIC_VERSION_GRANULARITY	Defines the scope of topic versions displayed. To decrease the amount of time it takes to display topic items in a viewing client, such as Mobius View, you can limit the scope of the topic versions. For example, the Monthly option displays topic versions divided into 12 folders, one for each month. When a user selects a folder for a specific month, the viewing client retrieves only the topic versions that were created during that month. This results in faster access when compared with retrieving topic versions for a longer period of time.	Optional	All, A, Monthly, M, Quarterly, Q, Yearly, or Y The default is All.
CAN_SEARCH	Indicates whether this member topic can be a search constraint in viewing clients such as Mobius View, and API applications.	Optional	Y, Yes, N, or No The default is Y.
TOPIC_IS_PROTECTED	Indicates the topic member can be modified. No or N Indicates the topic member can be modified. Yes or Y Indicates that no operations are allowed against the topic group.	Optional	Yes, Y, No, or N The default is No.
TOPIC_CATEGORY	Indicates the topic category. This value should be Document, unless you are advised to change it by ASG Support.	Optional	Document, Process, or Retention The default is Document.

Topic Group Instance Tags. A topic group instance is a specific group of index entries for a topic group. For example, if the topic group "checking account" contains member topics “account” and “check number,” a topic group instance is a specific occurrence of an account and check number value pair. The topic group instance tags, except for the SET_TOPIC_VALUE_PAIR tag, constrain the instances that Mobius adds, modifies, deletes, or exports. The SET_TOPIC_VALUE_PAIR tag adds or modifies an instance value.

The following XML tags describe the properties of a topic group instance:

XML Tags	Description	Required or Optional	Values
TOPIC_GROUP_INSTANCE	Identifies the beginning of a topic group instance entity.	Required	None
TOPIC_GROUP_ID	Identifier unique to an individual topic group.	Required	Up to 255 characters
SET_TOPIC_VALUE_PAIR	Applies to add and modify actions and indicates the beginning of a new TOPIC_ID and TOPIC_VALUE pair. This pair identifies the new value that Mobius applies to topic group instances.	Required with the add and modify actions. Not allowed with the get and delete actions	None
MATCH_TOPIC_VALUE_PAIR	Indicates the beginning of an existing TOPIC_ID and TOPIC_VALUE pair. This pair constrains the set of instances that Mobius modifies, deletes, or exports.	Required with the delete and get actions	None
TOPIC_ID	Specifies the topic ID associated with the topic value in a MATCH_TOPIC_VALUE_PAIR or SET_TOPIC_VALUE_PAIR.	Required	Up to 10 characters
TOPIC_VALUE	Specifies the topic value associated with the topic ID in a MATCH_TOPIC_VALUE_PAIR or SET_TOPIC_VALUE_PAIR.	Required	Up to 30 characters
REPORT_ID	Specifies the report ID of the topic group instance.	Required with the add action	Up to 10 characters
REPORT_VERSION_ID	Specifies the report version ID of the topic group instance. The timestamp must be in the format YYYYMMDDHHMMSS.	Required with the add action	Valid date format
SECTION_CODE	Identifies the row where the topic group instance starts, the column that it starts in, and the number of characters in the topic group instance.	Optional	Up to 30 characters
DOCUMENT_STARTING_PAGE_NUMBER	Indicates the first page of the report where the topic group instance begins.	Required with the add action	Number
DOCUMENT_PAGE_COUNT	Identifies the total number of pages included in the report.	Required with the add action	Number
PAGE_OF_DOCUMENT	Identifies the page number of the report where the topic group instance occurs. A value of -1 indicates all pages.	Optional	Number Default is -1
LOCATION	Identifies the page and specific location of the topic group instance when multiple instances occur on the same page. A value of -1 indicates ignore value.	Optional	Number Default is -1

Topic Item Access Right Tags. A topic item access right authorizes a recipient or group to access topic values and related index entries based on a specified member topic value. A recipient or group with permission to a topic group instance has access to all member topics and associated content within the topic group instance. For example, a topic group called “checking account” has member topics called “account number,” “check number,” and “amount.” The instances of the group refer to check images. If John Smith has topic item access rights to account 100, John also has access to the check number and amount values and can also view the associated check image.

The following XML tags describe the properties of a topic item access right:

XML Tags	Description	Required or Optional	Values
TOPIC_ITEM_ACCESS_RIGHTS	Identifies the beginning of a topic item access rights entity.	Required	None
RECIPIENT_OR_GROUP_ID	Specifies the RECIPIENT_ID or GROUP_ID of the recipient or group given permission to access the specified Topic ID and values.	Required	Up to 128 characters
TOPIC_ITEM_EXPRESSION	Indicates the beginning of a new TOPIC_ID and VALUES pair.	Required	None
TOPIC_ID	The member topic to which permission is granted. The Topic ID is a second level tag to TOPIC_ITEM_EXPRESSION.	Required	Up to 10 characters
VALUES	The values to which permission is granted. You can use wildcards (* or ?) to specify multiple values. Values are a second level tag to TOPIC_ITEM_EXPRESSION.	Required	Up to 30 characters
COMMENTS	Descriptive information about the topic item access rights.	Optional	Up to 240 characters

Example XML Files

The XML file starts and ends with the highest level tag <VDRNET_DB_MASS_UPDATE VDRNET_VERSION=”n.n>. Within this tag are references to the database table tags. Each database table tag has an action parameter, and contains tags and values for each field. Example XML files are shown below.

Recipient and Recipient Group Updates

This example XML file is shown in Sample XML file. This file updates the ASG database by:

•

Adding the recipient John Smith

•

Deleting the recipient John Doe

•

Adding the group ACC

•

Adding John Smith as a member of the ACC group

•

Adding report access rights for the ACC group

Sample XML file

<?xml version = “1.0” ?>

<!—This is a small sample XML file -->

<VDRNET_DB_MASS_UPDATE VDRNET_VERSION=”5.1”>

 

<!-- ==================== RECIPIENT ==================== -->

<RECIPIENT action=”add”>

<RECIPIENT_ID>JSMITH</RECIPIENT_ID>

<NAME>John Smith</NAME>

</RECIPIENT>

 

<RECIPIENT action=”del”>

<RECIPIENT_ID>JDOE</RECIPIENT_ID>

</RECIPIENT>

 

<!-- ==================== GROUP ==================== -->

<GROUP action=”add”>

<GROUP_ID>ACC</GROUP_ID>

<GROUP_NAME>Accounting</GROUP_NAME>

</GROUP>

 

<!-- ================ GROUP_MEMBERSHIP ================ -->

<GROUP_MEMBERSHIP action=”add”>

<RECIPIENT_OR_GROUP_ID>JSMITH</RECIPIENT_OR_GROUP_ID>

<GROUP_ID>ACC</GROUP_ID>

</GROUP_MEMBERSHIP>

 

<!-- ================ REPORT_ACCESS_RIGHTS ================ -->

<REPORT_ACCESS_RIGHTS action=”add/modify”>

<RECIPIENT_OR_GROUP_ID>ACC</RECIPIENT_OR_GROUP_ID>

<REPORT_ID>AC001</REPORT_ID>

<SECTION_CODE>NY*</SECTION_CODE>

</REPORT_ACCESS_RIGHTS>

 

</VDRNET_DB_MASS_UPDATE>

Topic Group Updates

The examples in this topic show how XML files can add, delete, and export topic groups.

Example 1 – Adding Topic Groups

The following XML file adds topic group “ACCOUNT” with member topics “ACCT NUMBER,” “DEPOSIT,” and “DATE” to the Mobius database.

<?xml version = “1.0” ?>

<!—This is a small sample XML file -->

<VDRNET_DB_MASS_UPDATE VDRNET_VERSION=”5.1”>

 

<!-- ============== TOPIC GROUP =============== -->

<TOPIC_GROUP action="add">

<TOPIC_GROUP_ID>ACCOUNT</TOPIC_GROUP_ID>

<TOPIC_GROUP_NAME>Savings Account</TOPIC_GROUP_NAME>

<TOPIC_GROUP_SCOPE>Any</TOPIC_GROUP_SCOPE>

 

<!-- ============== MEMBER TOPICS WITHIN TOPIC GROUP ================ -->

<MEMBER_TOPIC>

<TOPIC_ID>ACCT_NUMBER</TOPIC_ID>

<TOPIC_NAME>Account number</TOPIC_NAME>

<DESCRIPTION>Character Attribute Topic</DESCRIPTION>

<TOPIC_GLOBAL_ACCESS>Y</TOPIC_GLOBAL_ACCESS>

<DATA_TYPE>Character</DATA_TYPE>

<DATA_FORMAT>Character</DATA_FORMAT>

<CURRENT_TOPIC_VERSION>20050901020202</CURRENT_TOPIC_VERSION>

<TOPIC_VERSION_GRANULARITY>All</TOPIC_VERSION_GRANULARITY>

</MEMBER_TOPIC>

<MEMBER_TOPIC>

<TOPIC_ID>DEPOSIT</TOPIC_ID>

<TOPIC_NAME>Deposit amount</TOPIC_NAME>

<DESCRIPTION>Number Attribute Topic</DESCRIPTION>

<TOPIC_GLOBAL_ACCESS>Y</TOPIC_GLOBAL_ACCESS>

<DATA_TYPE>Number</DATA_TYPE>

<DATA_FORMAT>CR#.###</DATA_FORMAT>

<CURRENT_TOPIC_VERSION>20050902020202</CURRENT_TOPIC_VERSION>

<TOPIC_VERSION_GRANULARITY>All</TOPIC_VERSION_GRANULARITY>

<CAN_SEARCH>Yes</CAN_SEARCH>

</MEMBER_TOPIC>

<MEMBER_TOPIC>

<TOPIC_ID>DATE</TOPIC_ID>

<TOPIC_NAME>Transaction date</TOPIC_NAME>

<DESCRIPTION>Date Attribute Topic</DESCRIPTION>

<TOPIC_GLOBAL_ACCESS>Y</TOPIC_GLOBAL_ACCESS>

<DATA_TYPE>Date</DATA_TYPE>

<DATA_FORMAT>YYYYMMDD</DATA_FORMAT>

<CURRENT_TOPIC_VERSION>20050902020202</CURRENT_TOPIC_VERSION>

<TOPIC_VERSION_GRANULARITY>All</TOPIC_VERSION_GRANULARITY>

<CAN_SEARCH>Yes</CAN_SEARCH>

</MEMBER_TOPIC>

</TOPIC_GROUP>

 

</VDRNET_DB_MASS_UPDATE>

Example 2 – Deleting Topic Groups

The following XML file deletes topic group “FUNDS” from the Mobius database.

<?xml version = “1.0” ?>

<!—This is a small sample XML file -->

<VDRNET_DB_MASS_UPDATE VDRNET_VERSION=”5.1”>

 

<!-- ============== TOPIC GROUP =============== -->

<TOPIC_GROUP action="delete">

<TOPIC_GROUP_ID>FUNDS</TOPIC_GROUP_ID>

</TOPIC_GROUP>

</VDRNET_DB_MASS_UPDATE>

Example 3 – Exporting Topic Groups

The following XML file exports topic group "BONDS" from the Mobius database.

<?xml version = “1.0” ?>

<!—This is a small sample XML file>

<VDRNET_DB_MASS_UPDATE VDRNET_VERSION=”5.1”>

 

<!-- ============== TOPIC GROUP =============== -->

<TOPIC_GROUP action="get">

<TOPIC_GROUP_ID>BONDS</TOPIC_GROUP_ID>

</TOPIC_GROUP>

</VDRNET_DB_MASS_UPDATE>

Topic Group Instance Updates

The examples in this topic show how XML files can add, modify, delete, and export topic group instance entities.

Example 1 – Adding Topic Group Instances

The following XML file adds a topic group instance for the topic group “ACCOUNT” and sets a value for each member topic.

<?xml version = “1.0” ?>

<!—This is a small sample XML file -->

<VDRNET_DB_MASS_UPDATE VDRNET_VERSION=”5.1”>

 

<!-- ========== TOPIC GROUP INSTANCE ========== -->

<TOPIC_GROUP_INSTANCE action="add">

<TOPIC_GROUP_ID>ACCOUNT</TOPIC_GROUP_ID>

<REPORT_ID>ACCT</REPORT_ID>

<REPORT_VERSION_ID>20051014003720</REPORT_VERSION_ID>

<SECTION_CODE>Section1</SECTION_CODE>

<PAGE_OF_DOCUMENT>-1</PAGE_OF_DOCUMENT>

<LOCATION>-1</LOCATION>

<DOCUMENT_STARTING_PAGE_RBA>58</DOCUMENT_STARTING_PAGE_RBA>

<DOCUMENT_STARTING_PAGE_NUMBER>1</DOCUMENT_STARTING_PAGE_NUMBER>

<DOCUMENT_PAGE_COUNT>5</DOCUMENT_PAGE_COUNT>

<SET_TOPIC_VALUE_PAIR>

<TOPIC_ID>ACCT_NUMBER</TOPIC_ID>

<TOPIC_VALUE>CHAR_VALUE</TOPIC_VALUE>

</SET_TOPIC_VALUE_PAIR>

<SET_TOPIC_VALUE_PAIR>

<TOPIC_ID>DEPOSIT</TOPIC_ID>

<TOPIC_VALUE type="raw">999.99</TOPIC_VALUE>

</SET_TOPIC_VALUE_PAIR>

<SET_TOPIC_VALUE_PAIR>

<TOPIC_ID>DATE </TOPIC_ID>

<TOPIC_VALUE type="raw">20051120.0</TOPIC_VALUE>

</SET_TOPIC_VALUE_PAIR>

</TOPIC_GROUP_INSTANCE>

 

</VDRNET_DB_MASS_UPDATE>

Example 2 – Modifying Topic Group Instances

The following XML file modifies all topic group instances where the topic group is “ACCOUNT” the Report ID is “AC001,” the Report Version ID is “20051101125544,” and the office is “NY;” and sets the office value to “CT” and the zip code to “06801.”

<?xml version = “1.0” ?>

<!—This is a small sample XML file -->

<VDRNET_DB_MASS_UPDATE VDRNET_VERSION=”5.1”>

 

<!-- ========== TOPIC GROUP INSTANCE ========== -->

<TOPIC_GROUP_INSTANCE action="modify">

<TOPIC_GROUP_ID>ACCOUNT</TOPIC_GROUP_ID>

<REPORT_ID>AC001</REPORT_ID>

<REPORT_VERSION_ID>20051101125544</REPORT_VERSION_ID>

<MATCH_TOPIC_VALUE_PAIR>

<TOPIC_ID>Office</TOPIC_ID>

<TOPIC_VALUE>NY</TOPIC_VALUE>

</MATCH_TOPIC_VALUE_PAIR>

<SET_TOPIC_VALUE_PAIR>

<TOPIC_ID>Office</TOPIC_ID>

<TOPIC_VALUE>CT</TOPIC_VALUE>

</SET_TOPIC_VALUE_PAIR>

<SET_TOPIC_VALUE_PAIR>

<TOPIC_ID>ZipCode</TOPIC_ID>

<TOPIC_VALUE>06801</TOPIC_VALUE>

</SET_TOPIC_VALUE_PAIR>

</TOPIC_GROUP_INSTANCE>

 

</VDRNET_DB_MASS_UPDATE>

Example 3 – Modifying Topic Group Instances

The following XML file sets the office value to “CT” and the zip code to “06801” for all topic group instances where the topic group is “ACCOUNT,” the report ID is “AC001,” and the Report Version ID is “20051101125544.”

<?xml version = “1.0” ?>

<!—This is a small sample XML file -->

<VDRNET_DB_MASS_UPDATE VDRNET_VERSION=”5.1”>

 

<!-- ========== TOPIC GROUP INSTANCE ========== -->

<TOPIC_GROUP_INSTANCE action="modify">

<TOPIC_GROUP_ID>ACCOUNT</TOPIC_GROUP_ID>

<REPORT_ID>AC001</REPORT_ID>

<REPORT_VERSION_ID>20051101125544</REPORT_VERSION_ID>

<SET_TOPIC_VALUE_PAIR>

<TOPIC_ID>Office</TOPIC_ID>

<TOPIC_VALUE>CT</TOPIC_VALUE>

</SET_TOPIC_VALUE_PAIR>

<SET_TOPIC_VALUE_PAIR>

<TOPIC_ID>ZipCode</TOPIC_ID>

<TOPIC_VALUE>06801</TOPIC_VALUE>

</SET_TOPIC_VALUE_PAIR>

</TOPIC_GROUP_INSTANCE>

 

</VDRNET_DB_MASS_UPDATE>

Example 4 – Deleting Topic Group Instances

The following XML file deletes all topic group instances where the topic group is “ACCOUNT,” the office is “NY,” and the zip code is “11580.”

<?xml version = “1.0” ?>

<!—This is a small sample XML file -->

<VDRNET_DB_MASS_UPDATE VDRNET_VERSION=”5.1”>

 

<!-- ========== TOPIC GROUP INSTANCE ========== -->

<TOPIC_GROUP_INSTANCE action="delete">

<TOPIC_GROUP_ID>ACCOUNT</TOPIC_GROUP_ID>

<MATCH_TOPIC_VALUE_PAIR>

<TOPIC_ID>Office</TOPIC_ID>

<TOPIC_VALUE>NY</TOPIC_VALUE>

</MATCH_TOPIC_VALUE_PAIR>

<MATCH_TOPIC_VALUE_PAIR>

<TOPIC_ID>ZipCode</TOPIC_ID>

<TOPIC_VALUE>11580</TOPIC_VALUE>

</MATCH_TOPIC_VALUE_PAIR>

</TOPIC_GROUP_INSTANCE>

 

</VDRNET_DB_MASS_UPDATE>

Example 5 – Exporting Topic Group Instances

The following XML file exports all topic group instances where the topic group is “ACCOUNT,” the office is “WA,” and the zip code is “98118.”

<?xml version = “1.0” ?>

<!—This is a small sample XML file -->

<VDRNET_DB_MASS_UPDATE VDRNET_VERSION=”5.1”>

 

<!-- ========== TOPIC GROUP INSTANCE ========== -->

<TOPIC_GROUP_INSTANCE action="get">

<TOPIC_GROUP_ID>ACCOUNT</TOPIC_GROUP_ID>

<MATCH_TOPIC_VALUE_PAIR>

<TOPIC_ID>Office</TOPIC_ID>

<TOPIC_VALUE>WA</TOPIC_VALUE>

</MATCH_TOPIC_VALUE_PAIR>

<MATCH_TOPIC_VALUE_PAIR>

<TOPIC_ID>ZipCode</TOPIC_ID>

<TOPIC_VALUE>98118</TOPIC_VALUE>

</MATCH_TOPIC_VALUE_PAIR>

</TOPIC_GROUP_INSTANCE>

 

</VDRNET_DB_MASS_UPDATE>

Topic Item Access Right Updates

The examples in this topic show how XML files can add, delete, and export topic item access right entities.

Example 1 – Adding Topic Item Access Rights

The following example XML file adds topic item access rights for JSMITH to all accounts beginning with ACCT5 and to account ACCT999*.

<?xml version = “1.0” ?>

<!—This is a small sample XML file -->

<VDRNET_DB_MASS_UPDATE VDRNET_VERSION=”5.1”>

 

<!-- ============== TOPIC ITEM ACCESS RIGHTS ======================== -->

<TOPIC_ITEM_ACCESS_RIGHTS action="add">

<RECIPIENT_OR_GROUP_ID>JSMITH</RECIPIENT_OR_GROUP_ID>

<TOPIC_ITEM_EXPRESSION>

<TOPIC_ID>ACCOUNT</TOPIC_ID>

<VALUES>“ACCT5*”</VALUES>

</TOPIC_ITEM_EXPRESSION>

<COMMENTS>Allows access to accounts ACCT5*</COMMENTS>

</TOPIC_ITEM_ACCESS_RIGHTS>

 

<TOPIC_ITEM_ACCESS_RIGHTS action="add">

<RECIPIENT_OR_GROUP_ID>JSMITH</RECIPIENT_OR_GROUP_ID>

<TOPIC_ITEM_EXPRESSION>

<TOPIC_ID>ACCOUNT</TOPIC_ID>

<VALUES>“ACCT999\*”</VALUES>

</TOPIC_ITEM_EXPRESSION>

<COMMENTS>Allows access to the literal value ACCT999*</COMMENTS>

</TOPIC_ITEM_ACCESS_RIGHTS>

 

</VDRNET_DB_MASS_UPDATE>

Example 2 – Deleting Topic Item Access Rights

The following example XML file deletes topic item access rights for JSMITH to account ACCT999*.

<?xml version = “1.0” ?>

<!—This is a small sample XML file -->

<VDRNET_DB_MASS_UPDATE VDRNET_VERSION=”5.1”>

 

<!-- ============== TOPIC ITEM ACCESS RIGHTS ======================== -->

<TOPIC_ITEM_ACCESS_RIGHTS action="delete">

<RECIPIENT_OR_GROUP_ID>JSMITH</RECIPIENT_OR_GROUP_ID>

<TOPIC_ITEM_EXPRESSION>

<TOPIC_ID>ACCOUNT</TOPIC_ID>

<VALUES>“ACCT999\*”</VALUES>

</TOPIC_ITEM_EXPRESSION>

<COMMENTS>Removes access to the literal value ACCT999*</COMMENTS>

</TOPIC_ITEM_ACCESS_RIGHTS>

 

</VDRNET_DB_MASS_UPDATE>

Example 3 – Exporting Topic Item Access Rights

The following example XML file exports topic item access rights for JSMITH.

<?xml version = “1.0” ?>

<!—This is a small sample XML file -->

<VDRNET_DB_MASS_UPDATE VDRNET_VERSION=”5.1”>

 

<!-- ============== TOPIC ITEM ACCESS RIGHTS ======================== -->

<TOPIC_ITEM_ACCESS_RIGHTS action="get">

<RECIPIENT_OR_GROUP_ID>JSMITH</RECIPIENT_OR_GROUP_ID>

</TOPIC_ITEM_ACCESS_RIGHTS>

 

</VDRNET_DB_MASS_UPDATE>

Encryption Key Updates

The examples in this topic show how XML files of an Encryption Key can use the default Key Encryption Key and a customer provided Key Encryption Key.

Example 1 – Using Default Encryption Key

The following example XML file uses the default Key Encryption Key.

<ENCRYPTION_KEY action="add/modify">

<KEY_NAME>MySecretKey1</KEY_NAME>

<KEY_VALUE

encrypt="n">846F1B70AE2AA4F05FE419D7C6ADB71689BD1811EC517BBC9CE50F8A3401E08A</KEY_VALUE>

<KEY_ACTIVE>N</KEY_ACTIVE>

<CREATED>20180426070716</CREATED>

<LAST_USED>20180426071009</LAST_USED>

<DESCRIPTION>VDRNET-3523 First Key</DESCRIPTION>

<KEY_ENCRYPTION_KEY>Default</KEY_ENCRYPTION_KEY>

<KEY_ENCRYPTION_KEY_HASH></KEY_ENCRYPTION_KEY_HASH>

</ENCRYPTION_KEY>

Example 2 – Using Customer Provided Key Encryption Key

The following example XML file uses the customer provided Key Encryption Key.

<ENCRYPTION_KEY action="add/modify">

<KEY_NAME>MySecretKey1</KEY_NAME>

<KEY_VALUE encrypt="n">C6F001370BF70172575D0D0C500E15F11155417B44F94C45DA1D634DDE31B63B</KEY_VALUE>

<KEY_ACTIVE>N</KEY_ACTIVE>

<CREATED>20180426070716</CREATED>

<LAST_USED>20180426071009</LAST_USED>

<DESCRIPTION>VDRNET-3523 First Key</DESCRIPTION>

<KEY_ENCRYPTION_KEY>C:\Admin\EncryptionKeys\ CurrentKEK.txt</KEY_ENCRYPTION_KEY>

<KEY_ENCRYPTION_KEY_HASH>BE6EA4C4E29793490828BA170076C6A7E61B36D8</KEY_ENCRYPTION_KEY_HASH>

</ENCRYPTION_KEY>