Missing Input Parameters When Analyzing Files in SystemLink Enterprise

Issue Details

• I am trying to analyze files from the Product Insights >> Files page of SystemLink Enterprise (SLE). However, when I select the Jupyter Notebook to execute, no input parameters are loaded and the file's ID is not auto-populated. What could be going wrong?
• I have published a Jupyter Notebook to SLE and I want to use it to analyze files. When I select the Notebook, I see error The selected notebook has no parameters. Why is this happening?
• When I try to analyze a file in SLE I see the below error. I expected the file_ids parameter of the Jupyter Notebook to auto-fill. How do I fix this?

Solution

This error occurs due to one of the following conditions:

• The file_ids parameter is not properly defined in the Notebook's Cell Metadata.
• The Notebook's Cell Metadata was not saved.
• The Notebook has not been published since it was last modified.

Note: If you are encountering similar issues in other interfaces besides File Analysis, refer to the Additional Information section.

To resolve this error, follow the steps below:

1. In the SystemLink Enterprise (SLE) web UI, select the Automation >> Scripts tab and open your Jupyter Notebook.
2. Ensure that you have one code cell (usually near the top of the Notebook) that defines your expected input parameters.
   • For the SLE File Analysis interface, an input named file_ids that is an empty list of strings is required.

3. While this cell is selected, click the cog icon on the right-hand side of the page to open the Property Inspector window.
4. Expand the ADVANCED TOOLS section.
5. Verify that the Cell Metadata correctly defines the file_ids input parameter with a default value, display_name, type and id.
   • If correct, the Cell Metadata should resemble the below image:

1. • For ease, the full Cell Metadata can be copied from below:

{
    "editable": true,
    "papermill": {
        "parameters": {
            "file_ids": []
        }
    },
    "slideshow": {
        "slide_type": ""
    },
    "systemlink": {
        "namespaces": [],
        "parameters": [
            {
                "display_name": "file_ids",
                "id": "file_ids",
                "type": "string[]"
            }
        ],
        "version": 2
    },
    "tags": [
        "parameters"
    ]
}

6. Ensure that you click the tick icon to save the Cell Metadata. Without this, the changes will not be propagated to the Notebook.
   • If the tick icon is not visible, this indicates that there is a syntax error in the Cell Metadata. Review the contents carefully and ensure that they resemble the JSON string above.

7. Save the Notebook by clicking File >> Save Notebook.
8. Publish the Notebook by right-clicking the .ipynb file and selecting Publish to SystemLink.

9. Ensure that the publish settings are configured as follows, and then click Publish to SystemLink:
   1. Workspace should be set to whichever Workspace your end-user has access to.
   2. Interface should be set to File Analysis.

10. Now, re-attempt the file analysis from the web UI. The file_ids parameter should appear and be auto-populated.

Additional Information

If you are encountering a similar issue in other areas of SLE (e.g. Assets Grid, Test Data Analysis, Work Items Operations, Systems Grid etc.), ensure that your Notebook parameters and Cell Metadata comply with the requirements defined in Publishing a Jupyter Notebook.