The servicenow component is used to integrate Camel with ServiceNow cloud services.
| Name | Kind | Group | Required | Default | Type | Enum | Description |
|---|---|---|---|---|---|---|---|
| instanceName | path | producer | true | java.lang.String | The ServiceNow instance name | ||
| bridgeErrorHandler | parameter | consumer | boolean | Allows for bridging the consumer to the Camel routing Error Handler, which mean any exceptions occurred while the consumer is trying to pickup incoming messages, or the likes, will now be processed as a message and handled by the routing Error Handler. By default the consumer will use the org.apache.camel.spi.ExceptionHandler to deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| exceptionHandler | parameter | consumer (advanced) | org.apache.camel.spi.ExceptionHandler | To let the consumer use a custom ExceptionHandler. Notice if the option bridgeErrorHandler is enabled then this options is not in use. By default the consumer will deal with exceptions, that will be logged at WARN/ERROR level and ignored. | |||
| exchangePattern | parameter | consumer (advanced) | org.apache.camel.ExchangePattern | InOnly RobustInOnly InOut InOptionalOut OutOnly RobustOutOnly OutIn OutOptionalIn |
Sets the exchange pattern when the consumer creates an exchange. | ||
| display | parameter | producer | true | java.lang.String | false true all |
Set this parameter to true to return only scorecards where the indicator Display field is selected. Set this parameter to all to return scorecards with any Display field value. This parameter is true by default. | |
| displayValue | parameter | producer | false | java.lang.String | false true all |
Return the display value (true), actual value (false), or both (all) for reference fields (default: false) | |
| excludeReferenceLink | parameter | producer | java.lang.Boolean | True to exclude Table API links for reference fields (default: false) | |||
| favorites | parameter | producer | java.lang.Boolean | Set this parameter to true to return only scorecards that are favorites of the querying user. | |||
| includeAggregates | parameter | producer | java.lang.Boolean | Set this parameter to true to always return all available aggregates for an indicator, including when an aggregate has already been applied. If a value is not specified, this parameter defaults to false and returns no aggregates. | |||
| includeAvailableAggregates | parameter | producer | java.lang.Boolean | Set this parameter to true to return all available aggregates for an indicator when no aggregate has been applied. If a value is not specified, this parameter defaults to false and returns no aggregates. | |||
| includeAvailableBreakdowns | parameter | producer | java.lang.Boolean | Set this parameter to true to return all available breakdowns for an indicator. If a value is not specified, this parameter defaults to false and returns no breakdowns. | |||
| includeScoreNotes | parameter | producer | java.lang.Boolean | Set this parameter to true to return all notes associated with the score. The note element contains the note text as well as the author and timestamp when the note was added. | |||
| includeScores | parameter | producer | java.lang.Boolean | Set this parameter to true to return all scores for a scorecard. If a value is not specified, this parameter defaults to false and returns only the most recent score value. | |||
| inputDisplayValue | parameter | producer | java.lang.Boolean | True to set raw value of input fields (default: false) | |||
| key | parameter | producer | java.lang.Boolean | Set this parameter to true to return only scorecards for key indicators. | |||
| models | parameter | producer | java.lang.String | Defines both request and response models | |||
| perPage | parameter | producer | 10 | java.lang.Integer | Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100. | ||
| release | parameter | producer | HELSINKI | org.apache.camel.component.servicenow.ServiceNowRelease | FUJI GENEVA HELSINKI |
The ServiceNow release to target, default to Helsinki See https://docs.servicenow.com | |
| requestModels | parameter | producer | java.lang.String | Defines the request model | |||
| resource | parameter | producer | java.lang.String | The default resource, can be overridden by header CamelServiceNowResource | |||
| responseModels | parameter | producer | java.lang.String | Defines the response model | |||
| sortBy | parameter | producer | java.lang.String | value change changeperc gap gapperc duedate name order default group indicator_group frequency target date trend bullet direction |
Specify the value to use when sorting results. By default, queries sort records by value. | ||
| sortDir | parameter | producer | java.lang.String | asc desc |
Specify the sort direction, ascending or descending. By default, queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order. | ||
| suppressAutoSysField | parameter | producer | java.lang.Boolean | True to suppress auto generation of system fields (default: false) | |||
| suppressPaginationHeader | parameter | producer | java.lang.Boolean | Set this value to true to remove the Link header from the response. The Link header allows you to request additional pages of data when the number of records matching your query exceeds the query limit | |||
| table | parameter | producer | java.lang.String | The default table, can be overridden by header CamelServiceNowTable | |||
| target | parameter | producer | java.lang.Boolean | Set this parameter to true to return only scorecards that have a target. | |||
| topLevelOnly | parameter | producer | java.lang.Boolean | Gets only those categories whose parent is a catalog. | |||
| apiVersion | parameter | advanced | java.lang.String | The ServiceNow REST API version, default latest | |||
| httpClientPolicy | parameter | advanced | org.apache.cxf.transports.http.configuration.HTTPClientPolicy | To configure http-client | |||
| mapper | parameter | advanced | com.fasterxml.jackson.databind.ObjectMapper | Sets Jackson's ObjectMapper to use for request/reply | |||
| proxyAuthorizationPolicy | parameter | advanced | org.apache.cxf.configuration.security.ProxyAuthorizationPolicy | To configure proxy authentication | |||
| synchronous | parameter | advanced | false | boolean | Sets whether synchronous processing should be strictly used, or Camel is allowed to use asynchronous processing (if supported). | ||
| proxyHost | parameter | proxy | java.lang.String | The proxy host name | |||
| proxyPort | parameter | proxy | java.lang.Integer | The proxy port number | |||
| apiUrl | parameter | security | java.lang.String | The ServiceNow REST API url | |||
| oauthClientId | parameter | security | java.lang.String | OAuth2 ClientID | |||
| oauthClientSecret | parameter | security | java.lang.String | OAuth2 ClientSecret | |||
| oauthTokenUrl | parameter | security | java.lang.String | OAuth token Url | |||
| password | parameter | security | java.lang.String | ServiceNow account password, MUST be provided | |||
| proxyPassword | parameter | security | java.lang.String | Password for proxy authentication | |||
| proxyUserName | parameter | security | java.lang.String | Username for proxy authentication | |||
| sslContextParameters | parameter | security | org.apache.camel.util.jsse.SSLContextParameters | To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html | |||
| userName | parameter | security | java.lang.String | ServiceNow user account name, MUST be provided |