Appboard/2.4/builder/data sources/third party/servicenow: Difference between revisions
imported>Andy.hopper |
imported>David.moore m (→Query) |
||
| (7 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
{{DISPLAYTITLE:ServiceNow Data Adapter}} | {{DISPLAYTITLE:ServiceNow Data Adapter}} | ||
[[Category:AppBoard 2.4]] | |||
This page provides details for configuring ServiceNow adapters in AppBoard. | This page provides details for configuring ServiceNow adapters in AppBoard. | ||
| Line 14: | Line 15: | ||
!Name | !Name | ||
!Description | !Description | ||
|- | |||
|'''cacheTimeout''' | |||
|Maximum time a response from the database is kept before discarding. | |||
|- | |- | ||
|'''url''' | |'''url''' | ||
| The base URL referring to the ServiceNow web service. | | The base URL referring to the ServiceNow web service. | ||
|- | |- | ||
|'''httpAuthUsername''' | |'''httpAuthUsername''' | ||
| Line 28: | Line 29: | ||
|} | |} | ||
=== Query === | |||
You can configure one or more queries in each ServiceNow adapter configuration. Each configured query will have a different name | You can configure one or more queries in each ServiceNow adapter configuration. Each configured query will have a different name and result in a different Data Collection with that name. When naming a query, only alphanumeric characters, underscores, and hyphens are permitted. | ||
<b>Queries - Entity Settings</b> Screen: | <b>Queries - Entity Settings</b> Screen: | ||
| Line 43: | Line 44: | ||
|'''Description''' | |'''Description''' | ||
|A summary of the purpose of the query and any details or notes to provide for the system administrator | |A summary of the purpose of the query and any details or notes to provide for the system administrator | ||
|- | |||
|'''table''' | |||
|ServiceNow table to be queried. | |||
|- | |- | ||
|'''query''' | |'''query''' | ||
|ServiceNow query expression. | |ServiceNow query expression. | ||
|- | |- | ||
|'''[[appboard/2.4/builder/data_processing_scripts|Data Processing Script(s)]]''' | |'''[[appboard/2.4/builder/data_processing_scripts|Data Processing Script(s)]]''' | ||
| Line 54: | Line 55: | ||
|} | |} | ||
=== Pre-Configured Content === | |||
The ServiceNow adapter is pre-configured to present the following data collections: | The ServiceNow adapter is pre-configured to present the following data collections: | ||
{|class="wikitable" | {|class="wikitable" | ||
|'''change_request''' | |'''change_request''' | ||
|Change Requests in the last 30 days. | |Change Requests in the last 30 days. | ||
|- | |- | ||
|'''incident_Last30Days''' | |'''incident_Last30Days''' | ||
Incidents in the last 30 days. | |Incidents in the last 30 days. | ||
|- | |- | ||
|'''incident_LastYear''' | |'''incident_LastYear''' | ||
Incidents in the last year. | |Incidents in the last year. | ||
|} | |} | ||
Latest revision as of 17:17, 3 January 2014
This page provides details for configuring ServiceNow adapters in AppBoard.
In many cases, you will want to pass a parameter value into a query rather than using a static query definition. AppBoard provides a system of variable expressions, called SHIM, that can be used for this purpose. For instructions on this option, see SHIM Expressions.
Data Source Configuration
Configure Connection Settings
The table below details the settings you can configure for a ServiceNow Data Source:
| Name | Description |
|---|---|
| cacheTimeout | Maximum time a response from the database is kept before discarding. |
| url | The base URL referring to the ServiceNow web service. |
| httpAuthUsername | User name credential used to connect to ServiceNow. |
| httpAuthPassword | User password credential used to connect to ServiceNow. |
Query
You can configure one or more queries in each ServiceNow adapter configuration. Each configured query will have a different name and result in a different Data Collection with that name. When naming a query, only alphanumeric characters, underscores, and hyphens are permitted.
Queries - Entity Settings Screen:
| Name | Description |
|---|---|
| Name | Name of this query entity. Note: if editing the name all references internal to AppBoard are updated automatically, however in some cases Data Processing Scripts may have hardcoded references that will break as a result of the rename. In cases where AppBoard can detect this an error message is presented to the administrator identifying the affected scripts. |
| Description | A summary of the purpose of the query and any details or notes to provide for the system administrator |
| table | ServiceNow table to be queried. |
| query | ServiceNow query expression. |
| Data Processing Script(s) | List of one or more Data Processing Scripts to be run on the query. |
Pre-Configured Content
The ServiceNow adapter is pre-configured to present the following data collections:
| change_request | Change Requests in the last 30 days. |
| incident_Last30Days | Incidents in the last 30 days. |
| incident_LastYear | Incidents in the last year. |
