Design Specifications Message Structures for Data Synchronization

Version 1.11

April 6, 2006

This requirements document contains confidential information that is proprietary to FARES. In consideration of receipt of this document, the recipient agrees to maintain such information in confidence and to not reproduce or otherwise disclose this information to any person or entity without prior consent from FARES management.

Document Control

Change Record Date Author Version 1.0 1.1 1.2 1.3 1.4 1.5 1.6 1.7 1.8 1.9 1.10 1.11 Change Reference Initial Draft Changed data type for array or list fields. Added message code field for status update messages. Added new messages for updating user / group profiles and user / group accesses. Update technical names for all update messages. Added new data fields to update user message, new group message, and update group message. Added new log message. Added new message structures for advanced limits at package, user access and group access levels. Changed update message structures for contractual limits, user profiles and group profiles. Added update message structure for package limits. Added new data elements to messages. Added new data elements to messages. Added new message for product/geo access. Added new fields for package level.

04/06/06 Dennis Niggl 04/17/06 Dennis Niggl 04/23/06 Dennis Niggl 05/12/06 Dennis Niggl 05/16/06 Dennis Niggl 06/28/06 Dennis Niggl 07/26/06 Dennis Niggl 09/13/06 Dennis Niggl 03/14/07 03/27/07 06/06/07 10/29/07 Reviewers Name Devesh Sharma August Harrison Daniel Liu Pankaj Parashar Larry Bailey Vasan Varadarajan Michael Mount Dennis Niggl Dennis Niggl Dennis Niggl Dennis Niggl

Position Director, Technical Systems Project Leader Manager, DBA Group Senior DBA Senior DBA Consultant Developer

Table Of Contents

_______________________________________________________________________ _Messages Page 2 9/22/2013

1.0 2.0

PURPOSE OF DESIGN SPECIFICATIONS MESSAGE SUMMARY

...............................................................................5 ...............11

.................................................................................................................5

3.0 ARCHITECTURE OVERVIEW (PROVISIONING TO PRODUCT SYSTEMS)

