追加情報

このセクションでは、メソッド、イベント、パラメーター、メタデータに関する追加情報を提供します。
  • レシピをデプロイする特定のターゲットを設定できます。ターゲットの構造は、レシピスキーマに保存されている構造と同じである必要があります。
  • レシピは、リストビューまたは NetLogic で使用できます。
  • レシピパラメーターは、レシピスキーマエディタで選択された項目またはデータ項目です。リストビューで表されるレシピパラメーターは、常に読み取り専用として表示されます。
  • レシピでは、特定のタスクに対して挿入/更新/削除操作の数が増加します。これにより、特にリモートデータベースやレイテンシが高い場合には、操作を完了するために必要な時間が長くなる可能性があります。データ損失を防ぐために、最小限のトランザクション管理がサポートされています。トランザクション管理はカスタマイズできません。
    重要: データロガーやイベントロガーを使用する際のデータ損失を防ぐため、レシピに使用しているものと同じデータベースは使用しないことを強くお勧めします。
  • レガシーレシピスキーマと新しいレシピスキーマを同じプロジェクトで使用できますが、手動で調整する必要がある場合があります。
  • EmbeddedDatabase
    のクエリ例:
    SELECT R.*, M.* FROM Recipes AS R LEFT JOIN "RecipeMetadata_RecipeSchema1" AS M ON R.Id = M.RecipeId WHERE R.RecipeSchemaName = 'RecipeSchema1' ORDER BY R.Name

メソッド

次の表は、メソッドおよび関連するパラメーターについて説明します。
IDE および C# API から利用可能なメソッド
メソッド
入力引数
出力引数
CreateRecipe
  • レシピID [レシピID]
  • 結果 [レシピ作成の結果コード]
    • 成功: レシピが正常に作成されました
    • レシピIDが見つからない: メソッドが空のレシピID で呼び出されました
    • RecipeAlreadyExist: 同じ名前とバージョンのレシピがすでに存在します
    • ストアエラー: ストアへのアクセス中にエラーが発生しました
    • エラー: エラーが発生しました
DuplicateRecipe
  • レシピID [レシピID]
  • NewRecipeId [レシピID]
  • 結果 [レシピ複製の結果コード]
    • 成功: レシピが正常に複製されました
    • ジェネリックエラー: レシピの複製中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました (データベースエラーなど)
    • ソースの予期しない空のレシピ名: 指定されたソースレシピ名が空またはnullです
    • ターゲットの予期しない空のレシピ名: 指定されたターゲットレシピ名が空またはnullです
    • ソースレシピが存在しません: ストアでレシピが見つかりませんでした
    • ターゲットレシピはすでに存在します: ターゲット名のレシピはすでに存在します
    • ターゲットが見つかりません: レシピ重複のターゲットノードが見つかりませんでした
RenameRecipe
  • レシピID [レシピID]
  • NewName [String]
  • 結果 [レシピの名前変更の結果コード]
    • 成功: レシピの名前が正常に変更されました
    • ジェネリックエラー: レシピの名前変更中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました (データベースエラーなど)
    • 予期しない空のレシピ名: 指定されたレシピ名が空かnullです
    • ソースレシピが存在しません: ストアでレシピが見つかりませんでした
    • ターゲットレシピはすでに存在します: ターゲット名のレシピはすでに存在します
DeleteRecipe
  • レシピID [レシピID]
  • 結果 [レシピ削除の結果コード]
    • 成功: レシピが正常に削除されました
    • ジェネリックエラー: レシピの削除中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました (データベースエラーなど)
    • 予期しない空のレシピ名: 指定されたレシピ名が空かnullです
    • レシピが存在しません: ストアで指定されたレシピが見つかりませんでした
リファクタ
  • なし
なし。これが唯一の非同期メソッドです。操作が完了すると、イベント (リファクタ完了) が送出されます。
GetDataItems
  • レシピID [レシピID]
  • 結果 [Getdataitemsの結果コード]
    • 成功: データ項目が正常に取得されました
    • RecipeNotFound: ストアで指定されたレシピが見つかりませんでした
    • ストアエラー: ストアへのアクセス中にエラーが発生しました (データベースエラーなど)
    • ジェネリックエラー: データ項目の取得中に一般的なエラーが発生しました
