camel-servicenow-kafka-connector sink configuration

Connector Description: Interact with ServiceNow via its REST API.

When using camel-servicenow-kafka-connector as sink make sure to use the following Maven dependency to have support for the connector:

<dependency>
  <groupId>org.apache.camel.kafkaconnector</groupId>
  <artifactId>camel-servicenow-kafka-connector</artifactId>
  <version>x.x.x</version>
  <!-- use the same version as your Camel Kafka connector version -->
</dependency>

To use this sink connector in Kafka connect you’ll need to set the following connector.class

connector.class=org.apache.camel.kafkaconnector.servicenow.CamelServicenowSinkConnector

The camel-servicenow sink connector supports 93 options, which are listed below.

Name Description Default Priority

camel.sink.path.instanceName

Required The ServiceNow instance name.

HIGH

camel.sink.endpoint.display

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. One of: [false] [true] [all].

Enum values:

  • false

  • true

  • all

"true"

MEDIUM

camel.sink.endpoint.displayValue

Return the display value (true), actual value (false), or both (all) for reference fields (default: false) One of: [false] [true] [all].

Enum values:

  • false

  • true

  • all

"false"

MEDIUM

camel.sink.endpoint.excludeReferenceLink

True to exclude Table API links for reference fields (default: false).

MEDIUM

camel.sink.endpoint.favorites

Set this parameter to true to return only scorecards that are favorites of the querying user.

MEDIUM

camel.sink.endpoint.includeAggregates

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.

MEDIUM

camel.sink.endpoint.includeAvailableAggregates

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.

MEDIUM

camel.sink.endpoint.includeAvailableBreakdowns

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.

MEDIUM

camel.sink.endpoint.includeScoreNotes

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.

MEDIUM

camel.sink.endpoint.includeScores

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.

MEDIUM

camel.sink.endpoint.inputDisplayValue

True to set raw value of input fields (default: false).

MEDIUM

camel.sink.endpoint.key

Set this parameter to true to return only scorecards for key indicators.

MEDIUM

camel.sink.endpoint.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.sink.endpoint.models

Defines both request and response models.

MEDIUM

camel.sink.endpoint.perPage

Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100.

"10"

MEDIUM

camel.sink.endpoint.release

The ServiceNow release to target, default to Helsinki See https://docs.servicenow.com One of: [FUJI] [GENEVA] [HELSINKI].

Enum values:

  • FUJI

  • GENEVA

  • HELSINKI

"HELSINKI"

MEDIUM

camel.sink.endpoint.requestModels

Defines the request model.

MEDIUM

camel.sink.endpoint.resource

The default resource, can be overridden by header CamelServiceNowResource.

MEDIUM

camel.sink.endpoint.responseModels

Defines the response model.

MEDIUM

camel.sink.endpoint.sortBy

Specify the value to use when sorting results. By default, queries sort records by value. One of: [value] [change] [changeperc] [gap] [gapperc] [duedate] [name] [order] [default] [group] [indicator_group] [frequency] [target] [date] [trend] [bullet] [direction].

Enum values:

  • value

  • change

  • changeperc

  • gap

  • gapperc

  • duedate

  • name

  • order

  • default

  • group

  • indicator_group

  • frequency

  • target

  • date

  • trend

  • bullet

  • direction

MEDIUM

camel.sink.endpoint.sortDir

Specify the sort direction, ascending or descending. By default, queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order. One of: [asc] [desc].

Enum values:

  • asc

  • desc

MEDIUM

camel.sink.endpoint.suppressAutoSysField

True to suppress auto generation of system fields (default: false).

MEDIUM

camel.sink.endpoint.suppressPaginationHeader

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.

MEDIUM

camel.sink.endpoint.table

The default table, can be overridden by header CamelServiceNowTable.

MEDIUM

camel.sink.endpoint.target

Set this parameter to true to return only scorecards that have a target.

MEDIUM

camel.sink.endpoint.topLevelOnly

Gets only those categories whose parent is a catalog.

MEDIUM

camel.sink.endpoint.apiVersion

The ServiceNow REST API version, default latest.

MEDIUM

camel.sink.endpoint.dateFormat

The date format used for Json serialization/deserialization.

"yyyy-MM-dd"

