Acumatica

實體、作業和動作

所有整合連接器都會為所連應用程式的物件提供抽象層。您只能透過這個抽象化程序存取應用程式的物件。抽象化會以實體、作業和動作的形式呈現。

• 實體： 實體可以視為已連結應用程式或服務中的物件，或是屬性集合。實體的定義因連接器而異。舉例來說，在資料庫連接器中，資料表是實體；在檔案伺服器連接器中，資料夾是實體；在訊息系統連接器中，佇列是實體。

  不過，連接器可能不支援或沒有任何實體，在這種情況下，Entities 清單會是空白。

• 作業： 作業是指您可以在實體上執行的活動。您可以對實體執行下列任一操作：
  • 列出
  • 取得
  • 建立
  • 更新
  • 刪除

  從可用清單中選取實體，系統會產生該實體可用的作業清單。如需作業的詳細說明，請參閱 Connectors 工作的實體作業。 不過，如果連接器不支援任何實體作業，系統就不會在 Operations 清單中列出這些不支援的作業。

• 動作： 動作是透過連接器介面提供給整合的第一類函式。動作可讓您變更一或多個實體，且因連接器而異。一般來說，動作會有一些輸入參數和輸出參數。不過，連接器可能不支援任何動作，此時 Actions 清單會是空白。

動作

本節列出連接器支援的操作。如要瞭解如何設定動作，請參閱「動作範例」。

ExecuteAction 動作

這項動作可讓您執行動作。

ExecuteAction 動作的輸入參數

ExecuteAction 動作的輸出參數

這項動作會傳回 ExecuteAction 的確認訊息。

如要瞭解如何設定 ExecuteAction 動作，請參閱範例。

動作範例

範例 - 執行動作

這項動作會執行指定動作。

1. 在「Configure connector task」對話方塊中，按一下 Actions。
2. 選取 ExecuteAction 動作，然後按一下「完成」。
3. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
   "ActionName": "PrintSalesOrder",   
   "TopLevelEntity": "SalesOrder"
   "EntityRecord": "{
   "Type": {
     "value": "IN"
   },
   "OrderNbr": {
     "value": "000007"
   },
   "CustomerID": {
     "value": "CANDYY"
   },
   "LocationID": {
     "value": "MAIN"
   }}}"

如果動作成功，ExecuteAction 工作項目的 connectorOutputPayload 回應參數會包含類似下列內容的值：

[{
"Status": "Success",   
"AffectedRecords": "1"
}] 

實體作業範例

本節說明如何使用這個連接器執行部分實體作業。

範例 - 列出所有顧客

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Customer。
3. 選取「List」作業，然後按一下「完成」。
4. (選用) 在「連結器」工作的「工作輸入」部分，您可以指定篩選子句，篩選結果集。請一律在單引號 (') 內指定篩選子句值。

範例 - 列出所有日記帳交易

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 JournalTransaction。
3. 選取「List」作業，然後按一下「完成」。

範例 - 列出所有銷售訂單

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 SalesOrder。
3. 選取「List」作業，然後按一下「完成」。

範例 - 取得訂購單詳細資料

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 PurchaseOrder。
3. 選取「Get」作業，然後按一下「完成」。
4. 設定實體 ID，取得訂購單詳細資料。如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 000001，並選擇 EntityId 做為本機變數。

範例 - 取得銷售人員詳細資料

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Salesperson。
3. 選取「Get」作業，然後按一下「完成」。
4. 設定實體 ID，即可取得銷售人員詳細資料。如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 SP0001，並選擇 EntityId 做為本機變數。

範例 - 取得供應商詳細資料

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Vendor。
3. 選取「Get」作業，然後按一下「完成」。
4. 設定實體 ID，即可取得供應商詳細資料。如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 ACMEDO，並選擇 EntityId 做為本機變數。

範例 - 刪除帳戶

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Account。
3. 選取「Delete」作業，然後按一下「完成」。
4. 設定要刪除帳戶的實體 ID。如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 10250，並選擇 EntityId 做為本機變數。

範例 - 刪除客戶

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Customer。
3. 選取「Delete」作業，然後按一下「完成」。
4. 設定實體 ID，刪除客戶。如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 SANDWICH，並選擇 EntityId 做為本機變數。

範例 - 刪除銷售人員

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Salesperson。
3. 選取「Delete」作業，然後按一下「完成」。
4. 設定要刪除銷售人員的實體 ID。如要設定實體 ID，請在「資料對應」的「資料對應器」部分，按一下「開啟資料對應編輯器」，然後在「輸入值」欄位中輸入 SP0004，並選擇 EntityId 做為本機變數。

範例 - 建立日記帳交易

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 JournalTransaction。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
     "Description": "go again",
     "BatchNbr": "000008",
     "CurrencyID": "INR",
     "Module": "GL" 
       }
     

   如果整合成功，連接器工作的 connectorOutputPayload 欄位會包含類似下列內容的值：

   [{
       "BatchNbr": "000016",   "Module": "GL" 
       }]
       

