Jump to: navigation, search

channel-<any name>-monitor-<any name> Section

Tip
For a Twitter channel this section is called channel-<any name>-monitor.

access-token

Default Value: The value of the x-acess-token option
Valid Values: Any valid media access token (string)
Changes Take Effect: After the time interval specified in the sampling-period or x-sampling-period options

Specifies the default media access token that will be used for communication.

Important
There are the following requirements:
  • For Facebook monitors of type private-messaging, a page access token is required.
  • For Facebook monitors of type generic:
    • For Page monitors, a page access token is required.
    • For User Event and Group monitors, a user access token is required.

cleanup-relations

Default Value: 7
Valid Values: 0–365
Changes Take Effect: Immediately

Specifies, in days, how frequently the relations data (friends, followers and actions records) of Twitter channels is cleaned up by the server. A value of 0 means the cleaning is not performed.

control-str-public

Default Value: on
Valid Values: on, off
Changes Take Effect: After restart

Specifies whether Twitter Driver uses the public messages data stream. If on, the stream is used. If off, the stream is not used.

Tip
The public data stream delivers messages that are specified by the options str-follow-<any name> and str-track-<any name>.

control-str-user

Default Value: on
Valid Values: on, off
Changes Take Effect: After restart

Specifies whether Twitter Driver uses the user data stream. If on, the stream is used. If off, the stream is not used.

Important
The user data stream delivers home timeline tweets, tweets with mention of a channel account, and direct messages.

faulty-conditions-delay

Default value: value of the x-faulty-conditions-delay option
Valid values: 0 - 3600
Changes take effect: Immediately.

Specifies, in seconds, a timespan that takes effect in the event of problems with Facebook communications. Depending on the scenario, the Driver either restarts the affected monitor after the timespan or puts the monitor into sleeping mode for the length of the timespan. This option was introduced in release 8.5.101.17.

The description of the corresponding channel-level option includes a listing of the scenarios and explanations of the Driver's behavior in each.

get-direct-messages

Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately

Specifies whether to turn off (false) or on (true) fetching of direct messages from your own account. This option applies to Twitter channels only.

get-home-timeline

Default Value: false
Valid Values: true, false
Changes Take Effect: Immediately

Specifies whether to turn off (false) or on (true) fetching of messages from your home timeline. This option applies to Twitter channels only.

get-mentions

Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately

Specifies whether to turn off (false) or on (true) fetching of messages from your home account. This option applies to Twitter channels only.

history-length

Default Value: value of the x-history-length option
Valid Values: Any positive integer.
Changes Take Effect: After the time interval specified in the sampling-period or x-sampling-period options.

Specifies how many successfully submitted interaction IDs the RSS/ATOM driver will keep in the history file in order to avoid a duplicate submission.

Important
This option overwrites the option x-print-rss-channel in the main channel section.

history-time-period

Default Value: value of the x-history-time-period option
Valid Values: 60–31536000 (1 min-365 days)
Changes Take Effect: After restart

Specifies the length, in seconds, of the history time period during which objects are read from. This option applies to Facebook channels only.

Tip
The history-time-period option can be configured for all monitors using the x-history-time-period option. The option in a particular monitor section overwrites the option in the main channel section.

This option replaces the posts-time-period and messages-time-period options.

This option is processed by all monitor types.

history-writing-frequency

Default Value: value of the x-history-writing-frequency option
Valid Values: 10–10000
Changes Take Effect: Immediately

Specifies how often, in scanning cycles, the history is written to the history file. For example, if set to 3, each third scanning cycle writes to the history file. This option applies to Facebook channels only.

Tip
The history-writing-frequency option can be configured for all monitors using the x-history-writing-frequency option. The option in a particular monitor section overwrites the option in the main channel section. This option is processed by all monitor types.

id

Default Value: No default value
Valid Values: Any numeric string: the valid ID of a Facebook object for monitoring
Changes Take Effect: After restart

