Read (PicklistValue)

Operation Name

Function Overview

This operation is to read the picklist values.
Call will differ depending on the API version of the Global Resource.

API 29.0 or earlier
API 34.0 or later

With regarding to the API specification utilized by this operation, please refer to the version of the API document, selected for the Global Resource, in the below-mentioned link.

"Salesforce Developer Documentation"-(https://developer.salesforce.com/docs)
- Metadata API Developer's Guide

Data Model

The data model of this component is the XML type.

Properties

For information about using variables, refer to "variables".

Basic Settings

Item name	Required/Optional	Use of Variables	Description	Supplement
Name	Required	Not Available	Enter the name that appears on the script canvas.

Required Settings

Item name	Required/Optional	Use of Variables	Description	Supplement
Destination	Required	Not Available	Select Global Resources. [Add...]: Add new global resource. [Edit...]: Global resource settings can be edited by [Edit Resource list].
Table Name	Required	Not Available	Specify the Salesforce table name.	Only tables which can be obtained by Metadata API are selectable.
PicklistFieldName	Required	Not Available	Specify the select list field name.

Option Settings

Property Action

Item name	Description	Supplement
Display Table Information...	You can check the table structure of the object you are operating. For more information on how to view the table structure, please refer to Display Table Information	Click [Load All Table Information....] if you would like to check the table structure of other objects.
Load All Table Information	Retrieve all possible table information After running, you can verify the retrieved information from [Table Information].

Large Data Processing Settings

Item name	Required/Optional	Use of Variables	Description	Supplement
Large Data Processing	Required	Not Available	Select a Large Data Processing Settings. [Use the setting in the script]:(default) Apply Large Data Processing Settings settings of script property to adapter. [Disable Large Data Processing]: Large Data Processing is not performed. [Enable Large Data Processing]: Large Data Processing is performed.

Comment

Item name	Required/Optional	Use of Variables	Description	Supplement
Comment	Optional	Not Available	You can write a short description of this adapter. The description will be reflected in the specifications.

Schema

Input Schema

None.

Output Schema

<?xml version="1.0" encoding="UTF-8" ?>
<picklistValues>
  <values>
    <fullName>
    <default>
    <color>
    <allowEmail>
    <closed>
    <converted>
    <cssExposed>
    <description>
    <forecastCategory>
    <highPriority>
    <probability>
    <reverseRole>
    <reviewed>
    <won>
    <controllingFieldValues>
      <fullName>
    </controllingFieldValues>
  </values>
  <values>
  :
  </values>
</picklistValues>

Element Name 1	Element Name 2	Element Name 3	Element Name 4	Description	Supplement
picklistValues	-	-	-	-
-	values	-	-	Repeats as many times as the number of obtained picklist values.
-	-	fullName	-	The picklist value is output.
-	-	default	-	The default (true,false) is output.	If the item does not have this field, following will output. API 29.0 or earlier Empty string API 34.0 or later false
-	-	color	-	The graph color is output.	The output format is in hexadecimal. Example: #FF6600 If the item does not have this field, a null string is output.
-	-	allowEmail	-	The email permission (true,false) is output.	This is applied in "Status" of "Quote" etc. If the item does not have this field, following will output. API 29.0 or earlier Empty string API 34.0 or later false
-	-	closed	-	The completion flag (true,false) is output.	This is applied in "Status" of "Quote," "ToDo(Task)," and "Phase(StageName)" of "Opportunity" etc. If the item does not have this field, following will output. API 29.0 or earlier Empty string API 34.0 or later false
-	-	converted	-	The transaction-has-already-started (true,false) is output.	This is applied in "Lead Status(Status)" of "Lead" etc. If the item does not have this field, following will output. API 29.0 or earlier Empty string API 34.0 or later false
-	-	cssExposed	-	THe usable-within-self-service (true,false) is output.	This is applied in "Reason" of "Case" etc. If the item does not have this field, following will output. API 29.0 or earlier Empty string API 34.0 or later false
-	-	description	-	The description is output.	This is applied in "Phase(StageName)" of "Opportunity" etc. If the item does not have this field, a null string is output.
-	-	forecastCategory	-	The sales forecast category is output.	This is applied in "Phase(StageName)" of "Opportunity" etc. If the item does not have this field, a null string is output.
-	-	highPriority	-	The high-priority (true,false) is output.	This is applied in "Priority" of "ToDo(Task)" etc. If the item does not have this field, following will output. API 29.0 or earlier Empty string API 34.0 or later false
-	-	probability	-	The probalitity is output.	This is applied in "Phase(StageName)" of "Opportunity" etc. If the item does not have this field, a null string is output.
-	-	reverseRole	-	The role from the counterpart's view is output.	This is applied in "Role from the counterpart's view(ReverseRole)" of "PartnerRole" etc. If the item does not have this field, a null string is output.
-	-	reviewed	-	The review completion flag (true,false) is output.	This is applied in "Status" of "Solution" etc. If the item does not have this field, following will output. API 29.0 or earlier Empty string API 34.0 or later false
-	-	won	-	The conclusion flag (true,false) is output.	This is applied in "Phase(StageName)" of "Opportunity" etc. If the item does not have this field, following will output. API 29.0 or earlier Empty string API 34.0 or later false
-	-	controllingFieldValues	-	Repeats as many times as the number of obtained select list control item values.	If the controlling item is not set, the repetition will be 0 times. However, one empty element node will be extracted when the following API version is used. <controllingFieldValues><fullName/></controllingFieldValues> API 23.0 API 26.0 <controllingFieldValues> <fullName/> </controllingFieldValues>
-	-	-	fullName	The select list controlling field value is output.

Reading Schema by Mapper

The schema will be read automatically.

Large Data Processing

Large Data Processing is supported.

Usage on PSP Script

Cannot be used on PSP Script.

Available Component variables

Component Variable Name	Description	Supplement
count	The number of data that was successfully read is stored.	The default value is null.
controlling_field	The API name of controlling item is stored.	The default value is null.
server_url	The end point URL after Login is stored.	The default value is null.
session_id	The session Id is stored.	The default value is null.
message_category	In the case that an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	In the case that an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	In the case that an error occurs, the importance of the message code corresponding to the error is stored.	The default value is null.
operation_api_exception_code	The ExceptionCode of the occured error, in a case of API error, is stored.	The default value is null. For any error other than an API Error, the value is not stored. The content to be stored may change according to the version of DataSpider Servista.
operation_error_message	If an error occurs, the error message of the occured error is stored.	The default value is null. The content to be stored may change according to the version of DataSpider Servista.
operation_error_trace	When an error occurs, the trace information of the occured error is stored.	The default value is null. The content to be stored may change according to the version of DataSpider Servista.

Display Table Information

This display shows the available operations on Salesforce tables as well as field properties of the tables.
Also, the field information can be printed out.

Number in the Image	Name	Description
(1)	Table Name	Select the table whose structure to be shown.
(2)	Table Information	Display the available operations on the selected table.
(3)	Length	Display the Number of Digit of item
(4)	External ID	Display whether or not the object item is set as an external ID.
(5)	Createble	Display whether or not it can be set a value when adding data.
(6)	Updatable	Display whether or not it can be set a value when updating data.
(7)	Nullable	Display whether or not it can be set NULL when adding or updating data.
(8)	Default value	Display whether or not Salesforce automatically set a default value when adding data.
(9)	Reference To	Display the referring object name if the item is in reference relationship or master-servant relationship.

Specification Limits

In order to perform data reading and writing with this adapter, API's of Salesforce organization must be published.

All permissions for reading/writing data and other operations, as well as data access control, depend upon the profile, shared rule setting and API specifications in Salesforce.

The objects and fields that can be used may differ by API version. For details, please refer to the Salesforce documentation.

Main exceptions

Exception Name	Reason	Resolution
ResourceNotFoundException Resource Definition is Not Found. Name:[]	[Destination] is not specified.	Specify [Destination].
ResourceNotFoundException Resource Definition is Not Found. Name:[<Global Resource Name>]	The resource definition selected in [Destination] cannot be found.	Verify the global resource specified in [Destination]
java.net.UnknownHostException	This exception occurs when the PROXY server specified in the global resource cannot be found.	Verify the condition of the PROXY server. Or verify [Proxy Host] of the global resource specified in the [Destination].
java.net.SocketTimeoutException connect timed out	A time-out has occurred while connecting to Salesforce.	Verify the network condition and Salesforce server condition. Or check [Connection timeout(sec)] of the global resource specified in the [Destination].
java.net.SocketTimeoutException Read timed out	A time-out has occurred while waiting for a responce from the server after connecting to Salesforce.	Verify the network condition and Salesforce server condition. Or check [Timeout(sec)] of the global resource specified in the [Destination].
jp.co.headsol.salesforce.adapter.exception.SalesforceAdapterIllegalArgumentException	Invalid value is set for the property of Salesforce adapter.	Check the error message, and verify the settings.
com.sforce.soap.partner.fault.LoginFault	Login to Salesforce has failed.	Check the ExceptionCode or error message, and refer to the information about this type of error in Salesforce-related documents etc.
com.sforce.soap.partner.fault.InvalidFieldFault	An item included in the executed SOQL is invalid.	Check the ExceptionCode or error message, and refer to the information about this type of error in Salesforce-related documents etc.
com.sforce.soap.partner.fault.UnexpectedErrorFault	An unexpected error has occured while processing to Salesforce.	Check the ExceptionCode or error message, and refer to the information about this type of error in Salesforce-related documents etc.