SetRecipeDataItemValue
  • レシピID [レシピID]
  • ItemRelativeBrowsePath [String]
  • DataItemRelativeBrowsePath [String]
  • ElementAccess [ElementAccess]
  • 値 [BaseDataType]
  • 結果 [レシピデータ項目値の設定の結果コード]
    • 成功: レシピデータ項目の値が正常に設定されました
    • ジェネリックエラー: データ項目値の設定中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました (データベースエラーなど)
    • データ項目が見つかりません: 指定されたデータ項目がレシピに見つかりませんでした
    • 予期しない空のレシピ名: 指定されたレシピ名が空かnullです
    • RecipeNotFound: ストアで指定されたレシピが見つかりませんでした
SetRecipeMetadataValue
  • レシピID [レシピID]
  • MetadataName [String]
  • 値 [BaseDataType]
  • 結果 [レシピメタデータ値の設定の結果コード]
    • 成功: レシピメタデータ値が正常に設定されました
    • ジェネリックエラー: メタデータ値の設定中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました (データベースエラーなど)
    • 予期しない空のレシピ名: 指定されたレシピ名が空かnullです
    • RecipeNotFound: ストアで指定されたレシピが見つかりませんでした
    • メタデータが見つかりません: 指定されたメタデータフィールドがレシピに見つかりませんでした
TransferFromEditModelToStore
  • RequesterNodeId [NodeId]
  • レシピID [レシピID]
  • 結果 [編集モデルからストアへの転送の結果コード]
    • 成功レシピ作成: レシピが正常に作成され、編集モデルからストアに転送されました
    • 成功レシピ更新: レシピが正常に更新され、編集モデルからストアに転送されました
    • ジェネリックエラー: 編集モデルからストアへの転送中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました (データベースエラーなど)
    • RequesterNodeNotFound: リクエスターノードが見つかりませんでした
    • 予期しない空のレシピ名: 指定されたレシピ名が空かnullです
    • ターゲットが見つかりません: 転送のターゲットノードが見つかりませんでした
    • EditModelNodeNotFound: 編集モデルノードが見つかりませんでした
TransferFromEditModelToTarget
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • ErrorPolicy [エラーポリシーのDatatype]
  • 結果 [編集モデルからターゲットへの転送の結果コード]
    • 成功: レシピが編集モデルからターゲットに正常に転送されました
    • ジェネリックエラー: 編集モデルからターゲットへの転送中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました (データベースエラーなど)
    • RequesterNodeNotFound: リクエスターノードが見つかりませんでした
    • ターゲットが見つかりません: 転送のターゲットノードが見つかりませんでした
    • EditModelNodeNotFound: 編集モデルノードが見つかりませんでした
    • データの不一致: 編集モデルデータとターゲット構造の間に不一致があります。
TransferFromStoreToEditModel
  • RequesterNodeId [NodeId]
  • レシピID [レシピID]
  • 結果 [編集モデルからターゲットへの転送の結果コード]
    • 成功: レシピが編集モデルからターゲットに正常に転送されました
    • ジェネリックエラー: 編集モデルからターゲットへの転送中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました (データベースエラーなど)
    • RequesterNodeNotFound: リクエスターノードが見つかりませんでした
    • ターゲットが見つかりません: 転送のターゲットノードが見つかりませんでした
    • EditModelNodeNotFound: 編集モデルノードが見つかりませんでした
    • データの不一致: 編集モデルデータとターゲット構造の間に不一致があります。
TransferFromStoreToTarget
  • レシピID [レシピID]
  • TargetNodeId [NodeId]
  • ErrorPolicy [エラーポリシーのDatatype]
  • 結果 [TransferFromStoreToTargetResultCode]
    • 成功: レシピがストアからターゲットに正常に転送されました
    • ジェネリックエラー: ストアからターゲットへの転送中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました (データベースエラーなど)
    • 予期しない空のレシピ名: 指定されたレシピ名が空かnullです
    • RecipeNotFound: ストアで指定されたレシピが見つかりませんでした
    • ターゲットが見つかりません: 転送のターゲットノードが見つかりませんでした
    • データの不一致: レシピデータとターゲット構造の間にミスマッチがあります
