Skip to content

docs(connectors): a connector's label can be renamed after creation #16321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
paulOsinski wants to merge 1 commit into
base: dev
Choose a base branch
from
+2 −2
Open

docs(connectors): a connector's label can be renamed after creation #16321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/content/connectors/upstream/add_edit.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ You can also edit an existing Connector under the **Configured Connectors** head

4. You will need an accessible **Location URL** for the tool, along with an API **Secret** key. The location of the API key will depend on the tool you are trying to configure. See our [Tool\-Specific Reference](../../toolreference/upstream/) for more details.
​
5. Set a **Label** for this connection to help you identify it in DefectDojo.
5. Set a **Label** for this connection to help you identify it in DefectDojo. The label is cosmetic: you can rename it later from **Edit Configuration** without affecting the Records, Engagements or Tests the connector has already created. Each connector type can only use a given label once.
​
6. Schedule the Connector's automatic discovery and sync under the **Discovery Configuration** and **Synchronization Configuration** sections. For each, pick a **Frequency** (every 6, 12, or 24 hours) and a **Time**. At *Every 24 hours* the connector runs once a day at that time; at *Every 6 hours* or *Every 12 hours* the time sets when the first run of the day happens, and the connector repeats from there. Times are shown in your browser's local timezone. You can change any of this later.
​
Expand Down
2 changes: 1 addition & 1 deletion docs/content/connectors/upstream/manage_records.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Once a Record is Mapped, DefectDojo will be ready to import your tool’s scans

* Record Mappings are designed to be non-invasive. If you map an Asset to a Record which contains existing Engagements or Findings, those existing Engagements and Findings will not be affected or overwritten by the data sync process.
​
* All data created via a connector will be stored under a single Engagement called **Global Connectors**. That Engagement will create a separate Test for each Connector mapped to the Asset.
* All data created via a connector will be stored under a single Engagement named **Global Connectors - \<label\> - \<Vendor-Equivalent Product\>**. That Engagement will create a separate Test for each Connector mapped to the Asset. The Record stays linked to that Engagement by ID, not by name: renaming the Connector's label does not create a new Engagement, and syncs keep landing in the existing one under its original name.

![image](images/manage_records_2.jpg)

Expand Down
Loading