Data Source - eSales Manager
  • 27 Dec 2022
  • Dark
    Light
  • PDF

Data Source - eSales Manager

  • Dark
    Light
  • PDF

Article Summary

Note

This is a machine-translated version of the original Japanese article.
Please understand that some of the information contained on this page may be inaccurate.

Overview

This is a help page for setting up data transfer from the eSales Manager.

Settings

STEP 1: General Settings

Field NameRequiredDefault ValueDescription
eSales Manager Connection InformationYes-From the connection information registered in advance, select the one that has the necessary permissions for this transfer setting.
Search queriesYes-Set the query (SearchCondition) for search according to the specifications of the official documentation.

SearchCondition (Search Query) Example: Searching and Importing Business Card Entities

The following search queries

  • The target of extraction and search is business card (person)
  • Registration date is before 2022-03-17
  • The items to be extracted are
    • 902: Customer code
    • 928: Business card code
    • 903: Person Name
    • 932: Registration date
    • 934: Date of change

This is an example of a search condition.

{
  "searchCondition": {
    "targetObjectName": "person",
    "items": [
      {
        "columnCode" : 932,
        "operator" : "<",
        "date" : "2022-03-17"
      }
    ],
    "notExists":true,
    "relatedObjectConditions":[]
  },
  "columnCodes":[
    902,928,903,932,934
  ]
}
  • searchCondition
    • targetObjectName(string)
      • The name of the entity to search for.
    • items(array of SearchConditionItems)
      • A list that represents the search expressions. If you enter multiple conditions, it will be an AND condition.
        Please check the SearchConditionItem below for the description method.
    • notExists(boolean)
      • true: Matches a condition if there is a matching related entity in relatedObjectConditions.
      • false: Considered "condition" if there is no matching related entity in relatedObjectConditions.
    • relatedObjectConditions(SearchCondition)
      • A list that represents the search criteria for related entities. If more than one is specified, they will be combined under the AND condition. The filling method is the same as that of SearchCondition.
  • columnCodes: (array)
    • Please describe the item code of the entity to be extracted.
    • You can check the item code of the business card (person) from the REST API reference .

SearchConditionItem (Search Condition Expression) Example

{
  "columnCode" : 105 ,
  "operator" : "forward " ,
  "text" : "営業"
},
{
  "columnCode" : 104 ,
  "operator" : ">=" ,
  "date" : "2020-04-01"
},
{
  "columnCode" : 102 ,
  "operator" : "=" ,
  "num" : 10001
},
{
  "columnCode" : 144 ,
  "operator" : "=" ,
  "checkBox" : [true, false, false]
},
{
  "columnCode" : 10001 ,
  "operator" : "=" ,
  "decimal" : 1.23
},
{
  "columnCode" : 10002 ,
  "operator" : "=" ,
  "null" : true
},
{
  "columnCode" : 10003 ,
  "operator" : "=" ,
  "notNull" : true
}
  • columnCode(numeric)
    • The item to search for.
  • operator(string)
    • The operator for the search condition.
  • text(string)
    • For Text/TextArea fields, specify a value for this attribute.
  • date(date or datetime)
    • For Date/Datetime items, specify a value for this attribute.
      * In the current eSM REST API, the specified date/date and time are interpreted in UTC time.
      Please note that this is not the time zone specified on the eSM management screen.
  • num(numeric)
    • For integer/select items, specify a value for this attribute.
  • checkBox(boolean)
    • For array checkbox items, specify a value for this attribute.
  • decimal(numeric)
    • For decimal items, specify a value for this attribute.
  • null(boolean)
    • By specifying true, you can perform a NULL search on the specified entity. * When performing a NULL search, specify "=" in the operator's conditional expression.
  • notNull(boolean)
    • By specifying true, you can perform a NOT NULL search on the specified entity.
      * When performing a NOT NULL search, specify "=" in the operator's conditional expression.

Was this article helpful?