org.apache.nifinifi-slack-nar2.5.0org.apache.nifinifi-standard-shared-nar2.5.02.2.0rel/nifi-2.5.0main1org.apache.nifi.processors.slack.ConsumeSlackPROCESSORRetrieves messages from one or more configured Slack channels. The messages are written out in JSON format. See Usage / Additional Details for more information about how to configure this Processor and enable it to retrieve messages from Slack.slackconversationconversation.historysocial mediateamtextunstructuredChannelsChannelsA comma-separated list of Slack Channels to Retrieve Messages From. Each element in the list may be either a Channel ID, such as C0L9VCD47, or (for public channels only) the name of a channel, prefixed with a # sign, such as #general. If any channel name is provided instead,instead of an ID, the Access Token provided must be granted the channels:read scope in order to resolve the Channel ID. See the Processor's Additional Details for information on how to find a Channel ID.truefalsefalseNONEfalsefalseAccess TokenAccess TokenOAuth Access Token used for authenticating/authorizing the Slack request sent by NiFi. This may be either a User Token or a Bot Token. It must be granted the channels:history, groups:history, im:history, or mpim:history scope, depending on the type of conversation being used.truetruefalseNONEfalsefalseReply Monitor WindowReply Monitor WindowAfter consuming all messages in a given channel, this Processor will periodically poll all "threaded messages", aka Replies, whose timestamp is between now and this amount of time in the past in order to check for any new replies. Setting this value to a larger value may result in additional resource use and may result in Rate Limiting. However, if a user replies to an old thread that was started outside of this window, the reply may not be captured.7 daystruefalsefalseNONEfalsefalseReply Monitor FrequencyReply Monitor FrequencyAfter consuming all messages in a given channel, this Processor will periodically poll all "threaded messages", aka Replies, whose timestamp falls between now and the amount of time specified by the <Reply Monitor Window> property. This property determines how frequently those messages are polled. Setting the value to a shorter duration may result in replies to messages being captured more quickly, providing a lower latency. However, it will also result in additional resource use and could trigger Rate Limiting to occur.5 minstruefalsefalseNONEfalsefalseBatch SizeBatch SizeThe maximum number of messages to retrieve in a single request to Slack. The entire response will be parsed into memory, so it is important that this be kept in mind when setting this value.100truefalsefalseNONEfalsefalseResolve UsernamesResolve UsernamesSpecifies whether or not User IDs should be resolved to usernames. By default, Slack Messages provide the ID of the user that sends a message, such as U0123456789, but not the username, such as NiFiUser. The username may be resolved, but it may require additional calls to the Slack API and requires that the Token used be granted the users:read scope. If set to true, usernames will be resolved with a best-effort policy: if a username cannot be obtained, it will be skipped over. Also, note that when a username is obtained, the Message's <username> field is populated, and the <text> field is updated such that any mention will be output such as "Hi @user" instead of "Hi <@U1234567>".truetruetruefalsefalsetruefalsefalseNONEfalsefalseInclude Message BlocksInclude Message BlocksSpecifies whether or not the output JSON should include the value of the 'blocks' field for each Slack Message. This field includes information such as individual parts of a message that are formatted using rich text. This may be useful, for instance, for parsing. However, it often accounts for a significant portion of the data and as such may be set to null when it is not useful to you.falsetruetruefalsefalsetruefalsefalseNONEfalsefalseInclude Null FieldsInclude Null FieldsSpecifies whether or not fields that have null values should be included in the output JSON. If true, any field in a Slack Message that has a null value will be included in the JSON with a value of null. If false, the key omitted from the output JSON entirely. Omitting null values results in smaller messages that are generally more efficient to process, but including the values may provide a better understanding of the format, especially for schema inference.truetruetruefalsefalsetruefalsefalseNONEfalsefalsesuccessSlack messages that are successfully received will be routed to this relationshipfalseslack.channel.idThe ID of the Slack Channel from which the messages were retrievedslack.message.countThe number of slack messages that are included in the FlowFilemime.typeSet to application/json, as the output will always be in JSON formattruetrue3 sec30 secWARNMaintains a mapping of Slack Channel IDs to the timestamp of the last message that was retrieved for that channel. This allows the processor to only retrieve messages that have been posted since the last time the processor was run. This state is stored in the cluster so that if the Primary Node changes, the new node will pick up where the previous node left off.CLUSTERINPUT_FORBIDDENorg.apache.nifi.processors.slack.ListenSlackorg.apache.nifi.processors.slack.ListenSlackPROCESSORRetrieves real-time messages or Slack commands from one or more Slack conversations. The messages are written out in JSON format. Note that this Processor should be used to obtain real-time messages and commands from Slack and does not provide a mechanism for obtaining historical messages. The ConsumeSlack Processor should be used for an initial load of messages from a channel. See Usage / Additional Details for more information about how to configure this Processor and enable it to retrieve messages and commands from Slack.slackreal-timeeventmessagecommandlistenreceivesocial mediateamtextunstructuredApp TokenApp TokenThe Application Token that is registered to your Slack applicationtruetruefalseNONEfalsefalseBot TokenBot TokenThe Bot Token that is registered to your Slack applicationtruetruefalseNONEfalsefalseEvent Type to ReceiveEvent Type to ReceiveSpecifies the type of Event that the Processor should respond toReceive App Mention EventsReceive App Mention EventsReceive App Mention EventsThe Processor is to receive only slack messages that mention the bot user (App Mention Events)Receive Message EventsReceive Message EventsThe Processor is to receive Slack Message EventsReceive CommandsReceive CommandsThe Processor is to receive Commands from Slack that are specific to your application. The Processor will not receive Message Events.Receive Joined Channel EventsReceive Joined Channel EventsThe Processor is to receive only events when a member is joining a channel. The Processor will not receive Message Events.truefalsefalseNONEfalsefalseResolve User DetailsResolve User DetailsSpecifies whether the Processor should lookup details about the Slack User who sent the received message. If true, the output JSON will contain an additional field named 'userDetails'. The 'user' field will still contain the ID of the user. In order to enable this capability, the Bot Token must be granted the 'users:read' and optionally the 'users.profile:read' Bot Token Scope. If the rate limit is exceeded when retrieving this information, the received message will be rejected and must be re-delivered.falsetruetruefalsefalsetruefalsefalseNONEfalsefalseEvent Type to ReceiveEvent Type to ReceiveReceive App Mention EventsReceive Joined Channel EventsReceive Message EventssuccessAll FlowFiles that are created will be sent to this Relationship.falsemime.typeSet to application/json, as the output will always be in JSON formatslack.event.typeSet to the type of Slack event that occurredtrue250 millis30 secWARNINPUT_FORBIDDENorg.apache.nifi.processors.slack.ConsumeSlackorg.apache.nifi.processors.slack.PublishSlackPROCESSORPosts a message to the specified Slack channel. The content of the message can be either a user-defined message that makes use of Expression Language or the contents of the FlowFile can be sent as the message. If sending a user-defined message, the contents of the FlowFile may also be optionally uploaded as a file attachment. slackconversationchat.postMessagesocial mediateamtextunstructuredwriteuploadsendpublishAccess TokenAccess TokenOAuth Access Token used for authenticating/authorizing the Slack request sent by NiFi. This may be either a User Token or a Bot Token. The token must be granted the chat:write scope. Additionally, in order to upload FlowFile contents as an attachment, it must be granted files:write.truetruefalseNONEfalsefalseChannelChannelThe name or identifier of the channel to send the message to. If using a channel name, it must be prefixed with the # character. For example, #general. This is valid only for public channels. Otherwise, the unique identifier of the channel to publish to must be provided.truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsePublish StrategyPublish StrategySpecifies how the Processor will send the message or file to Slack.Send FlowFile Content as MessageSend FlowFile Content as MessageSend FlowFile Content as MessageThe contents of the FlowFile will be sent as the message text.Use 'Message Text' PropertyUse 'Message Text' PropertyThe value of the Message Text Property will be sent as the message text.truefalsefalseNONEfalsefalseMessage TextMessage TextThe text of the message to send to Slack.truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsePublish StrategyPublish StrategyUse 'Message Text' PropertyCharacter SetCharacter SetSpecifies the name of the Character Set used to encode the FlowFile contents.UTF-8truefalsetrueFLOWFILE_ATTRIBUTESfalsefalsePublish StrategyPublish StrategySend FlowFile Content as MessageInclude FlowFile Content as AttachmentInclude FlowFile Content as AttachmentSpecifies whether or not the contents of the FlowFile should be uploaded as an attachment to the Slack message.falsetruetruefalsefalsetruefalsefalseNONEfalsefalsePublish StrategyPublish StrategyUse 'Message Text' PropertyMax FlowFile SizeMax FlowFile SizeThe maximum size of a FlowFile that can be sent to Slack. If any FlowFile exceeds this size, it will be routed to failure. This plays an important role because the entire contents of the file must be loaded into NiFi's heap in order to send the data to Slack.1 MBtruefalsefalseNONEfalsefalseInclude FlowFile Content as AttachmentInclude FlowFile Content as AttachmenttrueThread TimestampThread TimestampThe Timestamp identifier for the thread that this message is to be a part of. If not specified, the message will be a top-level message instead of being in a thread.falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalseMethods Endpoint Url PrefixMethods Endpoint Url PrefixCustomization of the Slack Client. Set the methodsEndpointUrlPrefix. If you need to set a different URL prefix for Slack API Methods calls, you can set the one. Default value: https://slack.com/api/falsefalsetrueFLOWFILE_ATTRIBUTESfalsefalsefailureFlowFiles are routed to 'failure' if unable to be sent to Slack for any other reasonfalserate limitedFlowFiles are routed to 'rate limited' if the Rate Limit has been exceededfalsesuccessFlowFiles are routed to success after being successfully sent to Slackfalseslack.channel.idThe ID of the Slack Channel from which the messages were retrievedslack.tsThe timestamp of the slack messages that was sent; this is used by Slack as a unique identifier3 sec30 secWARNINPUT_REQUIREDSend specific text as a message to Slack, optionally including the FlowFile's contents as an attached file.INPUT_ALLOWEDSet "Access Token" to the value of your Slack OAuth Access Token. Set "Channel" to the ID of the channel or the name of the channel prefixed with the # symbol. For example, "C0123456789" or "#general". Set "Publish Strategy" to "Use 'Message Text' Property". Set "Message Text" to the text that you would like to send as the Slack message. Set "Include FlowFile Content as Attachment" to "true" if the FlowFile's contents should be attached as a file, or "false" to send just the message text without an attachment. Send the contents of the FlowFile as a message to Slack.INPUT_ALLOWEDSet "Access Token" to the value of your Slack OAuth Access Token. Set "Channel" to the ID of the channel or the name of the channel prefixed with the # symbol. For example, "C0123456789" or "#general". Set "Publish Strategy" to "Send FlowFile Content as Message". Respond to a Slack message in a thread.slackrespondreplythreadorg.apache.nifi.processors.standard.EvaluateJsonPathSet "Destination" to "flowfile-attribute" Add a new property named "thread.ts" with a value of `$.threadTs` Add a new property named "message.ts" with a value of `$.ts` Add a new property named "channel.id" with a value of `$.channel` Add a new property named "user.id" with a value of `$.user` Connect the "matched" Relationship to PublishSlack. org.apache.nifi.processors.slack.PublishSlackSet "Access Token" to the value of your Slack OAuth Access Token. Set "Channel" to `${'channel.id'}` Set "Publish Strategy" to "Use 'Message Text' Property". Set "Message Text" to the text that you would like to send as the response. If desired, you can reference the user of the original message by including the text `<@${'user.id'}>`. For example: `Hey, <@${'user.id'}>, thanks for asking...` Set "Include FlowFile Content as Attachment" to "false". Set "Thread Timestamp" to `${'thread.ts':replaceEmpty( ${'message.ts'} )}` org.apache.nifi.processors.slack.ListenSlackorg.apache.nifi.processors.slack.ConsumeSlackorg.apache.nifi.services.slack.SlackRecordSinkCONTROLLER_SERVICEFormat and send Records to a configured Channel using the Slack Post Message API. The service requires a Slack App with a Bot User configured for access to a Slack workspace. The Bot User OAuth Bearer Token is required for posting messages to Slack.slackrecordsinkapi-urlAPI URLSlack Web API URL for posting text messages to channels. It only needs to be changed if Slack changes its API URL.https://slack.com/apitruefalsefalseNONEfalsefalseaccess-tokenAccess TokenBot OAuth Token used for authenticating and authorizing the Slack request sent by NiFi.truetruefalseNONEfalsefalsechannel-idChannel IDSlack channel, private group, or IM channel to send the message to. Use Channel ID instead of the name.truefalsefalseNONEfalsefalseinput-character-setInput Character SetSpecifies the character set of the records used to generate the Slack message.UTF-8truefalsefalseNONEfalsefalserecord-sink-record-writerRecord WriterSpecifies the Controller Service to use for writing out the records.org.apache.nifi.serialization.RecordSetWriterFactoryorg.apache.nifinifi-standard-services-api-nar2.5.0truefalsefalseNONEfalsefalseweb-service-client-providerWeb Service Client ProviderController service to provide HTTP client for communicating with Slack APIorg.apache.nifi.web.client.provider.api.WebClientServiceProviderorg.apache.nifinifi-standard-services-api-nar2.5.0truefalsefalseNONEfalsefalseorg.apache.nifi.record.sink.RecordSinkServiceorg.apache.nifinifi-standard-services-api-nar2.5.0