Skip to content

Commit

Permalink
docs(YSP-593): add supporting docs for usage
Browse files Browse the repository at this point in the history
  • Loading branch information
dblanken-yale committed Sep 19, 2024
1 parent 5e0551f commit 1079141
Showing 1 changed file with 25 additions and 4 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,29 @@ Features include:
## Usage

1. Install the module
2. Create a new key in the keys module with the ServiceNow endpoint username and password credentials
2. Create a new key in the keys module with the ServiceNow endpoint username and password credentials (see pantheon secrets below)
3. Visit the ServiceNow Settings under Configuration
4. Enable the module and select the key you created
5. Save
6. Upon reload, you'll notice a Sync button; click this button to do a manual sync
4. Enable the module
5. Select the key you created from the drop down
6. Enter the endpoint URL you were given by the ServiceNow Team
1. Ensure that the following fields are present in the JSON output:
1. number: The KB article number
2. short_description: The title of the article
3. text: The body of the article
4. workflow_state: The state of the article (Published, etc)
7. Save
8. Upon reload, you'll notice a Sync button; click this button to do a manual sync

The service once turned on will attempt to sync hourly.

## Pantheon Secrets

Pantheon secrets can be used with their Drupal module to interact with the keys module. To do this you'd want to add a pantheon secret at the site level first with empty data:

`terminus secrets:site:set --scope web,user <siteName> servicenow_auth ""`

From there, you can then specify the multidev specific information. The key must ultimately be a JSON payload of the following:

`terminus secrets:site:set <siteName>.<env> servicenow_auth '{"username":"username","password":"password"}'`

Then simply sync pantheon secrets in the keys configuration to bring in the key; remember that there is a time delay on when that becomes available for sync.

0 comments on commit 1079141

Please sign in to comment.