TalkPoint Connector For TIBCO Scribe® Online

Use the TalkPoint Connector for TIBCO Scribe® Online to register audience members for TalkPoint events and retrieve detailed event and attendee information.

Connector Specifications

This Connector supports version 4.3 of the Registration API and version 2.0 of the Reporting API.

	Supported
Agent Types
On Premise	X
Cloud	X
Replication Services
Source
Target
Integration Services
Source	X
Target	X
Migration Services
Source	X
Target	X
Maps
Integration	X
Request-Reply	X
Message

Supported Entities

The TalkPoint Connector supports the following entities. Click a linked entity name for additional information when using that entity in TIBCO Scribe® Online.

Standard Operations

Entity	Query	Create	Update	Delete	Upsert
Registrant		X
WebcastList	X
WebcastDetails	X
WebcastDetails Related Entities
Surveys	X
Attendees	X
Attendees Related Entities
CustomRegistrationQA	X
GeneralQA	X
Sessions	X
SurveyQA	X

Setup Considerations

The TalkPoint Connector requires the following:

• Client ID — Used to access the TalkPoint Service Side Registration API when TalkPoint is the target and you are creating Registrants. When testing a TalkPoint Connection, the Client ID is not validated. If an invalid Client ID is used, an error occurs when a Map using the Create Block to create Registrants is executed.
• API User — Your TalkPoint API user name.
• API Password — Password associated with your TalkPoint API user name.

API Usage Limits

The TalkPoint API limits the requests for data and the number of calls used to register Attendees on a per second, per minute, and per hour basis.

Selecting An Agent Type For TalkPoint

Refer to TIBCO Scribe® Online Agents for information on available Agent types and how to select the best Agent for your Solution.

Connecting To TalkPoint

1. Select More > Connections from the menu.
2. From the Connections page select Add to open the Add a New Connection dialog.
3. Select the Connector from the drop-down list in the Connection Type field, and then enter the following information for this Connection:
   • Name — This can be any meaningful name, up to 25 characters.
   • Alias — An alias for this Connection name. The alias is generated from the Connection name, and can be up to 25 characters. The Connection alias can include letters, numbers, and underscores. Spaces and special characters are not accepted. You can change the alias. For more information, see Connection Alias.
   • API User — Your TalkPoint API user name.
   • API Password — Password associated with your TalkPoint API user name.
   • Client ID — The Client ID used to access the TalkPoint Service Side Registration API.
4. Select Test to ensure that the Agent can connect to TalkPoint. Be sure to test the Connection against all Agents that use this connection. See Testing Connections.
5. Select OK/Save to save the Connection.

Metadata Notes

Consider the following for TalkPoint data fields and entity types.

Naming

Connection metadata must have unique entity, relationship, and field names. If your Connection metadata has duplicate names, review the source system to determine if the duplicates can be renamed.

Relationships

Hierarchical relationships, such as grandparent, parent, grandchild relationships are not supported. See Hierarchical Data for examples.

DateTime Fields

All datetime fields are returned from and sent to TalkPoint in UTC time.

TalkPoint Connector As IS Source

Consider the following when using the TalkPoint Connector as an IS source.

Debug

Using the Debug feature to test a Map is not supported when using the TalkPoint Connector as a Source.

Boolean Field Values

Filtering on Boolean fields does not support t and f values, only the following values are supported:

• 1 / 0
• true / false
• "yes" / "no"
• "on" / "off"

TalkPoint Connector As IS Target

There are no special considerations when using the TalkPoint Connector as an IS target.

Notes On Standard Entities

Special information about standard entities appears below.

Attendees

• Query —
  • Data for this entity cannot be queried directly, but can be returned as a related entity to an event by querying the WebcastDetails entity.
  • Returns people that have registered for a given webcast regardless of whether or not they attend the webcast.
• Filter Or Lookup — Filtering is not supported for this entity.

CustomRegistrationQA

• Query —
  • Data for this entity cannot be queried directly, but can be returned as a related entity to an Attendee.
  • TalkPoint returns the field name of the field containing the question instead of the question itself.
  • TalkPoint returns multiple answers to Checkbox type questions separated by the pipe (|) symbol.
