コード解析結果のチェックアウト
- 更新日 2023/12/06
コード解析結果のチェックアウト
Bot Creator (RPA 開発者) または市民開発者として、コード解析を使用して、オートメーション ファイル (タスク Bot または API タスク) のコーディングの誤りをチェックし、修正することができます。設定されたコード解析ポリシーや定義済みルールに基づいてオートメーションを開発することができます。
コード解析により、変数の命名規則、コメント欄、およびエラー処理など、コーディングのベスト プラクティスを実行することで、オートメーションの信頼性を向上させることができます。事前に定義されたガイドラインやルールに従ってオートメーションを構築することで、オートメーション開発中に発生する可能性のあるエラーを特定することができます。これにより、本番環境でのオートメーションの障害を削減できます。非公開ワークスペースと公開ワークスペースの両方でコード解析を実行し、結果を確認することができます。
- 必要に応じて、コード解析を実行する。
- ルールを遵守するためのツールチップの説明が提供される。
- アカウンティングとガイダンスのためにアシスタントと統合する。
コード解析の結果
- 該当なし: 以下のいずれかの理由で、該当なしのステータスが表示されます。
- オブジェクトがタスク Bot または API タスク ファイルではないため、コード解析は適用されません。
- タスク Bot または API タスク ファイルまたはフォルダーにポリシーが割り当てられていません。タスク Bot または API タスク ファイルまたはフォルダーが N/A ステータスの場合、コード解析実行オプションの行レベル アクションは表示されません。N/A ステータスになっているこれらのオートメーションでは、コード解析は自動的には実行されません。
- 未スキャン: タスク Bot または API タスクでコード解析が実行されていません。
- 高い重大度: タスク Bot または API タスクに、1 つ以上の高い重大度の違反があります。
- 低い重大度: タスク Bot または API タスクに、1 つ以上の低い重大度の違反があるが、高い重大度の違反はありません。
- 違反なし: タスク Bot または API タスクにコード解析の違反がありません。
次の画像は、コード解析結果の例を示しています。
![[コード解析の結果] 列](https://automationanywhere-be-prod.automationanywhere.com/bundle/enterprise-v2019/page/enterprise-cloud/topics/control-room/administration/settings/../../../../../codeanalysisresultscolumn.png?_LANG=jajp)
- オートメーション ファイルは非公開ワークスペースで編集され、まだ保存されていません。
- 管理者がコード解析を最近有効にしたか、オートメーション ファイルに適用可能なポリシーでルール構成の一部が変更され、ファイルをスキャンするのを待機しています。
Bot エディターで結果を確認する
- 対象のオブジェクト: オートメーション ファイル、変数、アクション、アクション属性が表示されます。
- ルール コード: 一意の RULE_CODE ID。
- 重大度: [高] または [低]。
- ルール テキスト: コードに対して実行される評価の性質を示す記述。
次の画像は、アシスタントに表示されるコード解析の例を示しています。
| 属性 | ルール違反 |
|---|---|
| Bot |
|
| 変数 |
|
| アクション |
|
コード解析ヘッダーには、オートメーション ファイル内で違反エラーが発生したオブジェクトのカウントが表示されます。各オブジェクトには、重要度が低いものと高いものがあります。違反内容は、属性の後にライン番号と重大度が表示されます。重大度の高いエラーはすべて最初に表示されます。違反のあるオートメーション ファイルで該当する行に移動し、違反を修正して、オートメーションを保存します。
オートメーション ファイルを保存して、[アシスタント] で最新のコード解析結果を確認する必要があります。
Bot エディターでのコード解析違反とポリシーの詳細
プロと市民開発者は、キャンバス レベルでアクションのコード解析違反を見ることができます。違反インジケーターは、フローおよびリスト ビューで使用できるため、プロおよび市民開発者は、コード解析違反があるオートメーション内のアクションをすぐに確認して修正できます。開発者がオートメーション開発時に違反を容易に判断し、ベスト プラクティスを遵守できるようになれば、コード品質は向上します。
プロおよび市民開発者は、適用されたポリシーとポリシーに含まれるルールを表示するためにポリシー ページに移動する必要がなくなりました。現在のコード解析ポリシーとそのルールは、ドロップダウン メニューの Bot エディター内から直接確認できます (Bot エディターの右上にある縦の 3 点リーダーからアクセス)。これにより、[ポリシーの表示] および [ポリシーの管理] の権限を持っていないユーザーが、違反を表示するだけでなく、Bot エディター自体でオートメーションを編集しながら、現在のポリシーとそのルールを表示できるようになります。
システム作成変数
入力変数や出力変数、パッケージ提案変数、自動生成変数 (ウィンドウ変数) など、システムが生成した変数は、コード解析規則でフォーマットが定義されていない場合、コード解析のデフォルト変数命名規則、またはパスカル ケースを使用します。
監査ログ
- Bot名
- ユーザー情報
- コード解析を開始する方法 ([保存] オプションまたは [コード解析を実行] オプション)
- コード解析 (コード解析プロセスでキャプチャされた場合のコード ライン数などの詳細を含む) の実行に要した時間
- 違反の合計数
- 違反の詳細