Skip to content

Commit

Permalink
chore(docs): add connector type and status documentation (#409)
Browse files Browse the repository at this point in the history
  • Loading branch information
tmberthold authored Jan 8, 2025
1 parent e0e0225 commit 22395f5
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 1 deletion.
13 changes: 13 additions & 0 deletions docs/product/user-documentation/Authority Section.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,19 @@ The process is as follows:
Under "All Connectors", Authority Users and Admins can see all registered connectors of all organizations in the Authority Portal.
Also, the connector details can be accessed from here.

Additionally, the status of each connector is displayed, providing insights into their current operational state. Each Connector can have the following statuses:
- Online: The connector is reachable and operational.
- Offline: The connector is not reachable by the Authority Portal crawler.

Connectors of type CAAS (Connector as a Service) can also support extended operational statuses. These additional statuses provide more granular insights into the state of Connector as a Service Connectors, reflecting their dynamic and managed nature.
- Init: The connector is in the initialization process.
- Provisioning: The connector is being set up and is not yet available for use.
- Deprovisioning: The connector is being decommissioned or removed.
- Error: An issue has occurred that requires attention.
- Unknown: Connector has been deleted via other systems and no longer exists.

In rare cases, additional statuses may appear, reflecting specific scenarios or exceptions in the system's operation.

## Dashboard & Reporting

Additionally Authority Users and Admins have access to the following features on the Dashboard:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,11 @@ Currently, the Service Partner Admin role grants the following rights in additio

#### 1. View a list of provided connectors

As a Service Partner Admin a user is able to access the "Provided Connectors" page where all provided connectors are displayed.
A Service Partner Admin is able to access the "Provided Connectors" page, where all provided connectors are displayed. On this page, connectors are categorized by their types. The types of connectors include:
- Own: Connectors registered and maintained directly by the organization.
- Provided: Connectors supplied by a third-party service partner.
- CaaS: Connector as a Service - Managed connectors.
- Configure Button: The Connector needs further configuration for being set up.

![provide-connector](images/provide-connectors-overview.png)

Expand Down

0 comments on commit 22395f5

Please sign in to comment.