Data Source - e-Sales Manager

Prev Next

summary

Help Page for ETL Configuration of Data Setting from e-Sales Manager.

Setting items

STEP1 Basic settings

item name indispensable default value Contents
e-Sales Manager Connection Configuration Yes - Select the previously registered Connection Configuration that has the necessary permissions for this ETL Configuration.
search query Yes - Set the query (SearchCondition) for the search according to the specifications in the official documentation.

SearchCondition (search query) entry example:. Search and extraction of business card entities

The following search queries

  • Extraction and search targets are business cards (PERSON)
  • Registered on or before 2022-03-17
  • The items to be extracted are
    • 902: Customer Code
    • 928: business-card code
    • 903: Parson Name
    • 932: Registration Date
    • 934: Date of change

This is an example of a search condition called

{
  "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 be searched.
    • items (array of SearchConditionItem)
      • A list of search condition expressions. If multiple conditions are listed, they will be AND conditions.
        Please refer to SearchConditionItem below for the description method.
    • notExists (boolean)
      • true : A condition is considered "met" if there is a related entity matching the relatedObjectConditions.
      • false : If there is no related entity matching the relatedObjectConditions, it is considered to "match the condition".
    • relatedObjectConditions (SearchCondition)
      • A list of search criteria for related entities. If more than one is specified, they are combined under AND conditions. The entry method is the same as for SearchCondition.
  • columnCodes: (Array)
    • Please provide the item code of the entity to be extracted.
    • The item code for a business card (person) can be found in the REST API Reference.

Example of SearchConditionItem (search condition expression) entry

{
  "columnCode" : 105 ,
  "operator" : "forward " ,
  "text" : "Sales."
},
{
  "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)
    • Items to be searched.
  • operator (string)
    • Operator of the search condition.
  • text (string)
    • For text type/text area type items, specify a value for this attribute.
  • date (date or date and time)
    • For date/time type items, specify a value for this attribute.
      The eSM REST API at this time interprets the specified date/time in UTC time.
      Note that this is not the time zone specified on the eSM administration page.
  • num (number)
    • For integer/select type items, specify a value for this attribute.
  • checkBox (boolean value)
    • array (programming, programing) For checkbox type items, specify a value for this attribute.
  • decimal (numeric)
    • For decimal type items, specify a value for this attribute.
  • null (boolean value)
    • By specifying true, a null search can be performed for the specified entity. *When performing a null search, specify "=" in the operator conditional expression.
  • notNull (boolean)
    • By specifying true, a NOT NULL search can be performed on the specified entity.
      When performing a NOT NULL search, specify "=" in the operator conditional expression.