Connect Tibco Scribe Online to Acoustic Campaign
When you are using Scribe to synchronize data with Campaign, an OAuth Token is required to access the system from Scribe Online.
To connect Scribe Online to Acoustic Campaign, you might need to complete the following steps.
- Add Scribe access to Acoustic Campaign organization.
- Get the refresh token from the Acoustic Campaign.
Complete the following steps to add Scribe access to your organization.
- Log in to Acoustic Campaign as an Organization Administrator, and in your Organization settings click Add Account Access.
- In Application, select the Scribe Integration application.
- Select the Org Admin user that communicates with Acoustic Campaign from Scribe Online.
- Add a description. Adding a description is optional, but preferred if multiple organization administrators use the system and need to know why the user has the specified access.
The system automatically sends an email containing the refresh token to the notification email address of the selected user. Open the email to get the refresh token that you add to the Scribe Online connection.
Note: If access is already set for the Application and Acoustic Campaign user, but you cannot locate the original email with the token, then select the user and click Revoke Account Access. Proceed to generate a new token by clicking Add Account Access . For more information, see Step 1 and 2.
Synchronize UB Errors to MS OneDrive
Before you create a connection, create the OneDrive account and create or upload the error text file. If the text file does not exist, create the text file in OneDrive. The text file includes the column names for target connections.
Complete the following steps to synchronize UB errors to MS OneDrive.
- Log in to Scribe Online.
- Go to Connections and click New to create new connection.
- On the Location tab, choose OneDrive from File Location.
- Click the Authenticate button. A new browser window opens.
- Enter the OneDrive login and password and click Sign in. After a successful login, the message shows that a token is retrieved for the Scribe Connector. Cloud or on premise agent might be used.
- Click the Entities tab and type the name for your new entity. This entity contains the structure, field names, and other settings.
- Click the Entity tab and configure the following settings:
- File name: Type the name of the file that stores the error information.
- Processing: Choose the Overwrite the existing file. This setting overwrites the file with relevant information each time the solution gets at least one record from Acoustic Campaign. If you select another option, the text file remains untouched.
- Click the File Format tab to define the structure of the file. You can choose a Delimited file format or a Fixed Width file format. In this example, chose to format the file by using the delimited commas, so the values are separated by a comma.
- Field delimiter: Select Comma.
- Text qualifier: Select None.
- Decimal symbol: Select Period.
- File encoding: Select UTF8.
- Check the Field names in first row option.
- Click Preview to verify that the structure is correct.
- Click Test Connection to verify the Text File Connector works.
- Click the Field tab to configure the settings for each field type:
- Field name : Type the column name included in the text file, for example GeneralError, AttributeErrors, RawEventJson.
- Data type: Select Text as default value.
- Width: Type '255'as the default value.
- Click Test Connection to verify the connection and then click OK.
- Create a new advanced map withAcoustic Campaign connection as the source and the OneDrive connection, created above, as the target.
- Complete the following steps to add a query control block.
- Configure the following settings on the General tab.
- Label: Type the Query block from the source connection, for example 'Query UBErrors'.
- Entity: Select UBErrors.
- Save the query.
- Configure the following settings on the General tab.
- Complete the following steps to add a control block for each result to iterate over the retrieved records.
- Configure the following settings on the General tab:
- Label: Type the Create block from the target connection, for example 'Create UBError'.
- Entity: Select UBError as the text file in OneDrive.
- Click the Fields tab and map the fields.
- Click OK to save the block.
- Configure the following settings on the General tab:
Synchronize UB Errors to MS SQL table
Complete the following tasks to synchronize the UB Errors to MS SQL table.
- Log in to Scribe Online.
- Go to Connections and click New to create new connection.
- Choose Microsoft SQL Server connector type from the list.
- Click Test Connection.
- Click OK.
- Use on the premise agent that is installed in the same network as your MS SQL Server.
- Create a new advanced map with Acoustic Campaign connection as a source and the SQL connection, created above, as the target.
- Complete the following steps to add a Query control block.
- Configure the following settings on the General tab:
- Label: Type the Query block from the source connection, for example 'Query UBErrors'.
- Entity: Select UBErrors.
- Save the query.
- Configure the following settings on the General tab:
- Complete the following steps to add a control block for each result to iterate over the retrieved records.
- Configure the following settings on the General tab:
- Label: Type the Create block from the target connection, for example 'Create UBError'.
- Entity: Select UB Error from the MS SQL instance.
- Click the Fields tab and map the fields.
- Click OK to save the block.
- Configure the following settings on the General tab:
Synchronize UB Errors to local FTP storage
Before you create a connection, create or upload the error text file. If the text file does not exist, create the text file in local FTP storage. The text file includes the column names for our target connections.
Complete the following steps to synchronize the UB Errors to local FTP storage.
- Log in to Scribe Online.
- Go to Connections and click New to create new connection.
- On the Location tab, choose FTP (unencrypted) from File Location.
- Configure the settings in Location Properties.
- Host name: Type the website's IP address.
- Port: Type the host site port number. If you do not know the port number, leave the default value.
- Username: Type the username that is used on the host site.
- Password :Type the password that is used on the host site.
- Remote directory path :Type the path where the text file is located.
- Click the Verify button to get the file information and contents.
- Click the Entities tab and type the name for your new entity. This entity contains the structure, field names, and other settings.
- File name: Type the name of the file that stores the error information.
- Processing: Choose Overwrite the existing file. The setting overwrites the file with relevant information each time the solution gets at least one record from Acoustic Campaign. If you select another option, the text file remains untouched.
- Click the File Format tab to define the structure of the file. You can choose a Delimited file format or a Fixed Width file format. In this example, chose to format the file by using the Delimited commas, so the values are separated by a comma.
- Field delimiter: Select Comma.
- Text qualifier: Select None.
- Decimal symbol: Select Period.
- File encoding: Select UTF8.
- Check the Field names in first row option.
- Click Preview to verify that the structure is correct.
- Click Test Connection to verify the Text File Connector works.
- Click the Field tab to configure the settings for each field type:
- Field name: Type the column name included in the text file, for example GeneralError, AttributeErrors, RawEventJson.
- Data type: Select Text as the default value.
- Width: Type '255'is the default value.
- Click Test Connection to verify the connection and then click OK.
- Complete the following steps to add a Query control block.
- Configure the following settings on the General tab:
- Label: Type the Query block from the source connection, for example 'Query UBErrors'.
- Entity: Select UBErrors.
- Save the query.
- Configure the following settings on the General tab:
- Complete the following steps to add a control block for each result to iterate over the retrieved records.
- Configure the following settings on the General tab:
- Label: Type the Create block from the target connection, for example 'Create UBError'.
- Entity: Select UBError is the text file in FTP storage.
- Click the Fields tab and map the fields.
- Click OK to save the block.
- Configure the following settings on the General tab:
Synchronize relational tables through Scribe Online
You can synchronize your Acoustic Campaign relational table data with Scribe Online. Complete the following steps to synchronize relational table with Scribe Online.
- Set up the Acoustic Campaign connection in Scribe Online.
- Set up the CRM Connection in Scribe Online.
- After the connector is added and the relational table connection is created, complete the following steps:
- Create a new solution in Scribe Online representing the Relational Table Sync.
- Create a new integration map with the new solution.
- Set the source as CRM connection and select the entity. It is best to set the map to process only when the record has changed in CRM. Processing all records on a scheduled sync may cause a subscription overage for the number of records processed.
- Set the target as the Acoustic Campaign connection.
- Map the fields that will synchronize from CRM to the specified Acoustic Campaign relational table. If needed you can use the Preview tab of the Query block for the CRM connection to see the data that will be added to Acoustic Campaign.
Connector Universal Behavior Errors Retrieval Options
Acoustic Campaign Connector (Beta) is used to retrieve universal behavior errors from Campaign. File Connector from Scribe (Text file as a target) is used to save errors. The following section describes the three possible scenarios of universal behavior errors retrieval for the Acoustic Campaign Connector (Beta).
MS SQL Server 2008 R2 is used for MS SQL option and the MS OneDrive Information - Synchronizing to MS SQL Table.
Before you create a connection, create a database, or use an existing one, and create a table. The table has to have at least the following three columns:
- GeneralErrors
- AttributeErrors
- RawEventJson
These columns are the same names tha the Acoustic Campaign Connector exposes for the UB Errors entity.
Sign up for Scribe maintenance and release notifications
After setting up a Campaign Automation Scribe Online based integration, be sure to sign up for TIBCO Scribe® Online Status, Maintenance and Release notifications.
TIBCO Scribe® Online can have planned or unplanned maintenance updates that affect your integration with Campaign Automation. The TIBCO Cloud™ Services status site updates continuously to display the current status of the platform components, this includes updates and notifications of when there are any issues.
You can sign-up to receive updates from TIBCO Cloud™ Services at https://status.cloud.tibco.com
TIBCO Scribe® Online Release Notes and Known Issues for various connectors can be viewed in their Help Center
See Subscribe To Articles, Release Announcements, And Retirement Notices By Product for instructions on enabling notifications.
Campaign Automation (currently known as Silverpop) Connector releases are located in What's New in Scribe online connector.
Delete relational table records
You might need to have a process to delete relational table records in the event they are deleted in the source CRM object; otherwise, records are deleted in one place, and not deleted in the other, which amounts to synchronization inconsistencies between the CRM and the relational table.
The obvious requirement of any Scribe online synchronization to populate an Acoustic Campaign Relational Table is to insert and update the data. Deletions in CRM must be soft-deleted so that the record is available to query after the deletion.
For example, in Salesforce.com, a record is flagged as Deleted = true when the record is deleted. It is important because those deleted records continue to exist and can be queried out of Salesfore.com through the Scribe Online connector. If the source CRM record is hard-deleted, it disappears and is not available through the Salesforce API. In that case, the records cannot be queried out and consequently cannot be used to synchronize a delete to the relational table.
- Select the IS/MS - Include deleted items in query results setting within the Connection for Salesforce.com.
- Add an advanced map to your solution. The map must be the last map so that it runs last when the solution runs.
- On the Connection tab, select the Source object that uses the Salesforce.com connection.
- Add Filter.
- Choose Process all records on each run (or) Process only records created or updated since last run based on the value of the last modified field according to how you have set up the insert or update maps.
- On the Connection tab, select the Target object that uses the Acoustic Campaign connection.
- On the Fields tab, map the unique identifier from the Source object to the relational table unique ID.
- Click Ok.
Note: If your CRM object does not track deletes as described, you can work with your CRM administrator to build a process inside your CRM to put the object's Unique ID into a custom object during the CRM delete process. For example, a Scribe mapping can reference the custom object that stores the deleted record IDs and synchronizes a Delete to the Acoustic Campaign relational table. In Salesforce.com, when a Source object is deleted, a trigger can copy the ID over to a Custom object. Alternatively, you can choose to delete all the rows in the Relational table (performed inside Acoustic Campaign) and then repopulate the Relational table through the Scribe sync with all current data.
Expose the Scribe last modified date
Because field-level auditing does not exist in Acoustic Campaign, you cannot determine the values that exist and the values that came from CRM. However, you can distinguish the syncing data that is transferred by Scribe from existing data by creating a Timestamp field in the Acoustic Campaign. When you create a timestamp field in Acoustic Campaign, you can track Scribe syncs at the record level through Acoustic Campaign. You can name the field as ScribeModified or something similar.
Complete the following steps to expose the Scribe last modified date.
- Complete the following steps to expose the ScribeModifed date. After you create the timestamp field, in Scribe Online.
- Go To Connections, select the connection for Acoustic Campaign, click Reset Metadata.
- Update all the maps which use Acoustic Campaign as the Target. Add the formula
GETDATETIME()
to the timestamp field you create.
- When the Scribe runs, you can see when it updated the record.
Note: The modified date in Acoustic Campaign does not change when a record is updated via API changes like the Scribe Online synchronization.
- Use the Acoustic Campaign values report to see the records that are changed per date.
- Go to Data > View Data.
- Select the CRM database.
- Click the Values Tab.
- Create a Report by name ScribeMod
- Run the report to get each distinct date and time value for the Scribe Modified field and the number of records that have that value.
Update the report as often as needed to see new values. You can also create a query specifying the date to make sure that the Scribe Modified field is a Date or Timestamp field.