Read(CustomLabel)

Operation Name

Read(CustomLabel)

Function Overview

This operation is to read the custom labels.
Use readMetadata() from CRUD-Based calls and conduct simultaneous processing.
The input data will be divided into ten records per processing due to call restrictions.
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.

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 Supplement
Destination Required Not Available Select Global Resources.
  • [Add...]:
    Add new global resource.
  • [Edit...]:
    Global resource settings can be edited by [Edit Resource list].
  • A global resource on API 34.0 or later versions can be specified.
Option Settings
Item name Required/Optional Use of Variables Description Supplement
Language Required Available Enter or select the language.

The master label will be taken in the case of non-selection. Fully supported languages only appears in the list.
[https://help.salesforce.com/apex/HTViewHelpDoc?id=faq_getstart_what_languages_does.htm]
  • []:(default)
  • [Japanese]:
  • [English]:
  • [Chinese (Simplified)]:
  • [Chinese (Traditional)]:
  • [Danish]:
  • [Dutch]:
  • [Finnish]:
  • [French]:
  • [German]:
  • [Italian]:
  • [Korean]:
  • [Norwegian]:
  • [Portuguese (Brazil)]:
  • [Russian]:
  • [Spanish]:
  • [Spanish (Mexico)]:
  • [Swedish]:
  • [Thai]:
  • If you want to enter directly, enter the language code.
    e.g. "en_US"
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

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

Element Name Column Name Description Supplement
row
-
Repeats as many times as the number of custom labels whose corresponding results to be obtained.  
column customLabelName Input a name of the custom label.  

Output Schema

<?xml version="1.0" encoding="UTF-8" ?>
<table>
  <row>
    <column>fullName</column>
    <column>categories</column>
    <column>language</column>
    <column>protected</column>
    <column>shortDescription</column>
    <column>value</column>
  </row>
  <row>
  :
  </row>
</table>

Element Name Column Name Description Supplement
row
-
Repeats as many times as the number of results  
-
fullName The name of custom label.  
-
categories A comma-separated list of categories for the label.  
-
language The language of the translated custom label.  
-
protected Indicates whether this component is protected (true) or not (false).  
-
shortDescription An easily recognizable term to identify this custom label.  
-
value The translated custom label.  

Reading Schema by Mapper

The schema will be read automatically.

Large Data Processing

Large Data Processing is supported.

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 data that was successfully read 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.

Specification Limits

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