Update(PicklistValue)

Operation Name

Function Overview

This operation performs a Update operation to picklist values, based on input data.
Call type will differ be depending on the type of update.

[Rename]:
Use readMetadata() from CRUD-Based calls and conduct simultaneous processing.
Input data record will be sent one by one.
[Attribute value]:
Use readMetadata() from CRUD-Based calls and conduct simultaneous processing.
Send all records in one call, regardless of the number of input data.
An exception will occur if the call fails.

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 Table Model 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.
Input Data	Required	Not Available	Select the component on the script canvas.

Required Settings

Item name	Required/Optional	Use of Variables	Description
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.
PicklistFieldName	Required	Not Available	Specify the select list field name.
Update type	Required	Not Available	Specify the type of update. [Rename]: Rename the picklist value. [Attribute value]: Update the attribute value of the picklist value.

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

The schema depends on the API version of the global resource selected in [Destination] and the setting of [Update type].

[Update type]:Rename

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>currentName</column>
    <column>fullName</column>
  </row>
  <row>
  :
  </row>
</table>

Element Name	Column Name	Description	Supplement
row	-	Repeats as many times as the number of picklist values to be updated.
column	currentName	Gives the API name of the current name of picklist value.	Can not be omitted.
column	fullName	Gives the API name of the new name of picklist value.	Can not be omitted.

API 34.0 [Update type]:Attribute value

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

Element Name	Column Name	Description	Supplement
row	-	Repeats as many times as the number of picklist values to be updated.
column	fullName	Gives the API name of the picklist value.	Cannot be omitted.
	default	Gives the default (true,false).	Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	color	Gives the color of the graph.	Gives in hexadecimal form. Example: #FF6600 Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	allowEmail	Gives the email permission (true,false).	Applied for the "Status" of the "Quote", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	closed	Gives the completion flag (true,false).	Applied for "Status" of "Case" and "ToDo(Task)", "Stage" of "Opportunity", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	converted	Gives the already started transaction (true,false).	Applied for the "Lead Status" of the "Lead", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	cssExposed	Gives the usable within self service (true,false).	Applied for the "Reason" of the "Case", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	description	Gives the description.	Applied for the "Stage" of the "Opportunity", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	forecastCategory	Gives the sales forecast category. Omitted Pipeline BesCase Forecast Closed	Applied for the "Stage" of the "Opportunity", etc. Please give a value only for items bearing this field. Case sensitive. Giving a category that does not exist will lead to an update failure. An update will take place with the default value if omitted. The existing value will not be retained.
	highPriority	Gives the high priority (true,false).	Applied for the "Priority" of the "ToDo(Task)", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	probability	Gives the probability.	Applied for the "Stage" of the "Opportunity", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	reverseRole	Gives the role from the counterpart's view.	Applied for the "ReverseRole" of the "PartnerRole", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	reviewed	Gives the already reviewed flag (true,false).	Applied for the "Status" of the "Solution", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	won	Gives the won flag (true,false).	Applied for the "Stage" of the "Opportunity", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.

API 53.0 or later [Update type]:Attribute value

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

Element Name	Column Name	Description	Supplement
row	-	Repeats as many times as the number of picklist values to be updated.
column	fullName	Gives the API name of the picklist value.	Cannot be omitted.
	label	Gives the label of the picklist value.	If omitted, the existing value is retained.
	default	Gives the default (true,false).	Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	color	Gives the color of the graph.	Gives in hexadecimal form. Example: #FF6600 Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	allowEmail	Gives the email permission (true,false).	Applied for the "Status" of the "Quote", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	closed	Gives the completion flag (true,false).	Applied for "Status" of "Case" and "ToDo(Task)", "Stage" of "Opportunity", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	converted	Gives the already started transaction (true,false).	Applied for the "Lead Status" of the "Lead", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	cssExposed	Gives the usable within self service (true,false).	Applied for the "Reason" of the "Case", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	description	Gives the description.	Applied for the "Stage" of the "Opportunity", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	forecastCategory	Gives the sales forecast category. Omitted Pipeline BesCase Forecast Closed	Applied for the "Stage" of the "Opportunity", etc. Please give a value only for items bearing this field. Case sensitive. Giving a category that does not exist will lead to an update failure. An update will take place with the default value if omitted. The existing value will not be retained.
	highPriority	Gives the high priority (true,false).	Applied for the "Priority" of the "ToDo(Task)", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	probability	Gives the probability.	Applied for the "Stage" of the "Opportunity", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	reverseRole	Gives the role from the counterpart's view.	Applied for the "ReverseRole" of the "PartnerRole", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	reviewed	Gives the already reviewed flag (true,false).	Applied for the "Status" of the "Solution", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.
	won	Gives the won flag (true,false).	Applied for the "Stage" of the "Opportunity", etc. Please give a value only for items bearing this field. An update will take place with the default value if omitted. The existing value will not be retained.

Output Schema

The schema depends on the setting of [Update type].

[Update type]:Rename

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>currentName</column>
    <column>fullName</column>
    <column>RESULT_inputRowNumber</column>
    <column>RESULT_success</column>
    <column>RESULT_fullName</column>
    <column>RESULT_message</column>
    <column>RESULT_statusCode</column>
  </row>
  <row>
  :
  </row>
</table>

Element Name	Column Name	Description	Supplement
row	-	Repeats as many times as the number of data given to the input schema.
column	currentName	The API name of current name of picklist value, given to the input schema, is output.
	fullName	The API name of new name of picklist value, given to the input schema, is output.
	RESULT_inputRowNumber	The number, based on the position of the node in the data which was given to the input schema, is output.
	RESULT_success	The success flag (true,false) of the processing results(SaveResult) is output.	In the below mentioned cases, the Salesforce adapter will output the status code and message. In this case, null will be output for [RESULT_ASYNC_done] and [RESULT_ASYNC_id], and [Error] will be output for [RESULT_ASYNC_state]. SALESFORCE_ADAPTER_ILLEGAL_DATA_TYPE This is set when the defined item's attribute and the input data type do not match. For example, when a non-numerical character row is entered to the [probability]. SALESFORCE_ADAPTER_REQUIRED_FIELD This is set when a value is not given to a required schema. For example, when null is entered to the [fullName]. SALESFORCE_ADAPTER_ENUMERATED_TYPE_NOT_MATCH This is set when a value, given to an enumeration type schema, is invalid. For example, when a non-existing category is entered to the [forecastCategory].
	RESULT_fullName	The FullName of the processing results(SaveResult) is output.
	RESULT_message	The Message of the processing results(SaveResult) is output.
	RESULT_statusCode	The StatusCode of the processing results(SaveResult) is output.

[Update type]:Attribute value

Because the processing of update attribute value takes place as a whole, there will not be input data unit results.

Reading Schema by Mapper

The schema will be read automatically.

Please refer to Editing Schema for detials.

Large Data Processing

Performs Large Data Processing.

Transaction

Transaction is not supported.

Usage on PSP Script

Cannot be used on PSP Script.

Available Component variables

Component Variable Name	Description	Supplement
read_count	The number of passed data is stored.	The default value is null.
update_count	The number of data that was successful in the update processing is stored.	The default value is null.
error_count	The number of data that was unsuccessful in the update processing 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.

If you change a picklist that uses a global value set, other picklists that use that global value set will also reflect the change.

Inactive picklist values cannot be changed.

Cannot be changed to the same API name as an inactive picklist value.

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.