Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 12 Next »

 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 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

 Lucid Diagrams

Section 1: OEM Partner Account Setup

Introduction

This section outlines the process for setting up an OEM 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 Partner Account

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

  • 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.

  • DEV: Update the account status to “oem_Partner” 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:

update ch_account set reseller_id=99999, reseller_status=2, account_status='oem_Partner' where account_id=99999;

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

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. Billing Information Setup

image-20241025-185342.png

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.

image-20241025-180555.png

2. Select Subscription

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

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

Base subscription may autoselect.

Only 1 add on can be selected

image-20241025-183831.png

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.

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 Partner: can now use the end customer’s API Key to make API calls for content.

  • No labels