PossibleNOW MyPreferences Connector

The PossibleNOW MyPreferences Connector supports bi-directional preference data integration with MyPreferences and other applications. It allows you to seamlessly sync preference data captured in MyPreferences with other systems, or retrieve data from other systems and update MyPreferences, all in near real-time. For the latest release notes see, PossibleNOW MyPreferences Release Notes.

Connector Specifications

  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  

Note: This Connector is available only from PossibleNOW.

Supported Entities

The PossibleNOW MyPreferences Connector supports the following entities. Click a linked entity name for additional information when using that entity in TIBCO Scribe® Online. For a list of additional operations by entity see Special Operations.

Standard Operations

Entity Query Create Update Delete Upsert

BatchPreference

 

 

 

 

X

ChannelPreference

 

 

 

 

 

ContactElement

 

 

 

 

 

CustomProperties

 

 

 

 

 

PreferenceAttributes

 

 

 

 

 

PreferenceGET

X

 

 

 

 

PreferencePOST

 

 

 

 

 

Program

X

 

 

 

 

ProgramGroup

X

 

 

 

 

Special Operations

Entity Operations

DeactivatePreferenceInput

-Deactivate

ChannelPreference

PreferencePOST

-UpsertWith

PreferenceAttributes

-Add

Note: Operation results are not available for subsequent operations when using UpsertWith or Add Blocks.

Setup Considerations

Required Connection information, such as Client Id and Hash Key, is provided by PossibleNOW.

Selecting An Agent Type

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

Connecting To PossibleNOW MyPreferences

Note: Best practice is to create Connections with credentials that limit permissions in the target system, following the principle of least privilege. Using Administrator level credentials in a Connection provides Administrator level access to the target system for TIBCO Scribe® Online users. Depending on the entities supported, a TIBCO Scribe® Online user could alter user accounts in the target system.

  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.
    • Client ID — ID associated with .your MyPreferences account.
    • User Id— Your MyPreferences User ID. The MyPreferences Connector associates the preference data submissions with this UserId. To change the UserId associated with preference submissions, you must re-establish the Connection by entering a new User ID.
    • Hash Key — Provided by PossibleNOW.
    • BaseUrl — URL of the MyPreferences REST API.
  4. Select Test to ensure that the Agent can connect to your database. 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 data fields and entity types.

Reseting metatdata is only necessary when upgrading to a newer version of the Connector. There is no mechanism in the API to retrieve metadata changes, therefore the Connector must be updated to provide access to those changes.

Metadata Notes

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.

Retry Logic

If a request fails, the Connector retries three times with a delay of 1000 milliseconds before the first retry, 2000 before the second, and 3000 before the third.

PossibleNOW MyPreferences Connector As IS/MS Source

Consider the following when using the PossibleNOW MyPreferences Connector as an Integration Solution or Migration Solution source.

Supports querying Hierarchical data. See Hierarchical Data.

Relationships

This Connector only supports the Return records with or without relationship option when selecting related entities on the Include tab of source operation Blocks, such as Query, Fetch, and Lookup. This option is an outer join and returns all records for the parent or higher-level entity whether or not there are any matching related entity records. For example, if contact is the higher-level entity and account is the related entity, all contact records are returned whether there is a related account record or not.

Filtering

Using Net Change to query for new and updated records is supported for the LastDateTimeUTC field. Using the LastDateTimeUTC field for Net Change requires that you also use Segment as a filter on the Filter tab.

When a datetime is configured on the Query Block on the Block Properties Net Change Tab to query for new and updated records, that configuration is treated as an additional filter. The Net Change datetime filter is applied as an AND after any other filters specified on the Block Properties Filter Tab. TIBCO Scribe® Online builds a query combining both the Net Change filter and the filters on the Filter tab. See Net Change And Filters for an example.

Some Connectors for TIBCO Scribe® Online only support one filter. For those Connectors you can use either Net Change or one filter on the Filter tab, not both.

Note: The Net Change date is ignored when previewing data on the Preview tab. Filters on the Block Properties Filters tab are used to filter the data on the Preview tab.

PossibleNOW MyPreferences Connector As IS/MS Target

Consider the following when using the PossibleNOW MyPreferences Connector as an Integration Solution or Migration Solution source.

Notes On Standard Entities

Special information about standard entities appears below.

BatchPreference

Supports Batch Processing. Use this entity to bulk process Preference data.

ContactElement

ChannelPreference

CustomProperties

DeactivatePreferenceInput

DeactivatePreference is a virtual entity used to deactivate a Preference and include the related ContactElement entity.

PreferenceAttributes

PreferenceGET

PreferencePOST

Program

ProgramGroup

TIBCO Scribe® Online API Considerations

To create connections with the TIBCO Scribe® Online API, the PossibleNOW MyPreferences Connector requires the following information:

Connector Name

PossibleNOW MyPreferences

Connector ID

E6DAE32E-FA4E-49F2-948B-780DEF07D195

TIBCO Scribe® Online Connection Properties

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

Note: Connection property names are case-sensitive.

Name Data Type Required Secured Usage

ClientId

string

Yes

No

 

UserId

string

Yes

No

 

Saltvalue

string

Yes

Yes

 

BaseUrl

string

Yes

No

 

License Agreement

The TIBCO Scribe® Online End User License Agreement for the PossibleNOW MyPreferences Connector describes TIBCO and your legal obligations and requirements. TIBCO suggests that you read the End User License Agreement.

More Information

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