Skip to content

Commit

Permalink
Update README and option descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
sarus committed Aug 6, 2024
1 parent 8ef1c85 commit 5366b94
Show file tree
Hide file tree
Showing 3 changed files with 17 additions and 13 deletions.
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,21 +22,25 @@ The username of the Service Now user you want the integration to authenticate as
### Password
The password for the provided username you want the integration to authenticate as.

### Search By String
This will toggle whether or not to search the ServiceNow's Asset Table with strings found in your channels.
### Search By Annotated Entities
This will toggle whether to search ServiceNow for annotated entities found in your channels. The "string" Data Type must also be enabled for this option to have an effect.

### Enable Incident Search
If checked, the integration will search ServiceNow's Incident Table (incident) for IP Addresses, Domains, CVEs, annotated entities, and any added custom types

### Incident Query Fields
A comma separated list of Fields to query against Incidents.
> NOTE: If a field is not in this list, it will not be searched on on in ServiceNow's Incident Table.
> (This applies to IP Addresses, Domains, and String searches)
A comma separated list of fields to search when querying for Incidents. Incident searches are done for IPs, domains, CVEs, annotated entities and any added custom types. NOTE: If a field is not in this list, it will not be searched for Incident Queries.

### Incident Search Window in Days
Number of days back to search when searching incidents. Filters based on the date that the Incident was opened. Defaults to 360.

### Enable Asset Search
If checked, the integration will search ServiceNow's Asset Table (alm_asset) for IP Addresses, Domains, CVEs and annotated entities.
If checked, the integration will search ServiceNow's Asset Table (alm_asset) for IP Addresses, Domains, CVEs, annotated entities, and any added custom types.

### Asset Query Fields
A comma separated list of fields to search domains and IPs by in ServiceNow's Asset Table.
> NOTE: If a field is not in this list, it will not be searched on in ServiceNow's Asset Table.
> (This applies to IP Addresses, Domains, and String searches)
A comma separated list of fields to search when querying for Assets. Asset searches are done for IPs, domains, CVEs, annotated entities and any added custom types. NOTE: If a field is not in this list, the field will not be searched in ServiceNow's Asset Table.

This option defaults to searching the `ci.name` and `ci.asset_tag` fields. The correct fields to search are dependent on your ServiceNow implementation. A common additional field to add is `comments`.

## IP Lookups and Finding Query Fields
Because ServiceNow is often customized to fit specific needs, Polarity's ServiceNow Integration offers the ability to look up IPv4 matches on custom Incident and Asset fields. Simply add a comma separated list of custom fields to the `Custom Fields` integration option, and when Polarity recognizes an IP address, it will look up the address in the custom fields you listed and display the results. To determine what value you should put in this field your can reference our guide [**Here**](./HowToFindCustomFields.md) using the dashboard.
Expand Down
4 changes: 2 additions & 2 deletions config/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ module.exports = {
key: 'shouldSearchString',
name: 'Search By Annotated Entities',
description:
'This will toggle whether or not to search ServiceNow for annotated entities found in your channels. The "string" Data Type must also be enabled for this option to have an effect.',
'This will toggle whether to search ServiceNow for annotated entities found in your channels. The "string" Data Type must also be enabled for this option to have an effect.',
default: false,
type: 'boolean',
userCanEdit: false,
Expand Down Expand Up @@ -119,7 +119,7 @@ module.exports = {
key: 'enableAssetSearch',
name: 'Enable Asset Search',
description:
"If checked, the integration will search ServiceNow's Asset Table (alm_asset) for IP Addresses, Domains, CVEs, annotated entities, and any added custom types",
"If checked, the integration will search ServiceNow's Asset Table (alm_asset) for IP Addresses, Domains, CVEs, annotated entities, and any added custom types.",
default: true,
type: 'boolean',
userCanEdit: false,
Expand Down
4 changes: 2 additions & 2 deletions config/config.json
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@
{
"key": "shouldSearchString",
"name": "Search By Annotated Entities",
"description": "This will toggle whether or not to search ServiceNow for annotated entities found in your channels. The \"string\" Data Type must also be enabled for this option to have an effect.",
"description": "This will toggle whether to search ServiceNow for annotated entities found in your channels. The \"string\" Data Type must also be enabled for this option to have an effect.",
"default": false,
"type": "boolean",
"userCanEdit": false,
Expand Down Expand Up @@ -121,7 +121,7 @@
{
"key": "enableAssetSearch",
"name": "Enable Asset Search",
"description": "If checked, the integration will search ServiceNow's Asset Table (alm_asset) for IP Addresses, Domains, CVEs, annotated entities, and any added custom types",
"description": "If checked, the integration will search ServiceNow's Asset Table (alm_asset) for IP Addresses, Domains, CVEs, annotated entities, and any added custom types.",
"default": true,
"type": "boolean",
"userCanEdit": false,
Expand Down

0 comments on commit 5366b94

Please sign in to comment.