Relationships between web services and portal items
In this topic
- Publishing a service through the portal
- Publishing a service through a federated ArcGIS Server site
- Using the My Content page of the portal website to add the service as an item
- Best practices for editing and deleting items
Portal for ArcGIS gives you a platform for publishing web services and sharing links to existing services. This is accomplished through portal items, which present each service as a searchable and shareable entity. Understanding the relationship between web services and portal items can make it easier to work with Portal for ArcGIS.
It’s important to edit or delete services and portal items using the same means by which they were created. For example, if you publish a service using the portal website, you should use the portal website to delete the service; you should not use Manager to delete the service.
This topic describes three common ways to make a service available as an item on your portal. Appropriate rules for editing and deleting the service are provided for each approach.
Publishing a service through the portal
This approach is only available when the portal has been configured with a hosting server. You can publish a service through the portal, either using the My Hosted Services option in ArcMap, the portal website, Esri Maps for Office, or another client that works directly with the portal. Both a portal item and a service are created for you when you do this. All services are placed in an ArcGIS Server folder called Hosted.
Service types listed in the Hosted folder differ from those in other server folders. This is to match the item types that are displayed in Portal for ArcGIS. The table below lists all supported hosted services and their updated item types:
|ArcGIS Server service type||Hosted folder/Portal for ArcGIS item type|
Cached map service
Cached map service with feature service
Tile and Feature Layer
When you add the item by publishing a service through the portal, you should also edit and delete the item through the portal. For example, you could use the portal website or the My Hosted Services option in ArcMap to edit or delete the item. When you delete the item in this way, the back end service is deleted for you.
If you overwrite the hosted service in ArcMap, the existing service item is deleted from the portal and a new item is created with the same name. However, the item is created in the root folder of the server and is assigned a new ID. You will need to reconfigure sharing and, if necessary, move the item back to the folder it was in before the service was overwritten. You will also have to reconfigure any pop-up windows or symbology you previously saved with the item.
You sign in to the portal as publisher Jan and upload a CSV file. You choose to publish the CSV to your portal as a feature layer. Automatically, a portal item is also created.
To delete this service in the recommended way, you sign in to the portal website as publisher Jan (or an administrator) and delete the portal item representing the service. When you do this, the service is also deleted automatically.
In this scenario, you should not connect directly to the back end hosting server to delete the service. This would leave a portal item with no link to a service. You would be forced to clean up the portal item manually.
Publishing a service through a federated ArcGIS Server site
You can alternatively publish a service through a connection to an ArcGIS Server site that you have federated with your portal. You publish using ArcGIS Server Manager or an ArcGIS Server connection in the Catalog tree of ArcMap. A portal item is created automatically at the time you publish the service.
If you added the item this way, you should edit and delete the service using Manager or the GIS server connection in ArcMap.
When you delete the service in this way, the corresponding portal item is deleted for you.
If you overwrite the service in ArcMap, the existing service item is deleted from the portal and a new item is created with the same name. However, the item is created in the root folder of the server and assigned a new ID. You will need to reconfigure sharing and, if necessary, move the item back to the folder it was in before the service was overwritten. You will also need to reconfigure any pop-up windows or symbology you previously saved with the item.
You make an Add ArcGIS Server connection in ArcMap as publisher Jan and you publish an image service to an ArcGIS Server site that is federated with your portal. The service automatically becomes an item on your portal.
When you are ready to delete this service, you log in to Manager as publisher Jan (or an administrator) and delete it. The corresponding item is automatically removed from the portal.
In this scenario, you should not use the portal website to delete the item. Doing so would leave a running service with no corresponding portal item. The service would be unusable because access to the service would still be controlled through the portal’s sharing model. You would need to clean up the service manually.
Using the My Content page of the portal website to add the service as an item
You can add a service as a portal item using the My Content page of the portal website. This is how you share links to web services that are not running on a federated server.
If you added the item using My Content, you should edit and delete the item using the portal website. Even if you delete the item, the corresponding service continues to run unless you log in to its server and delete it. This is expected behavior because you may be using portal items to share links to third-party services that you have no intention or ability to permanently delete.
You find a useful web service from your neighboring department’s ArcGIS Server site and you want to add a portal item that links to it. You sign in to the portal website and use the My Content page to add the service as a portal item.
When you are ready to delete this item, you use the portal website to delete it. Deleting the item does not delete the service. This is the expected behavior because the service and the portal item have no built-in relationship in this scenario.
Best practices for editing and deleting items
The examples above have reiterated that you should edit and delete items using the same approach you use for publishing. This ensures that services and items maintain their appropriate linkage.
If you do not delete the items or services in the recommended way, you may be left with orphaned items or services that you must delete manually.
Note that a portal item can only be edited or deleted by one of the following:
- The publisher who added the item
- A portal administrator
This is different than the pattern used by ArcGIS Server, wherein all publishers can edit and delete all items.
Although administrators can edit items, this should be avoided. Editing items as an administrator can cause peripheral resources to accrue under the administrator’s account. Administrator accounts should primarily be used to change the ownership of items or delete items that are no longer needed.