Table Of Contents

Creating, Editing, Testing, and Uploading Analysis Procedures in Jupyter

Last Modified: September 24, 2021

Create, edit, or test analysis procedures in Jupyter and upload them to the procedures library in Analysis Automation. Analysis procedures define how SystemLink executes your automated data analyses and presents the results.

A procedure includes the analysis notebook, execution parameters, and the search query for the data you want to analyze.
  1. Click »Utilities»Jupyter to open the Jupyter environment for SystemLink. If Jupyter is not installed, refer to Creating a New Jupyter Notebook to find out how to install Jupyter.
  2. On the tab, click to add a new procedure or to edit an existing procedure.
  3. Create or edit the analysis notebook in the Jupyter editor and specify the analyses you want to run on your data. Refer to the Analysis Automation notebook for a basic example.
  4. On the Edit Procedure tab, specify the following information:
    1. Enter a name and description for the procedure.
    2. Choose a Workspace to define the users that can interact with the procedure.
    3. In the dropdown menu, choose a Search Query you saved in Data Navigation. The query defines the data you want to analyze with the analysis notebook.
    4. Select the Execution Mode.
      Execution Mode Result
      Comparative Runs the analysis notebook on all data elements the search query retrieves and outputs the results in one report. This allows you to compare the data at a glance.
      Parallel Runs the analysis notebook on each data element the search query retrieves and outputs the results in a separate report for each data element.
    5. To export the notebook to the file service, switch the toggle to Export Report and choose HTML or PDF as the export format. If you want to export results only, switch the toggle to Exclude Code.
    6. Click to open a new tab to test the analysis procedure.
      1. Choose a Data Source.
      2. Choose a Search Query.
      3. Click Start.
      Results are displayed in the same tab with errors, if any.
  5. Click . Click Save. The procedure uploads to Analysis Automation.
  6. In the dialog box that opens, you can either click Close to close the dialog box or click the link to Analysis Automation. The Procedures tab in Analysis Automation opens, where you can view the procedure.
  7. If you get a message saying that the procedure must be approved, you do not have the privileges to Approve and reject procedures. To extend your privileges, contact your system administrator.
After uploading the procedure, create a task to execute your procedure in Analysis Automation.

Recently Viewed Topics