Mandatory when the monitor-type is set to generic or private-messaging. If the monitor-type is generic, this can be the ID of a Page, Event, or Group. If the monitor-type is private-messaging, this can only be a the ID of a Page.

inbound-media

Default Value: The value of the x-inbound-media option
Valid Values: Any valid media name
Changes Take Effect: Immediately

Specifies the media type assigned to interactions that are submitted to Interaction Server on incoming Facebook messages.


Tip
For private-messaging monitors this value is hardcoded as facebooksession and cannot be changed. Make sure you have also properly configured facebooksession as a Media Type Business Attribute.

itx-submit-timeout

Default Value: 10
Valid Values: 1–60
Changes Take Effect: Immediately

Specifies the amount of time, in seconds, that Social Messaging Server waits for a positive response when it submits a request with an inbound message to Interaction Server.

itx-resubmit-attempts

Default Value: 3
Valid Values: 0–9
Changes Take Effect: Immediately

Specifies the number of times that Social Messaging Server resubmits an interaction after the itx-submit-timeout timeout expires.

itx-resubmit-delay

Default Value: 30
Valid Values: 1–120
Changes Take Effect: Immediately

Specifies the time, in seconds, that Social Messaging Server waits between attempts to resubmit an interaction.

max-comments-per-post-to-process

Default Value: value of x-max-comments-per-post-to-process option
Valid Values: 1–2147483647
Changes Take Effect: Immediately

Specifies the maximum number of comments per post and replies per comment that can be attached to an interaction. For example, if a Post has one hundred Comments and this option is set to 50, only the fifty most recent comments are attached to the interaction and passed to an Agent. The same for Replies: if Comment has one hundred Replies and the option is set to 50, only the fifty most recent replies are attached to the interaction. Parent Comments are included in the count. For example, if the driver retrieved ten recent Comments and ten latest Replies for some very old Comment, and the option is set to 5, only the five most recent Replies plus the four most recent Comments from the retrieved ten are attached to the interaction.

If the option is set to 0, all comments and replies are attached to the interaction and passed to an Agent. This option applies to Facebook channels only.

Tip
This option can be configured for all monitors using the x-max-comments-per-post-to-process option. The option in a particular monitor section overwrites the option in the main channel section. This option is processed by the generic and search monitor types.

max-listed-posts-per-request

Default Value: The value of the x-max-listed-posts-per-request option
Valid Values: 2–1000
Changes Take Effect: Immediately

Specifies the maximum number of explicitly listed post IDs in an FQL request. This option is intended for use by Genesys Professional Services only. In May 2013, Facebook could process FQL requests with more than 1,000 explicitly listed post IDs; however, in July 2013, this amount dropped to approximately 300. This option was added for fine-tuning in case of further changes in Facebook behavior.

max-objects-per-request

Default Value: value of the x-max-objects-per-request option
Valid Values: 50–1500
Changes Take Effect: Immediately

Specifies the maximum number of Facebook objects (Posts, Comments, Messages) that are retrieved by one request to the Facebook server. Applies to requests using either FQL (Facebook Query Language) or the Graph API.

Tip
The max-objects-per-request option can be configured for all monitors using the x-max-objects-per-request option. The option in a particular monitor section overwrites the option in the main channel section.

This option replaces the max-posts-per-fql-request, max-comments-per-fql-request, and max-messages-per-fql-request options.

The bigger the value is, the longer the response time from the Facebook Server. This increases the possibility of losing connection to the Facebook server due to HTTP session timeouts.

This option is processed by all monitor types.
Important
This option is intended for use by Genesys Professional Services only.

monitor-type

Default Value: No default value
Valid Values: generic, search, private-messaging
Changes Take Effect: After restart

Specifies the monitor type.

This option is mandatory and does not have a default value. If this option is missing, empty, or has an invalid value, Facebook Driver starts and prints an error message in the log, but the monitor is not created. In this situation, you can change monitor-type to any valid value and the Driver then works immediately.

