Bulk Write Data(Delete) (deprecated)

Operation Name

Bulk Write Data(Delete)

Function Overview

This operation performs a Delete 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.

In the Delete operation, the Salesforce ID is set as the key item when deleting data.

 

= 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.

 

Schema definition

Required

-

"ID" has been selected as the CSV data's header row item, to be registered with the batch. Editing cannot be done.

 

Schema definition/Label

Required

Not Available

Display the input schema item's label name.

 

Schema definition/API

Required

Not Available

Display the input schema item's API name.

 

Schema definition/Type

Required

Not Available

Display the input schema item's data type.

 

Option Settings

Item name

Required/Optional

Use of Variables

Description

Remarks

Hard Delete(Physical Delete)

Required

Not Available

Select whether or not to perform a hard deletion (HardDelete).

Selected

Operation type is specified as HardDelete and executed.

Not selected

(Default)

Operation type is specified as Delete and executed.

  • Can be specified on API 23.0 or later versions.

Note

If this is selected, deleted records are not saved in the recycle bin. They will be immediately deleted instead.

The authority of this "Bulk API Hard Delete" is by default invalid and must be validated by the system administrator.

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.

 

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

(Hereafter shown as "Label/API")

 

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

Element Name

Column Name

Description

Remarks

row

-

Repeats as many time as the number of input data.

 

column

ID/id

Gives the Salesforce ID.

 

Output Schema

The batch results information will be granted to the input schema column.

(Hereafter shown as "Label/API")

 

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>ID/Id</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.

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

check

check

check