ヘルプやQ&Aなどのアプリで、どのレコードがよく読まれているのか知りたくありませんか?
そんなときに活躍する、簡単に表示回数を記録できるプラグインです。
動作イメージ
レコードの詳細画面を開いたタイミングで、アクセス数記録用フィールドの数字がカウントアップされます。
オプションで最終アクセス日時とユーザー(最終アクセス1名または複数の閲覧ユーザー)を記録することもできます。
【値変更時の使用イベント(参考 cybozu developer network)】
レコード詳細画面の表示後イベント
プラグイン設定
設定項目 | 説明 |
---|---|
プラグインログ ログアプリID プラグインエラーが発生した場合 |
「プラグインログ機能について」のページを参照してください。 |
アクセス数記録フィールド | カウントを記録する数値フィールドを選択します。 |
最終アクセス日時記録フィールド | 日付または日時フィールドを選択します。選択しなくてもOKです。 |
アクセスユーザー記録フィールド | ユーザー選択フィールドを選択します。選択しなくてもOKです。 |
ユーザーフィールド更新方法 | アクセスユーザー記録フィールドに上書きするか追加するかのどちらかを選択します。 上書きの場合は、最終アクセスユーザー1名が記録されます。 追加の場合は、アクセスしたユーザーが追記されていきます。何度アクセスしても記録されるユーザーは1人につき1回です。アクセスユーザーが多くなる場合は、ユーザー選択フィールドの表示が縦長になりますのでご注意ください。 |
APIトークン(トークンで更新する場合のみ) | アクセス記録をトークンで更新する場合に、事前に生成したトークンを入力します。 トークンのアクセス権は、レコード閲覧とレコード編集の2つにチェックしてください。 ※セキュアアクセスおよびIPアドレス制限を行っている場合は、cybozu.com共通管理画面→セキュリティ→アクセス制限でIPアドレス制限の設定より、一部許可のIPアドレスに、 |
Basic認証のユーザー名/パスワード(トークンで更新する場合で、Basic認証使用時のみ入力) | Basic認証のユーザー名とパスワードを入力します。APIトークンで更新しない場合やBasic認証を使用していない場合は入力不要です。 |
- トークンで更新しない場合、記録先のフィールドには、ユーザーの編集権限が必要です。
制限事項等
- ライセンス有効状況確認のため、外部サーバーと通信を行います。
- 同一アプリに他のJavaScriptカスタマイズやプラグインが設定されている場合、正しく動作しない可能性があります。正しく動作しない場合は、他のJavaScriptカスタマイズやプラグインを外してご利用ください。
- アクセス数記録後に画面リロードが行われます。
- 詳細画面表示→レコード編集ボタンクリック→キャンセルまたは保存を行った場合は、アクセス数は2つカウントされます。(最初の詳細画面表示で1カウント、編集後の詳細画面表示で1カウント)
- 最終アクセス日時記録フィールドの記録日時はPCの日時になります。
- Internet Explorerでは動作しません。
プラグインダウンロード
利用規約に同意いただいたうえで、ダウンロード・ご利用ください。
警告メッセージが表示されますが、ライセンスキー無しでも無期限でトライアル可能ですので、お試しください。
更新情報
日付 | バージョン | 内容 |
---|---|---|
2018/09/28 | 1 | 初回リリース |
2020/09/18 | 2 | ・APIトークンでの更新に対応 ・ログ機能の追加 |
2021/02/24 | 3 | ・「ユーザーフィールド更新方法」を追加 ・「プラグインの有効化」を削除 |
2021/07/25 | 3.1 | ゲストユーザーがアクセスユーザー記録フィールドに記録されたなかった不具合修正 |
2022/01/23 | 3.2 | IEで動作しなくなっていた不具合対応 |
2022/06/05 | 4.0 | ・Basic認証に対応 ・Internet Explorerを対象外とする |
ログ記載内容・想定されるエラー等
レコード追加画面の保存実行前イベントレコード追加画面の保存成功後イベントレコード詳細画面の表示後イベントプラグイン設定保存イベント
【イベント】app.record.create.submit
※トークンで更新しない場合、コピーして新規登録された場合を考慮し記録先フィールドの値をクリアしています。
※トークンで更新しない場合、コピーして新規登録された場合を考慮し記録先フィールドの値をクリアしています。
想定されるエラー | ログ記録 |
---|---|
・フィールドが削除された ・フィールドコードが変更された ・フィールドの参照権限がない ※プラグイン設定で「プラグインエラーが発生した場合」で「処理停止」を選択している場合は、処理が止まり保存ができません。「処理続行」を選択している場合は、記録先フィールドの値クリアは行われないまま登録されます。 |
Error |
・記録先フィールドに更新権限がない ※エラーにはならず、記録先フィールドの値クリアも行われないまま登録されます。 |
なし |
【イベント】app.record.create.submit.success
※トークンで更新する場合、コピーして新規登録された場合を考慮し記録先フィールドの値をクリアしています。
※トークンで更新する場合、コピーして新規登録された場合を考慮し記録先フィールドの値をクリアしています。
想定されるエラー | ログ記録 |
---|---|
・トークンでの更新失敗 ※プラグイン設定で「プラグインエラーが発生した場合」で「処理停止」を選択していても処理は止まらず、記録先フィールドの値クリアは行われないまま登録されます。 |
Error |
【イベント】app.record.detail.show
想定されるエラー | ログ記録 |
---|---|
・フィールドが削除された ・フィールドコードが変更された ・フィールドの参照権限がない ・トークンでの更新失敗 |
Error |
・記録先フィールドに更新権限がない ※トークンで更新しない場合のみ。エラーにはならず、記録先フィールドの値変更も行われません。 |
なし |
【イベント(プラグイン設定保存)】caryncolabo.plugin.config.submit
ログ内容 | ログ記録 |
---|---|
・設定内容がJSON形式で書き込まれます。 | Information |