How to: |
Synonyms define unique names (or aliases) for each object that is accessible from the server. Synonyms are useful because they hide the underlying data source location and identity from client applications. They also provide support for extended metadata features of the server, such as virtual fields and additional security mechanisms.
Using synonyms allows an object to be moved or renamed while allowing client applications to continue functioning without modification. The only modification required is a redefinition of the synonym on the server. The result of creating a synonym is a Master File and an Access File, which represents the server metadata.
The Select adapter to configure or Select connection to create synonym dialog box opens.
The first of a series of synonym creation panes opens, showing a list of all of the available salesforce.com objects, as shown in the following image.
If you want to change the name of the synonym from the default name, click the name and edit as needed.
The Status pane indicates that the synonym was created successfully.
The synonym is created and added under the specified application directory.
Note: You can also create a synonym from the Adapters page by right-clicking a configured adapter connection and selecting Create Synonym.
A synonym with a cluster join facilitates reporting against multiple salesforce.com objects.
Salesforce.com relationships between objects are described in the data models on the web site. Search by data model for a list of the entity relationship diagrams (ERDs) available. For example, the Sales Objects model includes accounts, contacts, opportunities and other related objects. For an example of the Sales Objects model, go to the following Web site:
http://www.salesforce.com/us/developer/docs/api/Content/sforce_api_erd_majors.htm
When you create a cluster join for salesforce.com objects, you must make it a subset of the data model. This allows the join between the objects to be performed by salesforce.com, minimizing the number of queries sent to their servers.
For example, say you wanted to create a synonym that would allow you to report from the contact object to get the first and last name of a contact, and the account object to get the company name. From the model shown in the following image, we can see that there is a relationship from Account to Contact.
Here are the steps to create a synonym with a cluster join with that relationship.
The Select … connection to create synonym dialog box opens.
The Select Synonym candidates… dialog box opens, as shown in the following image.
The Status dialog box opens.
Click Close.
A blank synonym opens.
The Insert Reference to Existing Synonym as Child of ACCOUNT dialog box opens, as shown in the following image.
Note: Under Join Type some of the synonyms have a value Matching primary keys. To create a synonym with a cluster join for salesforce.com objects, you must select one of those synonyms. The Join Condition shown will be used to join to the two objects.
The two objects can now be seen in the modeling view.
The Save Synonym As dialog box opens.
Enter account_contact for the name of the synonym and click Save.
The report appears showing the Account Name and the contact Last Name and First Name.
You can control whether or not deleted and archived records are retrieved from salesforce.com.
where:
Indicates the adapter. You can omit this value if you previously issued the SET SQLENGINE command.
Deleted and archived records are included in the records displayed.
Deleted and archived records are not retrieved. This is the default.
You can control the number of records retrieved from salesforce.com in one block.
where:
Indicates the adapter. You can omit this value if you previously issued the SET SQLENGINE command.
The number of records to retrieve in a block. The default is 200. The maximum is 9999.
iWay Software |