Connect to a toolbox

Custom toolboxes can be stored on the file system or in geodatabases and can be accessed from folder connections and databases in the project. You can also add a toolbox to the catalog's Toolboxes container . This does not copy or move any files; rather, it creates a connection—essentially, a reference or shortcut—that allows you to use the resource without browsing to it. Toolbox connections are included in project packages.

You may need to refresh your toolbox connection if the contents of the toolbox are changed outside your current ArcGIS Pro session. You may need to repair the connection if it becomes invalid.

Note:

Only custom toolboxes can be connected to and viewed in the Catalog pane. System toolboxes can only be viewed and used on the Toolboxes tab of the Geoprocessing pane.

• Learn more about accessing system toolboxes

Access a toolbox in a folder

You can access and use a toolbox by browsing to the folder that contains it. This may be useful if the tools in the toolbox use data stored in the same folder location.

1. Connect to a folder containing the toolbox you want to use.
2. In the Catalog pane or a catalog view, browse to the toolbox from the folder connection.

Add a toolbox to a project

You can add an existing toolbox to the catalog's Toolboxes container . This allows you to access the toolbox without browsing to a folder or database.

1. Open the Add Toolbox browse dialog box by using any of the following methods:

   On the ribbon	Click the Insert tab. In the Project group, click Toolbox and click Add Toolbox .
   In the Contents pane of a catalog view	Click Toolboxes . On the ribbon, click the Catalog tab. In the Create group, click Add and click Add Toolbox .
   In the Catalog pane	On the Project tab, right-click Toolboxes and click Add Toolbox .

2. Browse to and select one or more toolboxes on your local computer, on a network computer, or in a file geodatabase.
3. Click OK.

   The toolbox appears in the Toolboxes container in the Catalog pane and the Contents pane of a catalog view.

   You can also add a toolbox to a project using the following methods:

   In the Catalog pane, a catalog view, or the Contents pane of a catalog view	Browse to a toolbox, right-click it, and click Add To Project . Browse to a toolbox, select it, and drag it to the Toolboxes container in the Catalog pane or the Contents pane of a catalog view.
   In File Explorer	Browse to a toolbox, select it, and drag it to the Catalog pane or the Contents pane of a catalog view. It appears in the Toolboxes container .

Create a toolbox

There are three toolbox formats in ArcGIS Pro:

• ArcGIS toolbox—This toolbox format is stored as an .atbx file on disk. This toolbox format stores tools, scripts, and models. It provides better cross-release compatibility and persistence, improved performance and scalability, and less possibility of file corruption due to binary storage, as this format is JSON based with an open specification compared to the legacy toolbox format (.tbx) described below. You can create toolsets, add new model and script tools, change properties, and copy and paste tools from legacy toolboxes into the new toolbox format using the Catalog pane.
• Legacy toolbox—This toolbox format is stored as a .tbx file on disk or in a database.
• Python toolbox—This toolbox format is stored as a .pyt file on disk. All properties of a Python toolbox and its tools are defined using Python code.

Note:

Starting with ArcGIS Pro 3.0, you can't create legacy toolboxes (.tbx) in a project. However, you can still add existing legacy toolboxes to a project and edit them.

Create a toolbox in the current folder

In this workflow, you first browse to a folder and then specify the toolbox you want to create.

1. Create a toolbox using one of the following methods:

   In a catalog view	Browse into a folder. On the ribbon, click the Catalog tab. In the Create group, click New and click Toolbox (.atbx) or Python Toolbox .
   In the Catalog pane	Browse to a folder and select it. Right-click the folder, point to New , and click Toolbox (.atbx) or Python Toolbox .
   On a browse dialog box	Browse into a folder. Click the New Item drop-down arrow and click Toolbox (.atbx) .

   A toolbox or Python toolbox is created with a default name. The name is immediately editable.

2. Type a new name for the toolbox and press the Enter key.

   The toolbox is updated with the new name. It appears in its folder location in the catalog. It does not appear under the Toolboxes container until you add it to the project.

   Tip:

   On the Add Toolbox browse dialog box, you can create a toolbox from the New Item drop-down list. This creates a toolbox and adds it to the project in one step.

Create a toolbox and browse to a folder

In this workflow, you first specify the toolbox you want to create and then browse to a folder.

1. Create a toolbox using one of the following methods:

   On the ribbon	Click the Insert tab. In the Project group, click Toolbox and click New Toolbox (.atbx) or New Python Toolbox .
   In the Contents pane of a catalog view	Click Toolboxes . On the ribbon, click the Catalog tab. In the Create group, click New and click New Toolbox (.atbx) or New Python Toolbox .
   In the Catalog pane	On the Project tab, right-click Toolboxes and click New Toolbox (.atbx) or New Python Toolbox .

2. Browse to a folder on your computer or a network computer.

   The default location is the project home folder.

3. In the Name box, type a name for the toolbox.
4. Click Save.

   A toolbox is created and added to the project. It appears in its folder in the catalog and in the Toolboxes container .

Add a toolbox to your project favorites

If you use the same toolbox in many projects, you can make it a favorite. A favorite can be added to any project from the Favorites tab of the Catalog pane or the Favorites container in the Contents pane of a catalog view. If your user profile supports roaming, your favorite toolboxes are available on every computer you use.

You can create toolboxes that are automatically made favorites. These toolboxes are stored by default in the Favorites folder in your roaming profile.

Tip:

You can make a toolbox a favorite by dragging it from its location in the Catalog pane, the Contents pane of a catalog view, or File Explorer to the Favorites tab of the Catalog pane or the Favorites container in the Contents pane of a catalog view.

Remove a connection

You can remove an item connection in the Catalog pane or catalog view if you no longer need to work with the item or if its contents become unavailable. When you remove an item connection, the item and its contents are no longer directly accessible from the project. However, they are not deleted from their computer, network, or cloud location.

You cannot remove item connections to items required by the project, such as the home folder, default toolbox, and default geodatabase.

To remove a connection, complete the following steps:

1. In the Catalog pane, browse to the item connection.

   Alternatively, with the catalog view active, browse to the item connection in the Contents pane or the catalog view.

2. Click the item connection to select it.
3. Right-click the item and click Remove From Project .

   When the catalog view is active, you can also use the ribbon to remove an item connection. On the ribbon, click the Catalog tab. In the Organize group, click Remove .