• Filter Or Lookup — Filtering is not supported for this entity.

GeneralQA

• Query — Data for this entity cannot be queried directly, but can be returned as a related entity to an Attendee.
• Filter Or Lookup — Filtering is not supported for this entity.

Registrant

• Create —
  • Valid Email and EventId fields are required to create a Registrant.
  • Registrant fields containing html or other script tags are blocked by the API's security filter.
  • Parameters not configured for the selected Event ID are discarded when submitted for a Registrant.
  • Custom Registration Questions — When creating Registrants and associated custom registration questions, note the following:
    • Question types include: Text, Text Area, Select Box, Radio Button, and Checkbox.
    • Multiple answers to Checkbox type questions must be separated by the pipe (|) symbol.
    • Report Column Title of a custom registration question in the source records must match the Report Column Title of the question in the TalkPoint target Webcast or it is ignored. Report Column Title is case sensitive.
    • Answers to Select Box, Checkbox, and Radio Button custom registration questions in the source data must match Answers in TalkPoint exactly or they are ignored. Answers are case sensitive.

Sessions

• Query — Data for this entity cannot be queried directly, but can be returned as a related entity to an Attendee.
• Filter Or Lookup — Filtering is not supported for this entity.

Surveys

• Query — Data for this entity cannot be queried directly, but can be returned as a related entity to an event by querying the WebcastDetails entity.
• Filter Or Lookup — Filtering is not supported for this entity.

SurveyQA

• Query — Data for this entity cannot be queried directly, but can be returned as a related entity to an Attendee.
• Filter Or Lookup — Filtering is not supported for this entity.

WebcastDetails

• Supports returning data from non-expired Events.
• Net Change — If you are filtering for new and updated records on the Net Change tab, note the following:
  • Net Change uses the DateRangeFilter field. Do not use the same field on the Filter tab or you may have inconsistent results.
  • If the date on the Net Change tab is set to Never, a starting date range of 1/1/1980 is used.
  • When filtering for new and updated records, TalkPoint expects a starting and ending date and does not support milliseconds in the timestamp. To accommodate this, the Net Change filter works as follows:
    • The date entered on the Net Change tab is the starting date in the range and the timestamp is set automatically to 12:00:00 AM regardless of what is entered, such as 5/15/2017 12:00:00 AM.
    • The current date is the ending date in the range and the time is set automatically to 11:59:59 PM, such as 5/22/2017 11:59:59 PM.
    • After the Map runs, the Net Change date is set to the current date with a time of 12:00:00:000 AM, such as 5/22/2017 12:00:00:000 AM. This may cause duplicate records to be returned the next time the Map runs because the new start date is earlier than the last end date. In our example, the start date is 5/22/2017 12:00:00:000 AM, which causes all records for 5/22/2017 to be processed again.
    • When Net Change is enabled, including the RegistrationDateFilter or the ViewingSessionsDateFilter boolean fields on the Filter tab controls whether RegistrationDate or ViewingSessionDate field values are used to compare against the date on the Net Change tab. If neither filter field is specified on the Filter tab, both default to True and both are used as shown in the table.

      Registration Date Filter	Viewing Sessions Date Filter	Records Filtered By
      True	False	RegistrationDate
      False	True	ViewingSession Date
      True	True	Both
      False	False	No filtering

