Get Server Info

Operation Name

Get Server Info

Function Overview

This operation is to get the server timestamp, using the getServerTimestamp() call of the SOAP API.
Furthermore, get the limit information about API calls for the organization from a response SOAP header.

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 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].
  • A global resource on API 29.0 or later versions can be specified.
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" ?>
<Result>
  <GetServerTimestampResult>
    <timestamp/>
  </GetServerTimestampResult>
  <LimitInfo>
    <limit_info_current/>
    <limit_info_limit/>
    <limit_info_type/>
  </LimitInfo>
</Result>
Element Name 1 Element Name 2 Element Name 3 Description Supplement
Result
-
-
-
 
-
GetServerTimestampResult
-
The "getServerTimestampResult" properties is output.  
-
-
timestamp The server timestamp is output.
  • Date format is "yyyy-MM-dd'T'HH:mm:ss.SSSz".
    e.g.: 2014-01-01T12:00:00.000+0900
-
LimitInfo
-
The "LimitInfoHeader" properties is output.
  • Retrieve only the limit information of "API REQUESTS" type.
-
-
limit_info_current The number of calls for the specified limit type that have already been used in the organization.  
-
-
limit_info_limit The organization's limit for the specified limit type.  
-
-
limit_info_type The type of limit information specified in the header.  

Reading Schema by Mapper

The schema will be read automatically.

Large Data Processing

Large Data Processing is not supported.

Usage on PSP Script

Cannot be used on PSP Script.

Available Component variables

Component Variable Name Description Supplement
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.
jp.co.headsol.salesforce.adapter.exception.SalesforceAdapterIllegalArgumentException
The login function by session ID is not activated. Please verify the global resource settings.
Invalid value is set for the property of Salesforce adapter. Please verify the [Login Control in Execution] setting in the global resource specified in [Destination].
jp.co.headsol.salesforce.adapter.exception.SalesforceAdapterIllegalArgumentException
The URL [<Server URL>] specified as server URL does not satisfy the validity of Salesforce server URL.
Invalid value is set for the property of Salesforce adapter. Check the URL specified in [Server URL].
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.