Bulk Write Data(Upsert) (deprecated)

Operation Name

Bulk Write Data(Upsert)

Function Overview

This operation performs a Upsert operation, based on input data, using Bulk API.

Job Creation, batch creation, batch result obtainment, and job closing will be done subsequently as one operation.

The Upsert processing checks the existence of data corresponding to the external ID(*) of Salesforce, and update the data if it exists, or add data if not. Also, the data update by specifying ID can be performed. (*) External ID needs to be defined beforehand, using the customization feature of Salesforce.

= Remarks =

For details about the API specification used in this operation, refer to the API documentation of the selected version in the connection resource from the following link destination page.

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

Data Model

The data model of this component is table model type.

Properties

= Remarks =

For details on use of variables, refer to Variables.

Basic Settings

Item name	Required/Optional	Use of Variables	Description	Remarks
Name	Required	Not Available	Enter a name that is used on the script canvas.
Input Data	Required	Not Available	Select a component on the script canvas.

Required Settings

Item name	Required/Optional	Use of Variables	Description	Remarks
Destination	Required	Not Available	Select a connection resource. Add A new connection resource can be added. Edit list Connection resource settings can be edited in > HULFT INTEGRATE > Connections.
Table Name	Required	Not Available	Select the name of a table in Salesforce.
Sort	Required	Not Available	Sorts the list of items by the selected method. Check Ascending order Check Descending order Label Ascending order Label Descending order API Ascending order (Default) API Descending order Type Ascending order Type Descending order External ID Ascending order External ID Descending order Insertable Ascending order Insertable Descending order Updatable Ascending order Updatable Descending order Null allow Ascending order Null allow Descending order
Item list	Required	-	Displays the item list of the table on Salesforce selected in Table Name.	Only the items that can be added are displayed.
Item list/Check	Optional	Not Available	Select the checkboxes for the columns that you want to select as Schema definition.
Item list/Label	Required	Not Available	Displays the label name of the column of the table selected in Table Name.
Item list/API	Required	Not Available	Displays the API name of the column of the table selected in Table Name.
Item list/Type	Required	Not Available	Displays the data type of the column of the table selected in Table Name.
Item list/External ID	-	-	Displays the external ID setting. Selected An external ID exists. Not selected An external ID does not exist.
Item list/Insertable	-	-	Displays the settings for item insertion. Selected Items can be inserted. Not selected Items cannot be inserted.
Item list/Updatable	-	-	Displays the settings for item updates. Selected Items can be updated. Not selected Items cannot be updated.
Item list/Null allow	-	-	Displays whether to allow setting of a null value. Selected Allows setting of a null value. Not selected Does not allow setting of a null value.
Schema definition	Required	-	Displays a list of columns for the table selected as the schema definition.
Schema definition/Update key	Required	Not Available	Displays the update key.
Schema definition/Label	Required	Not Available	Displays the label names of the columns for the table selected as the schema definition.
Schema definition/API	Required	Not Available	Displays the API names of the columns for the table selected as the schema definition.
Schema definition/Type	Required	Not Available	Displays the data types of the columns for the table selected as the schema definition.
Schema definition/External ID	-	-	Displays the external ID setting. Selected An external ID exists. Not selected An external ID does not exist.
Schema definition/Insertable	-	-	Displays the settings for item insertion. Selected Items can be inserted. Not selected Items cannot be inserted.
Schema definition/Updatable	-	-	Displays the settings for item updates. Selected Items can be updated. Not selected Items cannot be updated.
Schema definition/Null allow	-	-	Displays whether to allow setting of a null value. Selected Allows setting of a null value. Not selected Does not allow setting of a null value.
Schema definition(External ID)	Optional	-	In the case that relationship items exist in the Schema Definition, set items subject to updating by external key.	By selecting the external key item of the relation object, data passing with relations can be performed. Only when a connection resource for API 43.0 or later is selected, you can update with the Polymorphic Fields. Specify polymorphic items in Item API for relations. For more information on Polymorphic Fields, see the Salesforce documentation.
Schema definition(External ID)/Source item API	Required	Not Available	Display the API Name of the row of the relation item of the table specified in Table Name.
Schema definition(External ID)/Relationship name	Required	Not Available	Display the relationship name of the row of the relation item of the table specified in Table Name.
Schema definition(External ID)/Object API	Optional	Not Available	Select the API Name of the relation counterpart object in the relation item column of the table specified in Table Name.
Schema definition(External ID)/Item API for relations	Optional	Not Available	Select the external key item of the relation counterpart object in the relation item column of the table specified in Table Name.	If omitted, the ID of the relevant record of the relation counterpart object will be passed.