• Filter Or Lookup
  • Supports the logical operator AND, but not OR.
  • Values used in filters are also included in Query Results as mappable fields.
  • Equals is the only supported operator for all filter fields except, DateRangeFilter fields.
  • To return a single WebcastDetails record use EventID as a filter. If EventID is not used as a filter, all non-expired WebcastDetails records are returned.
  • All filter fields except EventID control which Attendees records are included in the query results.
  • DateRangeFilter — Starting date:
    • Works in conjunction with both the RegistrationDateFilter and ViewingSessionsDateFilter fields on the Filter tab. If neither is configured on the Filter tab, both default to true and both are used as filters. If you configure one of these two filter fields, you must configure the other. If you configure only one, errors or unexpected results occur.
    • The first occurrence of this field in the Filter tab is considered the start date for the range.
    • Time on datetime is ignored and only the date is used. For the starting date a default time value of 12:00:00 AM is always used.
    • Date range format is mm/dd/yyyy.
    • Supported operators include: is greater than (>), is less than (<), is greater than or equal to (>=), and is less than or equal to (<=).
    • Is greater than (>) and is greater than or equal to (>=) operators are both treated as is greater than or equal to (>=).

    Note: Do not use the DateRangeFilter field on the Filter tab if you have already used it on the Net Change tab or you may have inconsistent results.

  • DateRangeFilter — Ending date:
    • Works in conjunction with both the RegistrationDateFilter and ViewingSessionsDateFilter fields on the Filter tab. If neither is configured on the Filter tab, both default to true and both are used as filters. If you configure one of these two filter fields, you must configure the other. If you configure only one, errors or unexpected results occur.
    • The second occurrence of this field in the Filter tab is considered the end date for the range.
    • Time on datetime is ignored and only the date is used. For the ending date a default time value of 11:59:59 PM is always used.
    • Date range format is mm/dd/yyyy.
    • Supported operators include: is greater than (>), is less than (<), is greater than or equal to (>=), and is less than or equal to (<=).
    • Is greater than (>) and is greater than or equal to (>=) operators are both treated as is greater than or equal to (>=).

    Note: Do not use the DateRangeFilter field on the Filter tab if you have already used it on the Net Change tab or you may have inconsistent results.

  • RegistrationDateFilter —
    • Returns only Registrants who registered within the selected date range.
    • Requires a DateRange field filter to be set.
    • If undefined, defaults to On or true, but is not returned in the query unless a DateRange filter is set.
  • ViewingSessionsDateFilter —
    • Returns only Registrants with a viewing duration of any type within the selected date range.
    • Requires a DateRange field filter to be set.
    • If undefined, defaults to On or True, but is not returned in the query unless a DateRange filter is set.
  • StiFilter —
    • Includes only Registrants who accessed the event using a URL containing a Source Tracking Identifier.
    • Multiple values are separated with pipes (|).
    • If undefined, defaults to Off or false.
  • ExcludeEmailDomainFilter —
    • Excludes Registrants with email addresses in the specified domain.
    • Multiple values are separated with pipes (|).
    • If undefined, defaults to Off or false.
    • Cannot be used with the IncludeEmailDomainFilter field.
  • IncludeEmailDomainFilter —
    • Includes Registrants with email addresses in the specified domain.
    • If undefined, defaults to Off or false.
    • Multiple values are separated with pipes (|).
    • Cannot be used with the ExcludeEmailDomainFilter field.
  • SurveyDataFilter —
    • Includes only Registrants who responded to one or more surveys.
    • If undefined defaults, to Off or false.
  • AttendeeQADataFilter —
    • Includes only Registrants who asked a question during the webcast.
    • If undefined, defaults to Off or false.
  • LiveViewingSessionsFilter —
    • Includes only Registrants with one or more live viewing sessions.
    • If undefined, defaults to Off or false.
  • NoShowsFilter —
    • Includes only Registrants with no viewing sessions of any type.
    • If undefined, defaults to Off or false.
  • OnDemandViewingSessionsFilter —
    • Includes only Registrants with one or more On-Demand or Archive viewing sessions.
    • If undefined, defaults to Off or false.
  • SimliveViewersFilter —
    • Includes only Registrants with one or more Simulated Live viewing sessions.
    • If undefined, defaults to Off or false.

WebcastList

• Query — Returning data from expired Events is not supported.
• Net Change — Filtering for new or updated records using the Query Block Net Change tab options is not supported for this entity.
• Filter Or Lookup — Filtering is not supported for this entity.

TIBCO Scribe® Online API Considerations

To create Connections with the TIBCO Scribe® Online API, the TalkPoint Connector requires the following information:

Connector Name	TalkPoint
Connector ID	6FFA111A-3874-4016-970A-8E232FB00338

TIBCO Scribe® Online Connection Properties

In addition, this Connector uses the Connection properties shown in the following table.

Name	Data Type	Required	Secured	Usage
ApiUser	String	Yes	No
ApiPassword	String	Yes	Yes
ClientId	String	Yes	No

More Information

For additional information on this Connector, refer to the Knowledge Base and Discussions in the TIBCO Community.