IBQConfigBase API:スコープ対象
要求トラッカーが要求を追跡するために拡張する必要があるスクリプトインクルード セールスと注文管理 。このスクリプトインクルードは、要求の実行方法を定義する上書き可能なメソッドを提供します。
IBQConfigBase スクリプトインクルードをインスタンスで使用できるようにするには、セールスアンドサービス API Core (com.sn_tmt_core) プラグインを有効にする必要があります。このスクリプトインクルードは sn_tmt_core 名前空間に属しており、admin ロールが必要です。
IBQConfigBase API の拡張
IBQConfigBase API の上書き可能なメソッドを使用してスクリプトインクルードを定義します。
- スクリプトインクルードを作成します。名前は IBQConfig で始まる必要があります ( 例: IBQConfigQuoteToOrderFlowSNC)。
- IBQConfigBase API を拡張します。たとえば、次のようになります:
IBQConfigQuoteToOrderFlowSNC.prototype = Object.extendsObject(sn_tmt_core.IBQConfigBase, { ... }); - IBQConfigBase API によって提供される必要なメソッドを上書きします。たとえば、次のようになります:
getRunMode: function(inboundQueueParams) { return this.quoteUtil.getQuoteSize(inboundQueueParams.source_record_ids, this.threshold); }, generateParentRecord: function(inboundQueueParams, additionalParams, context) { var result = ""; var entityMappingGr = this.getMapingConfigIdFromSysId(inboundQueueParams.requested_flow); var sourceToTargetConfigID = entityMappingGr.getValue("mapping_config_id"); var sourceHeaderId = inboundQueueParams.source_record_ids; if (gs.nil(inboundQueueParams.requested_flow)) throw "sourceToTargetConfigID cannot be null"; if (gs.nil(inboundQueueParams.source_record_ids)) throw "source record id cannot be null"; var util = new sn_l2c_core.PrimitiveUtil(); if (gs.nil(additionalParams)) additionalParams = {}; additionalParams[this.SKIP_LINES_KEY] = "true"; }, processInboundQueueRequest: function(inboundQueueGR) { gs.info("processRequest inboundQueueGR " + JSON.stringify(inboundQueueGR)); var result = this.quoteUtil.createOrderFromQuoteUsingMetadata(inboundQueueGR.getValue('source_record_ids'), 'sn_l2c_quote_to_order', null, null, inboundQueueGR.getValue('record_id')); return result; } - 受信要求構成 [sn_tmt_core_inbound_queue_config] テーブルに新しいメタデータエントリを作成し、要求の処理方法を定義します。
- 作成されたスクリプトインクルードをメタデータレコードの configuration_api フィールドにリンクして、要求の処理中に定義されたカスタムロジックを使用します。スクリプトインクルードは、受信要求構成メタデータを作成するときに [ configuration_api ] フィールドで参照されます。
ユースケース:IBQConfigQuoteToOrderFlow
var IBQConfigQuoteToOrderFlowSNC = Class.create();
IBQConfigQuoteToOrderFlowSNC.prototype = Object.extendsObject(sn_tmt_core.IBQConfigBase, {
initialize: function() {
this.quoteUtil = new sn_quote_mgmt.OrderIntegration();
this.SKIP_LINES_KEY = "skipLines";
this.threshold = 15;
},
getRunMode: function(inboundQueueParams) {
return this.quoteUtil.getQuoteSize(inboundQueueParams.source_record_ids, this.threshold);
},
generateParentRecord: function(inboundQueueParams, additionalParams, context) {
var result = "";
var entityMappingGr = this.getMapingConfigIdFromSysId(inboundQueueParams.requested_flow);
var sourceToTargetConfigID = entityMappingGr.getValue("mapping_config_id");
var sourceHeaderId = inboundQueueParams.source_record_ids;
if (gs.nil(inboundQueueParams.requested_flow))
throw "sourceToTargetConfigID cannot be null";
if (gs.nil(inboundQueueParams.source_record_ids))
throw "source record id cannot be null";
var util = new sn_l2c_core.PrimitiveUtil();
if (gs.nil(additionalParams))
additionalParams = {};
additionalParams[this.SKIP_LINES_KEY] = "true";
// additional parameters are retrieved using the PrimitiveUtil() utility methods provided by the Lead to Cash Core application
var service = util.getPrimitivesEPService(sourceToTargetConfigID, context);
var isEmpty = false;
if (service) {
var createInstanceOutput = service.createInstance(sourceHeaderId, null, false, additionalParams);
if (gs.nil(sourceHeaderId))
isEmpty = this.__isEmpty(createInstanceOutput.lineItems);
else
isEmpty = this.__isEmpty(createInstanceOutput);
if (!isEmpty) {
var effectOutput = service.effect(createInstanceOutput, null, additionalParams);
if (!this.__isEmpty(effectOutput)) {
var commitOutput = service.commitInstance(effectOutput, additionalParams);
return commitOutput;
}
}
}
return result;
},
processInboundQueueRequest: function(inboundQueueGR) {
gs.info("processRequest inboundQueueGR " + JSON.stringify(inboundQueueGR));
var result = this.quoteUtil.createOrderFromQuoteUsingMetadata(inboundQueueGR.getValue('source_record_ids'), 'sn_l2c_quote_to_order', null, null, inboundQueueGR.getValue('record_id'));
return result;
},
__isEmpty: function(sourceObj) {
if (gs.nil(sourceObj))
return true;
return Object.keys(sourceObj).length === 0;
},
getMapingConfigIdFromSysId(requestedFlow) {
var gr = new GlideRecord("sn_l2c_core_entity_mapping");
gr.addQuery("sys_id", requestedFlow);
gr.query();
if (gr.next()) {
gs.info("mapping id received to corresponding requestedFlow");
return gr;
}
},
type: 'IBQConfigQuoteToOrderFlowSNC'
});IBQConfigBase – generateParentRecord(オブジェクト ibqParams)
要求を処理する前に受信要求 [sn_tmt_core_inbound_queue_list] レコードのrecord_idに追加される親レコードを作成します。
処理前に 親レコード を作成すると、非同期処理に最適で、処理中に実行できるアクティビティをスクリプトインクルードに追加できます。たとえば、画面にメッセージを表示するなどです。
| 名前 | タイプ | 説明 |
|---|---|---|
| ibqParams | オブジェクト | 作成する受信要求レコードの詳細を含む JSON オブジェクト。 |
| アカウント | 文字列 | オプション。レコードに関連付けられているアカウントに関する情報。 テーブル:アカウント [customer_account] |
| consumer | 文字列 | オプション。レコードに関連付けられたコンシューマーに関する情報。 テーブル:コンシューマー [csm_consumer] |
| 連絡先 | 文字列 | オプション。レコードに関連付けられた連絡先に関する情報。 テーブル:連絡先 [customer_contact] |
| ペイロード | オブジェクト | オプション。PrimitiveUtil() API を使用して要求を処理するために必要な JSON オブジェクト。使用方法の詳細については、「 LeadToCashCore」を参照してください。 |
| payload.additionalParams | オブジェクト | オプション。使用する追加パラメーター。 |
| payload.additionalParams.action | 文字列 | オプション。実行する宣言アクションのタイプを指定します。詳細については、「Customer Life Cycle Management Workflows」を参照してください。 可能な値:
|
| payload.additionalParams.actionReason | 文字列 | オプション。宣言アクションを使用するフローで使用されるプロパティ。アクションの理由。 |
| payload.additionalParams.endDate | 文字列 | オプション。宣言アクションを使用してフローを実行するために必要な終了日。 形式:yyyy-MM-dd HH:mm:ss |
| payload.additionalParams.skipLines | ブール | オプション。指定したエンティティの品目をフェッチするかどうかを示すフラグ。 有効な値:
|
| payload.additionalParams.startDate | 文字列 | オプション。宣言アクションを使用してフローを実行する開始日。 形式:yyyy-MM-dd HH:mm:ss |
| payload.context | オブジェクト | オプション。属性値を表示し、一度に複数のインスタンスを呼び出すための追加のパラメーターオプション。 |
| payload.context.isMultiSelect | ブール | オプション。インスタンスを作成するために複数のエンティティを入力として渡すかどうかを示すフラグ。 有効な値:
|
| payload.context.sourceToTargetConfigID | 文字列 | オプション。ソースからターゲットへのマッピングのマッピング構成 ID。 テーブル:「Lead-to-Cash」エンティティマッピング [sn_l2c_core_entity_mapping] |
| payload.inputParams | オブジェクト | オプション。このオブジェクトは、特定のフローの使用を呼び出すために必要な入力パラメーターのプレースホルダーです。 |
| payload.source | アレイ | オプション。データを取得するソースエンティティの詳細を含む JSON オブジェクト。 |
| payload.source.headerId | 文字列 | オプション。データの取得元のソースエンティティのヘッダー sys_id。
|
| payload.source.lineIds | アレイ | オプション。エンティティデータを取得するエンティティのソース品目sys_idを含むアレイ。 ヘッダー ID を指定せず、エンティティ構造が [販売済み製品] などの品目で始まる場合は必須です。 |
| payload.target | アレイ | オプション。ターゲットエンティティの詳細を含む JSON オブジェクト。 |
| payload.target.headerId | 文字列 | オプション。データを取得するターゲットエンティティのヘッダー sys_id。lineIdsパラメーターを指定しない場合は必須です。ヘッダー sys_idsを渡さない場合は null を渡します。 |
| payload.target.lineIds | アレイ | オプション。エンティティデータを取得するエンティティのターゲット品目sys_idを含むアレイ。ヘッダー ID を指定せず、エンティティ構造が [販売済み製品] などの品目で始まる場合は必須です。 |
| record_id | 文字列 | オプション。ターゲットレコードのSys_id (既に存在する場合)。 |
| requested_flow | 文字列 | オプション。ソースからターゲットへのマッピングのマッピング構成 ID。このプロパティは、 Entity configuration and mappingを使用するフローに必要です。 テーブル:「Lead-to-Cash」エンティティマッピング [sn_l2c_core_entity_mapping] |
| source_record_ids | アレイ | ソースレコードのsys_idsを含むアレイ。 |
| source_table | 文字列 | フローのソースレコードを含むテーブルの名前。 |
| テーブル | 文字列 | フローのターゲットレコードを含むテーブルの名前。 |
| タイプ | 説明 |
|---|---|
| JSON オブジェクト | 作成されたターゲットレコードのヘッダー ID を含む JSON オブジェクト。
|
| headerID | 作成されたターゲットレコードのヘッダーのSys_id。この値は、受信要求レコードの作成時にrecord_idフィールドに入力するために使用されます。 |
var ibqParams = {
"source_record_ids": "f83e29574df02210f877142d1adc9531",
"requested_flow": "0feb6d9da36271105c24939ef31e61dc",
"initiated_by": "admin",
"source_table": "sn_quote_mgmt_core_quote",
"table": "sn_ind_tmt_orm_order",
"payload": {}
};
var service = new sn_quote_mgmt.IBQConfigQuoteToOrderFlow();
var parentRecord = service.generateParentRecord(ibqParams);
gs.info("Parent record = "+JSON.stringify(parentRecord));
Parent record = {"headerID":"d11bd507dc6c6a10f877720033b5d0b9", ...} IBQConfigBase:getRunMode(オブジェクト ibqParams)
フローを同期モードで実行するか非同期モードで実行するかを決定します。
| 名前 | タイプ | 説明 |
|---|---|---|
| ibqParams | オブジェクト | 作成する受信要求レコードの詳細を含む JSON オブジェクト。 |
| アカウント | 文字列 | オプション。レコードに関連付けられているアカウントに関する情報。 テーブル:アカウント [customer_account] |
| consumer | 文字列 | オプション。レコードに関連付けられたコンシューマーに関する情報。 テーブル:コンシューマー [csm_consumer] |
| 連絡先 | 文字列 | オプション。レコードに関連付けられた連絡先に関する情報。 テーブル:連絡先 [customer_contact] |
| ペイロード | オブジェクト | オプション。PrimitiveUtil() API を使用して要求を処理するために必要な JSON オブジェクト。使用方法の詳細については、「 LeadToCashCore」を参照してください。 |
| payload.additionalParams | オブジェクト | オプション。使用する追加パラメーター。 |
| payload.additionalParams.action | 文字列 | オプション。実行する宣言アクションのタイプを指定します。詳細については、「Customer Life Cycle Management Workflows」を参照してください。 可能な値:
|
| payload.additionalParams.actionReason | 文字列 | オプション。宣言アクションを使用するフローで使用されるプロパティ。アクションの理由。 |
| payload.additionalParams.endDate | 文字列 | オプション。宣言アクションを使用してフローを実行するために必要な終了日。 形式:yyyy-MM-dd HH:mm:ss |
| payload.additionalParams.skipLines | ブール | オプション。指定したエンティティの品目をフェッチするかどうかを示すフラグ。 有効な値:
|
| payload.additionalParams.startDate | 文字列 | オプション。宣言アクションを使用してフローを実行する開始日。 形式:yyyy-MM-dd HH:mm:ss |
| payload.context | オブジェクト | オプション。属性値を表示し、一度に複数のインスタンスを呼び出すための追加のパラメーターオプション。 |
| payload.context.isMultiSelect | ブール | オプション。インスタンスを作成するために複数のエンティティを入力として渡すかどうかを示すフラグ。 有効な値:
|
| payload.context.sourceToTargetConfigID | 文字列 | オプション。ソースからターゲットへのマッピングのマッピング構成 ID。 テーブル:「Lead-to-Cash」エンティティマッピング [sn_l2c_core_entity_mapping] |
| payload.inputParams | オブジェクト | オプション。このオブジェクトは、特定のフローの使用を呼び出すために必要な入力パラメーターのプレースホルダーです。 |
| payload.source | アレイ | オプション。データを取得するソースエンティティの詳細を含む JSON オブジェクト。 |
| payload.source.headerId | 文字列 | オプション。データの取得元のソースエンティティのヘッダー sys_id。
|
| payload.source.lineIds | アレイ | オプション。エンティティデータを取得するエンティティのソース品目sys_idを含むアレイ。 ヘッダー ID を指定せず、エンティティ構造が [販売済み製品] などの品目で始まる場合は必須です。 |
| payload.target | アレイ | オプション。ターゲットエンティティの詳細を含む JSON オブジェクト。 |
| payload.target.headerId | 文字列 | オプション。データを取得するターゲットエンティティのヘッダー sys_id。lineIdsパラメーターを指定しない場合は必須です。ヘッダー sys_idsを渡さない場合は null を渡します。 |
| payload.target.lineIds | アレイ | オプション。エンティティデータを取得するエンティティのターゲット品目sys_idを含むアレイ。ヘッダー ID を指定せず、エンティティ構造が [販売済み製品] などの品目で始まる場合は必須です。 |
| record_id | 文字列 | オプション。ターゲットレコードのSys_id (既に存在する場合)。 |
| requested_flow | 文字列 | オプション。ソースからターゲットへのマッピングのマッピング構成 ID。このプロパティは、 Entity configuration and mappingを使用するフローに必要です。 テーブル:「Lead-to-Cash」エンティティマッピング [sn_l2c_core_entity_mapping] |
| source_record_ids | アレイ | ソースレコードのsys_idsを含むアレイ。 |
| source_table | 文字列 | フローのソースレコードを含むテーブルの名前。 |
| テーブル | 文字列 | フローのターゲットレコードを含むテーブルの名前。 |
| タイプ | 説明 |
|---|---|
| 文字列 | 要求の実行に使用される実行モードに関する情報。 可能な値:
|
非同期です。var ibqParams = {
"source_record_ids": "04ba9004f11f3110f8777d7194f166f6",
"requested_flow": "0feb6d9da36271105c24939ef31e61dc",
"initiated_by": "admin",
"source_table": "sn_quote_mgmt_core_quote",
"table": "sn_ind_tmt_orm_order",
"payload": {}
};
var service = new sn_quote_mgmt.IBQConfigQouteToOrderFlow();
var runMode = service.getRunMode(ibqParams);
gs.info("RunMode = "+JSON.stringify(runMode));
RunMode = "async"var ibqParams = {
"source_record_ids": "0b0f5cc8f11f3110f8777d7194f16610",
"requested_flow": "0feb6d9da36271105c24939ef31e61dc",
"initiated_by": "admin",
"source_table": "sn_quote_mgmt_core_quote",
"table": "sn_ind_tmt_orm_order",
"payload": {}
};
var service = new sn_quote_mgmt.IBQConfigQouteToOrderFlow();
var runMode = service.getRunMode(ibqParams);
gs.info("RunMode = "+JSON.stringify(runMode));
RunMode = "sync"IBQConfigBase – processInboundQueueRequest (GlideRecord ibqGr)
受信要求レコードを処理するためのロジックを定義します。
| 名前 | タイプ | 説明 |
|---|---|---|
| ibqGr | GlideRecord | フローをトリガーした受信要求レコードへの GlideRecord 参照。 テーブル:受信要求 [sn_tmt_core_inbound_queue] |
| タイプ | 説明 |
|---|---|
| オブジェクト | 受信要求レコードの処理の詳細を含む JSON オブジェクト。 |
| エラー | 要求の処理中に発生したエラーを示す値。 データタイプ:文字列 |
| 応答 | 受信要求レコードを処理する応答を含む JSON オブジェクト。Lead to Cash Core PrimitiveUtil API によって作成されたフローの場合、この出力は commitInstance() メソッドを使用して提供できます。 データタイプ:オブジェクト |
| ステータス | 要求処理のステータスを示す値。 可能な値:
データタイプ:文字列 |
| ターゲット | オプション。UI 確認応答などの処理を進めるターゲットレコードのSys_id。ターゲットは、フロー中に作成することも、要件に応じて generateParentRecord() メソッドのibqParamsに入力として渡すことも可能です。 データタイプ:文字列 |
var gr = new GlideRecord('sn_tmt_core_inbound_queue');
gr.get('c48ea9974df02210f877142d1adc951a');
var service = new sn_quote_mgmt.IBQConfigQuoteToOrderFlow();
var processRequest = service.processInboundQueueRequest(gr);
gs.info("processRequest = "+JSON.stringify(processRequest));
processRequest = {
"response": {
"status": "success",
"error": "",
"message": "Commit operation successfully processed.",
"displayMessage": "Commit operation successfully processed.",
"dataObject": {
"sys_id": "a6f4568bdce0aa10f877720033b5d069",
"table": "sn_ind_tmt_orm_order",
"attributes": {
"account": {
"value": "9e2fd2ee11b43110f877366201dea674"
},
"quote": {
"value": "c8841a4bdce0aa10f877720033b5d0f8"
}
},
"_glide_action": "UPDATE",
"_source_object": {
"sys_id": "c8841a4bdce0aa10f877720033b5d0f8",
"table": "sn_quote_mgmt_core_quote"
},
"lineItems": [
{
"sys_id": "-1",
"table": "sn_ind_tmt_orm_order_line_item",
"attributes": {
"short_description": {
"value": "Home Automation Bundle"
},
"account": {
"value": "9e2fd2ee11b43110f877366201dea674"
}
},
"_glide_action": "INSERT",
"_source_object": {
"sys_id": "afc4528bdce0aa10f877720033b5d0d0",
"table": "sn_quote_mgmt_core_quote_line_item"
},
"characteristics": [],
"lineItems": [
{
"sys_id": "-1",
"table": "sn_ind_tmt_orm_order_line_item",
"attributes": {
"short_description": {
"value": "Door Sensor"
},
"account": {
"value": "9e2fd2ee11b43110f877366201dea674"
}
},
"_glide_action": "INSERT",
"_source_object": {
"sys_id": "77c4528bdce0aa10f877720033b5d0d5",
"table": "sn_quote_mgmt_core_quote_line_item"
},
"characteristics": [],
"lineItems": [],
"pricingAdjustments": [
{
"sys_id": "-1",
"table": "sn_ind_tmt_orm_pricing_adjustment",
"attributes": {
"name": {
"value": "door sensor bundle discount"
}
},
"_glide_action": "INSERT",
"_source_object": {
"sys_id": "f3c4928bdce0aa10f877720033b5d02f",
"table": "sn_quote_mgmt_core_pricing_adjustment"
},
"_commitObjectInfo": {
"sys_id": "e6955acbdce0aa10f877720033b5d082",
"status": "success"
}
}
],
"coveredProducts": [],
"attributeAdjustment": [],
"_commitObjectInfo": {
"sys_id": "26955acbdce0aa10f877720033b5d07d",
"status": "success"
}
}
],
"pricingAdjustments": [],
"coveredProducts": [],
"attributeAdjustment": [],
"_commitObjectInfo": {
"sys_id": "22955acbdce0aa10f877720033b5d078",
"status": "success"
}
}
],
"_commitObjectInfo": {
"status": "success"
}
},
"headerID": "a6f4568bdce0aa10f877720033b5d069",
"rootLineIDs": [
"22955acbdce0aa10f877720033b5d078"
]
},
"status": "success",
"error": "",
"target": "a6f4568bdce0aa10f877720033b5d069"
}