SiteToSiteProvenanceReportingTask

Specifies how many records to send in a single batch, at most.

Display Name: Batch Size
Description: Specifies how many records to send in a single batch, at most.
API Name: Batch Size
Default Value: 1000
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Specifies how long to wait to a response from the destination before deciding that an error has occurred and canceling the transaction

Display Name: Communications Timeout
Description: Specifies how long to wait to a response from the destination before deciding that an error has occurred and canceling the transaction
API Name: Communications Timeout
Default Value: 30 secs
Expression Language Scope: Not Supported
Sensitive: false
Required: true

Compress Events

Indicates whether or not to compress the data being sent.

Display Name

Compress Events

Description

Indicates whether or not to compress the data being sent.

API Name

Compress Events

Default Value

true

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Destination URL

The URL of the destination NiFi instance or, if clustered, a comma-separated list of address in the format of http(s)://host:port/nifi. This destination URL will only be used to initiate the Site-to-Site connection. The data sent by this reporting task will be load-balanced on all the nodes of the destination (if clustered).

Display Name: Destination URL
Description: The URL of the destination NiFi instance or, if clustered, a comma-separated list of address in the format of http(s)://host:port/nifi. This destination URL will only be used to initiate the Site-to-Site connection. The data sent by this reporting task will be load-balanced on all the nodes of the destination (if clustered).
API Name: Destination URL
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: true

Include Null Values

Indicate if null values should be included in records. Default will be false

Display Name

Include Null Values

Description

Indicate if null values should be included in records. Default will be false

API Name

include-null-values

Default Value

false

Allowable Values

true
false

Expression Language Scope

Not Supported

Sensitive

false

Required

true

Input Port Name

The name of the Input Port to deliver data to.

Display Name: Input Port Name
Description: The name of the Input Port to deliver data to.
API Name: Input Port Name
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: true

Instance URL

The URL of this instance to use in the Content URI of each event.

Display Name: Instance URL
Description: The URL of this instance to use in the Content URI of each event.
API Name: Instance URL
Default Value: http://${hostname(true)}:8080/nifi
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: true

Platform

The value to use for the platform field in each event.

Display Name: Platform
Description: The value to use for the platform field in each event.
API Name: Platform
Default Value: nifi
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: true

Proxy Configuration Service

Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

Display Name

Proxy Configuration Service

Description

Specifies the Proxy Configuration Controller Service to proxy network requests. Supported proxies: HTTP + AuthN

API Name

proxy-configuration-service

Service Interface

org.apache.nifi.proxy.ProxyConfigurationService

Service Implementations

org.apache.nifi.proxy.StandardProxyConfigurationService

Expression Language Scope

Not Supported

Sensitive

false

Required

false

Dependencies

Transport Protocol is set to any of [HTTP]

Record Writer

Specifies the Controller Service to use for writing out the records.

Display Name: Record Writer
Description: Specifies the Controller Service to use for writing out the records.
API Name: record-writer
Service Interface: org.apache.nifi.serialization.RecordSetWriterFactory
Service Implementations: org.apache.nifi.avro.AvroRecordSetWriter

org.apache.nifi.csv.CSVRecordSetWriter

org.apache.nifi.text.FreeFormTextRecordSetWriter

org.apache.nifi.json.JsonRecordSetWriter

org.apache.nifi.lookup.RecordSetWriterLookup

org.apache.nifi.record.script.ScriptedRecordSetWriter

org.apache.nifi.xml.XMLRecordSetWriter
Expression Language Scope: Not Supported
Sensitive: false
Required: false

Event Type to Include

Comma-separated list of event types that will be used to filter the provenance events sent by the reporting task. Available event types are [CREATE, RECEIVE, FETCH, SEND, UPLOAD, REMOTE_INVOCATION, DOWNLOAD, DROP, EXPIRE, FORK, JOIN, CLONE, CONTENT_MODIFIED, ATTRIBUTES_MODIFIED, ROUTE, ADDINFO, REPLAY, UNKNOWN]. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.

Display Name: Event Type to Include
Description: Comma-separated list of event types that will be used to filter the provenance events sent by the reporting task. Available event types are [CREATE, RECEIVE, FETCH, SEND, UPLOAD, REMOTE_INVOCATION, DOWNLOAD, DROP, EXPIRE, FORK, JOIN, CLONE, CONTENT_MODIFIED, ATTRIBUTES_MODIFIED, ROUTE, ADDINFO, REPLAY, UNKNOWN]. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.
API Name: s2s-prov-task-event-filter
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Event Type to Exclude

Comma-separated list of event types that will be used to exclude the provenance events sent by the reporting task. Available event types are [CREATE, RECEIVE, FETCH, SEND, UPLOAD, REMOTE_INVOCATION, DOWNLOAD, DROP, EXPIRE, FORK, JOIN, CLONE, CONTENT_MODIFIED, ATTRIBUTES_MODIFIED, ROUTE, ADDINFO, REPLAY, UNKNOWN]. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If an event type is included in Event Type to Include and excluded here, then the exclusion takes precedence and the event will not be sent.