Important
Once a monitor is created, you cannot change its type. Instead, you must delete the monitor and recreate it with the desired monitor type.
Warning
Do not use the search type for Genesys Driver for use with Facebook if the Driver uses an access token that was issued for a Facebook application that was created after 04/30/2014. This is because, starting on 05/01/2014, Facebook does not support searching of publicly-available posts by applications which were created after 04/30/14. For applications created before 04/30/14, searching of publicly-available posts will be supported until about 04/30/15. For details see https://developers.facebook.com/docs/apps/changelog.
Tip
If the value of monitor-type is private-messaging, then access-token must represent a Facebook Page access token.

If the value of monitor-type is invalid or empty, Facebook Driver will not create a monitor for this section. In this case, the monitor-type option can be changed to any valid value at any time without restarting the server. Once a valid monitor is created, changes to

monitor-type are ignored unless the server is restarted.

posts-buffer-size

Default value: 1000
Valid values: 0–2147483647
Changes take effect: Immediately

Specifies the maximum number of posts to be monitored for update. These posts are retrieved during startup and later are added in a normal scan cycles. If the actual number of posts is greater than this value, the most recent posts are retrieved. The Driver processes this option only when the monitor-type is generic.
This option applies to Facebook channels only.

Tip
This value can also be configured at the channel level using the x-posts-buffer-size option.

print-rss-channel

Default value: false
Valid values: true, false
Changes take effect: After the time interval specified in the sampling-period or x-sampling-period options.

Specifies whether the driver should print common fields of the received RSS/ATOM feed to a log file.

Important
This option overwrites the option x-print-rss-channel in the main channel section.

print-rss-items

Default value: 0
Valid values: Any interger 0 and above. Changes take effect: After the time interval specified in the sampling-period or x-sampling-period options.

Specifies how many received RSS/ATOM items the driver prints to a log file.

Important
This option overwrites the option x-print-rss-items in the main channel section.

publish-access-token

Default: No default value
Valid Values: Any valid access token (string)
Changes take effect: Immediately

Specifies an access token that is used by the Driver to publish posts and comments. The Driver processes this option only when the monitor-type is generic. This option applies to Facebook channels only.

query

Default Value: No default value
Valid Values: Any valid Facebook query (string)
Changes Take Effect: After the time interval specified in the sampling-period or x-sampling-period options

Specifies the text to search in Posts on Facebook. The Driver processes this option only when the monitor-type is set to search.

refresh-period-channel-account

Default Value: 60
Valid Values: 0–2147483648
Changes Take Effect: Immediately

Specifies, in minutes, how frequently the account information of the channel is refreshed with data that is re-fetched from Twitter. A value of 0 means the list is not refreshed.

refresh-period-followers

Default Value: 60
Valid Values: 0–2147483648
Changes Take Effect: Immediately

Specifies, in minutes, how frequently the followers list of the account channel is refreshed with data that is re-fetched from Twitter. A value of 0 means the list is not refreshed.

refresh-period-friends

Default Value: 60
Valid Values: 0–2147483648
Changes Take Effect: Immediately

Specifies, in minutes, how frequently the friends list of the account channel is refreshed with data that is re-fetched from Twitter. A value of 0 means the list is not refreshed.

rss-url

Default value: empty
Valid values: Any valid URL.
Changes take effect: After the time interval specified in the sampling-period or x-sampling-period options.

Specifies URL of an RSS feeder, which is used to request data from the feeder.

sampling-history

Default Value: 0
Valid Values: 0–864000
Changes Take Effect: After Restart

Specifies the "historical depth," in seconds, of the first data fetching cycle from the Twitter data source. The first data fetching cycle requests messages with time stamps from (current_time_in_seconds minus sampling-history value) to (current_time_in_seconds). A value of zero means only new messages are fetched; that is, messages created after the driver's start time.

