カスタムコードのスニペット

スクリプトによっては、Studioアクションのみでは提供できない複雑な操作が必要とされます。 Studioを使用すると、スクリプトにカスタムコードを追加できます。 これにより、組織のニーズに合わせてスクリプトをカスタマイズすることができます。

カスタムコードの作成にはスクリプトやプログラミングの知識が必要です。 Studioは、Snippetで使用するために開発された、Studioと呼ばれるカスタムプログラミング言語を使用しています。 この言語の使い方を学べるよう、オンラインヘルプに完全なテクニカルリファレンスガイドが用意されています。

スニペットに関する重要ポイント

  • コードスニペットは、スクリプトの構成と効率を向上させるのに役立ちます。 いつ、どのように実行するか、および実行されるプロセスをさらに効果的にコントロールできるようになります。 独自の変数やオブジェクトを作成し、IF、FOR、FOREACHなどのステートメントを使用してプログラミングロジックを追加できます。
  • 製品や機能によってはスニペットを必要としますが、必要ない場合でもスクリプトで使用することができます。
  • 製品や機能でコードスニペットが必要な場合、含める必要があるスニペットに関する詳細情報はオンラインヘルプに提供されています。 スクリプトでのコードスニペットの使い方を示すため、スクリプトの例も含まれています。 製品や機能を実装するには、追加のスクリプトが必要になる場合があります。
  • Snippetスクリプト言語は.NETフレームワークに基づいて構築されています。 この言語はサーバー側で実行され、C#やVisual Basic .NETと同様にMSIL（Microsoft Intermediate Language）にコンパイルされます。

スニペットアクション

スクリプトにカスタムコードを追加するには、Snippetアクションが必要です。 このアクションをダブルクリックするとエディターウィンドウが開き、カスタムコードを追加できます。 エディターウィンドウではコードをデバッグすることもできます。 場合によってはスクリプトに複数のSnippetアクションを含める必要があります。 複数のアクションを使用する場合、各アクションのCaptionフィールドをその目的がわかるようなフレーズで更新してください。

Snippetアクションの配置は重要です。 Snippetが変数に値を代入する場合、その値を必要とするアクションの前にこれを配置しなければなりません。 一方、Snippetに、受け取った値に基づいて行われる意思決定コードが含まれる場合、Snippetはその値を提供するアクションの後に配置しなければなりません。

スニペットとアクションの比較

スニペットで行えることのいくつかは、Studioアクションを使って行うことも可能です。 たとえば、IFおよびFORステートメント用のアクションがあります。 また、カスタム変数を作成して値を代入するために使用できるASSIGNアクションもあります。 これらのアクションを使ってスクリプトにその機能を追加することも可能です。 しかし、スニペットを使用する方がより効率的です。

スニペットにコードを配置することで、スクリプトが整理されてわかりやすくなります。 これにより、スクリプトの作成作業がより簡単で効率的なものになります。 常にスニペットで変数を宣言する習慣をつけることで、今後特定の宣言を探す必要が生じたときに、検索する場所を少なくすることができます。

スクリプトにカスタムコードを追加する

Snippetアクションを使用すると、スクリプトにカスタムコードを追加できます。 このアクションは、ツールタブのデフォルトパレットにあるアドバンスセクションにあります。

  1. Studioで、スクリプトを開きます。
  2. Snippetアクションをスクリプト内の必要な場所に配置し、他のアクションに接続します。
  3. アクションをダブルクリックして、エディターウィンドウを開きます。 ここでコードを追加できます。

  4. コードの追加に使用するタブをクリックします。 各タブにコードを追加するさまざまな方法が提供されています。 以下のタブがあります。

  5. 必要に応じてコードをデバッグします。

  6. Applyをクリックすると、エディターウィンドウを閉じずにいつでも変更内容を保存することができます。
  7. コードの編集が終了したら、OKをクリックします。

テキストビューを使用したコード

