Create a custom role for notebook authors

In the ArcGIS Enterprise portal, members can perform a task only when they are assigned a member role that includes the privilege pertaining to that task. For example, publishing hosted tile layers is controlled by one privilege, while registering data stores is controlled by another. The portal includes several default portal roles, each with a set of privileges, but portal administrators can also create custom roles and configure them with privileges as needed.

For a portal member to open, run, create, and edit ArcGIS Notebooks, one or more of the following privileges must be assigned to their account:

• The Create and edit notebooks privilege allows members to open and run notebooks, including shared notebooks and notebooks created from a notebook file (*.ipynb) imported into the portal, and create and edit notebooks using the ArcGIS Notebooks Standard runtime.
• The Advanced notebooks privilege must be assigned, along with the Create and edit notebooks privilege, for a member to create and edit notebooks using the Advanced notebook runtime.
• The Schedule notebooks privilege allows members with one or both of the above privileges to schedule the automated run of a notebook using the Tasks pane in the notebook editor.
• The Publish web tools privilege allows members with the Create and edit notebooks privilege to create parameters and publish notebooks as web tools from the notebook editor.
• The Organization webhooks privilege allows members to configure webhooks. To configure a webhook for notebook automation, members will need the Create and edit notebooks privilege, and optionally, the Advanced notebooks privilege.
• The Run web tools privilege allows members to run web tools published from a notebook. With this privilege, members do not need the Create and edit notebooks and Advanced notebooks privileges to run web tools published from a notebook.

  Note:

  Members who have the Create and edit notebooks, Advanced notebooks, or Publish web tools privilege are also able to run web tools published from a notebook.

Tip:

Notebook runtimes are explained in Docker and ArcGIS Notebook Server.

These privileges are included by default with the Administrator role only. Notebook authors who are not portal administrators need a custom role assigned to them that includes one or both notebook privileges. Each member can only be assigned one role at a time. To create a custom role (or multiple custom roles) for your notebook authors, complete the following steps:

1. Verify that you are signed in as a portal administrator.
2. Go to the Organization > Settings page and click Member roles.

   On this page, you can view the portal's roles, create custom roles, and assign members to a role.

3. Click Create role.
4. Provide a name and description for the role.

   The name must be unique within your organization and can contain up to 128 characters. The name and description are not case sensitive. Administrator, Publisher, User, Data Editor, and Viewer cannot be used as a name. The description can have up to 250 characters.

5. Assign the necessary privileges to the custom role.

   Notebook authors need the Create and edit notebooks privilege at a minimum. If also assigned the Schedule notebooks privilege, they can create tasks to schedule the automated run of a notebook. Both of these privileges can be found in the Content category.

   If notebook authors will use the Advanced notebook runtime, they need the Advanced Notebooks privilege in addition to the Create and edit notebooks privilege. The Advanced notebooks privilege can be found in the Content and analysis category.

   If the notebook author intends to publish the notebook as a web tool, they will need the Publish web tools and Create and edit notebooks privileges. You can find the Publish web tools privilege under the Administrative privileges content category.

   If a notebook author will need the privilege to create webhooks for automating notebooks, assign the Organization webhooks privilege.

   You may want your notebook authors to perform other actions from their accounts in the portal, and some notebook actions require other portal privileges. At a minimum, the custom role you create should include the Create, update, and delete content and Publish hosted feature layers privileges, in addition to one or both notebook privileges.

   To create a custom role for web tool users who only need to run web tools published from notebooks, assign the Run Web Tools privilege.

   Note:

   Notebook privileges are not required to run web tools published from notebooks.

6. Review the available privileges, and select those your notebook authors will need.

   Tip:

   You can populate the privileges list with privileges from another role. Click Import settings from an existing role or template, and select a role such as Publisher or Analyst. The privileges included in that role will be turned on, and you can add the notebook privileges.

7. Click Save role when you're satisfied with the privileges included with the custom role.
8. To create multiple custom roles for notebook authors (for example, to separate Standard and Advanced notebook authors), repeat steps 3 through 7 for each new role.
9. Assign the new custom role or roles to existing portal members.
   1. Go to the Members page.
   2. Search for members by name, group, or role.
   3. Use the Role drop-down menu to select the new role you want to assign to the member.
10. Choose the role to assign to selected members, and click Assign.
11. Repeat steps 9 and 10 to assign members to another custom role.

This topic concludes the ArcGIS Notebook Server installation guide. Refer to the Administer section of the ArcGIS Notebook Server documentation for administrative information and workflows.