TransferFromTargetToEditModel
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • ErrorPolicy [エラーポリシーのDatatype]
  • 結果 [ターゲットから編集モデルへの転送の結果コード]
    • 成功: レシピはターゲットから編集モデルに正常に転送されました
    • ジェネリックエラー: ターゲットから編集モデルへの転送中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました (データベースエラーなど)
    • RequesterNodeNotFound: リクエスターノードが見つかりませんでした
    • ターゲットが見つかりません: 転送のターゲットノードが見つかりませんでした
    • EditModelNodeNotFound: 編集モデルノードが見つかりませんでした
    • データの不一致: ターゲットデータと編集モデル構造の間に不一致があります
TransferFromTargetToStore
  • レシピID [レシピID]
  • TargetNodeId [NodeId]
  • Overwrite [Bool]
  • ErrorPolicy [エラーポリシーのDatatype]
  • 結果 [TransferFromTargetToStoreResultCode]
    • 成功レシピ作成: レシピが正常に作成され、ターゲットからストアに転送されました
    • 成功レシピ更新: レシピが正常に更新され、ターゲットからストアに転送されました
    • ジェネリックエラー: ターゲットからストアへの転送中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました (データベースエラーなど)
    • 予期しない空のレシピ名: 指定されたレシピ名が空かnullです
    • レシピはすでに存在します: 同じ名前のレシピがストアにすでに存在します
    • ターゲットが見つかりません: 転送のターゲットノードが見つかりませんでした
    • データの不一致: ターゲットデータとストア構造の間に不一致があります
C# API からのみ利用可能なメソッド
メソッド
入力引数
出力引数
GetRecipes
入力引数なし
  • 結果 [Getrecipesの結果] (配列)
    • 成功: レシピが正常に取得されました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました
    • ジェネリックエラー: レシピの取得中に一般的なエラーが発生しました
GetRecipeMetadataValue
  • レシピID [レシピID]
  • MetadataName [String]
  • 結果 [レシピメタデータ値の取得の結果]
    • 成功: レシピメタデータ値が正常に取得されました
    • ジェネリックエラー: メタデータ値の取得中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました
    • 予期しない空のレシピ名: 指定されたレシピ名が空かnullです
    • RecipeNotFound: ストアで指定されたレシピが見つかりませんでした
    • メタデータが見つかりません: 指定されたメタデータフィールドがレシピに見つかりませんでした
GetRecipeMetadataValues
レシピID [レシピID]
  • 結果 [レシピメタデータ値の取得の結果]
    • 成功: レシピメタデータ値が正常に取得されました
    • ジェネリックエラー: メタデータ値の取得中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました
    • 予期しない空のレシピ名: 指定されたレシピ名が空かnullです
    • RecipeNotFound: ストアで指定されたレシピが見つかりませんでした
GetRecipeDataItemValue
  • レシピID [レシピID]
  • ItemRelativeBrowsePath [String] (配列)
  • DataItemRelativeBrowsePath [String] (配列)
  • ElementAccess [ElementAccess]
  • 結果 [レシピデータ項目値の取得の結果]
    • 成功: レシピデータ項目値が正常に取得されました
    • ジェネリックエラー: データ項目値の取得中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました
    • データ項目が見つかりません: 指定されたデータ項目がレシピに見つかりませんでした
    • 予期しない空のレシピ名: 指定されたレシピ名が空かnullです
    • RecipeNotFound: ストアで指定されたレシピが見つかりませんでした