Property actions

Item name	Description	Remarks
Select	Set items selected in the List item/Check column in Schema definition.

Option Settings

Item name	Required/Optional	Use of Variables	Description	Remarks
Column name type	Required	Not Available	Select the display type of the column name, for displaying the schema in mapping. Label The label name (item name) defined in Salesforce is displayed. API (Default) The API reference name defined in Salesforce is displayed.
Replace Null/empty characters with "#N/A"	Required	Not Available	In the case that the input data is null or null string, select whether or not to replace it with the string "#N/A." Selected (Default) Replace the string. Not selected Do not replace the string.	Note Due to the API specification, "#N/A" needs to be specified if data is updated with null.
Batch size	Required	Available	Input the upper limit of the number of records that can be registered to one batch.	The default value is "2000." You can set the value between 1 and 10000. An error message will be shown if a value outside this range is set. Note As the specification of this connector, in a case in which 100,000 cases of data is written, and the batch size is set as 2,000, 50 batches will be created. However, in cases where 1 batch exceeds the API limit of 10 MB, the batch will be created with a size smaller than the specified batch size.
Concurrency mode	Required	Not Available	Select the job's concurrency mode. Parallel (Default) The job is created with the parallel processing mode. Serial The job is created with the sequential processing mode.	Note If parallel processing is performed, database conflicts can occur. If there is a severe database conflict, reads may fail. If the sequential processing mode is used, the batches will be reliably processed one after another. However, with this option, the reading processing time may increase greatly.
Obtain the batch results after waiting until the task is completed	Required	Not Available	Select whether or not to monitor the situation until the created batches are finished, and to obtain batch results. Selected (Default) Obtain batch results. The obtained batch results can be passed onto the subsequent processing from the output schema. Not selected Do not obtain batch results.	If this is selected, the item specified as the schema definition, as well as the result information item, can be passed onto the subsequenct proccessing as Table Model type data. Please refer to "Schemas" for information to be obtained.
Waiting Time before the monitoring (sec) starts	Optional	Available	Input the waiting time, until the beginning of the batch state monitoring, in seconds.	The default value is "3". Will be valid only when Obtain the batch results after waiting until the task is completed is checked. A value of 3 or greater and 10800 or smaller can be specified. If a value is specified outside of this range, an error will occur.
Batch monitoring intervals (sec)	Optional	Available	Input the intervals, which determine whether or not the batch results have been obtained and the process has completed, in seconds.	The default value is "10". Will be valid only when Obtain the batch results after waiting until the task is completed is checked. A value of 10 or greater and 600 or smaller can be specified. If a value is specified outside of this range, an error will occur.
Max. monitoring time(sec)	Required	Not Available	Input the maximum monitoring time for the batch state in seconds.	The default value is "14400". Will be valid only when Obtain the batch results after waiting until the task is completed is checked. A value of 1 or greater can be specified. If a value is specified outside of this range, an error will occur.

Comment

Item name	Required/Optional	Use of Variables	Description	Remarks
Comment	Optional	Not Available	You can write a short description of this connector.

Schemas

Input Schema

The number of columns varies depending on the Schema definition settings.

= Remarks =

For schema structure, refer to Table model type .

Output schema

Information regarding the results of batch processing will appear in the column, set in the Schema definition.

