Welcome to the NLG Studio Documentation

Publish View

Publish View is the place to publish your project, run it inside Studio, get API information and make CORS settings. This view has two tabs, Run Project and API, and from these you can do the following:

Run Project

  • Publish – you can publish your project from the top of this page.

  • Run Project – here you can run your latest published project from inside Studio.

API

  • Publish – you can publish your project from the top of this page.

  • API Key – you can generate an API key for calling your project from its API endpoint.

  • API Endpoint – you can get the URL to access your project.

  • Studio Runner – enable the Studio Runner app so it can be used to submit data to your project’s endpoint.

  • CORS – you can configure domains for Cross-Origin Resource Sharing.

  • Convert Data to API Format – a utility to convert your project data into the format required to send to its API endpoint.

Publish

Before you can run your project, you must first publish it. Click on the Publish button. You will see this button in both the Run Project and API tabs.

publish-view-01-publish-tab.png

You’ll be asked to confirm that you want to publish the project.

Once you have published your project, you’ll see a congratulatory message to let you know that your project has now gone live. That message also provides you with the URL corresponding to your project’s API endpoint (sometimes called the API endpoint). See Using the API of an NLG Studio App for how to use the endpoint.

publish-view-02-congrats-msg.png

After you have published your project, the Publish button changes to Re-Publish.

publish-view-05-republish.png

If you make changes to your project (e.g. change a script), these will appear in the published version of your project only when you re-publish it.

Run Project

After publishing a project, you can run it inside Studio, or from outside Studio via the API endpoint. On the Run Project tab you will see two buttons: Run with New Data and Run with Sample Data.

publish-view-run-project.png

Run with New Data allows you to upload a data file containing new rows of data, whereas Run with Sample Data will run the published project with its sample data (which you can see in Data View).

When it has run, you will be offered a download of the results file.

For further details on running a project, see Publishing a Project .

API Key

The button to generate an API key can be found in the API tab in Publish View.

publish-view-03-generate-api-key.png

When you have published your project, you can call it using the API endpoint from another application or website.  

Note

Running a published project is chargeable in accordance with the terms of your subscription.

To use the API endpoint, you will need an API key. Click on the Generate API Key button in the API tab to generate a new API key for your already-published project.

When you click on the Generate API Key button, the API key is shown as a long string of characters in the pop-up. Make sure you copy the key (clicking the button next to the key will save it to the clipboard). On generating the key, the Generate button changes to Regenerate API Key, and a new button appears: Deactivate API Key.

publish-view-04-regenerate-deactivate.png

The Regenerate API Key is useful if you have mislaid the original key, or if you believe it has become compromised in some way. Generating a new API key will automatically deactivate any existing keys.

By clicking Deactivate API Key, you can deactivate the existing key for this project without creating a new key. This is useful if you simply want to switch off access to your project.

API Endpoint

The API endpoint can be found under the API tab in Publish View, below the API Key buttons (see screenshot above). It contains the URL to access your project. Click the button next to the endpoint to save it to the clipboard.

See Using the API of an NLG Studio App for how to use the endpoint.

Studio Runner

Once you have created a project and published it, you, or someone you choose, can submit data to your Arria NLG Studio project’s API endpoint via our Studio Runner web page at https://app.studio.arria.com/runner.

Studio Runner can be found under the API tab in Publish View (scroll down until you see Studio Runner).

working-with-studio-runner-03-API.png

Click on the slider (shown as ‘disabled’) to enable Studio Runner. Copy the ID that appears (you need to enter this ID on the Studio Runner web site).

working-with-studio-runner-04-enable-runner.png

You can use the Copy to Clipboard button on the right to copy the ID.

Click on the Launch Studio Runner button. Studio Runner will open the URL https://app.studio.arria.com/runner/ in a new tab in your browser.

In Studio Runner, you will need:

  1. Your project’s ID (this appears when you enable Studio Runner as shown above).

  2. Your project’s API Key.

  3. Data for your project that has been converted to the correct format (see Convert Data to API Format).

For information on how to use Studio Runner, see the Getting Started Tutorials section Working with Studio Runner or Key Concepts >Studio Runner.

CORS

CORS information can be found in the API tab in Publish View.

If you want to use the API from an external domain, use the Cross-Origin Resource Sharing (CORS) feature. It enables you to specify up to 20 domains that can call the endpoint of your published project. Enter your domain name under ADD A DOMAIN. You can specify a port number, for example 8181 as in http://www.mydomain.com:8181, or leave out the port number to use the default port 80 as in http://www.mysuperservice.com.

publish-view-07-cors.png

Click the Add Domain button to add it to the CORS list. Once you have added your domain, you will need to re-publish your project and re-generate the API key before it becomes effective.

Convert Data to API Format

The Convert Data to API Format utility can be found in the API tab in Publish View, Once your project is published, you can use this utility to convert your project sample data, or a new data file, into the format required to post to the API endpoint.

publish-view-08-convert-data.png

Click Convert New Data to upload a data file to be converted or click Convert Sample Data to convert your project sample data. The data file should hold valid data for your project, and for a CSV data project, it needs to have the same columns as your published project.

The output file containing the converted data is downloaded to your computer; the file has suffix _api.json.

If you attempt to convert a data file with errors, the Convert Data to API Format utility will produce an error.