CreateEditModel
  • ParentNodeId [NodeId]
  • RequesterNodeId [NodeId]
  • TargetNodeId [NodeId]
  • レシピID [レシピID]
  • 結果 [編集モデル作成の結果コード]
    • 成功: 編集モデルが正常に作成されました
    • ジェネリックエラー: 編集モデルの作成中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました
    • ParentNodeNotFound: 編集モデルの親ノードが見つかりませんでした
    • RequesterNodeNotFound: リクエスターノードが見つかりませんでした
TransferFromStores
レシピID [レシピID]
  • 結果 [ストアからの転送の結果コード]
    • 成功: レシピがストアから正常に転送されました
    • ジェネリックエラー:ストアからの転送中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました
    • RecipeNotFound: ストアで指定されたレシピが見つかりませんでした
    • ターゲットが見つかりません: 転送のターゲットノードが見つかりませんでした
TransferToStore
  • レシピID [レシピID]
  • 結果 [ストアへの転送の結果コード]
    • 成功:レシピが正常にストアに転送されました
    • ジェネリックエラー:ストアへの転送中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました
ターゲットへの転送
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicy]
  • 結果 [ターゲットへの転送の結果コード]
    • 成功: レシピがターゲットに正常に転送されました
    • ジェネリックエラー:ターゲットへの転送中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました
    • ターゲットが見つかりません: 転送のターゲットノードが見つかりませんでした
    • データの不一致: レシピデータとターゲット構造の間にミスマッチがあります
TransferFromTarget
  • TargetNodeId [NodeId]
  • ErrorPolicy [ErrorPolicy]
  • 結果 [ターゲットからの転送の結果コード]
    • 成功: レシピがターゲットから正常に転送されました
    • ジェネリックエラー: ターゲットからの転送中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました
    • ターゲットが見つかりません: 転送のターゲットノードが見つかりませんでした
    • データの不一致: ターゲットデータとレシピ構造の間にミスマッチがあります。
SetDataItemValue
  • ItemId [NodeId]
  • DataItemRelativeBrowsePath [String] (配列)
  • ElementAccess [ElementAccess]
  • DataTypeId [NodeId]
  • 値 [BaseDataType]
  • 結果 [データ項目値設定の結果コード]
    • 成功: データ項目の値が正常に設定されました
    • ジェネリックエラー: データ項目値の設定中に一般的なエラーが発生しました
    • ストアエラー: ストアへのアクセス中にエラーが発生しました
    • データ項目が見つかりません: 指定されたデータ項目が見つかりませんでした

イベント

レシピスキーマには、以下のイベントが含まれます。
リファクタ完了
メソッドリファクタが完了したときに発生します。
レシピアプリケーションイベント
TransferFromStoreToTarget または TransferEditModelToTarget が完了したときに発生します。

パラメーターとメタデータ

レシピスキーマは、無制限のパラメーターとメタデータで作成、編集、保存できます。作成者や作成日、関連する画像などのカスタムメタデータを定義して保存できるため、レシピのトレーサビリティおよびコンテキストの理解が向上します。

データベーステーブル

レシピスキーマモデル構造はデータベースに保存でき、変数が単独で存在する場合でもオブジェクトの一部である場合でも情報を保持できます。レシピパラメーターは、以下のように整理された行に表示されます。
  • レシピ:
    • Id (主キー) [UInt32]
    • 名前 [String]
    • バージョン [String]
    • RecipeSchemaName [String]
    • RecipeSchemaNamespaceUri [String]
    • RecipeSchemaTimestamp [日時]
    • CreatedAt [日時]
    • ModifiedAt [日時]
  • RecipeItems:
    • Id (主キー) [UInt32]
    • レシピID [UInt32]
    • RelativeBrowsePath [String]
    • TypeId [String]
  • RecipeDataItems:
    • Id (主キー) [UInt32]
    • RecipeItemId [UInt32]
    • RelativeBrowsePath [String]
    • ElementAccess [String]
    • DataTypeId [String]
    • 値 [String]
  • レシピメタデータ:
    • Metadata1 [UserDefined]
    • Metadata2 [UserDefined]
    • Metadata_n [UserDefined]
ご質問やご意見
このドキュメントに関するご質問やご意見は、こちらまでお寄せください。 こちらからご意見をお寄せください。
Normal