User Guide : Map Connectors : Source and Target Map Connectors : Pivotal Business Server 5.9
 
Share this page                  
Pivotal Business Server 5.9
Pivotal Business Server is a customer relations management (CRM) system that enables you to access information using a Web Services interface. Using the Pivotal Business Server 5.9 connector, the integration platform can write to Pivotal Business Server tables. The Pivotal connector supports the following operations:
• Insert
• Update
• Upsert
• Delete
This connector sets field width in bytes. What actually varies is the number of characters that fit into a given field. For example, if a field width is 10 bytes and the encoding is Shift-JIS, the field can hold a minimum of 5 characters and a maximum of 10. This means that if you try to write 8 Japanese characters, data is truncated (the Kanji characters all take 2 bytes). For more details, see Determining Field Width in Characters or Bytes.
Connectivity Pointers
• To connect to the Pivotal Business Server, enter the URL, Pivotal system name and your user ID and password, if needed.
• Before attempting to connect, verify that your path environment variable contains both the default installation directory and the Pivotal directory.
• The HTTP user ID and password are not required unless the Pivotal system you are connecting to has Basic Authentication enabled. If unsure of the security settings, ask your Pivotal system administrator.
• Fields marked Read Only can be mapped, but the value is not used by the Pivotal CRM system.
• When performing operations, the connector uses the primary key of the entity in the database, when referring to a field within an entity.
• When an entity references another entity, the ID field of the referenced entity, such as Customer_id, is used instead of the entity name.
• You must enable the API for your organization within Pivotal. In addition, you must configure security and install the Pivotal Business Server updates. For details, see Pivotal Server Administration.
Connector-Specific Notes
None.
Property Options
You can set the following source (S) and target (T) properties.
Property
S/T
Description
Batch Response
T
Creates a batch response file using a name you provide, which serves as a reporting mechanism for the connector. The file provides detailed results for each object in a batch where the batch size is greater than 1. Obtaining detailed results is useful in the following cases:
• Capturing system-generated object IDs for use in future updates.
• Correlating an error with its object and have enough information about the error for exception handling and error diagnosis.
For more information, see Batch Response File.
Connection Type
T
Sets the level of integration with the Pivotal CRM system:
• Active Form (default)
• Table
Debug Directory
T
Specifies a directory to write the debug XML files to during testing of a map. Specify only when the Debug Mode property is set to true.
Note:  Use of the Debug Directory property is for design time, not run time.
Debug Mode
T
Determines whether to produce a series of XML files containing the request and response XML data:
• False (default) – Does not create XML files with request and response data.
• True – Creates XML files with request and response data. You must enter a value for Debug Directory.
Note:  Use of the Debug Mode property is for design time, not run time.
FlushFrequency
T
Sets the number of operations that the Pivotal connector should buffer before sending to the Pivotal CRM.
• 0 (default) – Buffers all operations before sending. Error trapping is not supported. You must include a step to process the resulting batch response file and retrieve the operation counts and return values, as needed.
• 1 – Allows the connector to trap individual, non-fatal errors during a transformation so you can handle them. If errors occur and no error handling is defined, the errors are considered fatal, and the map execution stops.
• 2 or more – Buffers specified number of operations before sending. Error trapping is not supported.
Note:  The batch response file must be specified in the Batch Response property.
Ignore Nulls
T
Determines whether to ignore null values. Unmapped target fields have a null value. To compensate for this, the Pivotal Business Server connector supports removal of unused fields, and the target field is not sent to the Pivotal System.
• False (default) – Sends null values for unmapped fields to the Pivotal CRM.
• True – Ignores unmapped fields.
Login Type
T
Specifies the type of login to use. The default value of Active Client is normally sufficient for integrating with the Pivotal CRM system.
Note:  Only change this property if you are an experienced user of Pivotal CRM and are directed to do so by your system administrator.
Time Zone
T
Specifies the time zone to use. The default value of Not Specified is generally adequate. If you require a specific time zone, consult your administrator for which time zone to use.
Target Schema
The Target Schema icon is active in the toolbar when Pivotal Business Server is the target connector.
The following options are applicable for Pivotal Business Server files.
Target Field Name
These are field names that appear in your target data table.
• If you are writing data to a new table, you may enter a name for each field.
• If you are writing data to an existing table, the field names default to field names in the selected table.
Length
These are field lengths in your data. If you need to change field lengths, reset them in the schema.
Caution!  A field length shorter than the default may truncate data.
Data Types
The integration platform does not support ID field types. These following data types are supported:
• Boolean
• Date
• Double
• Float
• Integer
• String
• Text
Additional Information
Log File
The conversion log file contains the number of successful record operations performed, instead of the specific number of entities updated, deleted, and inserted.
Pivotal Record Relationships
The Pivotal Business Server connector maintains parent-child relationships by using the parent record ID. If the parent record ID is created from the previous data insertion, the connector supports the reuse of the record ID for the child record.
You can reuse record IDs by entering the designated escape sequence:
@xxxx*
The xxxx string represents the record layout name from which the desired record ID is returned. The record layout name is passed as a string value, so the value must be enclosed in double quotes before the designator is recognized by the connector.
Note:  The designator only handles records with single, distinct record IDs. If more than one record ID is available for a record, then the designator does not process the record ID. This causes an error that you must handle.
Unicode Support
The Pivotal Business Server connector supports Unicode.
Check with your system administrator to verify that your Pivotal CRM system has Unicode support enabled.
Creating DJExport Objects for Writing Data
With the Pivotal Business Server connector, you can use a DJExport object to write data into the Pivotal CRM system.
Best practices around using DJExports include the following:
• Use the DJImport/DJExport wizard to build connection strings
• Use macro values when creating connection strings
• Use field names when adding data to the DJExport
• Make sure your connection string includes the table name
The following example shows the EZscript needed to create a DJExport object that writes data to Pivotal. DJExport objects can make reference to fields added to an object by using either the field number or the field name. This example illustrates referencing DJExport objects with field names.
'Create a new DJExport object instance
Dim PVTLExport As DJExport
'Create a new DJField object instance
Dim newField As DJField
'Initialize the DJExport object
Set PVTLExport = New DJExport "Pivotal Business Server"
'Create a new dummy field
Set newField = PVTLExport.newField
'Set the DJExport object connection string
connection = "Server=URLHERE;Database=SystemName;Table=Company;FlushFrequency=1;Batch Response=;Connection Type=ACTIVE FORM;Login Type=Active Client;Time Zone=Not Specified;Ignore Nulls=True;Debug Mode=False;Debug Directory= "
'Set the connection string
PVTLExport.ConnectString = connection
'Add data values to export object by field name - only use one field reference type
PVTLExport.Records(0).Fields("Account_Manager_Id") = "0000000000000001"
PVTLExport.Records(0).Fields("Address_1") = "123456 Test Ave"
PVTLExport.Records(0).Fields("City") = "TestCity"
PVTLExport.Records(0).Fields("Company_Name") = "TestCompany"
PVTLExport.Records(0).Fields("Country") = "US"
PVTLExport.Records(0).Fields("Currency_Id") = "0000000000000001"
PVTLExport.Records(0).Fields("Phone") = "1234567890"
PVTLExport.Records(0).Fields("State_") = "ST"
PVTLExport.Records(0).Fields("Type") = "Partner"
PVTLExport.Records(0).Fields("Zip") = "12345"
'Execute the import object
PVTLExport.PutRecord
'Destroy the export object
Set PVTLExport = nothing
Note:  Adding the table is a manual process, as the DJExport object does not implicitly connect to a single table. Modify the connection string property by using EZscript to concatenate the table value to the end of the connection string.