For the latest version of JMP Help, visit JMP.com/help.


Publication date: 06/21/2023

JMP Live Prerequisites

Before you can use JSL to publish reports to JMP Live, do the following:

1. Get an API key (if required by a JMP Live administrator). See Get an API Key.

2. Establish a connection to a JMP Live server. See Add a JMP Live Server in Using JMP. When you add a JMP Live server, you need to enter your API key (if required).

When you establish a connection, a JMP Live Connection is created in JSL:

liveconnection = New JMP Live( Connection( "My JMP Live" ), Prompt( If Needed ));

where "My JMP Live" is the name of the JMP Live server connection you created. If authentication is required, an interactive prompt appears. You can change the Prompt to No, but if authentication is required, the connection fails.

Get an API Key

Before you can script reports and publish them to JMP Live, you might need an API key. JMP Live administrators determine whether an API key is required for scripting.

Caution: An API key is unique for a user and a JMP Live server. That means that if you obtain a new API key, it overrides the previous one, and any scripts using the previous API key will need to be updated to use the new API key.

To obtain an API key:

1. Log into JMP Live.

2. At the top, click your user icon and select Settings.

3. Click the Generate New API Key icon.

Tip: If you need to reference your API key in a script or to set up a JMP Live connection, you can click the Copy icon and paste it.

Want more information? Have questions? Get answers in the JMP User Community (community.jmp.com).