(Hereafter shown as "Label/API")

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>Label/API set in the Schema definition</column>
       :
    <column>ResultInformation_InputRowNumber/RESULT_inputRowNumber</column>
    <column>ResultInformation_Batch_ID/RESULT_BATCH_id</column>
    <column>ResultInformation_Batch_State/RESULT_BATCH_state</column>
    <column>ResultInformation_Batch_StateMessage/RESULT_BATCH_stateMessage</column>
    <column>ResultInformation_Record_ID/RESULT_ROW_id</column>
    <column>ResultInformation_Record_SuccessFlag/RESULT_ROW_success</column>
    <column>ResultInformation_Record_CreationFlag/RESULT_ROW_created</column>
    <column>ResultInformation_Record_ErrorMessage/RESULT_ROW_error</column>
  </row>
  <row>
    :
  </row>
</table>

Element Name	Column Name(Label/API)	Description	Remarks
row	-	Repeats as many times as the number of data given to the input schema.	In the case where Obtain the batch results after waiting until the task is completed is not checked, the result will be 0 times.
column	ResultInformation_InputRowNumber/RESULT_inputRowNumber	A number will be output, based on the position of the node in the data that was given to the input schema.
	ResultInformation_Batch_ID/RESULT_BATCH_id	The IDs of the batches that processed the records will be output.
	ResultInformation_Batch_State/RESULT_BATCH_state	The state of the batches that processed the records will be output. Completed The process has completed. Failed The process was not successful. Please verify the ResultInformation_Batch_StateMessage/RESULT_BATCH_stateMessage.	In the Completed case as well, the results for each record will vary. Please verify the "ResultInformation_Record."
	ResultInformation_Batch_StateMessage/RESULT_BATCH_stateMessage	The state message of the batches that processed the records will be output.
	ResultInformation_Record_ID/RESULT_ROW_id	The record ID is output.
	ResultInformation_Record_SuccessFlag/RESULT_ROW_success	The record's success flag is output. true The process was successful. false The process was unsuccessful. Please verify the ResultInformation_Record_ErrorMessage/RESULT_ROW_error.	In the case where the ResultInformation_Batch_State/RESULT_BATCH_state is not Completed, the outcome will be false.
	ResultInformation_Record_CreationFlag/RESULT_ROW_created	The record's new creation flag is output. true A record was newly created. false A record was not newly created.
	ResultInformation_Record_ErrorMessage/RESULT_ROW_error	The record's error message is output. In the case where the batch results cannot be obtained, the state message of the batches that processed the records will be output.

Loading schema in Mapper

The schema is loaded automatically.

= Remarks =

For details, refer to Edit Schema.

Mass data processing

Mass data processing isn't supported.

Transaction

Transaction isn't supported.

Parallel Stream Processing

PSP isn't supported.

Available Component variables

Component Variable Name	Description	Remarks
job_id	The IDs of the jobs created are stored.	The default value is null.
read_count	The number of input data is stored.	The default value is null.
created_batch_count	The number of batches created is stored.	The default value is null.
get_result_success_count	The number of data that was successful in the processing is stored.	The default value is null. If Obtain the batch results after waiting until the task is completed is not checked, a value will not be stored.
get_result_error_count	The number of data that was unsuccessful in the processing is stored.	The default value is null. If Obtain the batch results after waiting until the task is completed is not checked, a value will not be stored.
get_result_updated_count	The number of data that was successful in the updating processing is stored.	The default value is null. If Obtain the batch results after waiting until the task is completed is not checked, a value will not be stored.
get_result_error_count	The number of data that was unsuccessful in the processing is stored.	The default value is null. If Obtain the batch results after waiting until the task is completed is not checked, a value will not be stored.
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	When an error occurs, the category of the message code corresponding to the error is stored.	The default value is null.
message_code	When an error occurs, the code of the message code corresponding to the error is stored.	The default value is null.
message_level	When an error occurs, the severity 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.
operation_error_message	When an error occurs, the error message is stored.	The default value is null.
operation_error_trace	When an error occurs, the trace information for the error is stored.	The default value is null.

Message codes, exception messages, and limitations

Connector	Message code	Error message	Limitations
Messages and limitations of the Salesforce(deprecated) connector