Expand

title	Table of Contents

Introduction

This guide provides a step-by-step walkthrough for setting up both OEM Partner accounts and OEM End-User accounts within the NextGen & CCH system. It is divided into two sections:

OEM Partner Account Setup: Covers the initial setup, configuration, and billing setup for OEM Partners.
OEM End-User Account Setup: Details the steps for OEM 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.

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

title	Lucid Diagrams

Section 1: OEM Partner Account Setup

Introduction

This section outlines the process for setting up an OEM Partner account that will be utilizing the NextGen APIs, configuring Authority Document access, and setting up billing information. It is important to understand that even though the account will be created in NextGen, there also must be an account in CCH because the Partner Postal (Reseller) requires a CCH account for authentication into the application. Furthermore, we will still be leveraging Authority Document Lists in CCH (as NextGen does not have the concept of Lists at this time) which therefore also requires a CCH account. So, these OEM partners will have two accounts, one in CCH and one in NextGen. Their customers, however, that they create accounts for will only have an account in NextGen.

Follow these steps to ensure that the OEM Partner account is correctly set up and equipped for content management utilizing NextGen APIs. Note that a few of these steps require direct database access (to be done by the development team).

1. Create a New OEM Partner Account in CCH

The following are the steps required to set up a new CCH OEM Partner account in CCH:

SALES: Create a new Account in CCH Production (account_status = demo). Note the account_ID value. The Partner can sign up and create this account themselves, or, Unified Compliance can create it for them. (Must use the partner’s email address for creation.)
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

language	sql

UPDATE ch_account SET reseller_id = 99999, reseller_status = 2, account_status = 'oem_vendor' WHERE account_id = 99999;

2. Configure 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.

Note
NOTE: An account may only have OEM or Non-OEM enablements and they can’t be mixed. Currently Nextgen (Non-OEM) is not supported and/or tested and is planned for a future release.

DEV: For a NextGen OEM Partner, run the following insert statement with the correct account_id value:

Code Block

language	sql

INSERT INTO reseller_enablements (type, account_id) values ('nextgen_oem', 99999);

3. Authority Document Access Configuration

SALES: Sales to provide DEV the list of Authority Document ID’s as specified in OEM 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

language	sql

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

4. Create NextGen Account

For the OEM Partner to get access to a NextGen API Key for them to make API calls themselves, we need to create a NextGen account for them.

SALES: Sign in to the Partner Portal, choose the Admin tab, search for the OEM Partner account, and the select Impersonate. Select a Customer Type of Nextgen OEM, and then choose Add Customer. Enter the First Name, Last Name, Email Address and Organization name of the partner and select Continue. Let the Dev team know that the account has been created.
DEV: Manually update the NextGen database to set the status value of the account to oem_vendor. The reseller_id should be correct if the account was created from the partner’s account, otherwise it will need to be set accordingly. Replace 99999 with the actual account ID in the SQL statement below:

Code Block

language	sql

UPDATE accounts SET "status" = 'oem_vendor' WHERE id = 99999;

5. Billing Information Setup

OEM Partner: Navigate to the Billing tab in the Partner Portal (https://partner.unifiedcompliance.com). NOTE: UCF can do this as well - impersonate the account in the Partner Portal and then go to the Billing tab and specify the billing information.
OEM Partner: Complete the required Admin/Billing user details and submit.

6. 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:

Section 2: OEM End-User Account Setup

Introduction

Once the OEM 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 Partner: Log into the Partner Portal and select Add Customer > Create New Account.
OEM Partner: Provide end-customer details (first and last name, email, organization name), and select Continue.

2. Select Subscription

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

OEM Partner: 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

3. Manage Lists

OEM Partner: In the Partner Portal, select View Customer > Manage Lists.
OEM Partner: 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.