Difference between revisions of "External Data Sources"
From AgileApps Support Wiki
imported>Aeric |
imported>Aeric |
||
| Line 27: | Line 27: | ||
|- | |- | ||
|align="right" width="120em"| '''Title''' | |align="right" width="120em"| '''Title''' | ||
| | | The text that identifies the data source in a listing. | ||
|- | |- | ||
| align="right"| | | align="right"| ''Name''' | ||
| | | Internal name used to access the data source. Populated automatically from the title, but can be modified when the service is created. (Thereafter, it is fixed.) | ||
|- | |- | ||
| align="right"| '''Web Service''' | | align="right"| '''Web Service''' | ||
| | | Choose the [[Web Service]] used to retrieve records. | ||
|- | |- | ||
| align="right"| {{TBD|'''Record Element'''}} | | align="right"| {{TBD|'''Record Element'''}} | ||
| | | In the hierarchy of data returned from the Web Service, specify the element that contains record data. (Generally, there will be multiple records, and this will be a repeating element.) | ||
|- | |- | ||
| align="right"| '''Input Mapping''' | | align="right"| '''Input Mapping''' | ||
| | | Specify the values to deliver to the web service: | ||
* '''Use Object Field -''' Select a field in the record from which the External Data Source is invoked. | |||
* '''Use Fixed Value -''' Hardcode a value. | |||
{{TBD| | |||
* '''Use Expression -''' Specify a combination of fields, values, operators, and functions. | |||
}} | |||
For each choice, specify which Web Service input gets the value. | |||
|- | |- | ||
| align="right"| '''Output Mapping''' | | align="right"| '''Output Mapping''' | ||
| | | Select a value coming back from the web service: | ||
* '''Display -''' Provide the label of the column heading for this value, when the returned records are displayed in a [[Form]]. | |||
* '''Ignore -''' Ignore the value. | |||
|} | |} | ||
Revision as of 02:36, 27 February 2014
> Objects > {object} > External Data Sources
About External Data Sources
An External Data Source lets you access a collection of related records from an external data store. Those records can then be displayed in the Related Information section of an object record.
- Considerations
-
- Records retrieved from an external data source are display-only. They are fetched each time the record is displayed.
- To store local copies of external data, use a Web Service to access the data.
- To determine when the data fetch occurs, invoke the Web Service from a Rule.
- Sample Use
- ...
Working with External Data Sources
Prerequisites
- A Web Service must be configured to supply the records that will be accessed
Adding or Editing an External Data Source
To add or edit an External Data Source:
- Go to [File:GearIcon.png]] > Objects > {object} > External Data Sources
- Click on an existing data source, or click [New External Data Source] to create a new one.
- Modify settings below __TBD: or click [Delete] to remove it.__
- Click [Save].
Settings
Title The text that identifies the data source in a listing. Name' Internal name used to access the data source. Populated automatically from the title, but can be modified when the service is created. (Thereafter, it is fixed.) Web Service Choose the Web Service used to retrieve records. __TBD: Record Element__ In the hierarchy of data returned from the Web Service, specify the element that contains record data. (Generally, there will be multiple records, and this will be a repeating element.) Input Mapping Specify the values to deliver to the web service: - Use Object Field - Select a field in the record from which the External Data Source is invoked.
- Use Fixed Value - Hardcode a value.
__TBD:
- Use Expression - Specify a combination of fields, values, operators, and functions.
__ For each choice, specify which Web Service input gets the value.
Output Mapping Select a value coming back from the web service: - Display - Provide the label of the column heading for this value, when the returned records are displayed in a Form.
- Ignore - Ignore the value.
Using an External Data Source in a Form
To use an External Data Source:
- Go to
> Objects > {object} > Forms > {form} - In the sidebar, click New Related Information.
- Fill in the settings:
- Information Source - Choose External Data Source
The remaining list of options changes to reflect your selection. - External Data Source - Choose the External Data Source that will supply the records.
- Title - Provide the title to be displayed in the form for the Related Information section.
- Learn more: Related Information
- Information Source - Choose External Data Source