範例 - 建立客戶

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Customer。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
        "LocationName": "Primary Location",
        "StatementCycleID": "WEEKLY",
        "CustomerClass": "CSTMRCLAS1",
        "CurrencyID": "INR",
        "CustomerID": "BISCCITY",
        "CustomerName": "Biscuit City Cafe" 
        }

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
        "CustomerID": "BISCCITY"
        }

範例 - 建立銷售訂單

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 SalesOrder。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
        "Approved": true,
        "BaseCurrencyID": "INR",
        "CashAccount": "10200",
        "ControlTotal": 30.0,
        "CustomerID": "BISCCITY",
        "Description": "SO--0016"
        }

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
        "OrderNbr": "000025",
        "OrderType": "CS" 
        }

範例 - 建立訂購單

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 PurchaseOrder。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
        "ControlTotal": 200.0,
        "CurrencyID": "INR",
        "Description": "PO--14",
        "VendorID": "ACMEDO"
        }

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
        "OrderNbr": "000021",
        "Type": "Normal"
        }

範例 - 建立銷售人員

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Salesperson。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
        "Name": "Sales person 0009",
        "SalespersonID": "SP0009",
        "DefaultCommission": 10.0
        }

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
        "SalespersonID": "SP0009" 
        }

範例 - 建立供應商

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Vendor。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
        "APAccount": "20000",
        "CashAccount": "10200",
        "LocationName": "Secondary Location",
        "MaxReceipt": 100.0,
        "MinReceipt": 0.0,
        "VendorClass": "DEFAULTV",
        "VendorID": "ALLFRUITS"
        }

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
        "VendorID": "ALLFRUITS"
        }

範例 - 建立帳單

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Bill。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
        "Amount": 10.0,
        "Description": "new test",
        "DueDate": "2024-01-26 00:00:00.0",
        "LocationID": "MAIN",
        "Terms": "30D",
        "Vendor": "TESTVENDOR"
        }

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
        "ReferenceNbr": "000020",
        "Type": "Bill"
        }

範例 - 建立檢查

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Check。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
        "Description": "check check check",
        "CurrencyID": "INR",
        "CashAccount": "10200",
        "PaymentMethod": "CHECK",
        "Vendor": "ACMEDO"
        }

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
        "ReferenceNbr": "000013",
        "Type": "Payment"
        }

範例 - 建立銷貨發票

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 SalesInvoice。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
        "Description": "testing custom",
        "Amount": 10.0,
        "Balance": 0.0,
        "CustomerID": "BISCCITY",
        "DueDate": "2023-04-21 00:00:00.0"
        }

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
        "ReferenceNbr": "000024",
        "Type": "Invoice"
        }

範例 - 建立月結單

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Invoice。
3. 選取「Create」作業，然後按一下「完成」。
4. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   { 
        "Terms": "30D",
        "Description": "forever",
        "LocationID": "MAIN",
        "Customer": "BISCCITY", 
        "LinkARAccount": "11000"
        }

   執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

   {
        "ReferenceNbr": "000026",
        "Type": "Invoice"
        }

範例 - 更新銷售訂單詳細資料

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 SalesOrder。
3. 選取「Update」作業，然後按一下「完成」。
4. 在「Connectors」(連結器) 任務的「Task Input」(任務輸入內容) 區段中，按一下 connectorInputPayload，然後在 Default Value 欄位中輸入類似下列的值：

   {
         "Approved": true,
         "Description": "SO--0014"
           }
     

5. 按一下「entityId」，然後在「Default Value」欄位中輸入 000025。

   如果整合成功，連接器工作的 connectorOutputPayload 欄位會包含類似下列內容的值：

   [{
         "OrderNbr": "000025",
         "OrderType": "CS"
           }]
     

範例 - 更新付款詳情

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Payment。
3. 選取「Update」作業，然後按一下「完成」。
4. 設定實體 ID，以更新付款詳細資料。如要設定實體 ID，請在「Tasks」(工作) 的「Data mapper」(資料對應器) 區段中，按一下「FilterClause」(篩選子句)，然後在指定欄位中輸入 ReferenceNbr='000007' AND Type='Payment'。
5. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
   "CurrencyID": "INR"
   }
   

除了指定 entityId，您也可以將 filterClause 設為 ReferenceNbr='000007' AND Type='Payment'。

執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

{
"ReferenceNbr": "000007",
"Type": "Payment" 
}

範例 - 更新專案交易詳細資料

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 ProjectTransaction。
3. 選取「Update」作業，然後按一下「完成」。
4. 設定實體 ID，更新專案交易詳細資料。如要設定實體 ID，請在「Tasks」(工作) 的「Data mapper」(資料對應器) 區段中，按一下「FilterClause」(篩選子句)，然後在指定欄位中輸入 Module='PM' AND ReferenceNbr='PM00000003'。
5. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
   "Description": "updated"
   }
   

除了指定 entityId，您也可以將 filterClause 設為 Module='PM' AND ReferenceNbr='PM00000003'。

執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

{
"Module": "PM",
"ReferenceNbr": "PM00000003"
}

