Connecting an Analytics Case to a Python Script

You can connect Python to Results Analytics to enable the use of scripting APIs.

Before you begin:
  • Upload an analytics case to Results Analytics. For more information, see About Creating an Analytics Case.
  • Ensure that you have a local Python installation.
  • Ensure that Results Analytics is connected to a 3DOrchestrate localhost station. The scripting API is not supported on public (Regular) and remote stations.
See Also
About Results Analytics Scripting
  1. Install py4j and requests with a package manager such as pip.

    For example, from a command line, enter pip install py4j.

  2. From the command line, enter and run pip install Install Location/reffiles/SMAMDOPython/dist/ResultsAnalytics-1.0-py3-none-any.whl to install the Results Analytics scripting module.

    Install Location is the file location of your 3DOrchestrate Station installation.

  3. Add Install Location\reffiles\SMAMDOPython to your PYTHONPATH, where Install Location is the file location of your 3DOrchestrate Station installation.
  4. Open a Python IDE or notebook.
  5. From Results Analytics, run an analytics case.
  6. From the upper right of Results Analytics, click Connect .
  7. Click Copy to copy the string to your clipboard.
  8. Paste the string into the top of a Python script.

You can now begin using the provided API calls to interact with your analytics case.

Every time you run an analytics case, you must copy a new connection code from the Connect dialog box into your script.