Skip to main content

Manage web tools

Once you have published a web tool, it is important to test and confirm its functionality before sharing it. Additionally, you can update or delete a web tool.

Test a web tool

Once you have published a web tool, confirm it is functioning properly by testing it from its service endpoint and from the client application users are expected to run it in.

Test from a service endpoint

To test a web tool from its service endpoint, follow the steps below:

  1. Open the web tool's item page.

  2. Under Tools, open the service URL.

    Note:

    If the page displays The Services Directory has been disabled, ask an administrator to enable it by setting disableServicesDirectory to false in system properties.

  3. Enter necessary input values and submit the job.

  4. Open the job resource and review its status and results.

Test in a client application

To test a web tool in a client application, follow the steps below:

  1. Run the web tool with the necessary inputs and monitor the application's network traffic.

  2. Check the results in your client application.

If there is an error, or if you want to confirm the results, follow these steps:

  1. Inspect the submitJob request payload to see the input values and data structures sent to the geoprocessing service and compare them to the input formats the notebook handles.

  2. Copy the job url in the response.

  3. Open the job url to review the job's status and results.

Review job results

Once a job has finished running, inspect its status and results and the output it generated.

The web tool item's owner can access the outputPreview result, an HTML preview showing the notebook's cells and their outputs, and use it to verify a run or troubleshoot unexpected errors.

Share web tool items

After you have published a notebook as a web tool, you can share web tool items with the appropriate audiences. You can share items with your organization or with a group. Notebook web tool items can't be shared publicly.

Users must have the Run web tools privilege and any additional privileges necessary for running the notebook to share a notebook as a web tool.

Note:

After upgrading ArcGIS Notebook Server, change the runtime of the notebook from which the web tool was published to the latest runtime version supported by your site. Review the notebook code for any changes needed to run with the new runtime, then save the notebook and update the web tool. This helps keep the tool compatible with the upgraded site and lets it benefit from runtime improvements.

Update an existing web tool

Follow the steps below to update a web tool's notebook, parameters, or configuration and verify the changes.

Note:

After a notebook has been published as a web tool, the notebook item and web tool item are separate, and the parameter definitions are part of the web tool item. Changing or deleting parameters can affect client applications, scripts, and other workflows that use the web tool.

  1. Update the notebook's code as needed in the notebook editor.

  2. To change parameter definitions, open the Parameters pane and click Enable editing.

  3. Edit, reorder, or delete parameters as needed.

    Note:

    Parameter changes do not automatically update code already inserted in the notebook.

  4. In your notebook, update or reinsert the input variables or output snippets that correspond to the parameters updated in the previous step.

  5. Save the notebook.

  6. Click Publish and review the web tool configuration and parameters.

  7. Click Overwrite to apply the changes to the existing web tool.

  8. Test the web tool.

Delete a web tool

To remove a published notebook web tool, see Delete items.

Note:

Deleting a notebook web tool item will also remove the geoprocessing service associated with it.

Note:

Deleting a notebook from which a web tool was published will also delete the web tool.