JSCAPE Connector 1.0.0.1

The JSCAPE Connector lets you manage RunMyJobs from MFT Server.

New Features in 1.0.0.1

  • Version 1.0.0.1 includes a number of stability improvements.

Prerequisites

  • RunMyJobs 9.2.9 or higher.
  • Connections Component 1.0.0.2 or later. Note that the Connections component will be installed or updated automatically if necessary when you install this Connector.
  • API Key Component. Note that this dependency is handled automatically by the Catalog.

Contents of the Connector

Object Type Name
Application GLOBAL.Redwood.REDWOOD.RedwoodMFT
Extension Point REDWOOD.Redwood_RedwoodMFT
Library REDWOOD.RedwoodMFT

Installation / Upgrade

  1. Choose in the tool bar.
  2. Fill any part of the name of the component, for example JSCAPE, into the filter cell of the Name column.
  3. Locate the component, choose Install Specific Version from the context menu.
  4. Select the version you wish to install, in this example, 1.0.0.0:
  5. In this example version 1.0.0.0 is installed along with the API Key Authentication dependency:

URL Format

To connect to the central Redwood server, you need the URL and an API Key (for more information, see Creating an API Key). The URL format is as follows.

http[s]://<server>[:<port>]/<context>/api-extension/External/[<partition>/]Redwood_RedwoodMFT/rest/v1

For example:

  • https://s1.example.local/redwood/api-extension/External/REDWOOD/Redwood_RedwoodMFT/rest/v1

  • https://s1.example.local:8443/redwood/api-extension/External/REDWOOD/Redwood_RedwoodMFT/rest/v1

  • https://dublin.runmyjobs.cloud/example/test/api-extension/External/REDWOOD/Redwood_RedwoodMFT/rest/v1

Swagger Documentation

Swagger documentation is available at the following URL.

http[s]://<server>[:<port>]/<context>/api-extension/External/[<partition>/]Redwood_RedwoodMFT/rest/swagger.yml

Creating an API Key to Connect from JSCAPE to RunMyJobs

Before JSCAPE can connect to RunMyJobs, you must create an API key for a specific user and enter it in the User Key field of the JSCAPE Add Trading Partner window.

You will also need to enter a special URL in the JSCAPE Add Trading Partner window, so that it can communicate with RunMyJobs. The format for this URL is as follows:

http[s]://<server>[:<port>]/<context>/api-extension/External/[<partition>/]Redwood_RedwoodMFT/rest

Here, http[s]://<server>[:<port>]/<context> should be the base URL normally used to access RunMyJobs, and the portion that starts with /api-extension should be same for all users, except for the fact that the <partition> may be different depending on the user. For example:

https://oregon-test.runmyjobs.cloud/corp-qa/test/api-extension/External/REDWOOD/Redwood_RedwoodMFT/rest

Running a Process Definition or Chain Definition from JSCAPE

For information on running a RunMyJobs Process Definition or Chain Definition from JSCAPE, see the JSCAPE documentation.

See Also