SSAD Internal User Guide
Overview
The Open iT Shared Software Assets Directory (SSAD) is a central repository for software information and its normalized format. It plays a crucial role in Open iT’s ServiceNow integration by automatically distributing a standard software catalog for data normalization that ensures report accuracy in the ServiceNow for Engineering Dashboard.
Scope and Limitation
This guide is specifically for the management of the Open iT Shared Software Assets Directory (SSAD) in the Customer Portal and is intended for internal use only.
It provides instructions on how to:
- Create and manage client credentials to connect to the SSAD
- Manage the SSAD content
Moreover, this document does not cover broader IT infrastructure customer’s Open iT application management, or detailed technical troubleshooting.
Requirements
Your account in the Customer Portal must have the SSAD-Admin role to manage the SSAD and JWT Clients pages.
Generating the Client ID and Secret
The customer’s Open iT setup needs a client ID and client secret to access the SSAD hosted in the Customer Portal.
-
Log in to the Open iT Customer Portal Admin page.
-
Go to the JWT Clients page.
tipIf you can't see JWT Clients from the Service Catalog after accessing the Customer Portal Admin page, you may not have the required role.
Coordinate with iTools or your administrator to request an SSAD-Admin role.
-
Click the Add JWT Client button.
-
On the Add JWT Client prompt, supply the following information:
- In Select Company, choose the Open iT customer name that will use the client credentials.
- Create a unique client ID, click Generate Guid, or leave the default client ID as-is.
- Create a descriptive client name.
- (Optional) Click Generate Guid for the Client Secret Value as needed.
noteKeep the predefined values of Allowed Scopes and Grant Types as-is.
warningCopy and securely save the client secret immediately as you won't be able to retrieve it after clicking Save.
-
Click Save.
Managing the SSAD Tables
The SSAD database consists of the Software, Feature, Daemon, Vendor, and License Manager tables. You can manually manage (add, edit, delete) information per table or upload a CSV file containing the software details to easily populate and manage the catalog.
You can also manage (add, edit, delete) source information per entry per table for historical reference.
Importing a CSV Source File
-
Log in to the Open iT Customer Portal Admin page.
-
Go to the SSAD page.
-
Go to File Import.
-
Drag then drop the CSV file on the available download area or browse for the file.
-
You may update the details per entry as needed. To do so, scroll to the right then click on the Edit icon.
Update the information as needed, then click Update.
-
You may also delete an entry by clicking on the Delete icon. Click Delete on the confirmation prompt to proceed.
-
Once done with updating the details, click Save to upload the CSV file.
Adding a Table Entry
-
Log in to the Open iT Customer Portal Admin page.
-
Go to the SSAD page.
-
Choose the table to update.
-
Select the Add button on the upper-right corner of the page.
-
Supply the necessary details.
-
Click Save.
Editing a Table Entry
-
Log in to the Open iT Customer Portal Admin page.
-
Go to the SSAD page.
-
Choose the table to update.
-
Search for the target entry
-
Under the Actions column, click the corresponding Edit icon.
-
Update the details as needed.
-
Click Save.
Deleting a Catalog Entry
-
Log in to the Open iT Customer Portal Admin page.
-
Go to the SSAD page.
-
Choose the table to update.
-
Search for the target entry.
-
Under the Actions column, click the corresponding Delete icon.
-
Click Delete to proceed.
Adding Source Information
-
Log in to the Open iT Customer Portal Admin page.
-
Go to the SSAD page.
-
Choose the table to update.
-
Search for the target entry.
-
Under the Actions column, click the corresponding More Actions icon and select Edit Source Information.
-
In the Source Information table, click the Plus button to add new source information.
-
Click the Edit icon to enable the fields.
-
Update the details as needed.
-
Click the Save button.
Editing Source Information
-
Log in to the Open iT Customer Portal Admin page.
-
Go to the SSAD page.
-
Choose the table to update.
-
Search for the target entry.
-
Under the Actions column, click the corresponding More Actions icon and select Edit Source Information.
-
In the Source Information table, search for the source information entry to update.
-
Click the Edit icon to enable the fields.
-
Update the details as needed.
-
Click the Save button.
Deleting Source Information
-
Log in to the Open iT Customer Portal Admin page.
-
Go to the SSAD page.
-
Choose the table to update.
-
Search for the target entry.
-
Under the Actions column, click the corresponding More Actions icon and select Edit Source Information.
-
In the Source Information table, search for the source information entry to delete.
-
Click the Delete icon.
Adding an Alias Rule
Use Alias Rules to rename certain values in specific fields in the SSAD catalog. This is currently available for the FeatureVersion and LicenseManager fields.
-
Log in to the Open iT Customer Portal Admin page.
-
Go to the Alias Rules page.
-
Click Add Alias Rule.
-
Input the needed information.
-
Click Save.
Managing the SSAD Site Values
Site values are predefined options that can be selected for certain dropdown menus within forms in the SSAD pages. You can set values for License Metrics, Pricing Model, License Installations, Discipline, Workflow, and Elements.
These site values are crucial for maintaining consistency, accuracy, and efficiency in data entry and management processes.
Adding Site Values
-
Log in to the Open iT Customer Portal Admin page.
-
On the upper-right corner of the page, click the Site Values icon.
-
Under SSAD Site Values, choose the field to update.
-
In the right panel, supply the site value details.
-
Click Save.
Editing Site Values
-
Log in to the Open iT Customer Portal Admin page.
-
On the upper-right corner of the page, click the Site Values icon.
-
Under SSAD Site Values, choose the field to update.
-
In the Site Values table, select the entry to update.
-
In the right panel, edit the site value details as needed.
-
Click Save.
Deleting Site Values
-
Log in to the Open iT Customer Portal Admin page.
-
On the upper-right corner of the page, click the Site Values icon.
-
Under SSAD Site Values, choose the field to update.
-
In the Site Values table, select the entry to delete.
-
In the right panel, click the Delete icon.
-
Click Delete to proceed.