スニペットウィンドウのテキストビュータブでは、Snippetコードを手書きで記述できます。 この言語の使い方を学べるよう、オンラインヘルプに完全なリファレンスガイドが用意されています。

  1. Studioで、スクリプトを開きます。
  2. Snippetアクションをスクリプトに追加し、ダブルクリックしてスニペットウィンドウを開きます。
  3. ツリービュータブの左側にコードを入力します。 コードは手動で入力するか、このヘルプサイトや別のスクリプトなど他のソースからコピーして貼り付けることができます。
  4. Tree Viewタブをクリックすると、あらかじめ定義されたキーワードからコードをいつでも追加できます。 上矢印ボタンと下矢印ボタンを使って、キーワードに関連するコードをスクリプト内の別の箇所に移動させることができます。
  5. 現在のコードの構文が正しいかどうかを確認するには、Check Syntaxアイコン構文チェックアイコン（3つの小さな緑色の丸に右向きの三角形）。をクリックします。 エラーがなければ、テキストビュータブの下部にあるツールバーのステータスフィールドに Okayステータスが表示されます。 エラーがある場合、エラーに関するポップアップメッセージが開き、ツールバーのステータスフィールドにもメッセージが表示されます。 たとえば、「Error at line 4」などと表示されます。
  6. 現在カーソルのある行をコメントに変換するには、Commentアイコンコメントアイコン（山かっこで囲まれた青いスラッシュ）。をクリックします。
  7. 現在カーソルのある行からコメント文字を削除するには、Uncommentアイコンコメント解除アイコン（山かっこで囲まれた青いスラッシュに、大きな赤いスラッシュが重なったアイコン）をクリックします。
  8. Applyをクリックすると、エディターウィンドウを閉じずにいつでも変更内容を保存することができます。
  9. コードの編集が終了したら、OKをクリックします。

ツリービューを使ったコーディング

スニペットプロパティウィンドウのツリービュータブは、カスタムコードの作成プロセスをガイドします。 あらかじめ定義されているキーワードのセットから選択することができます。

  1. Studioで、スクリプトを開きます。
  2. スクリプトにSnippetアクションを追加してダブルクリックし、スニペットウィンドウを開きます。
  3. ツリービュータブの下部にあるプラスのアイコン下向き矢印が付いたプラス記号。をクリックします。

  4. スニペットプロパティウィンドウのツリービュータブ。 緑色のプラスアイコンを押すと、スニペットコマンドのメニューが表示されます。

    コードに追加するキーワードを選択します。
  5. ウィンドウの左側のリストに表示されるキーワードをクリックして、そのプロパティを表示します。

  6. ウィンドウの右側のリストで、キーワードのプロパティを設定します。 以下の操作が可能です。

    • 各プロパティを選択して、右側ペインの下のスペースでプロパティの定義を確認します。
    • このページのスニペットキーワードセクションを参照し、各コマンドの設定についての詳細を確認します。
  7. 必要に応じてキーワードをさらに追加します。
  8. Text Viewタブを随時クリックして、従来のコーディング形式で記述されたコードを確認します。
  9. Applyをクリックすると、エディターウィンドウを閉じずにいつでも変更内容を保存することができます。
  10. コードの編集が終了したら、OKをクリックします。

スニペットコードをデバッグする

Snippetアクションには独自のデバッガがあり、これを使ってコードをチェックできます。 コードのデバッグはテキストビュータブでのみ可能です。

ツリービュータブでコードを作成した場合、テキストビュータブに切り替えるとデバッガを使えるようになります。 デバッガで問題が見つかった場合、指定された行番号に基づいてコード内の問題がある箇所を特定してください。 その後、ツリービュータブに戻って問題を修正することができます。

1行ずつコードをステップスルーしたり、ブレークポイントを使用するなど、追加のデバッグオプションを利用できます。 また、スニペットコードでTRACEステートメントを使用して、デバッグ時にテキストを出力することもできます。 この出力はスクリプトに含まれる問題を修正するために役立ちます。

  1. Studioで、Snippetアクションを含むスクリプトを開きます。
  2. Snippetアクションをダブルクリックします。
  3. Text View タブにコードがない場合、Snippetコードを追加します。
  4. Snippet editorウィンドウの右側で、Debuggerタブをクリックします。
  5. Debugアイコンの右側にある下矢印ボタンをクリックし、Start再生ボタン（緑の三角形）のアイコン。を選択します。

  6. コードに構文エラーがある場合は、Snippet editorウィンドウが展開されます。 コード内のすべてのエラーがウィンドウ下部のペインに表示されます。 エラーがない場合は、次のステップに進んでください。

    ウィンドウ下部にエラーペインがあるスニペットエディターウィンドウ。
    1. エラーを修正します。
    2. エラーを修正したら、CloseまたはClear Trace Outputアイコンをクリックしてエラーペインを閉じます。
    3. デバッガーをもう一度起動します。
  7. Variables as Text タブの内容を表示します。 このタブには、ブレークポイントを設定しなかった場合、すべてのコードが実行されたときの変数とその値が表示されます。
  8. スニペットコード内の行を1つ以上選択し、Comment out selected linesアイコンをクリックできます。 これは、コードの一部を削除して、デバッグの結果がどのように変わるかを確認したい場合に便利です。
  9. コメントアウトされたコードを1行以上選択し、Uncomment the selected linesアイコンをクリックすると、それらの行をスニペットに戻すことができます。