範例 - 更新日記帳交易詳細資料

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 JournalTransaction。
3. 選取「Update」作業，然後按一下「完成」。
4. 設定實體 ID，以更新日記帳交易詳細資料。如要設定實體 ID，請在「Tasks」(工作) 的「Data mapper」(資料對應器) 區段中，按一下「FilterClause」(篩選子句)，然後在指定欄位中輸入 BatchNbr='000016' AND Module='GL'。
5. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

    
   {
   "BatchNbr": "000012",
   "CurrencyID": "INR",
   "Description": "updated",
   "Module": "GL"
   }
   

除了指定 entityId，您也可以將 filterClause 設為 BatchNbr='000016' AND Module='GL'。

執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

{
"BatchNbr": "000012",
"Module": "GL"
}

範例 - 更新顧客詳細資料

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Customer。
3. 選取「Update」作業，然後按一下「完成」。
4. 設定實體 ID，以更新顧客詳細資料。如要設定實體 ID，請在「Tasks」(工作) 的「Data mapper」(資料對應工具) 區段中，按一下「entityId」，然後在指定欄位中輸入 BISCCITY。
5. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
   "LocationName": "Primary Location",
   "StatementCycleID": "DAILY",
   "CustomerID": "BISCCITY",
   "CustomerClass": "CSTMRCLAS1",
   "Terms": "30D"
   }
   

除了指定 entityId，您也可以將 filterClause 設為 BISCCITY。

執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

 {
"CustomerID": "BISCCITY"
} 

範例 - 更新訂購單詳細資料

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 PurchaseOrder。
3. 選取「Update」作業，然後按一下「完成」。
4. 設定實體 ID，更新訂購單詳細資料。如要設定實體 ID，請在「Tasks」(工作) 的「Data mapper」(資料對應器) 區段中，按一下「FilterClause」(篩選子句)，然後在指定欄位中輸入 OrderNbr='000025' AND OrderType='CS'。
5. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
   "Approved": true,
   "Description": "SO--0014"
   }
   

除了指定 entityId，您也可以將 filterClause 設為 OrderNbr='000025' AND OrderType='CS'。

執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

{
"OrderNbr": "000025",
"OrderType": "CS"
}

範例 - 更新銷售人員詳細資料

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Salesperson。
3. 選取「Update」作業，然後按一下「完成」。
4. 設定實體 ID，即可更新銷售人員詳細資料。如要設定實體 ID，請在「Tasks」(工作) 的「Data mapper」(資料對應工具) 區段中，按一下「entityId」，然後在指定欄位中輸入 SP0009。
5. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
   "DefaultCommission": 20.0
   }
   

除了指定 entityId，您也可以將 filterClause 設為 SP0009。

執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

{
"SalespersonID": "SP0009"
}

範例 - 更新帳單詳細資料

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Bill。
3. 選取「Update」作業，然後按一下「完成」。
4. 設定實體 ID，以更新帳單詳細資料。如要設定實體 ID，請在「Tasks」(工作) 的「Data mapper」(資料對應器) 區段中，按一下「FilterClause」(篩選子句)，然後在指定欄位中輸入 ReferenceNbr='000019' AND Type='Bill'。
5. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
   "Amount": 10.0,
   "Description": "updated"
   }
   

除了指定 entityId，您也可以將 filterClause 設為 ReferenceNbr='000019' AND Type='Bill'。

執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

{
"ReferenceNbr": "000019",
"Type": "Bill"
}

範例 - 更新支票詳細資料

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 Check。
3. 選取「Update」作業，然後按一下「完成」。
4. 設定實體 ID，即可更新檢查詳細資料。如要設定實體 ID，請在「Tasks」(工作) 的「Data mapper」(資料對應器) 區段中，按一下「FilterClause」(篩選子句)，然後在指定欄位中輸入 ReferenceNbr='000013' AND Type='Payment'。
5. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

   {
   "Description": "updated check"
   }
   

除了指定 entityId，您也可以將 filterClause 設為 ReferenceNbr='000013' AND Type='Payment'。

執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

{
"ReferenceNbr": "000013",
"Type": "Payment"
}

範例 - 更新銷售月結單詳細資料

1. 在「Configure connector task」對話方塊中，按一下 Entities。
2. 從 Entity 清單中選取 SalesInvoice。
3. 選取「Update」作業，然後按一下「完成」。
4. 設定實體 ID，即可更新銷售月結單詳細資料。如要設定實體 ID，請在「Tasks」(工作) 的「Data mapper」(資料對應器) 區段中，按一下「FilterClause」(篩選子句)，然後在指定欄位中輸入 ReferenceNbr='000024'。
5. 在「Task」(工作) 的「Data mapper」(資料對應器) 部分，按一下 OpenDataMapping 編輯器，然後在 field: 中輸入類似下列的值：

    
   {
   "Description": "shipping pastries"
   }
   

除了指定 entityId，您也可以將 filterClause 設為 ReferenceNbr='000024'。

執行這個範例後，Connector 工作的 connectorOutputPayload 輸出變數會傳回類似下列內容的回應：

 {
"ReferenceNbr": "000024",
"Type": "Invoice"
}