MEDIUM

camel.sink.endpoint.dateTimeFormat

The date-time format used for Json serialization/deserialization.

"yyyy-MM-dd HH:mm:ss"

MEDIUM

camel.sink.endpoint.httpClientPolicy

To configure http-client.

MEDIUM

camel.sink.endpoint.mapper

Sets Jackson’s ObjectMapper to use for request/reply.

MEDIUM

camel.sink.endpoint.proxyAuthorizationPolicy

To configure proxy authentication.

MEDIUM

camel.sink.endpoint.retrieveTargetRecordOnImport

Set this parameter to true to retrieve the target record when using import set api. The import set result is then replaced by the target record.

"false"

MEDIUM

camel.sink.endpoint.timeFormat

The time format used for Json serialization/deserialization.

"HH:mm:ss"

MEDIUM

camel.sink.endpoint.proxyHost

The proxy host name.

MEDIUM

camel.sink.endpoint.proxyPort

The proxy port number.

MEDIUM

camel.sink.endpoint.apiUrl

The ServiceNow REST API url.

MEDIUM

camel.sink.endpoint.oauthClientId

OAuth2 ClientID.

MEDIUM

camel.sink.endpoint.oauthClientSecret

OAuth2 ClientSecret.

MEDIUM

camel.sink.endpoint.oauthTokenUrl

OAuth token Url.

MEDIUM

camel.sink.endpoint.password

Required ServiceNow account password, MUST be provided.

HIGH

camel.sink.endpoint.proxyPassword

Password for proxy authentication.

MEDIUM

camel.sink.endpoint.proxyUserName

Username for proxy authentication.

MEDIUM

camel.sink.endpoint.sslContextParameters

To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html.

MEDIUM

camel.sink.endpoint.userName

Required ServiceNow user account name, MUST be provided.

HIGH

camel.component.servicenow.configuration

Component configuration.

MEDIUM

camel.component.servicenow.display

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. One of: [false] [true] [all].

Enum values:

  • false

  • true

  • all

"true"

MEDIUM

camel.component.servicenow.displayValue

Return the display value (true), actual value (false), or both (all) for reference fields (default: false) One of: [false] [true] [all].

Enum values:

  • false

  • true

  • all

"false"

MEDIUM

camel.component.servicenow.excludeReferenceLink

True to exclude Table API links for reference fields (default: false).

MEDIUM

camel.component.servicenow.favorites

Set this parameter to true to return only scorecards that are favorites of the querying user.

MEDIUM

camel.component.servicenow.includeAggregates

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.

MEDIUM

camel.component.servicenow.includeAvailableAggregates

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.

MEDIUM

camel.component.servicenow.includeAvailableBreakdowns

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.

MEDIUM

camel.component.servicenow.includeScoreNotes

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.

MEDIUM

camel.component.servicenow.includeScores

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.

MEDIUM

camel.component.servicenow.inputDisplayValue

True to set raw value of input fields (default: false).

MEDIUM

camel.component.servicenow.key

Set this parameter to true to return only scorecards for key indicators.

MEDIUM

camel.component.servicenow.lazyStartProducer

Whether the producer should be started lazy (on the first message). By starting lazy you can use this to allow CamelContext and routes to startup in situations where a producer may otherwise fail during starting and cause the route to fail being started. By deferring this startup to be lazy then the startup failure can be handled during routing messages via Camel’s routing error handlers. Beware that when the first message is processed then creating and starting the producer may take a little time and prolong the total processing time of the processing.

false

MEDIUM

camel.component.servicenow.models

Defines both request and response models.

MEDIUM

camel.component.servicenow.perPage

Enter the maximum number of scorecards each query can return. By default this value is 10, and the maximum is 100.

"10"

MEDIUM

camel.component.servicenow.release

The ServiceNow release to target, default to Helsinki See https://docs.servicenow.com One of: [FUJI] [GENEVA] [HELSINKI].

Enum values:

  • FUJI

  • GENEVA

  • HELSINKI

"HELSINKI"

MEDIUM

camel.component.servicenow.requestModels

Defines the request model.

MEDIUM

camel.component.servicenow.resource

The default resource, can be overridden by header CamelServiceNowResource.