Display Name: Event Type to Exclude
Description: Comma-separated list of event types that will be used to exclude the provenance events sent by the reporting task. Available event types are [CREATE, RECEIVE, FETCH, SEND, UPLOAD, REMOTE_INVOCATION, DOWNLOAD, DROP, EXPIRE, FORK, JOIN, CLONE, CONTENT_MODIFIED, ATTRIBUTES_MODIFIED, ROUTE, ADDINFO, REPLAY, UNKNOWN]. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If an event type is included in Event Type to Include and excluded here, then the exclusion takes precedence and the event will not be sent.
API Name: s2s-prov-task-event-filter-exclude
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Component ID to Include

Comma-separated list of component UUID that will be used to filter the provenance events sent by the reporting task. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.

Display Name: Component ID to Include
Description: Comma-separated list of component UUID that will be used to filter the provenance events sent by the reporting task. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.
API Name: s2s-prov-task-id-filter
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Component ID to Exclude

Comma-separated list of component UUID that will be used to exclude the provenance events sent by the reporting task. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component UUID is included in Component ID to Include and excluded here, then the exclusion takes precedence and the event will not be sent.

Display Name: Component ID to Exclude
Description: Comma-separated list of component UUID that will be used to exclude the provenance events sent by the reporting task. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component UUID is included in Component ID to Include and excluded here, then the exclusion takes precedence and the event will not be sent.
API Name: s2s-prov-task-id-filter-exclude
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Component Name to Include

Regular expression to filter the provenance events based on the component name. Only the events matching the regular expression will be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.

Display Name: Component Name to Include
Description: Regular expression to filter the provenance events based on the component name. Only the events matching the regular expression will be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.
API Name: s2s-prov-task-name-filter
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Component Name to Exclude

Regular expression to exclude the provenance events based on the component name. The events matching the regular expression will not be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component name is included in Component Name to Include and excluded here, then the exclusion takes precedence and the event will not be sent.

Display Name: Component Name to Exclude
Description: Regular expression to exclude the provenance events based on the component name. The events matching the regular expression will not be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component name is included in Component Name to Include and excluded here, then the exclusion takes precedence and the event will not be sent.
API Name: s2s-prov-task-name-filter-exclude
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Component Type to Include

Regular expression to filter the provenance events based on the component type. Only the events matching the regular expression will be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.

Display Name: Component Type to Include
Description: Regular expression to filter the provenance events based on the component type. Only the events matching the regular expression will be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative.
API Name: s2s-prov-task-type-filter
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Component Type to Exclude

Regular expression to exclude the provenance events based on the component type. The events matching the regular expression will not be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component type is included in Component Type to Include and excluded here, then the exclusion takes precedence and the event will not be sent.

Display Name: Component Type to Exclude
Description: Regular expression to exclude the provenance events based on the component type. The events matching the regular expression will not be sent. If no filter is set, all the events are sent. If multiple filters are set, the filters are cumulative. If a component type is included in Component Type to Include and excluded here, then the exclusion takes precedence and the event will not be sent.
API Name: s2s-prov-task-type-filter-exclude
Expression Language Scope: Environment variables defined at JVM level and system properties
Sensitive: false
Required: false

Transport Protocol

Specifies which transport protocol to use for Site-to-Site communication.

Display Name

Transport Protocol

Description

Specifies which transport protocol to use for Site-to-Site communication.

API Name

s2s-transport-protocol

Default Value

RAW

Allowable Values

RAW
HTTP

Expression Language Scope

Not Supported

Sensitive

false

Required

true

SSL Context Service

The SSL Context Service to use when communicating with the destination. If not specified, communications will not be secure.

Display Name: SSL Context Service
Description: The SSL Context Service to use when communicating with the destination. If not specified, communications will not be secure.
API Name: SSL Context Service
Service Interface: org.apache.nifi.ssl.RestrictedSSLContextService
Service Implementations: org.apache.nifi.ssl.StandardRestrictedSSLContextService
Expression Language Scope: Not Supported
Sensitive: false
Required: false

Start Position

If the Reporting Task has never been run, or if its state has been reset by a user, specifies where in the stream of Provenance Events the Reporting Task should start

Display Name

Start Position

Description

If the Reporting Task has never been run, or if its state has been reset by a user, specifies where in the stream of Provenance Events the Reporting Task should start

API Name

start-position

Default Value

beginning-of-stream

Allowable Values

Beginning of Stream
End of Stream

Expression Language Scope

Not Supported

Sensitive

false

Required

true

SiteToSiteProvenanceReportingTask 2.0.0