4.0 MESSAGE STRUCTURES FOR DATA SYNCHRONIZATION (PROVISIONING TO PASSPORT) ..................................................................................................................................................13 4.1 MESSAGE HEADER (MESSAGE_HEADER_MSG_T) ........................................................................13 4.2 NEW CONTRACT MESSAGE (NEW_CONTRACT_MSG_T) ..............................................................14 4.3 NEW PACKAGE MESSAGE (NEW_PACKAGE_MSG_T) ....................................................................16 4.4 NEW PRODUCT MESSAGE (NEW_PRODUCT_MSG_T)........................................................................17 4.5 NEW PRODUCT PRICING MESSAGE (NEW_PRICING_MSG_T) ...........................................................18 4.6 NEW USER PROFILE MESSAGE (NEW_USER_MSG_T).......................................................................19 4.7 NEW GROUP PROFILE MESSAGE (NEW_GROUP_MSG_T).................................................................20 4.8 NEW USER ACCESS MESSAGE (NEW_USER_ACCESS_MSG_T) .......................................................21 4.9 NEW GROUP ACCESS MESSAGE (NEW_GROUP_ACCESS_MSG_T) ................................................22 4.10 NEW PRODUCT MESSAGE FOR CREATE REPORT COVERAGE (NEW_REPORT_COVERAGE_MSG_T). 22 4.11 NEW CONTRACTUAL LIMITS MESSAGE (NEW_CONTRACTUAL_LIMITS_MSG_T) ........................23 4.12 UPDATE CONTRACT STATUS MESSAGE (UPDATE_CONTRACT_STATUS_MSG_T) ...........................23 4.13 UPDATE PACKAGE STATUS MESSAGE (UPDATE_PACKAGE_STATUS_MSG_T).................................24 4.14 UPDATE PACKAGE ADVANCED LIMIT MESSAGE (UPDATE_PKG_ADVLIMIT_MSG_T)......................24 4.15 UPDATE PRODUCT STATUS MESSAGE (UPDATE_PRODUCT_STATUS_MSG_T)..................................25 4.16 UPDATE USER ACCESS STATUS MESSAGE (UPDATE_ USER_ACCESS_STAT_MSG_T)......................25 4.17 UPDATE GROUP ACCESS STATUS MESSAGE (UPDATE_GROUP_ACCESS_STAT_MSG_T)..................25 4.18 UPDATE USER PROFILE STATUS MESSAGE (UPDATE_USER_STATUS_MSG_T) ...............................26 4.19 UPDATE GROUP PROFILE STATUS MESSAGE (UPDATE_GROUP_STATUS_MSG_T)...........................26 4.20 UPDATE PACKAGE LIMIT MESSAGE (UPDATE_PACKAGE_LIMIT_MSG_T) ....................................27 4.21 UPDATE PRODUCT LIMIT MESSAGE (UPDATE_PRODUCT_LIMIT_MSG_T)........................................28 4.22 UPDATE USER ACCESS LIMIT MESSAGE (UPDATE_USER_ACCESS_LIMIT_MSG_T).........................28 4.23 UPDATE USER ACCESS ADVANCED LIMITS MESSAGE (UPD_USER_ACCESS_ADVLIMIT_MSG_T). . .29 4.24 UPDATE USER ACCESS ADVANCED LIMIT OVERRIDE MESSAGE (UPD_UA_ADVLIMIT_OVERRIDE_MSG_T)...................................................................................................29 4.25 UPDATE GROUP ACCESS LIMIT MESSAGE (UPD_GROUP_ACCESS_LIMIT_MSG_T)..........................30 4.26 UPDATE GROUP ACCESS ADVANCED LIMITS MESSAGE (UPD_GROUP_ACCES_ADVLIMIT_MSG_T)30 4.27 UPDATE GROUP ACCESS ADVANCED LIMIT OVERRIDE MESSAGE (UPD_GA_ADVLIMIT_OVERRIDE_MSG_T)...................................................................................................31 4.28 UPDATE USER PROFILE MESSAGE (UPDATE_USER_MSG_T)...........................................................31 4.29 UPDATE GROUP PROFILE MESSAGE (UPDATE_GROUP_MSG_T)......................................................32 4.30 UPDATE USER ACCESS MESSAGE (UPDATE_USER_ACCESS_MSG_T) ............................................33 4.31 UPDATE GROUP ACCESS MESSAGE (UPDATE_GROUP_ACCESS_MSG_T) ....................................34 4.32 UPDATE USER PASSWORD MESSAGE (UPDATE_USER_PASSWORD_MSG_T) .................................34 4.33 UPDATE REPORT COVERAGE MESSAGE (UPDATE_REPORT_COVERAGE_MSG_T)...........................35 4.34 UPDATE BILLING PERIOD MESSAGE (UPD_CONTRACT_BILL_PERIOD_MSG_T) ............................35 4.35 UPDATE CONTRACT MESSAGE (UPDATE_CONTRACT_MSG_T).......................................................35 4.36 UPDATE CONTRACTUAL LIMITS MESSAGE (UPD_CONTRACTUAL_LIMITS_MSG_T) ....................36 4.37 UPDATE CONTRACT LIMIT MESSAGE (UPDATE_CONTRACT_LIMIT_MSG_T ................................37 4.38 TERMINATE CONTRACT MESSAGE (TERMINATE_CONTRACT_MSG_T) ........................................38 4.39 CUSTOMER MERGE MESSAGE (CUSTOMER_MERGE_MSG_T)...........................................................38 4.40 UPDATE PRODUCT GEO ACCESS MESSAGE (UPDATE_PRODUCT_GEO_ACCES_MSG_T) .............39 5.0 MESSAGE STRUCTURES FOR DATA SYNCHRONIZATION (PASSPORT TO PROVISIONING ........................................................................................................................................40 5.1 5.2 5.3 OVER LIMIT MESSAGE (OVERLIMIT_MSG_T) ...................................................................................40 UPDATE USER PASSWORD MESSAGE (UPDATE_USER_PASSWORD_MSG_T) ...................................41 LOG MESSAGE (LOG_MSG_T) ..........................................................................................................41

_______________________________________________________________________ _Messages Page 3 9/22/2013

5.4 5.5

NEW ROLLOVER AMOUNT MESSAGE (NEW_ROLLOVER_AMOUNT_MSG_T) ...................................42 TRANSACTION RESULTS MESSAGE (TRANS_RESULTS_MSG_T) ......................................................42

_______________________________________________________________________ _Messages Page 4 9/22/2013

1.0

Purpose of Design Specifications

The purpose of this document is to define the data structures for messages that are sent between Provisioning and Product Systems. Messages may be sent as a group or as individual messages. An example of a group would be a new contract which would include messages for contract, packages, products, pricing and user profiles. An individual message would be a single message such as update product status. Both group and individual messages will be preceded by a message header which will identify the type of message and transaction.

2.0

Message Summary

The table below summarizes the messages and shows the publisher and subscriber for each message. ID 1 2 3 4 Message Message Header New Contract New Package New Product Description Message Header identifies the message and transaction type. This message will be associated with one or more messages that follow the message header. New contract message contains general information about the contract. This message will be created for new contract, contract renewal and supersede. New package message contains information about the package related to the contract. This message will be created for new contract, contract renewal and supersede. New product message contains information about the product related to the package. This message will be created for new contract, contract renewal and supersede. Publisher Provisioning Provisioning Provisioning Provisioning Subscriber Passport Passport Passport Passport

___________________________________________________________________________________________________________ Messages Page 5 9/22/2013

ID 5

Message New Product Pricing

Description New product pricing message contains pricing data for each product included in the package. This message accommodates multiple pricing plans including range, point, in plan, overage and roaming. This message will be created for new contract, contract renewal and supersede. New user profile message contains information about each user. This message will be created when a new user is added or when specific user data is updated. New group profile message contains information about each group of users. This message will be created when a new group is added or when specific group data is updated. New user access message contains information related to which products a user is authorized to access. This message will be created when new user access to product is added or when specific user access data is updated. New group access message contains information related to which products a group of users are authorized to access. This message will be created when new group access to product is added or when specific group access data is updated. New product message contains information about each new product or report that is implemented. This message will be created when a new product or report is implemented for the first time. New contractual limits contain limits at the customer level and is used for global fraud detection. This message will be created for new contract, contract renewal and supersede.

Publisher Provisioning

Subscriber Passport

6 7 8

New User Profile New Group Profile New User Access

Provisioning Provisioning Provisioning

Passport Passport Passport

New Group Access

Provisioning

Passport

10

New Product Message

Provisioning

Passport

11

New Contractual Limits

Provisioning

Passport

___________________________________________________________________________________________________________ Messages Page 6 9/22/2013

ID 12 13 14

Message Update Contract Status Update Package Status Update Package Advanced Limit Status Update Product Status Update User Access Status Update Group Access Status Update User Profile Status Update Group Profile Status Update Package Limit

Description Contract status is used for shutoff or enablement of product downloads. This message will be created when a contract status is updated. Package status is used for shutoff or enablement of product downloads. This message will be created when a package status is updated. Package advanced limit status is used for shutoff or enablement of product downloads at the product level. This message will be created when a package/geo status is updated. Product status is used for shutoff or enablement of product downloads. This message will be created when a product status is updated. User access status is used for shutoff or enablement of product downloads for a specific user. This message will be created when user access status is updated. Group access status is used for shutoff or enablement of product downloads for a specific group of users. This message will be created when group access status is updated. User status is used for shutoff or enablement of all product downloads for a specific user. This message will be created when user status is updated. Group status is used for shutoff or enablement of all product downloads for a specific group of users. This message will be created when group status is updated. Package limits (quantity and/or dollar) are used for entitlement checking. This message will be created when a limit is updated at the package level.

Publisher Provisioning Provisioning Provisioning

Subscriber Passport Passport Passport

15 16 17 18 19 20

Provisioning Provisioning Provisioning Provisioning Provisioning Provisioning

Passport Passport Passport Passport Passport Passport

___________________________________________________________________________________________________________ Messages Page 7 9/22/2013

ID 21 22 23 24 25 26 27 28 29

Message Update Product Limit Update User Access Limit Update User Access Advanced Limits Update User Access Advanced Limit Override Update Group Access Limit Update Group Access Advanced Limits Update Group Access Advanced Limit Override Update User Profile Update Group Profile

Description Product limits (quantity and/or dollar) are used for entitlement checking. This message will be created when a limit is updated at the product level. User access limits (quantity and/or dollar) are used for entitlement checking. This message will be created when a limit is updated at the user product level. The update user access advanced limits message contains the advanced limits which are used for entitlement to a product (geo) by a specific user. The update user access advanced limit override message contains the advanced limits which are used for entitlement to a product (geo) by a specific user. Group access limits (quantity and/or dollar) are used for entitlement checking. This message will be created when a limit is updated at the group product level. The update group access advanced limits message contains the advanced limits which are used for entitlement to a product (geo) by a specific group of users. The update group access advanced limit override message contains the advanced limits which are used for entitlement to a product (geo) by a specific group. The update user profile message is used to update general information about a user such as first name, last name, email address and role. The update group profile message is used to update general information about a group of users such as group name.

Publisher Provisioning Provisioning Provisioning Provisioning Provisioning Provisioning Provisioning Provisioning Provisioning

Subscriber Passport Passport Passport Passport Passport Passport Passport Passport Passport

___________________________________________________________________________________________________________ Messages Page 8 9/22/2013

ID 30 31 32 33 34

Message Update User Access Update Group Access Update User Password Update Report Coverage Update Billing Period

Description The update user access message is used to update information related to which products and geo(s) a user can access. The update group access message is used to update information related to which products and geo(s) a group of users can access. Update user password message is used to update the password for a user. Report coverage message contains information about where products and data are available. This message will be created when specific report coverage data is updated. Billing period message contains the next billing period end date. This message will be used to trigger the bill period end date process where accumulators are reset to zero and inactive records are removed. This message will be used to update account data on the contract. Contractual limits contain limits at the customer level and can be used for global fraud detection. Terminate contract message is used to inactivate a contract and prevent users from accessing products and downloading reports. This message is used to restrict product and geographical access immediately after a contract has been created. Over limit message is used to inform Focus that an over limit condition has occurred in a product application. Update user password message is used to update the password for a user.

Publisher Provisioning Provisioning Provisioning Provisioning Provisioning

Subscriber Passport Passport Passport Passport Passport

35 36 37 38 39 40

Update Contract Message Update Contractual Limits Terminate Contract Update Product Geo Access Over limit Update User Password

Provisioning Provisioning Provisioning Provisioning Passport Passport

Passport Passport Passport Passport Provisioning Provisioning

___________________________________________________________________________________________________________ Messages Page 9 9/22/2013

ID 41 42

Message Log Transaction Results

Description The log message contains information about user login and logout. The transaction results message contains the status of an update transaction.

Publisher Passport Passport

Subscriber Provisioning Provisioning

___________________________________________________________________________________________________________ Messages Page 10 9/22/2013

3.0 Architecture Overview (Provisioning to Product Systems)

___________________________________________________________________________________________________________ Messages Page 11 9/22/2013

Architecture Overview (Product Systems to Provisioning)

___________________________________________________________________________________________________________ Messages Page 12 9/22/2013

4.0 Message Structures for Data Synchronization (Provisioning to Passport)

4.1 Message Header (message_header_msg_t) This message identifies the message and transaction type. This type of message will be needed for all messages regardless of destination. Name MESSAGE_TYPE Description Identifies the type of message (e.g. group, contract, package, product). Data Type Length

VARCHAR2 25 VARCHAR2 25

TRANSACTION_TYPE Identifies the type of transaction (e.g. new contract, user status update, password update)

_______________________________________________________________________ _Messages Page 13 9/22/2013

4.2 New Contract Message (new_contract_msg_t) The new contract message contains general information about the contract such as contract name, account number, account type, limits, billing period, current status and effective dates. Name CHR_ID CONTRACT_NAME ACCOUNT_ NUMBER CUSTOMER_ACCOUNT _ ID COMPANY_NAME ACCOUNT_TYPE FRAUD_ CHECK_FLAG MONTHLY_ FRAUD DOLLAR_LIMIT QUANTITY_LIMIT DOLLAR_LIMIT MONTHLY_FEE_ AMOUNT STATUS_ CODE MSG_CODE START_DATE END_DATE BILLING_PERIOD_ END_DATE OLD_CHR_IDS Description Contract header ID. Name assigned to contract. Account number. Customer account number. Company name. Identifies the type of account. Types include trial national, and regional. Indicates if fraud check is turned on or off (Y or N). Contract monthly fraud dollar limit. Contract monthly quantity limit. Dollar limit for contract. Monthly fee amount due from customer. Current Status Code for contract (e.g. A (Active), I (Inactive). Code related to a status and specific message passed to the product application. Start date of contract. Renewal date of contract. Billing period end dates for the contract. Can occur multiple times. List of old contract numbers that will be inactivated during a contract renewal or supersede process. Can occur multiple times. Zip code associated with billing address. Used for sales tax. Data Type NUMBER VARCHAR2 VARCHAR2 NUMBER VARCHAR2 VARCHAR2 CHAR NUMBER NUMBER NUMBER NUMBER VARCHAR VARCHAR DATE DATE DATE OLD_CONT RACT _LIST VARCHAR 9 10,2 10,2 1 2 Length

50 30

240 10 1 10,2

BILL_TO_ZIP_CODE

_______________________________________________________________________ _Messages Page 14 9/22/2013

Name ROLLOVER_FLAG CONTRACT_ PRICE_ DISPLAY_FLAG ENFORCE_LIMITS_FLA G

Description Indicates if rollover is enabled or not (Y or N). Indicates if pricing is to be displayed for all users associated with the contract. (Y=Yes, N=No). Used to indicate if entitlement rules are to be enforced for the application. Values are E = Enforce Limits, A = Allow to go over limit. Identifies the type of contract. Values are S = Subscription, T = Trial. Date and time contract was created. Date and time contract was last modified.

Data Type VARCHAR VARCHAR

Length 1 1

VARCHAR2

CONTRACT_TYPE CREATION_DATE LAST_UPDATE_ DATE

VARCHAR2 DATE DATE

_______________________________________________________________________ _Messages Page 15 9/22/2013

4.3 New Package Message (new_package_msg_t) The new package message contains information about the package such as associated contract, product application, geographies, limits, monthly commitment / fee amounts, current status and effective dates. Name CHR_ ID PACKAGE_ID GEO_LIST Description Contract header ID. Identifies the package associated with a contract. Identifies the geography associated with all products in the package. Can occur multiple times. Package monthly quantity limit. Package monthly dollar limit. List of data for specific product/geo combinations. This includes: product code, geo, quantity limit, dollar limit and enforce allow flag. Monthly commitment amount for the package. Monthly flat fee amount for the package. Indicates if rollover is enabled or not (Y or N) for the package. Current Status Code for product (e.g. A (Active), I (Inactive). Code related to a status and specific message passed to the product application. Start date for using package. Expiration date for using package. Date and time package was created. Date and time package was last modified. Data Type NUMBER NUMBER GEOLIST Length

QUANTITY_LIMIT DOLLAR_LIMIT ADVANCED_LIMITS

NUMBER NUMBER PROD_GEO_LIST 10,2

MONTHLY COMMITMENT AMOUNT FLAT_FEE AMOUNT ROLLOVER_FLAG STATUS_CODE MSG_CODE START_ DATE END_DATE CREATION_DATE LAST_UPDATE_ DATE

NUMBER

10,2

NUMBER VARCHAR2 VARCHAR2 VARCHAR DATE DATE DATE DATE

10,2 1 1 2

_______________________________________________________________________ _Messages Page 16 9/22/2013

4.4 New Product Message (new_product_msg_t) The new product message contains information about each product associated with a package such as product identifier, limits, current status and effective dates. Name CHR_ID PACKAGE_ID PRODUCT_CODE UNIT_OF_ MEASURE Description Contract header ID. Identifies the package associated with a contract. Identifies the product. Identifies what is being measured and quantified. Options will include searches, records downloaded and reports. Quantity limit associated with the number of products downloaded. Dollar limit associated with the product. Fraud quantity limit associated with the product. Data Type NUMBER NUMBER VARCHAR2 10 VARCHAR2 10 Length

QUANTITY_ LIMIT DOLLAR_LIMIT FRAUD_QUANTITY_ LIMIT

NUMBER NUMBER NUMBER VARCHAR2 1 VARCHAR2 1 VARCHAR DATE DATE DATE DATE 2 10,2

FRAUD_STATUS_CODE Fraud Status Code for the product (A=Active, I=Inactive). STATUS_CODE Current Status Code for the product (A=Active, I=Inactive). MSG_CODE Code related to a status and specific message passed to the product application. START_DATE Date users may begin using a product. END_DATE Date users must stop using a product. CREATION_DATE Date and time product was created. LAST_UPDATE_ DATE Date and time product was last modified.

_______________________________________________________________________ _Messages Page 17 9/22/2013

4.5 New Product Pricing Message (new_pricing_msg_t) The new product pricing message contains pricing data for each product included in the package. This message accommodates multiple pricing plans including range, point, in plan, overage and roaming. Name CHR_ID PACKAGE_ID PRODUCT_CODE PRICING_TYPE Description Contract header ID. Identifies the package associated with a contract. Identifies a product associated with a package. Data Type NUMBER NUMBER VARCHAR2 10 2 Length

VALUE 1

Indicates type of pricing (C = VARCHAR2 Commitment Based, RO=Roaming, FF= Flat Fee, PT=Point, RG=Range). When pricing type is Point or Range, NUMBER this is the beginning quantity within a range for product downloaded. When pricing type is Commitment, this is the In Plan unit price for the requested product. When pricing type is Point or Range, NUMBER this is the ending quantity within a range for the product downloaded. When pricing type is Commitment, this is the Overage unit price for the product downloaded. When pricing type is Point or Range, this is the unit price relative to the range for the product downloaded. When pricing type is Roaming, this is the Roaming unit price for the product downloaded. Date and time product pricing was created. Date and time product pricing was last modified. NUMBER

10,2

VALUE 2

10,2

VALUE 3

10,2

CREATION_DATE LAST_UPDATE_ DATE

DATE DATE

_______________________________________________________________________ _Messages Page 18 9/22/2013

4.6 New User Profile Message (new_user_msg_t) The new user profile message contains information about each user such as user identifier, user name, customer account, user role, status code and effective dates. Name USER_ID GROUP_ID CUST_ACCOUNT_ ID FIRST_ NAME LAST_ NAME TIER_NUMBER LOGIN_ID PASSWORD CHANGE_PASSW ORD_FLAG EMAIL_ADDRESS ROLE_CODE SALES_HISTORY_ YEARS HVE_USER_ID HVC_USER_ID MAX_CONCURRE NT_ SESSIONS NUMBER_CONCU RRENT_ SESSIONS ACCOUNT_TYPE PRICE_DISPLAY_ FLAG STATUS_ CODE MESSAGE_CODE Description Unique user identifier. Group that a user is assigned to. This is an option. Customer account number. Customer first name. Customer last name. Used to control access to applications during system outage or disaster recovery. User name for login. User password for login. Used to indicate that a password needs to be changed. Users email address. Role of user (e.g. Group Administrator, User). Number of years of sales transaction history desired. HVE user identifier. HVC user identifier. Data Type NUMBER NUMBER NUMBER VARCHAR2 VARCHAR2 NUMBER VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 NUMBER VARCHAR2 VARCHAR2 21 21 25 25 Lengt h

50 255 1 50 10

Specifies the maximum number of NUMBER concurrent sessions allowed for the user. Current number of concurrent sessions for a user. Type of account (e.g. national, regional, trial) Indicates if pricing is to be displayed for the user (Y or N). Current Status Code for user (e.g. A (Active), I (Inactive). Code related to a specific message passed to the application. NUMBER VARCHAR2 VARCHAR VARCHAR2 VARCHAR2 2 1 1 1 2

_______________________________________________________________________ _Messages Page 19 9/22/2013

Name START_DATE END_DATE CREATION_DATE LAST_UPDATE_ DATE

Description Start date that user may begin to use any product. End date for a user to access any product. Date and time user profile was created. Date and time user profile was last modified.

Data Type DATE DATE DATE DATE

Lengt h

4.7 New Group Profile Message (new_group_msg_t) The new group profile message contains information about each group of users such as group identifier, parent group identifier, customer account, status code and effective dates. Name GROUP_ID PARENT_GROUP_ ID GROUP_NAME CUST_ACCOUNT_ ID STATUS_CODE MSG_CODE PRICE_DISPLAY_FLAG START_DATE END_DATE CREATION_DATE LAST_UPDATE_ DATE Description Group that a user is assigned to. Parent group that a sub-group is assigned to. Name assigned to group. Customer account number. Current Status Code for group (e.g. A (Active), I (Inactive). Code related to a status and specific message passed to the product application. Indicates if pricing is to be displayed for the group (Y or N). Start date that group may begin to use any product. End date for a group to access any product. Date and time group profile was created. Date and time group profile was last modified. Data Type NUMBER NUMBER VARCHAR2 NUMBER VARCHAR2 VARCHAR VARCHAR DATE DATE DATE DATE 40 30 1 2 1 Lengt h

_______________________________________________________________________ _Messages Page 20 9/22/2013

4.8 New User Access Message (new_user_access_msg_t) The new user access message contains information related to which products a user can access. This includes limits, geographical restrictions, current status and effective dates. Name CHR_ ID PACKAGE_ ID PRODUCT_LIST USER_ID PRODUCT _INHERITANCE_TYP E QUANTITY_ LIMIT DOLLAR_LIMIT GEO_LIST GEO_INHERITANCE_ TYPE ADVANCED_LIMITS Description Contract header ID. Identifies the package associated with a contract. Products user is authorized to access. Can Occur multiple times. User identifier. Type of inheritance. Values are: N (normal), R (restrict), E (exclude). User monthly quantity limit for the product. User monthly dollar limit for the product. State and county user is authorized to access. Can Occur multiple times. Type of inheritance. Values are: N (normal), R (restrict), E (exclude). List of limits for specific product/geo combinations. This includes: product code, geo, quantity limit, dollar limit and enforce allow flag. Current Status Code of the product for the user (A=Active, I=Inactive). Code related to a status and specific message passed to the product application. Date and time user entitlement was created. Date and time user entitlement was modified. Data Type NUMBER NUMBER PRODUCTL IST NUMBER VARCHAR2 1 NUMBER NUMBER GEOLIST VARCHAR2 1 PROD_GEO _LIMIT_LIS T VARCHAR2 VARCHAR DATE DATE
1

Length

10,2

STATUS_CODE MSG_CODE CREATION_DATE LAST_UPDATE_DAT E

_______________________________________________________________________ _Messages Page 21 9/22/2013

4.9 New Group Access Message (new_group_access_msg_t) The new group access message contains information related to which products a group is entitled to use. This will include limits, geo restrictions, current status and effective dates. Name CHR_ ID PACKAGE_ ID PRODUCT_LIST GROUP_ID PRODUCT _INHERITANCE_TYP E QUANTITY_ LIMIT DOLLAR_LIMIT GEO_LIST GEO_INHERITANCE_ TYPE ADVANCED_LIMITS Description Contract header ID. Identifies the package associated with a contract. Products group is authorized to access. Can Occur multiple times. Group users are assigned to. Type of inheritance. Values are: N (normal), R (restrict), E (exclude). Group monthly quantity limit for the product. Group monthly dollar limit for the product. State and county group is authorized to access. Can Occur multiple times. Type of inheritance. Values are: N (normal), R (restrict), E (exclude). List of limits for specific product/geo combinations. This includes: product code, geo, quantity limit, dollar limit and enforce allow flag. Current Status Code of the product for the group (A=Active, I=Inactive). Code related to a status and specific message passed to the product application. Date and time group entitlement was created. Date and time group entitlement was modified. Data Type NUMBER NUMBER PRODUCTL IST NUMBER VARCHAR2 1 NUMBER NUMBER GEOLIST 10,2 5 Length

VARCHAR2 1 PROD_GEO _LIMITS_LI ST VARCHAR2 1 VARCHAR DATE DATE 2

STATUS_CODE MSG_CODE CREATION_DATE LAST_UPDATE_DAT E

4.10 New Product Message for Create Report Coverage (new_report_coverage_msg_t) The new product message contains information about each new product such as product identifier, geography, availability and effective dates. _______________________________________________________________________ _Messages Page 22 9/22/2013

Name PRODUCT CODE GEO STATE COUNTY AVAILABLE START_DATE END_DATE

Description Identifies the product. Geography associated with a product. State abbreviation. Name of County. Report availability indicator (Y=Yes, N=No). Date when report was first available. Date when report is no longer available.

Data Type VARCHAR VARCHAR2 VARCHAR VARCHAR CHAR DATE DATE

Length 10 10 2 40 1

4.11 New Contractual Limits Message (new_contractual_limits_msg_t) The new contractual limits message contains limits at a customer level which is related to all products across all contracts. These limits are used for fraud checking in product systems. Name Description Data Type NUMBER NUMBER NUMBER PROD_GEO_ LIMITS_LIS T NUMBER 10,2 Lengt h

CUSTOMER_ACCOUNT Customer account number. _ID CHR_ID Contract header ID. PACKAGE_ID ADVANCED_LIMITS Identifies the package associated with a contract. List of limits for specific product / geo combinations. This includes: product code, geo, quantity limit, dollar limit, and enforce allow flag. Dollar limit associated with the product.

DOLLAR_LIMIT

4.12 Update Contract Status Message (update_contract_status_msg_t) The contract message contains the contract identifier and status code which is used to shutoff or enable products related to a contract.

_______________________________________________________________________ _Messages Page 23 9/22/2013

Name CHR_ID STATUS_CODE MSG_CODE

Description Contract header ID. Current Status Code for the contract (A=Active, I=Inactive). Code related to a status and specific message passed to the product application.

Data Type NUMBER

Length

VARCHAR2 1 VARCHAR 2

4.13 Update Package Status Message (update_package_status_msg_t) The update package status message contains the contract, package and status code which is used to shutoff or enable a package. Name CHR_ID PACKAGE_ID STATUS_CODE MSG_CODE Description Contract header ID. Identifies the package associated with a contract. Current Status Code for the product (A=Active, I=Inactive). Code related to a status and specific message passed to the product application. Data Type NUMBER NUMBER VARCHAR2 1 VARCHAR 2 Length

4.14 Update Package Advanced Limit Message (update_pkg_advlimit_msg_t) The update package advanced limit status message contains the contract, package, product and geo that may be enabled or disabled. Name CHR_ID PACKAGE_ID ADVANCED_LIMITS Description Contract header ID. Identifies the package associated with a contract. An array of products, geos, limits and enforce_allow_flags associated with the package. Data Type NUMBER NUMBER PROD_GEO_LIMITS_LIS T Length

_______________________________________________________________________ _Messages Page 24 9/22/2013

4.15 Update Product Status Message (update_product_status_msg_t) The update product status message contains the contract, package, product identifier and status code which is used to shutoff or enable a product. Name CHR_ID PACKAGE_ID PRODUCT_CODE MSG_CODE STATUS_CODE Description Contract header ID. Identifies the package associated with a contract. Identifies the product associated with a package. Message stating the reason why status was changed to inactive. Current Status Code for the product (A=Active, I=Inactive). Data Type NUMBER NUMBER VARCHAR2 10 VARCHAR2 2 VARCHAR2 1 Length

4.16 Update User Access Status Message (update_ user_access_stat_msg_t) The update user access status message contains the contract, package, product identifier, user identifier and status code which is used to shutoff or enable a product for a user. Name CHR_ID PACKAGE_ID PRODUCT_CODE USER_ID MSG_CODE STATUS_CODE Description Contract header ID. Identifies the package associated with a contract. Identifies the product associated with a package. User identifier. Message stating the reason why status was changed to inactive. Current Status Code for the product (A=Active, I=Inactive). Data Type NUMBER NUMBER VARCHAR2 10 NUMBER VARCHAR2 2 VARCHAR2 1 Length

4.17 Update Group Access Status Message (update_group_access_stat_msg_t) The update group access status message contains the contract, package, product identifier, group identifier and status code which is used to shutoff or enable a product for a group of users.

_______________________________________________________________________ _Messages Page 25 9/22/2013

Name CHR_ID PACKAGE_ID PRODUCT_CODE GROUP_ID MSG_CODE STATUS_CODE

Description Contract header ID. Identifies the package associated with a contract. Identifies the product associated with a package. Group one or more users are assigned to. Message stating the reason why status was changed to inactive. Current Status Code for the product (A=Active, I=Inactive).

Data Type NUMBER NUMBER

Length

VARCHAR2 10 NUMBER VARCHAR2 2 VARCHAR2 1

4.18 Update User Profile Status Message (update_user_status_msg_t) The update user profile message contains the user identifier and status code which is used to shutoff or enable a users access to products. Name USER_ID GROUP_ID STATUS_ CODE MSG_CODE Description Unique user identifier. Group that a user is assigned to. This is an optional. Current Status Code for user (e.g. A (Active), I (Inactive). Code related to a status and specific message passed to the product application. Data Type NUMBER NUMBER VARCHAR2 VARCHAR 1 2 Lengt h

4.19 Update Group Profile Status Message (update_group_status_msg_t) The update group profile status message contains the group identifier and status code which is used to shutoff or enable a group of user's access to products.

_______________________________________________________________________ _Messages Page 26 9/22/2013

Name GROUP_ID PARENT_GROUP_ ID STATUS_ CODE MSG_CODE

Description Group that a user is assigned to. This is an option. Parent group that a sub-group is assigned to. Current Status Code for user (e.g. A (Active), I (Inactive). Code related to a status and specific message passed to the product application.

Data Type NUMBER NUMBER VARCHAR2 VARCHAR

Lengt h

1 2

4.20 Update Package Limit Message (update_package_limit_msg_t) The update package limit message contains the contract, package and limits which are used for entitlement at the package level. Name CHR_ ID PACKAGE_ID QUANTITY_LIMIT DOLLAR_LIMIT Description Contract header ID. Identifies the package associated with a contract. Package monthly quantity limit. Package monthly dollar limit. Data Type NUMBER NUMBER NUMBER NUMBER 10,2 Length

_______________________________________________________________________ _Messages Page 27 9/22/2013

4.21 Update Product Limit Message (update_product_limit_msg_t) The update product limit message contains the contract, package, product identifier and limits which are used for entitlement to product. Name CHR_ID PACKAGE_ID PRODUCT_CODE QUANTITY _LIMIT DOLLAR _LIMIT Description Contract header ID. Identifies the package associated with a contract. Identifies the product associated with a package. Quantity limit associated with the number of downloads for a product. Dollar limit associated with an amount for a product downloaded. Data Type NUMBER NUMBER VARCHAR2 10 NUMBER NUMBER 10,2 10,2 Length

4.22 Update User Access Limit Message (update_user_access_limit_msg_t) The update user access limit message contains the contract, package, user identifier and limits which are used for entitlement to a product by a specific user. Name CHR_ID PACKAGE_ID USER_ID QUANTITY _LIMIT DOLLAR _LIMIT Description Contract header ID. Identifies the package associated with a contract. User identifier. Quantity limit associated with the number of downloads of a product by a user. Dollar limit associated with an amount for a product downloaded by a user. Data Type NUMBER NUMBER NUMBER NUMBER NUMBER 10,2 Length

_______________________________________________________________________ _Messages Page 28 9/22/2013

4.23 Update User Access Advanced Limits Message (upd_user_access_advlimit_msg_t) The update user access advanced limits message contains the contract, package, user identifier and advanced limits which are used for entitlement to a product (geo) by a specific user. Name CHR_ID PACKAGE_ID USER_ID ADVANCED_LIMITS Description Contract header ID. Identifies the package associated with a contract. User identifier. Data Type NUMBER NUMBER NUMBER Length

List of limits for PROD_GEO_LIMIT_LIS specific product/geo T combinations. This includes: product code, geo, quantity limit and dollar limit.

4.24 Update User Access Advanced Limit Override Message (upd_ua_advlimit_override_msg_t) The update user access advanced limit status message contains the contract, package, product and geo that may be enabled or disabled for a user. Name USER_ID CHR_ID PACKAGE_ID PRODUCT_CODE GEO Description User identifier. Contract header ID. Identifies the package associated with a contract. Identifies the product associated with a package. Identifies the geography associated with all products in the package. Data Type NUMBER NUMBER NUMBER VARCHAR2 10 VARCHAR2 10 Length

_______________________________________________________________________ _Messages Page 29 9/22/2013

Name

Description

Data Type

Length

ENFORCE_ALLOW_FLAG Used to enable or disable product access at the geo level. E - disable product access in this geo when the limit is reached. A allow product access in this geo.

VARCHAR2 1

4.25 Update Group Access Limit Message (upd_group_access_limit_msg_t) The update group access limit message contains the contract, package, product identifier, group identifier and limits which are used for entitlement to a product by a specific group of users. Name CHR_ID PACKAGE_ID GROUP_ID QUANTITY _LIMIT DOLLAR _LIMIT Description Contract header ID. Identifies the package associated with a contract. Group one or more users are assigned to. Quantity limit associated with the number of downloads of a product by a group of users. Dollar limit associated with an amount for a product downloaded by a group of users. Data Type NUMBER NUMBER NUMBER NUMBER NUMBER 10,2 Length

4.26 Update Group Access Advanced Limits Message (upd_group_acces_advlimit_msg_t) The update group access advanced limits message contains the contract, package, user identifier and advanced limits which are used for entitlement to a product (geo) by a specific user. Name CHR_ID PACKAGE_ID GROUP_ID Description Contract header ID. Identifies the package associated with a contract. Group one or more users are assigned to. Data Type NUMBER NUMBER NUMBER Lengt h

_______________________________________________________________________ _Messages Page 30 9/22/2013

Name ADVANCED_LIMITS

Description List of limits for specific product/geo combinations. This includes: product code, geo, quantity limit and dollar limit.

Data Type PROD_GEO_LIMIT_LIS T

Lengt h

4.27 Update Group Access Advanced Limit Override Message (upd_ga_advlimit_override_msg_t) The update group access advanced limit status message contains the contract, package, product and geo that may be enabled or disabled for a group. Name GROUP_ID CHR_ID PACKAGE_ID Description User identifier. Contract header ID. Data Type NUMBER NUMBER NUMBER VARCHAR2 10 VARCHAR2 10 VARCHAR2 1 Length

Identifies the package associated with a contract. PRODUCT_CODE Identifies the product associated with a package. GEO Identifies the geography associated with all products in the package. ENFORCE_ALLOW_FLAG Used to enable or disable product access at the geo level. E - disable product access in this geo when the limit is reached. A allow product access in this geo.

4.28 Update User Profile Message (update_user_msg_t) The update user profile message contains information about each user such as user identifier, first name, last name, email address and role. Name USER_ID Description Unique user identifier. Data Type NUMBER Lengt h

_______________________________________________________________________ _Messages Page 31 9/22/2013

Name GROUP_ID FIRST_ NAME LAST_ NAME EMAIL_ADDRESS ROLE_CODE CHANGE_PASSW ORD_FLAG MAX_CONCURRE NT_ SESSIONS TIER_NUMBER CUST_ACCOUNT_ ID ACCOUNT_TYPE HVE_USER_ID HVC_USER_ID PRICE_DISPLAY_ FLAG STATUS_CODE MSG_CODE START_DATE END_DATE CREATION_DATE LAST_UPDATE_ DATE

Description Group that a user is assigned to. This is an option. Customer first name. Customer last name. Users email address. Role of user (e.g. Group Administrator, User). Used to indicate that a password needs to be changed. Specifies the maximum number of concurrent sessions allowed for the user. Used to control access to applications during system outage or disaster recovery. Customer account number. Type of account (S=Subscription, H=House, T=Trial). HVE user identifier. HVC user identifier. Indicates if pricing is to be displayed for the user (Y or N). Current Status Code for user. (A=Active, I=Inactive). Code related to a status and specific message passed from Focus to the product application. Start date that user may begin to use any product. End date for a user to access any product. Date and time user profile was created. Date and time user profile was last modified.

Data Type NUMBER VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 NUMBER NUMBER NUMBER VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR VARCHAR2 VARCHAR DATE DATE DATE DATE

Lengt h 25 25 50 10 1

1 21 21 1 1 2

4.29 Update Group Profile Message (update_group_msg_t) The update group profile message contains information about each group of users such as group name. _______________________________________________________________________ _Messages Page 32 9/22/2013

Name GROUP_ID PARENT_GROUP_ ID GROUP_NAME CUST_ACCOUNT_ID START_DATE END_DATE STATUS_CODE MSG_CODE PRICE_DISPLAY_FLAG CREATION_DATE LAST_UPDATE_DATE

Description Group that a user is assigned to. Parent group that a sub-group is assigned to. Name assigned to group. Customer account number. Date a group may begin using a product. Date a group must stop using a product. Current Status Code for user. (A=Active, I=Inactive). Code related to a status and specific message passed from Focus to the product application. Indicates if pricing is to be displayed for the group (Y or N). Date and time group entitlement was created. Date and time group entitlement was modified.

Data Type NUMBER NUMBER VARCHAR2 NUMBER DATE DATE VARCHAR2 VARCHAR VARCHAR DATE DATE

Lengt h

40

1 2 1

4.30 Update User Access Message (update_user_access_msg_t) The update user access message contains information related to which products a user can access. This includes product list, geo list and inheritance type. Name CHR_ ID PACKAGE_ ID USER_ID PRODUCT_LIST PRODUCT _INHERITANCE_TYP E Description Contract header ID. Identifies the package associated with a contract. User identifier. Products user is authorized to access. Can Occur multiple times. Type of inheritance. Values are: N (normal), R (restrict), E (exclude). Data Type NUMBER NUMBER NUMBER PRODUCTL IST VARCHAR2 1 Length

_______________________________________________________________________ _Messages Page 33 9/22/2013

Name GEO_LIST GEO_INHERITANCE_ TYPE MSG_CODE

Description State and county user is authorized to access. Can Occur multiple times. Type of inheritance. Values are: N (normal), R (restrict), E (exclude). Code related to a status and specific message passed from Focus to the product application.

Data Type GEOLIST

Length

VARCHAR2 1 VARCHAR 2

4.31 Update Group Access Message (update_group_access_msg_t) The update group access message contains information related to which products a group of users can access. This includes product list, geo list and inheritance type. Name CHR_ ID PACKAGE_ ID GROUP_ID PRODUCT_LIST PRODUCT _INHERITANCE_TYP E GEO_LIST GEO_INHERITANCE_ TYPE MSG_CODE Description Contract header ID. Identifies the package associated with a contract. Group users are assigned to. Products group is authorized to access. Can Occur multiple times. Type of inheritance. Values are: N (normal), R (restrict), E (exclude). State and county group is authorized to access. Can Occur multiple times. Type of inheritance. Values are: N (normal), R (restrict), E (exclude). Code related to a status and specific message passed from Focus to the product application. Data Type NUMBER NUMBER NUMBER PRODUCTL IST VARCHAR2 GEOLIST VARCHAR2 VARCHAR 1 5 1 2 Length

4.32 Update User Password Message (update_user_password_msg_t) The update user password message contains the user identifier and password which is used to login to a product application. _______________________________________________________________________ _Messages Page 34 9/22/2013

Name USER_ID PASSWORD

Description Unique user identifier. User password for login.

Data Type NUMBER VARCHAR2

Lengt h 255

4.33 Update Report Coverage Message (update_report_coverage_msg_t) The update report coverage message contains information that may change for report coverage such as availability and start / end dates. Name PRODUCT CODE GEO AVAILABLE START_DATE END_DATE Description Identifies the product. Geography associated with a product. Report availability indicator (Y=Yes, N=No). Date when report was first available. Date when report is no longer available. Data Type VARCHAR VARCHAR2 CHAR DATE DATE Length 10 10 1

4.34 Update Billing Period Message (upd_contract_bill_period_msg_t) The update billing period date is used by the billing period end process to maintain the cumulative indexes and totals tables. Name CHR_ID Description Contract header ID. Data Type NUMBER DATE NUMBER 10,2 Length

BILLING_PERIOD_ Contract billing period end date. END_DATE ROLLOVER_ Rollover amount that needs to be AMOUNT applied to a specific billing period.

4.35 Update Contract Message (update_contract_msg_t) This message will be used to update account data on the contract. _______________________________________________________________________ _Messages Page 35 9/22/2013

Name CHR_ID CONTRACT NAME ACCOUNT_ NUMBER ACCOUNT_TYPE CUSTOMER_ACC OUNT_ ID BILL_TO_ZIP_CO DE CONTRACT_ PRICE_ DISPLAY_FLAG ENFORCE_LIMIT S_FLAG CONTRACT_TYP E START_DATE END_DATE

Description Contract header ID. Name assigned to contract. Customer account number. Identifies the type of account. Types include trial national, and regional. Customer account identifier. Zip code associated with billing address. Used for sales tax. Indicates if pricing is to be displayed for all users associated with the contract. (Y=Yes, N=No). Used to indicate if entitlement rules are to be enforced for the application. Values are E = Enforce Limits, A = Allow to go over limit. Identifies the type of contract. Values are S = Subscription, T = Trial. Start date for contract. End date for contract.

Data Type NUMBER VARCHAR2 VARCHAR2 VARCHAR2 NUMBER VARCHAR2 VARCHAR VARCHAR2

Lengt h 50 30 10

9 1 1

VARCHAR2 DATE DATE

4.36 Update Contractual Limits Message (upd_contractual_limits_msg_t) This message is used to update contractual limits and status at a customer level which is related to all products across all contracts. These limits can be used for fraud checking in product systems. Name Description Data Type NUMBER NUMBER NUMBER Lengt h

CUSTOMER_ACCOUNT Customer account number. _ID CHR_ID Contract header ID. PACKAGE_ID Identifies the package associated with a contract.

_______________________________________________________________________ _Messages Page 36 9/22/2013

Name ADVANCED_LIMITS

Description List of limits for specific product / geo combinations. This includes: product code, geo, quantity limit, dollar limit, and enforce allow flag. For trial accounts product code will be MAXRECORDS, Geo will be US000, and quantity limit will be the maximum number of records. Dollar limit associated with the product.

Data Type PROD_GEO_ LIMITS_LIS T

Lengt h

DOLLAR_LIMIT

NUMBER

10,2

4.37 Update Contract Limit Message (update_contract_limit_msg_t This message is used to update quantity and/or dollar limit at the contract level. Limits are used during entitlement checking by the product application. Name CHR_ ID Description Contract header ID. Data Type NUMBER VARCHAR2 1 Len gth

ENFORCE_LIMITS_FLA Used to indicate if entitlement G rules are to be enforced for the application. Values are E = Enforce Limits, A = Allow to go over limit. QUANTITY_LIMIT Contract monthly quantity limit. DOLLAR_LIMIT EFFECTIVE_DATE Contract monthly dollar limit. Date that limits will be in effect.

NUMBER NUMBER DATE

10,2 10,2

_______________________________________________________________________ _Messages Page 37 9/22/2013

4.38 Terminate Contract Message (terminate_contract_msg_t) This message is used to inactivate a contract and prevent users associated with the contract from accessing products and downloading reports. Name CHR_ID STATUS_CODE MSG_CODE END_DATE Description Contract header ID. Current Status Code for the product (A=Active, I=Inactive). Code related to a status and specific message passed to the product application. Date users must stop using a product. Data Type NUMBER VARCHAR2 VARCHAR DATE 1 2 Lengt h

4.39 Customer Merge Message (customer_merge_msg_t) This message will be used to support the customer account merge function in Oracle. For customer accounts that are merged with another customer, the account number and customer account ID on the contract(s) will be updated to be the same as the TO contract account number and customer account ID. Name TO_CHR_ID TO_ACCOUNT_ NUMBER TO_CUSTOMER_AC COUNT_ID FROM_CHR_ID_LIS T Description Contract header ID. Account number. Customer account identifier. List of contracts that will need to have their account data updated to be the same as the TO contract account data. Data Type NUMBER VARCHAR2 NUMBER FROM_CONTRACT_LIS T 30 Length

_______________________________________________________________________ _Messages Page 38 9/22/2013

4.40 Update Product Geo Access Message (update_product_geo_acces_msg_t) This message is used to update product and geo access shortly after a contract has been created, provisioned and processed in passport. Name CHR_ ID PACKAGE_ ID Description Contract header ID. Data Type NUMBER Length

Identifies the package NUMBER associated with a contract. PRODUCT_LIST_A List of Product codes that users PRODUCTLIST CTIVE and groups are authorized to access. Products not on this list, but on the package, should have a status of 'I'. GEO_LIST_ACTIVE List of States and counties GEOLIST (FIPS codes) users and groups are authorized to access. Access to other Geos are not allowed. MSG_CODE Code related to a status and specific message passed from Focus to the product application. Should have a value of 'RV' VARCHAR 2

_______________________________________________________________________ _Messages Page 39 9/22/2013

5.0 Message Structures for Data Synchronization (Passport to Provisioning

5.1 Over limit Message (overlimit_msg_t) The over limit message is used to inform Focus that an over limit condition has occurred in a product application. Name CHR_ID PACKAGE_ID PRODUCT_CODE GEO GROUP_ID USER_ID COUNTER_ID COUNTER_TYPE Description Contract header ID. Identifies the package associated with a contract. Identifies the product associated with a package. Identifies the geography associated with all products in the package. Data Type NUMBER NUMBER VARCHAR2 VARCHAR2 10 10 Length

Group that a user is assigned to. This NUMBER is an optional. Unique user identifier. NUMBER Counter identifier. Identifies type of counter (e.g. contract, package, product, user product). User monthly quantity limit for the product. User monthly dollar limit for the product. Cumulated quantity of products downloaded. Cumulated Cost for products downloaded. Code associated with a message Descriptive message. Date when message was sent. NUMBER VARCHAR2 10 20

QUANTITY_ LIMIT DOLLAR_LIMIT QUANTITY_USAGE DOLLAR_USAGE MSG_CODE MSG_TEXT MSG_DATE

NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2 DATE NUMBER VARCHAR2 15 10 10,2 15 300 10,2

DUE_TO_USER_ID Unique user identifier. DUE_TO_PRODUCT_ Identifies the product associated CODE with a package.

_______________________________________________________________________ _Messages Page 40 9/22/2013

5.2 Update User Password Message (update_user_password_msg_t) The update user password message contains the user identifier and password which is used to login to a product application. Name USER_ID GROUP_ID PASSWORD Description Unique user identifier. Group that a user is assigned to. This is an optional. User password for login. Data Type NUMBER NUMBER VARCHAR2 255 Length

5.3 Log Message (log_msg_t) The log message contains information about user login and logout. This data is captured and sent to provisioning each time a user logs in or logs out of a product application. Name TYPE USER_ID SESSION_COUNT STATUS LOG_DATE Description Identifies the type of log. Type can be login or logout. Unique user identifier. Number of users logged into the product application. Status of login or logout function. Log status can be success or failure. Date and time user logged in or logged out of the product application. Data Type VARCHAR2 NUMBER NUMBER VARCHAR2 DATE 8 Length 6

_______________________________________________________________________ _Messages Page 41 9/22/2013

5.4 New Rollover Amount Message (new_rollover_amount_msg_t) This message will be created in passport and sent to provisioning when a rollover amount is calculated. This new message is needed to support ListSource subscriptions. Name CHR_ID PACKAGE_ID Description Contract Header ID Identifies the package associated with a contract. If this field contains null values then the rollover amount is applied at the contract level. Contract billing period end date. Calculated dollar amount of unused commitment that can be used in future billing periods. Data Type NUMBER NUMBER Length

BILLING_PERIOD_ END_DATE ROLLOVER_AMOUNT

DATE NUMBER 10,2

5.5 Transaction Results Message (trans_results_msg_t) The transaction results message provides the status of an update transaction to provisioning. Name CHR_ID PACKAGE_ID PRODUCT_CODE GEO GROUP_ID USER_ID RESULT_CODE RESULT_TEXT FOCUS_MSG_ID Description Contract header ID. Identifies the package associated with a contract. Identifies the product associated with a package. Identifies the geography associated with all products in the package. Group that a user is assigned to. This is an optional. Unique user identifier. Code associated with a message Descriptive message. Unique transaction identifier. Data Type NUMBER NUMBER VARCHAR2 VARCHAR2 NUMBER NUMBER NUMBER VARCHAR2 NUMBER 15 300 20 10 10 Lengt h

_______________________________________________________________________ _Messages Page 42 9/22/2013