sampling-period

Default Value:

  • For monitors of type generic and search—The value of the x-sampling-period option. If x-sampling-period is missing, the default value is 240.
  • For monitors of type private-messaging—3

Valid Values:

  • generic or search monitors—30–31536000
  • private-messaging monitors—1–31536000

Changes Take Effect: Immediately

Specifies how frequently, in seconds, data-fetching from a Facebook data source will occur.

Important
The value of sampling-period cannot be smaller than the value of sampling-time-buffer.
Facebook Driver checks its configuration every time it requests data from Facebook.
Tip
This value can also be configured at the channel level using the x-sampling-period option.

sampling-time-buffer

Default Value:

  • For monitors of type generic and search—The value of the x-sampling-time-buffer option. If x-sampling-time-buffer is missing:
    • generic monitors—30
    • search monitors—86400
  • For monitors of type private-messaging—1

Valid Values:

  • search monitors—86400–7776000 (1–90 days)
  • generic monitors—10–180
  • private-messaging monitors—1–180

Changes Take Effect: After the time interval specified in the sampling-period or x-sampling-period options

Specifies, in seconds, the buffer time for the sampling period. The buffer time is deducted from the start time of each sampling period in monitors.

The increased valid values for the search type monitor enable this monitor to retrieve more of the comments, likes, shares, and so on that relate to a post. But note the warning concerning the search type.

Tip
This value can also be configured at the channel level using the x-sampling-time-buffer option.

str-follow-<any name>

Default Value: No default value
Valid Values: Positive integer
Changes Take Effect: Immediately

Specifies the numeric ID of a Twitter user. Public statuses for this user are included in the messaging stream. Refer to the stream query parameter follow that is described at https://dev.twitter.com/streaming/overview/request-parameters#follow.

str-track-<any name>

Default Value: No default value
Valid Values: Any string
Changes Take Effect: Immediately

Specifies keywords or phrases to track. Public statuses that match this option are included in the messaging stream. Refer to the stream query parameter track that is described at https://dev.twitter.com/streaming/overview/request-parameters#track.

submit-as-chat

Default Value: true
Valid Values: true, false
Changes Take Effect: After the time interval specified in the sampling-period or x-sampling-period options

Specifies how new incoming Facebook private messages are introduced into the system. With the value true, the driver submits a new Facebook private chat session via Chat Server. With the value false, the driver submits a regular interaction of media-type facebookprivatemessage.

Important
Workspace Desktop Edition 8.5.1 does not support the facebookprivatemessage media type for inbound interactions. If you are using Workspace Desktop Edition 8.5.1, you must not change the default setting of this option. If you are using a custom desktop, you may use either setting.

submit-comments-itx

Default Value: The value of the x-submit-comments-itx option
Valid Values: true, false
Changes Take Effect: After the time interval specified in the sampling-period or x-sampling-period options

Specifies whether a new interaction with Facebook type comment will be created for each comment (true). The Driver processes this option only when the monitor-type is generic or search.

Tip
This value can also be configured at the channel level using the x-submit-comments-itx option.

submit-internal-itx

Default Value: The value of the x-submit-internal-itx option
Valid Values: true, false
Changes Take Effect: After the time interval specified in the sampling-period or x-sampling-period options

When the Facebook driver is monitoring the Facebook wall it will read all of the posts and comments and some of the posts and comment might be created by agents. If this option is set to true, all Facebook interactions (regardless of who created the posts and comments) will be created. If this option is set to false, only interactions in which there is new content (posts or comments) created by customers will be created. All interactions that have older posts created prior to monitor read times and comments created only by agents will not be submitted. The Driver processes this option only when the monitor-type is generic or search.

Tip
This value can also be configured at the channel level using the x-submit-internal-itx option.
This page was last modified on November 20, 2018, at 10:26.

Feedback

Comment on this article:

blog comments powered by Disqus