Ctrlk
About CoherentAPI referenceSupportYouTube
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Tutorial: Get started in 5 minutes

Convert Excel calculations into a Spark service with an integration-ready API!

This tutorial uses a simple calculation but the process is the same for even the most complex workbooks!

Map inputs and outputs

Right circular cone volume is V = π * r^2 * h/3.

Spark uses Excel names to identify calculation inputs and outputs.

  1. Open Excel and create the cone-volume calculation:

    • Enter the radius in C3.

    • Enter the height in C4.

    • Enter =ROUND(PI()*C3^2*C4/3,3) in C5.

  2. Use the Name Box to name C3 as Xinput_r.

    Enter Xinput_r in the Name Box.

  3. Use the Name Box to name C4 as Xinput_h.

  4. Use the Name Box to name C5 as Xoutput_V. Spark recognizes Xinput_ names as inputs and Xoutput_ names as outputs.

    Enter =ROUND(PI()*C3^2*C4/3,3) into C5. Enter Xoutput_V in the Name Box.

  5. You can map input and output tables the same way. A range of cells that include a header row can be selected and also be denoted as Xinput or Xoutput, for example Xinput_dimensions, or Xoutput_volumes.

  6. On the Formulas tab, select Name Manager. Confirm it lists Xinput_r, Xinput_h, and Xoutput_V.

    Name Manager is in the Formula tab of the ribbon.
    Name Manager lists Xinput_h, Xinput_r, Xoutput_V.

  7. Save the workbook. Alternatively, download the sample workbook.

Spark get started.xlsx
33KB
Open

Sign in to Spark

  1. Open your tenant URL. Tenant URLs use the format http://spark.{environment}.coherent.global/{tenant}.

  2. Sign in with your credentials.

    1. If you are not using single sign-on, enter your Email and Password and select Sign in.

    2. If you use single sign-on, select the appropriate sign-in option.

  3. Spark opens the Home screen.

Create a folder

Spark calls a converted Excel workbook a service. Folders organize services.

  1. Select New folder.

  2. Enter a unique folder Name.

  3. Select a Folder category. Folder categories can be filtered on the Home screen.

  4. Optionally, upload a cover image.

  5. Select Create.

  6. Spark opens the Folder overview.

Publish a service

A service is published when Spark converts an Excel workbook into code and an API.

  1. Select New service at the top right.

  2. Select Browse or drag the workbook into the upload area. Spark supports .xlsx and .xlsm files.

    New service upload accepts Excel files for conversion.

  3. While Spark converts the workbook, optionally change the Service name. The default name is the workbook filename.

    Excel file converting to code.

  4. When conversion finishes, select Publish.

    Excel file successfully converted and ready to be published.

  5. Spark opens the API Tester. Your API is ready to test and integrate.

Call the API

Use the API Tester to test the converted calculation and its Execute API. The /execute endpoint processes calculation requests.

  1. In API request (inputs), confirm r and h appear as inputs.

  2. Enter values for the radius and height.

  3. Select Submit.

  4. In API response (outputs), expand Single values to view the calculated Volume.

  5. Use JSON view or Raw view to inspect the API response.

Next steps

Last updated