MEDIUM

camel.component.servicenow.responseModels

Defines the response model.

MEDIUM

camel.component.servicenow.sortBy

Specify the value to use when sorting results. By default, queries sort records by value. One of: [value] [change] [changeperc] [gap] [gapperc] [duedate] [name] [order] [default] [group] [indicator_group] [frequency] [target] [date] [trend] [bullet] [direction].

Enum values:

  • value

  • change

  • changeperc

  • gap

  • gapperc

  • duedate

  • name

  • order

  • default

  • group

  • indicator_group

  • frequency

  • target

  • date

  • trend

  • bullet

  • direction

MEDIUM

camel.component.servicenow.sortDir

Specify the sort direction, ascending or descending. By default, queries sort records in descending order. Use sysparm_sortdir=asc to sort in ascending order. One of: [asc] [desc].

Enum values:

  • asc

  • desc

MEDIUM

camel.component.servicenow.suppressAutoSysField

True to suppress auto generation of system fields (default: false).

MEDIUM

camel.component.servicenow.suppressPaginationHeader

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.

MEDIUM

camel.component.servicenow.table

The default table, can be overridden by header CamelServiceNowTable.

MEDIUM

camel.component.servicenow.target

Set this parameter to true to return only scorecards that have a target.

MEDIUM

camel.component.servicenow.topLevelOnly

Gets only those categories whose parent is a catalog.

MEDIUM

camel.component.servicenow.apiVersion

The ServiceNow REST API version, default latest.

MEDIUM

camel.component.servicenow.autowiredEnabled

Whether autowiring is enabled. This is used for automatic autowiring options (the option must be marked as autowired) by looking up in the registry to find if there is a single instance of matching type, which then gets configured on the component. This can be used for automatic configuring JDBC data sources, JMS connection factories, AWS Clients, etc.

true

MEDIUM

camel.component.servicenow.dateFormat

The date format used for Json serialization/deserialization.

"yyyy-MM-dd"

MEDIUM

camel.component.servicenow.dateTimeFormat

The date-time format used for Json serialization/deserialization.

"yyyy-MM-dd HH:mm:ss"

MEDIUM

camel.component.servicenow.httpClientPolicy

To configure http-client.

MEDIUM

camel.component.servicenow.instanceName

The ServiceNow instance name.

MEDIUM

camel.component.servicenow.mapper

Sets Jackson’s ObjectMapper to use for request/reply.

MEDIUM

camel.component.servicenow.proxyAuthorizationPolicy

To configure proxy authentication.

MEDIUM

camel.component.servicenow.retrieveTargetRecordOnImport

Set this parameter to true to retrieve the target record when using import set api. The import set result is then replaced by the target record.

"false"

MEDIUM

camel.component.servicenow.timeFormat

The time format used for Json serialization/deserialization.

"HH:mm:ss"

MEDIUM

camel.component.servicenow.proxyHost

The proxy host name.

MEDIUM

camel.component.servicenow.proxyPort

The proxy port number.

MEDIUM

camel.component.servicenow.apiUrl

The ServiceNow REST API url.

MEDIUM

camel.component.servicenow.oauthClientId

OAuth2 ClientID.

MEDIUM

camel.component.servicenow.oauthClientSecret

OAuth2 ClientSecret.

MEDIUM

camel.component.servicenow.oauthTokenUrl

OAuth token Url.

MEDIUM

camel.component.servicenow.password

Required ServiceNow account password, MUST be provided.

HIGH

camel.component.servicenow.proxyPassword

Password for proxy authentication.

MEDIUM

camel.component.servicenow.proxyUserName

Username for proxy authentication.

MEDIUM

camel.component.servicenow.sslContextParameters

To configure security using SSLContextParameters. See http://camel.apache.org/camel-configuration-utilities.html.

MEDIUM

camel.component.servicenow.useGlobalSslContextParameters

Enable usage of global SSL context parameters.

false

MEDIUM

camel.component.servicenow.userName

Required ServiceNow user account name, MUST be provided.

HIGH

The camel-servicenow sink connector has no converters out of the box.

The camel-servicenow sink connector has no transforms out of the box.

The camel-servicenow sink connector has no aggregation strategies out of the box.

Back to top