Using the Connections dashboard
Summarize
Summary of Using the Connections dashboard
The Connections dashboard in ServiceNow Zurich release offers a streamlined interface for managing connection and credential aliases. It lets connection administrators add, edit, and configure multiple connections efficiently in one place, enhancing integration management.
Show less
Key Features
- Centralized Management: Manage multiple connection and credential aliases through a single dashboard.
- Alias Cards: Each alias is presented in a card format showing the application icon, alias name and scope, description (if no connections exist), total connections count, and a list of associated connections.
- Sorting and Searching: Easily search aliases by name and sort them by creation date or alphabetically.
- Details View: View detailed information about an alias and its child connections, including connection names, endpoints, credential names, credential types, and OAuth token status if applicable.
- Connection Actions: Add new connections if a configuration template exists, configure unconfigured connections, or edit existing ones. OAuth tokens can be requested directly from the dashboard.
- Configuration Templates: Simplify complex integration setups (such as OAuth) by using templates that create necessary records from a single form. Not all aliases have templates; those without show an Advanced Setup option to configure connections manually.
- Pagination: The dashboard shows up to 12 aliases per page for easy navigation.
- Role-Based Access: Access requires connectionadmin or admin roles.
Managing Unconfigured Connections
When aliases are transferred or promoted to production, underlying connection details do not migrate, resulting in unconfigured connections. These must be reconfigured before use, either through the dashboard (if a configuration template is present) or via the platform user interface (if no template exists).
Practical Benefits for ServiceNow Customers
- Efficiently manage integration connections across your instance with a user-friendly interface.
- Reduce setup complexity by leveraging configuration templates for common integration types.
- Quickly identify and resolve unconfigured connections after instance transfers or promotions.
- Maintain secure and up-to-date OAuth credentials with token management directly accessible in the dashboard.
View and configure your connection and credential aliases through a simplified interface. Add new connections, edit existing connections, and view connection details.
Benefits
- Enables connection admins to manage multiple connections through a single interface.
- Provides simplified processes for adding, editing, and configuring connections.
- Displays details about an alias and all associated child connections in a single location.
Landing page
The dashboard landing page displays all the connection and credential aliases available on your instance. You can search for an alias by name, sort aliases by date created, or sort them alphabetically in ascending or descending order.
- The application's icon.
- The name and scope of the parent alias.
- A short description of the application associated with the alias. This option only appears when there are no connections.
- The total number of connections.
- A list of all the connections associated with the alias. The first connection is the default parent connection.
- A View Details option that displays specific information about the alias and any child connections.
- An Advanced Setup option. This option only appears when an alias doesn't have a configuration template.
- An Add Connection option. This option is only available when an alias has a configuration template.
Each page of the Connections dashboard displays a maximum of 12 aliases. Page through to see additional aliases.
Detailed view
- The application's icon.
- The name and scope of the parent alias.
- An option to View connection alias, which opens the associated Connection & Credential Aliases record.
- An Add Connection or Advanced Setup option, depending on whether the alias has a configuration template.
- The number of connections associated with the alias.
- A list of connections associated with the alias. The default connection is marked.
Connections that are not configured have a Configure option. Connections that are configured have an Edit option. Each configured connection displays the connection name, endpoint, credential name, and credential type.
If an alias uses an OAuth credential, the OAuth access or refresh token status is displayed with each connection. For connections that require a new token, you can request one by clicking Get OAuth Token.
Configuration templates
Configuration templates enable you to set up complex integrations using a single form. For example, an OAuth integration requires registering an OAuth provider, generating a token, and creating several connection and credential records. But if you use a configuration template to set up an OAuth integration, you only need to fill in one form. The system creates the associated records. To learn more about templates, see Connection and Credential configuration templates.
To add, edit, or configure connections directly through the dashboard, an alias must have a configuration template. Not all aliases have templates. Templates were first introduced in the Orlando release, so aliases from previous versions may not have them yet. An alias without a template displays an Advanced Setup option on both its dashboard and detailed view. Clicking Advanced Setup opens the alias's connection and credential record, where you can set up the alias. For more information about working with aliases that don't have templates, see Create a Connection and Credential alias.
Unconfigured connections
- If the alias has a template, you can configure the connection through the dashboard.
- If it doesn't have a template, configure it through the platform user interface. For more information about configuring a connection without a template, see Getting started with connections.
Roles
To access the Connections dashboard, you must have the connection_admin or admin role.