ProcessMiningIntegrationAPI :スコープ指定

  • リリースバージョン: Zurich
  • 更新日 2025年07月31日
  • 所要時間:35分
  • ProcessMiningIntegrationAPI スクリプトインクルードは、プロセスマイニングプロジェクトを管理し、検出結果とブレークダウンを取得するためのメソッドを提供します。

    このスクリプトインクルードには、プロセスマイニングコアプラグイン (com.sn_process_optimization) が必要です。詳細については、「Process Mining」を参照してください。

    呼び出し元ユーザーには、sn_process_optimization_analyst または sn_process_optimization_power_user ロールが必要です。

    次のシステムプロパティを使用して、API 機能を管理できます。
    promin.limit.api.project_creation
    API を使用して毎日作成できるプロジェクトの数を制限します。

    デフォルト:25。

    promin.limit.api.max_daily_minings
    API を使用して毎日スケジュールできるマイニングの数を制限します。

    デフォルト:25。

    promin.limit.api.max_daily_minings_per_project
    API を使用してプロジェクトごとに毎日スケジュールできる マイニング の数を制限します。

    デフォルト:1。

    promin.api.allow_no_role_mining
    sn_process_optimization_analystロールを持たないユーザーがプロジェクトをマイニングできるようにします。

    デフォルト値:false。

    promin.api.auto_share_project_with_creator
    プロジェクトの作成者とプロジェクトを自動的に共有します。

    デフォルト値:false。

    ProcessMiningIntegrationAPI:createProject(文字列テーブル、アレイアクティビティ、アレイブレークダウン、文字列encodedQuery、文字列 templateType、オブジェクト権限、ブール値 autoRetire)

    プロセスマイニングプロジェクトを作成します。

    プロジェクトは、プロセスマイニング操作の詳細計画として機能します。マイニングを実行するプロセスと、マイニング中に考慮されるプロセスの属性を選択します。

    表 : 1. パラメーター
    名前 タイプ 説明
    table 文字列 分析するデータを含むテーブルの名前。
    アクティビティ アレイ プロジェクトのアクティビティ定義。

    アクティビティ定義は、ステータスやアサイン先グループなど、マイニング中に考慮するプロセスの属性です。table パラメーターで指定されたテーブルの列である必要があります。プロジェクトをマイニングするには、少なくとも 1 つのアクティビティ定義が必要です。アクティビティ定義の詳細については、「 Set activity definitions」を参照してください。

    注:
    アクティビティ定義は、 templateType パラメーターで指定されたプロジェクトテンプレートにも含まれています。activities パラメーターを使用して、テンプレートに含まれていない追加のアクティビティを指定します。
    ["<column_name>"]
    ブレークダウン アレイ プロジェクトのブレークダウン定義。

    ブレークダウン定義を使用すると、レコードをフィルタリングし、優先度やビジネスカテゴリなどのカテゴリ別にプロセスマップを分析できます。table パラメーターで指定されたテーブルの列である必要があります。プロジェクトのマイニングにブレークダウン定義は必要ありません。ブレークダウン定義の詳細については、「 Set breakdown definitions」を参照してください。

    注:
    ブレークダウン定義は、 templateType パラメーターで指定されたプロジェクトテンプレートにも含まれています。breakdownsパラメーターを使用して、テンプレートに含まれていない追加のブレークダウンを指定します。
    ["<column_name>"]
    encodedQuery 文字列 分析するデータを選択するためのエンコードされたクエリ。これにより、指定した期間のデータのみを選択するなど、分析するデータを制限できます。

    テーブルにすべてのデータを含めるには、空の文字列を渡します。

    templateType 文字列 プロジェクトに使用するテンプレートのタイプ。
    有効な値:
    • デフォルト
    • デジタルポートフォリオ管理
    • ベンダー管理
    • WFO

    WFO、ベンダー管理、またはデジタルポートフォリオ管理の一部ではないプロジェクトの場合は、[デフォルト] を選択します。たとえば、パフォーマンスアナリティクスプロジェクトを作成するには、[デフォルト] を選択します。

    permissions オブジェクト プロジェクトを共有するグループ、ロール、およびユーザーのマップ。キーはsys_idで、値はタイプ (グループ、ロール、またはユーザー) を指定します。

    プロジェクトが共有されているすべてのユーザーは、解析されたモデルを表示し、プロジェクト構成を表示できます。sn_process_optimization_analystまたはsn_process_optimization_power_userを持つユーザーのみがプロジェクトをマイニングできます。

    {
       "<user_sys_id>":"user",
       "<role_sys_id>":"role",
       "<group_sys_id>":"group"
    }
    自動廃止 ブール

    オプション。プロジェクトを自動的に廃止するかどうかを示すフラグ。

    有効な値:
    • true:プロジェクトは作成から 7 日後に自動的に廃止されます。
    • false:プロジェクトは自動的に廃止されません。

    デフォルト値:False

    表 : 2. 返される内容
    タイプ 説明
    オブジェクト プロジェクトに関する情報を含むオブジェクト。
    {
       "entity": {Object},
       "findingDefinitionKPIMap": {Object},
       "id": "String",
       "lastMined": String",
       "miningState": "String",
       "name": "String",
       "permissions": [Array],
       "retiredDate": "String"
    }
    <Object>。実体 プロジェクトで分析されたデータに関する情報を含むオブジェクト。

    データタイプ: オブジェクト

    {
       "activityDefinitions": [Array],
       "breakdownDefinitions": [Array],
       "condition": "String,"
       "table": "String"
    }
    <Object>.entity.activityDefinitions プロジェクトのアクティビティ定義。

    データタイプ:アレイ

    [
       {
          "activityOfInterest":Boolean,
          "field":"String",
          "type":"String"      
       }
    ]
    <Object>.entity.activityDefinitions.activityOfInterest

    フィールドの変更をアナリストワークベンチに表示するかどうかを示すフラグ。

    有効な値:
    • true:フィールドの変更がアナリストワークベンチに表示されます。
    • false:フィールドの変更は Analyst Workbench には表示されませんが、移行または検出結果のコンテキスト条件で使用できます。
    <Object>.entity.activityDefinitions.field 分析するデータを含むフィールド。フィールドは、 table パラメーターで指定されたテーブルのものである必要があります。
    <Object>.entity.activityDefinitions.type マイニングする値のタイプ。
    有効な値:
    • フィールド値 (デフォルト):これがデフォルトの選択です。このオプションは、アクティビティ定義を作成するたびに使用できます。
    • 日時:監査履歴ではなく実際のレコードの日時値を使用し、プロセスマップにグループ化されたノードとして表示されます。
    • 複合:監査履歴ではなく、実際のレコードの複数フィールド値の 変更 を表す 1 つのノードまたはプロセスグラフ。
    • 添付された子:このオプションは、テーブル構成用に 2 つのテーブルを選択し、親子関係を設定した場合に使用できます。このオプションは、親テーブル構成でのみ使用できます。可視化では、子がいつプロセスで添付されたかがわかります。
    • 添付された親:このオプションは、親レコードがいつ子に添付されたかを表すノードを子プロセスに作成します。
    <Object>.entity.breakdownDefinitions プロジェクトのブレークダウン定義。

    データタイプ:アレイ

    [
     {
       "field":"String",
       "fieldLabel":"String"
     }
    ]
    <Object>.entity.breakdownDefinitions.field ブレークダウンで使用されるフィールドの名前。

    データタイプ:文字列

    <Object>.entity.breakdownDefinitions.fieldLabel ブレークダウンで使用されるフィールドのラベル。

    データタイプ:文字列

    <Object>.entity.condition 分析するデータを選択するためのエンコードされたクエリ。

    データタイプ:文字列

    <Object>.entity.table 分析するデータを含むテーブルの名前。

    データタイプ:文字列

    <Object>.findingDefinitionKPIMap 検索定義と重要業績評価指標 (KPI) のマップ。キーは検索定義sys_idで、値は検索定義の影響を受ける KPI のsys_idsのアレイです。

    検索定義は、検索定義 [promin_finding_def] および自動検索定義 [promin_automated_finding] テーブルにあります。KPI はインジケーター [pa_indicators] テーブルにあります。

    検索定義と KPI の詳細については、「 Working with finding definitionsViewing business insights」を参照してください。

    データタイプ: オブジェクト

    {
       "<finding_def_sys_id":[
          "<kpi_sys_id>"
       ]
    }
    <Object>。身分証明書 プロジェクトのSys_id。

    テーブル:プロジェクト定義 [promin_project]

    データタイプ:文字列

    <Object>.lastMined プロジェクトが最後にマイニングされた日付。

    データタイプ:文字列

    <Object>.miningState プロジェクトのマイニングステータス。

    マイニング状態の説明については、「 Mine states」を参照してください。

    データタイプ:文字列

    <Object>.name プロジェクトの名前。

    データタイプ:文字列

    <Object>。権限 プロジェクトのグループ、ロール、およびユーザー権限。

    データタイプ: オブジェクト

    [
       {
          "type":"String",
          "value":"String"      
       }
    ]
    <Object>.permissions.type 権限のタイプ。
    有効な値:
    • グループ
    • ロール
    • user

    データタイプ:文字列

    <Object>.permissions.value 権限を付与するグループ、ロール、またはユーザーのSys_id。

    データタイプ:文字列

    <Object>.retiredDate プロジェクトが廃止される日付。

    データタイプ:文字列

    この例では、先月作成されたインシデントのデータを使用してプロジェクトを作成します。

    SNC.ProcessMiningIntegrationAPI
    .createProject(
    "incident", // table name
    ["state"], // activity definitions
    ["priority"], // breakdown definitions
    "sys_created_onONLast month@javascript:gs.beginningOfLastMonth()@javascript:gs.endOfLastMonth()", // incident created on last month
    "DEFAULT", // template type
    {"02acf036b3120010ed7fc9c316a8dc0c":"user"}, // map of permissions "sys_id":"type"
    true // auto retire project
    );

    出力:

    {
       "entity":{
          "table":"incident",
          "condition":"sys_created_onONLast month@javascript:gs.beginningOfLastMonth()@javascript:gs.endOfLastMonth()",
          "activityDefinitions":[
             {
                "field":"assignment_group",
                "type":"DEFAULT",
                "activityOfInterest":false
             },
             {
                "field":"business_service",
                "type":"DEFAULT",
                "activityOfInterest":false
             },
             {
                "field":"category",
                "type":"DEFAULT",
                "activityOfInterest":false
             },
             {
                "field":"priority",
                "type":"DEFAULT",
                "activityOfInterest":false
             },
             {
                "field":"state",
                "type":"DEFAULT",
                "activityOfInterest":false
             }
          ],
          "breakdownDefinitions":[
             {
                "field":"contact_type",
                "fieldLabel":"Channel"
             },
             {
                "field":"assignment_group",
                "fieldLabel":"Assignment group"
             },
             {
                "field":"location",
                "fieldLabel":"Location"
             },
             {
                "field":"priority",
                "fieldLabel":"Priority"
             },
             {
                "field":"category",
                "fieldLabel":"Category"
             }
          ]
       },
       "name":"Incident Process",
       "permissions":[
          {
             "value":"62826bf03710200044e0bfc8bcbe5df1",
             "type":"user"
          },
          {
             "value":"02acf036b3120010ed7fc9c316a8dc0c",
             "type":"user"
          }
       ],
       "id":"a4286c4f4f831210c98b8a4a91ce0bf5",
       "miningState":"NEW",
       "findingDefinitionKPIMap":{
          "f23c20c34fc31210c98b8a4a91ce0bac":[
             "002d65c3d7131100b96d45a3ce6103e2"
          ]
       },
       "retiredDate":null,
       "lastMined":null
    }

    ProcessMiningIntegrationAPI - deleteProject(文字列 projectId)

    プロセスマイニングプロジェクトを削除します。

    表 : 3. パラメーター
    名前 タイプ 説明
    projectId 文字列 プロジェクトのSys_id。

    テーブル:プロジェクト定義 [promin_project]

    表 : 4. 返される内容
    タイプ 説明
    なし

    この例では、プロセスマイニングプロジェクトを削除します。

    SNC.ProcessMiningIntegrationAPI.deleteProject("a4286c4f4f831210c98b8a4a91ce0bf5");

    ProcessMiningIntegrationAPI:getBreakDownStats(文字列 projectId)

    プロセスマイニングプロジェクトのブレークダウン統計情報を取得します。

    ブレークダウンを使用すると、レコードをフィルタリングし、優先度やビジネスカテゴリなどのカテゴリ別にプロセスを分析できます。

    表 : 5. パラメーター
    名前 タイプ 説明
    projectId 文字列 プロジェクトのSys_id。

    テーブル:プロジェクト定義 [promin_project]

    表 : 6. 返される内容
    タイプ 説明
    アレイ ブレークダウンオブジェクトのアレイ。各オブジェクトには、ブレークダウンの統計情報が含まれています。
    [
       {
          "caseCount": Number,
          "field": "String",
          "fieldValue": "String",
          "performanceStats": {Object},
          "tableName": "String",
          "variantCount": Number     
       }
    ]
    <Array>.caseCount このブレークダウンの一部であるケースレコード [promin_case_record] テーブルのケースの数。

    データタイプ:数値

    <Array>.field ブレークダウンに使用されるフィールド。

    データタイプ:文字列

    <Array>.fieldValue ブレークダウンに使用されるフィールド値。

    データタイプ:文字列

    <Array>.performanceStats ブレークダウンのパフォーマンス統計情報。
    {
       "max": Number,
       "mean": Number,
       "median": Number, 
       "min": Number,  
       "n": Number, 
       "q1": Number, 
       "q3": Number, 
       "q4": Number, 
       "stdDeviation": Number, 
       "sum": Number, 
       "total": Number, 
       "trimmedAverage": Number, 
       "trimmedPercentage": Number
    }

    データタイプ: オブジェクト

    <アレイ>.performanceStats.max レコードがルートを完了するために要した最長時間。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.mean レコードが開かれてからクローズされるまでに、レコードがルートを完了するまでにかかった平均時間。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.median 期間の中央値、または 2 つの中間値の平均。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.min レコードがルートを完了するのにかかった最短時間。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.n このブレークダウンの一部であるレコードの数。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.q1 期間の第 1 四分位値。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.q3 期間の第 3 四分位値。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.q4 期間の第 4 四分位値 (最大)。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.stdDeviation 工順期間の平均値からの変動。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.sum ルートをたどるすべてのレコードの、最初のイベントから最後のイベントまでのすべての期間の合計。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.total ルートをたどるすべてのレコードの、最初のイベントから最後のイベントまでのすべての期間の合計。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.trimmedAverage レコードがルートを完了するまでにかかった平均時間。最小値と最大値の割合を削除した後に計算されます。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.trimmedPercentage trimmedAverage値の計算に使用されるパーセンテージ。

    データタイプ:数値

    <Array>.tableName ブレークダウンに使用されるテーブル。

    データタイプ:文字列

    <Array>.variantCount このブレークダウンに対応するバリアントの数 (プロセスで実行されるアクティビティの一意のシーケンス)。

    データタイプ:数値

    この例では、プロジェクトのブレークダウン統計を取得します。

    SNC.ProcessMiningIntegrationAPI.getBreakDownStats("a4286c4f4f831210c98b8a4a91ce0bf5");

    出力:

    [
       {
          "fieldValue":"1",
          "field":"priority",
          "tableName":"incident",
          "variantCount":21,
          "caseCount":33,
          "performanceStats":{
             "sum":6.4945381E7,
             "min":0.0,
             "max":5.2334704E7,
             "n":33,
             "median":0.0,
             "mean":0.0,
             "total":64945381,
             "stdDeviation":9144841.0,
             "trimmedAverage":165594.0,
             "trimmedPercentage":-1.0,
             "q1":0.0,
             "q3":313333.0,
             "q4":5.2334704E7
          }
       }
    ]

    ProcessMiningIntegrationAPI:getFindings(文字列 projectId)

    プロセスマイニングプロジェクトの結果を取得します。

    表 : 7. パラメーター
    名前 タイプ 説明
    projectId 文字列 プロジェクトのSys_id。

    テーブル:プロジェクト定義 [promin_project]

    表 : 8. 返される内容
    タイプ 説明
    アレイ 検出結果オブジェクトのアレイ。
    [
       {
          "caseIds":[],  
          "category": "String",
          "categoryDescription": "String",
          "categoryLabel": "String",
          "createdOn": Number, 
          "findingDefId": "String", 
          "id": "String",
          "impactedKpis": [],
          "matchingRecords": Number,
          "message": "String",
          "performanceStats": {},
          "shortMessage": "String",
          "tableName": "String",
          "totalRecords": Number,
          "type": "String",
          "typeLabel": "String",    
          "versionId": "String"  
       }
    ]
    <Array>.caseIds 検索パターンに一致する ケースの ID のリスト。ケースレコード [promin_case_record] テーブルの [ケース ID] 列にあります。

    データタイプ:アレイ

    <Array>.category 検出結果のカテゴリ。
    可能な値:
    • 自動化
    • COMPLIANCE
    • 準拠
    • 費用
    • パフォーマンス
    • 品質
    • 速度

    データタイプ:文字列

    <Array>.categoryDescription 結果カテゴリの説明。

    データタイプ:文字列

    <Array>.categoryLabel 結果カテゴリのラベル。

    データタイプ:文字列

    <Array>.createdOn 検出結果の作成日。

    データタイプ:数値

    <Array>.findingDefId 検索定義のSys_id。

    検索定義は、検索定義 [promin_finding_def] および自動検索定義 [promin_automated_finding] テーブルにあります。

    データタイプ:文字列

    <Array>.id 検出結果のSys_id。結果 [promin_finding] テーブルにあります。

    データタイプ:文字列

    <Array>.impactedKpis 検出結果の影響を受ける KPI の sys_ids のリスト。インジケーター [pa_indicators] テーブルにあります。

    データタイプ:アレイ

    <Array>.matchingRecords 検索パターンに一致するケースレコード [promin_case_record] テーブルのケース ID の数。

    データタイプ:数値

    <Array>.message 検索定義からのメッセージ。

    データタイプ:文字列

    <Array>.performanceStats 検出結果のパフォーマンス統計情報。
    {
       "max": Number,
       "mean": Number,
       "median": Number, 
       "min": Number,  
       "n": Number, 
       "q1": Number, 
       "q3": Number, 
       "q4": Number, 
       "stdDeviation": Number, 
       "sum": Number, 
       "total": Number, 
       "trimmedAverage": Number, 
       "trimmedPercentage": Number
    }

    データタイプ: オブジェクト

    <アレイ>.performanceStats.max レコードがルートを完了するために要した最長時間。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.mean レコードが開かれてからクローズされるまでに、レコードがルートを完了するまでにかかった平均時間。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.median 期間の中央値、または 2 つの中間値の平均。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.min レコードがルートを完了するのにかかった最短時間。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.n この検出結果に含まれるレコードの数。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.q1 期間の第 1 四分位値。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.q3 期間の第 3 四分位値。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.q4 期間の第 4 四分位値 (最大)。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.stdDeviation 工順期間の平均値からの変動。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.sum ルートをたどるすべてのレコードの、最初のイベントから最後のイベントまでのすべての期間の合計。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.total ルートをたどるすべてのレコードの、最初のイベントから最後のイベントまでのすべての期間の合計。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.trimmedAverage レコードがルートを完了するまでにかかった平均時間。最小値と最大値の割合を削除した後に計算されます。

    データタイプ:数値

    単位:ミリ秒

    <Array>.performanceStats.trimmedPercentage trimmedAverage値の計算に使用されるパーセンテージ。

    データタイプ:数値

    <Array>.shortMessage 検索定義からの短いメッセージ。

    データタイプ:文字列

    <Array>.tableName 検索結果で使用されるテーブルの名前。

    データタイプ:文字列

    <Array>.totalRecords マイニングで分析されたレコードの合計数。

    データタイプ:数値

    <Array>.type 検索定義のタイプ。
    可能な値:
    • EXTRA_STEP
    • EXTREME_DURATION
    • EXTREME_REPETITION
    • その他
    • パターン
    • PERFORMANCE_OUTLIER
    • 卓球
    • リワーク

    詳細については、「Automated improvement opportunities」を参照してください。

    <Array>.typeLabel 検索定義タイプのラベル。

    データタイプ:文字列

    <Array>.versionId プロジェクトバージョンのSys_id。プロジェクト定義バージョン [promin_model_def_version] テーブルにあります。

    データタイプ:文字列

    この例では、プロジェクトの検索結果を取得します。

    SNC.ProcessMiningIntegrationAPI.getFindings("a4286c4f4f831210c98b8a4a91ce0bf5");

    出力:

    [
       {
          "message":"Rework on Closed",
          "id":"0ef09b2e1c6cf0d98045e6ba1c3c9edb",
          "type":"REWORK",
          "createdOn":1727036052.000000000,
          "category":"AUTOMATION",
          "tableName":"incident",
          "categoryLabel":"Automation",
          "matchingRecords":111,
          "versionId":"9a2f187177b412102f7a1b56ba5a99e2",
          "totalRecords":19758,
          "findingDefId":"791f587177b412102f7a1b56ba5a99eb",
          "categoryDescription":"Category that groups all opportunities that are subject to automation.",
          "impactedKpis":[
             
          ],
          "performanceStats":{
             "sum":2.09532828E8,
             "min":1.0,
             "max":6563078.0,
             "n":111,
             "median":1036715.0,
             "mean":1.0,
             "total":209532828,
             "stdDeviation":1855944.0,
             "trimmedAverage":1716904.0,
             "trimmedPercentage":-1.0,
             "q1":776859.0,
             "q3":2246368.0,
             "q4":6563078.0
          },
          "typeLabel":"Automation",
          "shortMessage":"Closed",
          "caseIds":[
             "119e4a569397fd14849bbcd74dba1018",
             "b16b355f47197190498cc044846d43b0",
             "cf9bca7597fe7d90ef889504a253af9e",
          ]
       }
    ]

    ProcessMiningIntegrationAPI:getMiningStatus(文字列 projectId)

    プロセスマイニングプロジェクトのマイニングステータスを取得します。

    表 : 9. パラメーター
    名前 タイプ 説明
    projectId 文字列 プロジェクトのSys_id。

    テーブル:プロジェクト定義 [promin_project]

    表 : 10. 返される内容
    タイプ 説明
    オブジェクト プロジェクトsys_idとトラッカーを含むオブジェクト。
    {
       "projectId":"String",
       "trackerId":"String"  
    }
    <Object>.projectId プロジェクトのSys_id。

    テーブル:プロジェクト定義 [promin_project]

    データタイプ:文字列

    <Object>.trackerId プロジェクトのマイニングの進行状況を監視するトラッカーのSys_id。

    テーブル:実行トラッカー [sys_execution_tracker]

    データタイプ:文字列

    この例では、プロジェクトのマイニングステータスを取得します。

    SNC.ProcessMiningIntegrationAPI.getMiningStatus("c0b91f0cff01121047cae835f2cb14bc");

    出力:

    {
       "trackerId":"aec9530cff01121047cae835f2cb147e",
       "projectId":"c0b91f0cff01121047cae835f2cb14bc"
    }

    ProcessMiningIntegrationAPI - getProject(文字列 projectId)

    プロセスマイニングプロジェクトを取得します。

    表 : 11. パラメーター
    名前 タイプ 説明
    projectId 文字列 プロジェクトのSys_id。

    テーブル:プロジェクト定義 [promin_project]

    表 : 12. 返される内容
    タイプ 説明
    オブジェクト プロジェクトに関する情報を含むオブジェクト。
    {
       "entity": {Object},
       "findingDefinitionKPIMap": {Object},
       "id": "String",
       "lastMined": String",
       "miningState": "String",
       "name": "String",
       "permissions": [Array],
       "retiredDate": "String"
    }
    <Object>。実体 プロジェクトで分析されたデータに関する情報を含むオブジェクト。

    データタイプ: オブジェクト

    {
       "activityDefinitions": [Array],
       "breakdownDefinitions": [Array],
       "condition": "String,"
       "table": "String"
    }
    <Object>.entity.activityDefinitions プロジェクトのアクティビティ定義。

    データタイプ:アレイ

    [
       {
          "activityOfInterest":Boolean,
          "field":"String",
          "type":"String"      
       }
    ]
    <Object>.entity.activityDefinitions.activityOfInterest

    フィールドの変更をアナリストワークベンチに表示するかどうかを示すフラグ。

    有効な値:
    • true:フィールドの変更がアナリストワークベンチに表示されます。
    • false:フィールドの変更は Analyst Workbench には表示されませんが、移行または検出結果のコンテキスト条件で使用できます。
    <Object>.entity.activityDefinitions.field 分析するデータを含むフィールド。フィールドは、 table パラメーターで指定されたテーブルのものである必要があります。
    <Object>.entity.activityDefinitions.type マイニングする値のタイプ。
    有効な値:
    • フィールド値 (デフォルト):これがデフォルトの選択です。このオプションは、アクティビティ定義を作成するたびに使用できます。
    • 日時:監査履歴ではなく実際のレコードの日時値を使用し、プロセスマップにグループ化されたノードとして表示されます。
    • 複合:監査履歴ではなく、実際のレコードの複数フィールド値の 変更 を表す 1 つのノードまたはプロセスグラフ。
    • 添付された子:このオプションは、テーブル構成用に 2 つのテーブルを選択し、親子関係を設定した場合に使用できます。このオプションは、親テーブル構成でのみ使用できます。可視化では、子がいつプロセスで添付されたかがわかります。
    • 添付された親:このオプションは、親レコードがいつ子に添付されたかを表すノードを子プロセスに作成します。
    <Object>.entity.breakdownDefinitions プロジェクトのブレークダウン定義。

    データタイプ:アレイ

    [
     {
       "field":"String",
       "fieldLabel":"String"
     }
    ]
    <Object>.entity.breakdownDefinitions.field ブレークダウンで使用されるフィールドの名前。

    データタイプ:文字列

    <Object>.entity.breakdownDefinitions.fieldLabel ブレークダウンで使用されるフィールドのラベル。

    データタイプ:文字列

    <Object>.entity.condition 分析するデータを選択するためのエンコードされたクエリ。

    データタイプ:文字列

    <Object>.entity.table 分析するデータを含むテーブルの名前。

    データタイプ:文字列

    <Object>.findingDefinitionKPIMap 検索定義と重要業績評価指標 (KPI) のマップ。キーは検索定義sys_idで、値は検索定義の影響を受ける KPI のsys_idsのアレイです。

    検索定義は、検索定義 [promin_finding_def] および自動検索定義 [promin_automated_finding] テーブルにあります。KPI はインジケーター [pa_indicators] テーブルにあります。

    検索定義と KPI の詳細については、「 Working with finding definitionsViewing business insights」を参照してください。

    データタイプ: オブジェクト

    {
       "<finding_def_sys_id":[
          "<kpi_sys_id>"
       ]
    }
    <Object>。身分証明書 プロジェクトのSys_id。

    テーブル:プロジェクト定義 [promin_project]

    データタイプ:文字列

    <Object>.lastMined プロジェクトが最後にマイニングされた日付。

    データタイプ:文字列

    <Object>.miningState プロジェクトのマイニングステータス。

    マイニング状態の説明については、「 Mine states」を参照してください。

    データタイプ:文字列

    <Object>.name プロジェクトの名前。

    データタイプ:文字列

    <Object>。権限 プロジェクトのグループ、ロール、およびユーザー権限。

    データタイプ: オブジェクト

    [
       {
          "type":"String",
          "value":"String"      
       }
    ]
    <Object>.permissions.type 権限のタイプ。
    有効な値:
    • グループ
    • ロール
    • user

    データタイプ:文字列

    <Object>.permissions.value 権限を付与するグループ、ロール、またはユーザーのSys_id。

    データタイプ:文字列

    <Object>.retiredDate プロジェクトが廃止される日付。

    データタイプ:文字列

    この例では、プロセスマイニングプロジェクトを取得します。

    SNC.ProcessMiningIntegrationAPI.getProject("fa465748ff01121047cae835f2cb1473");

    出力:

    {
       "entity":{
          "table":"incident",
          "activityDefinitions":[
             {
                "field":"assignment_group",
                "type":"DEFAULT",
                "activityOfInterest":false
             },
             {
                "field":"business_service",
                "type":"DEFAULT",
                "activityOfInterest":false
             },
             {
                "field":"state",
                "type":"DEFAULT",
                "activityOfInterest":false
             },
             {
                "field":"category",
                "type":"DEFAULT",
                "activityOfInterest":false
             },
             {
                "field":"priority",
                "type":"DEFAULT",
                "activityOfInterest":false
             }
          ],
          "condition":"",
          "breakdownDefinitions":[
             {
                "field":"contact_type",
                "fieldLabel":"Channel"
             },
             {
                "field":"close_code",
                "fieldLabel":"Resolution code"
             },
             {
                "field":"assignment_group",
                "fieldLabel":"Assignment group"
             },
             {
                "field":"location",
                "fieldLabel":"Location"
             },
             {
                "field":"priority",
                "fieldLabel":"Priority"
             },
             {
                "field":"category",
                "fieldLabel":"Category"
             }
          ]
       },
       "name":"Incident Process",
       "permissions":[
          {
             "value":"some_group_sys_id",
             "type":"group"
          },
          {
             "value":"some_role_sys_id",
             "type":"role"
          },
          {
             "value":"some_user_sys_id",
             "type":"user"
          }
       ],
       "id":"fa465748ff01121047cae835f2cb1473",
       "miningState":"NEW",
       "findingDefinitionKPIMap":{
          
       },
       "retiredDate":1728292672.622894000,
       "lastMined":null
    }

    ProcessMiningIntegrationAPI - scheduleMining(文字列 projectId)

    マイニング用のプロセスマイニングプロジェクトを送信します。

    表 : 13. パラメーター
    名前 タイプ 説明
    projectId 文字列 プロジェクトのSys_id。

    テーブル:プロジェクト定義 [promin_project]

    表 : 14. 返される内容
    タイプ 説明
    オブジェクト プロジェクトsys_idとトラッカーを含むオブジェクト。
    {
       "projectId":"String",
       "trackerId":"String"  
    }
    <Object>.projectId プロジェクトのSys_id。

    テーブル:プロジェクト定義 [promin_project]

    データタイプ:文字列

    <Object>.trackerId プロジェクトのマイニングの進行状況を監視するトラッカーのSys_id。

    テーブル:実行トラッカー [sys_execution_tracker]

    データタイプ:文字列

    この例では、マイニングのためにプロジェクトを送信します。

    SNC.ProcessMiningIntegrationAPI.scheduleMining("c0b91f0cff01121047cae835f2cb14bc");

    出力:

    {
       "trackerId":"aec9530cff01121047cae835f2cb147e",
       "projectId":"c0b91f0cff01121047cae835f2cb14bc"
    }