Epicor Kinetic Cloud
This article contains needed information specific to Epicor Kintetic Cloud, including prerequisites, ordering, setting up the product, and enabling access.
Prerequisites
The following are the prerequisites required before setting up Spreadsheet Server with Epicor Kinetic Cloud.
- Order a Cloud Connector Environment
- Add or Remove Users to the Cloud Connector Environment
- Cloud Connector User Email Verification
- Cloud Connector Multi-Factor Authentication
Order a Cloud Connector Environment
The Cloud Connector environment hosts a replication database that stores Epicor Kinetic Cloud data. Spreadsheet Server then queries the Cloud Connector environment, rather than Epicor Kinetic Cloud directly.
To order a Cloud Connector environment, email insightsoftware support at globalsupport@insightsoftware.com, using the below subject and body text as a template:
Email Template
Subject: New Cloud Connector Instance – [Company Name]
Body:
Company: [Company Name]
Country: [Country Name]
Environment: Production
ERP: Epicor Kinetic Cloud
Product: Spreadsheet Server - Cloud Connector
DB Type: PostgreSQL
Primary User: [FirstName LastName:EmailAddress]
Additional Users: [FirstName1 LastName1:Email1,FirstName2 LastName2:Email2...]
- Replace all variables contained in brackets with the appropriate information.
- Sending this email generates a support case, which the insightsoftware support team will reply to by email to confirm the request has been received and that a new Cloud Connector environment will be created within 48 hours (two business days).
- Once the environment is available, insightsoftware support will reply to the support case email again to provide the Cloud Connector Environment ID.
- This environment ID will be similar to companyname-prod001, but the exact ID may vary. For example, longer names may be shortened and customers that have had to migrate environments as part of a previous upgrade may have a higher prod number.
- If you are ever uncertain of your Cloud Connector Environment ID, email insightsoftware support at globalsupport@insightsoftware.com to request confirmation.
Add or Remove Users to the Cloud Connector Environment
Additional Cloud Connector environment users may be added and removed at any time by emailing a request to globalsupport@insightsoftware.com. Use the below subject and body text as a template and replace all variables contained in brackets with the appropriate information:
Email Template
Subject: Add Cloud Connector Users – [Company]
Body:
Cloud Connector Environment ID: [Cloud Connector Environment ID]
Additional Users: [FirstName1 LastName1:Email1,FirstName2 LastName2:Email2...]
Note: for more information outlining the steps to configure Cloud Connector, see the ConfigureCloudConnector.mp4 video contained in the Documentation folder located within the Spreadsheet Server [version] Epicor.zip package.
Cloud Connector User Email Verification
When the Cloud Connector environment has been created, each user will be sent an email from no-reply-admin@insightsoftware.com with subject line “Verify your email.” The email contains a Confirm my account link which, prompting the user to create a password. These credentials will be used to log into the Cloud Connector environment and to establish the connection in Spreadsheet Server.
Important: You must verify your email address within five days, otherwise the user login will be locked, and insightsoftware support must be contacted again to unlock the account.
Cloud Connector Multi-Factor Authentication
After completing the first user email verification, each user will be sent a second email from devops.core.ci@insightsoftware.com with the subject line “insightsoftware Spreadsheet Server New User Login Details.” This email contains a link to the Multi Factor Authentication (MFA) User Guide with directions for completing MFA setup.
If you are unable to locate the email, the Multi Factor Authentication (MFA) User Guide can be found at: http://is-cloud-connector.insightsoftware.com.s3-eu-west-1.amazonaws.com/Releases/MFA%20Guide.pdf.
Set up
The following are the set up steps required for Spreadsheet Server with Epicor Kinetic Cloud.
- Enable CDC Access
- Create a Security Manager User
- Collect the Epicor Kinetic Cloud Connection Details
Enable CDC Access
Changed Data Capture (CDC) is the technology that Epicor uses to keep the Spreadsheet Server Cloud Connector data up to date for reporting. The user making these changes must log in to Epicor using an account with Global Security Manager rights and enable CDC for the tables listed below.
Note: only the Epicor Public Cloud team has such privileges. Epicor Public Cloud customers need to raise an EpicCare case to Public Cloud requesting this update.
The following tables must be CDC-enabled:
General Ledger
| Table | Service | Table Description |
|---|---|---|
|
|
The allowed values for |
|
|
The active company file. |
|
|
The valid combinations of the controlled segments as defined in the |
|
|
The general ledger book. |
|
|
The general ledger journal detail. These records are created by the "transfer from other modules" process or by the general ledger journal entry program. |
|
|
The general ledger account by book period balances. |
Other Finance
| Table | Service | Table Description |
|---|---|---|
|
|
The allowed values for |
|
|
The general characteristics of the fiscal calendar. |
|
|
The general characteristics of the fiscal period. |
|
|
The general characteristics of the fiscal year. |
Once the Cloud Operations team confirms the tables have been set to Capture Enabled, you will see the check box selected in the CDC Table Management window within Epicor ERP, located under System Management > CDC Management > CDC Table Management.
Create a Security Manager User
Global Security Manager user credentials are required to establish the integration between Epicor ERP Cloud and the Spreadsheet Server Cloud Connector.
A new Security Manager user needs to be created for this purpose, rather than using an existing user.
- The Security Manager user’s password needs to be set to not expire.
- In the event the Security Manager user’s password does expire, it will prevent the Cloud Connector replication task from retrieving new data from Epicor Kinetic.
- For more information about Security Manager, see Appendix D: Epicor Kinetic User Security Guidelines
- Information on how to create a new user can be found through the Epicor ERP application help, as well as in the following knowledge base article: KB0047624 - Create New User in ERP Cloud Multi-Tenant or Public Cloud.
Important: Ensure the user has the Security Manager check box selected under the Options tab.
Collect the Epicor Kinetic Cloud Connection Details
Collect the following information from Epicor Kinetic Cloud, which will be used to configure the Cloud Connector to start replicating data:
- Service URL: this can be copy-pasted by navigating to Help > About Kinetic > System Info > System Summary > Connection.
-
API Key:
- If an API Key doesn’t already exist, you will need to create one.
- Information on how to create an API key through the System Setup > Security Maintenance > API Key Maintenance window can be found in the Help section within the same window.
- When creating a new API Key, the decrypted key value to be used in REST calls will display and be copied to the clipboard.
- Save or make a note of this API Key value as it is not stored in the database and will not be visible in plain text form again.
- Once it is saved, the key value will become encrypted.
Note: it is recommended to use a date that is years in advance.
-
Company
- Any individual company code may be used when configuring Cloud Connector, which will enable access to data for all active companies in Epicor Kinetic Cloud.
- The company code used must be an active company within Epicor Kinetic Cloud.