Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Expand
titleTable of Contents
Table of Contents
minLevel1
maxLevel3
outlinefalse
stylenone
typelist
printabletrue
Lucidchart
pageCount3
autoUpdatefalse
alignleft
typerich
autoSize1
macroIdac450dce-cb12-41b1-8460-3a59d2d77b73
instanceIdConfluence:0040515398
pages
width700
documentTokenv2_ac57583258bc85b7e64fa51dd532079c9eed4dcbcdf271e26a420158fc64cb14-a=142689142&c=Confluence%3A0040515398&d=0316fdb8-9949-4bc6-8e0b-ab97fe4d9d6c&p=2658369541
documentId0316fdb8-9949-4bc6-8e0b-ab97fe4d9d6c
updated1732291207445
height500

Introduction

This guide provides a step-by-step walkthrough for setting up both OEM

Vendor

Partner accounts and OEM End-User accounts within the CCH system. It is divided into two sections:

  • OEM

Vendor
  • Partner Account Setup: Covers the initial setup, configuration, and billing setup for OEM

Vendors
  • Partners.

  • OEM End-User Account Setup: Details the steps for OEM

Vendors Section 1: OEM Vendor
  • Partners to create and manage end-customer accounts.

Each section includes specific roles and tasks involved in the setup, along with SQL commands and portal actions where applicable.

Expand
titleTable of Contents
Table of Contents
minLevel1
maxLevel3
outlinefalse
stylenone
typelist
printabletrue

References

https://unifiedcompliance.atlassian.net/wiki/x/CgDln

Legacy (CCH) OEM Partner - API Quick Start Guide

Related PRDs

/wiki/spaces/ICP/pages/2598764545

/wiki/spaces/ICP/pages/2656436242

/wiki/spaces/ICP/pages/2656436227

Flows

Expand
titleLucid Diagrams
Lucidchart
urlhttps://lucid.app/lucidchart/0db104c7-a907-42f8-ba37-570a7b34f971/edit?viewport_loc=-772%2C630%2C3105%2C1433%2C0_0&invitationId=inv_9de32dd0-e969-4fde-9778-3e04e0b26e94
Lucidchart
urlhttps://lucid.app/lucidchart/0316fdb8-9949-4bc6-8e0b-ab97fe4d9d6c/edit?viewport_loc=-260%2C-72%2C2812%2C1542%2Cm-5o7ONTd-nK&invitationId=inv_2314b820-d4ae-46af-ab99-2b4e26554b54

Section 1: OEM Partner Account Setup

Introduction

This section outlines the process for setting up an OEM Vendor Partner account, configuring Authority Document access, and setting up billing information. Follow these steps to ensure that the account is correctly established and equipped for content management.

1. Create a New OEM

Vendor

Partner Account

The following are the steps required to set up a new CCH OEM Vendor Partner that requires database access:

  • SALES: Create a new Account in CCH Production (account_status = DEMO). Note the account_ID value. The vendor Partner can sign up and create this account themselves, or, Unified Compliance can create it for them.

  • DEV: Update the account status to “oem_vendor” and put the account in the Partner Portal. Run the following SQL and change the reseller_id and account_id value to the one from step #1:

Code Block
languagesql
update ch_account set reseller_id=99999, reseller_status=2, account_status='oem_vendor' where account_id=99999;

2. Enable Customer Type

In the Partner Portal, a customer type dropdown has been added with these possible values: CCH, CCH OEM, Nextgen, and Nextgen OEM. We need to specify which of these this account will have access to. In the short-term, we expect accounts will only have access to one of these, but it is possible for an account to have multiple of them enabled. A new reseller_enablements table has been added for this and these are the possible TYPE values: cch, cch_oem, nextgen, nextgen_oem. So, for a CCH OEM Partner, run the following insert statement with the correct account_id value:

insert into reseller_enablements (type, account_id) values ('cch_oem', 99999);

3. Authority Document Access Configuration

  • SALES: Sales to provide DEV the list of Authority Document ID’s as specified in OEM Vendor Partner contract.

  • DEV: Configure the account to have access to list of AD IDs provided by Sales. Replace the account_id below with the one from step #1 and the AD ID’s to the ones provided by Sales:

Code Block
languagesql
insert into entity_singular_entitlements (class_name, entity_id, account_id)
select 'Db_Entity_AuthorityDocument', ad_id , 99999
from authority_documents where ad_id in (3687,3242,3241,3240,3224,3222,3221,3212,3647,3292,3567,3430,3714,3201,3986,3960,3200,3208,986,985,3946,3134,3417,3416,3438,3415,3420,3419,102,2935,3009,176);
  • SALES / SUPPORT: Log in to CCH Manage in production and impersonate the Admin user of the account, and create the Authority Document List(s) that correspond to their contractual list of authority documents. The lists can be created manually OR imported from published lists that UCF may have already created. NOTE: Only lists created via impersonate will appear in the Partner Portal. It is possible to manually update a list that was not created via impersonate (should we need to) by setting ch_authdoc_list.reseller_assignable = 1

3

4. Billing Information Setup

  • OEM VENDORPartner: Navigate to the Billing tab in the Partner Portal (https://partner.unifiedcompliance.com)

  • OEM VENDORPartner: Complete the required Admin/Billing user details and submit.

image-20241025-185342.png

5. Configure Discount / Coupon Code Amount

This step is optional. Due to the workload of manually managing invoices for a large number of customers, the majority of OEM Partners will be comp’ed in Recurly using a 100% coupon code. This configuration can be accomplished in the Partner Portal or in Recurly itself. Follow these steps to update in the Partner Portal.

  • SALES: Configure the appropriate coupon code amount for the account. Sign in to the Partner Portal under the Unified Compliance account, then go to the Admin tab, search for the account (the OEM Partner account in CCH) and then select the Manage button, specify the Discount amount (up to 100%) and press UPDATE:

image-20241210-175314.pngImage Added

Section 2: OEM End-User Account Setup

Introduction

Once the OEM Vendor Partner account is set up, this section details the process for adding and managing end-customer accounts. It includes steps for subscription setup, list management, and enabling API access to Authority Documents for each end customer.

1. End Customer Account Creation

  • OEM VENDORPartner: Log into the Partner Portal and select Add Customer > Create New Account.

  • OEM VENDORPartner: Provide end-customer details (first and last name, email, organization name), and select Continue.

image-20241025-180555.png

2. Select Subscription

  • OEM VENDORPartner: Fill out the street address, city, state, county, and zip code. If applicable, add a PO Number.

image-20241025-180831.png
  • OEM VENDORPartner: Choose the base subscription and appropriate Add-On. Select Checkout to complete the subscription setup.

Info

Base subscription may autoselect.

Note

Only 1 add on can be selected

image-20241025-183831.pngImage Removedimage-20241211-213335.pngImage Added

3.

Manager

Manage Lists

  • OEM VENDORPartner: In the Partner Portal, select View Customer > Manage Lists.

  • OEM VENDORPartner: Add the applicable Authority Document List based on the purchased Add-On. This will copy the list into the end customer account and grant access to the documents included in that list.

Note

NOTE: Once a list has been added, it cannot be removed (as a security measure). Contact Development should a list need to be removed.

image-20241025-190002.png

4. Final Configuration

  • OEM VendorPartner: can now use the end customer’s API Key to make API calls for content.