Appendices

This article contains extra information about components of this product.

• Appendix A: Editing Tasks
• Appendix B: Test the Epicor Cloud API Responsiveness
• Appendix C: Test the Cloud Connector API Responsiveness
• Appendix D: Epicor Kinetic User Security Guidelines

Appendix A: Editing Tasks

1. In the task to be edited, click Edit.
2. Type a descriptive task name and click OK.
3. Select the Source from the drop-down list.

Note: If no Source drop-down options are available, no source has been configured. See Configure the Source for more information.

4. Use the search field to search for the desired table names.
5. Select the check box for each table needed, then click the > button to add the table to the replication task.

Important: As a minimum requirement, the following six tables need to be assigned to a replication task to allow base functionality to pull data with the Spreadsheet Server base profile for Epicor Kinetic Cloud. Additional tables may be added if desired to pull data from using Query Designer.

• COASegValues
• Company
• GLAccount
• GLBook
• GLJrnDtl
• GLPeriodBal

Note: To remove tables, select a table from the Selected Tables list, then click the >> button.

6. Click the Save button.
7. Apply Table Indexing:

Applying indexing can significantly improve query performance speed, particularly for larger databases. The steps below detail how to apply indexing by including a post command script on the replication task.

While the indexing script is only for specific tables, it is recommended to apply the indexing script to all Cloud Connector tasks for the following reasons:

• Tasks may be edited at any time, and the tables included in the task could change.
• Including the script ensures indexing is applied in the event a related table is added to the task.
• If a task is ever run with a force rebuild for a table, previously applied indexing will be dropped with the old table as part of the force rebuild.
• Including the script ensures that indexing is reapplied if a force rebuild is ever run.
• The script runs as one of the final steps of the replication task process.
• The time this adds to the replication task run time is minimal and does not significantly impact performance.
1. Click Edit for the first replication task.
2. Click the Commands tab.
3. Copy the script text below, then paste it into the Enter SQL Script field:

CREATE INDEX IF NOT EXISTS GLJrnDtl_idx01 ON GLJrnDtl ( FiscalYear, FiscalPeriod );
CREATE INDEX IF NOT EXISTS GLPeriodBal_idx01 ON GLPeriodBal ( FiscalYear, FiscalPeriod );

4. Click Save.
5. Repeat steps a-d for all replication tasks.

The script will run, and indexing will be applied each time the replication task is run. Tasks may be run immediately if desired.

Appendix B: Test the Epicor Cloud API Responsiveness

You can validate the API’s responsiveness using the Epicor ERP Security Manager credentials. For more information, see page 12 of the Epicor ERP REST Services User Guide: https://epicweb.epicor.com/doc/Docs/Epicor10_RESTServices_v2_102700.pdf#search=api%2Fhelp.

For example, you can use the below link in a new browser window with the appropriate services URL provided in step 3 a) of the aforementioned guide. This link is for the example server live 201, however, each customer should use the link that corresponds to their service link/server. This example is for ODataERP.BO.GLBookSvr (from the OData list section of the aforementioned guide, beginning on page 18), as GLBooks is one of the tables setup for CDC enablement in step 1: https://ausmtsapp01.epicorsaas.com/SaaS201/apps/resthelp/#/select-service/v2/odata/Erp.BO.GLBookSvc/GLBooks.

1. Click Get, then Try it out.
2. Type the required parameters currentCompany and X-API-Key in the appropriate fields.
3. Click Execute. If successful, the server response displays code 200.

Appendix C: Test the Cloud Connector API Responsiveness

To check if the Cloud Connector reporting service is up and running, navigate to the URL in a browser. If the reporting service is working properly, the page will display service details as such:

To check if the Cloud Connector replication service is up and running, navigate to the URL in a browser. If the replication service is working properly, the page will display service details as such:

If any of these services do not return the service details, contact globalsupport@insightsoftware.com for assistance and include the URLs you are testing.

If both these URLs return service details, but data is not replicated correctly, log in to the environment using the Cloud Connector application to check for error messages. For each replication task, click the status and date label to display additional details from the last task run, including a list of the tables replicated and, if an error occurred, a detailed error message.

Important: Ensure that all tables are CDC-enabled.

If you still cannot resolve the problem, please contact globalsupport@insightsoftware.com, and include the URLs you are testing.

Appendix D: Epicor Kinetic User Security Guidelines

When setting up the initial Spreadsheet Server CDC subscription, the user must have the Security Manager role assigned to them. For example, during the first request Cloud Connector makes against the Epicor APIs.

This is also the case when additional tables are added to the subscription as the user setup in the initial synchronization must have Security Manager status to create the CDC subscription records.