[Sitecore][SPE] SPE 使って、定期的にメールにてレポート

検証環境は次の通りです。

  • Sitecore Experience Platform 9.0 rev. 180604 (9.0 Update-2)
  • Sitecore PowerShell Extensions 5.0

概要:

よく、お客さんからいろいろなレポートが要求されるので、Sitecore Fast Queryをメインで使っていました。

一昨年より、SPEに切り替えてから、ずっと、SPEのみ使ってきました。今後よく使った簡単で便利なスクリプト

をメモ書きしていこうと思います。 

SPE Sitecore PowerShell Extensions (SPE) 

2019-05-09_01

始めとして、Sitecore PowerShell Extensions を使って定期的にレポートをメールで送信するメモ書きをします。

2019-05-09_02

昔、テレビで最大のインフォマーシャルキャッチフレーズを思い出し、 ”設定して忘れる ”のように、一度設定すれば、

いちいち確認しなくでも済す。今回、サイトコアのスケジューラーを使って、定期的にレポートを生成し、メールにて送る手順を書き留めます。

1.まず、管理しやすいようにカスタムスクリプトのフォルダを作成します。

 これにて、このサイトに特有な変更であるかどうかを一目瞭然です。       2019-05-09_03

2.スクリプトを追加します。毎週ごどに送るレポートを設定してみます。

2019-05-09_04

3.スクリプトのセクションにてウィークリーレポートのスクリプトを設定。

2019-05-09_05

4.ここにて直接スクリプトを書き、実行することもできますが、PowerShell ISEを使って編集することをお勧めです。

2019-05-09_06

特にディバグとイミディエイトウィンドウの機能をしようすればスクリプトの作成を楽々!!

2019-05-09_07

5.ウィークリーレポートのスクリプトを PowerShell ISE にて作成してみましょう。

まず、簡単なメールを送る関数を作成:

  1. 次に、何かのレポートを生成し、メールにて送る。

今回簡単に特定のテンプレートを使用しているアイテムの特定なフィードの値をチェックしてみましょう。

よく、検索に使用するのは検索可能かどうかというチェックボックスが使用されます。

サンプルテンプレートにチェックボックスを追加し、スクリプトにて検索可能なアイテムの一覧を取得します。

2019-05-09_08

スクリプト:

ここでいったん走らせてみましょう。

2019-05-09_09

  1. メールが受信できたところで、次にこれをサイトコアのスケジューラーを使って毎週ごどに配信するように設定します。

まず、カスタムフォルダを作成しましょう。

これにて今後バージョンアップデートの際に、このサイトに特有な変更であるかどうかを一目瞭然です。

2019-05-09_19

ここで、毎週ごどに送るレポートのスケジュールを作成します。

2019-05-09_11

スケジュールの設定で実行させたいスケジュールを設定します。

下記の例で毎週の月曜にに走らせるように設定します。

2019-05-09_12

スケジュールのフォーマットをわかりやすい設定したい場合はこのモジュールを使用すればいい。

https://marketplace.sitecore.net/en/Modules/Sitecore_Shell_Wax.aspx

2019-05-09_13

分かりやすいUIが提供され、簡単に設定ができます。

2019-05-09_14

プロダクションの環境にてこれをインストールしたくないの場合はRAW値をつかって、テキストをコピーすればいい。

2019-05-09_15

設定が完了したところで、実行してみましょう。

もし、エラーなく、そしてメールを受信したら、これにて設定完了です。

プロダクションの環境へ移す際に、サイトコアのパーケージを使うか、TDSまた、Unicornを使用すればいい。

2019-05-09_17