コンテンツにスキップ

作業完了確認

以下のチェック項目を参考にして、Kappletsの設定が正常に完了したかどうかを確認してください。

チェック項目のアイコンについて

チェック項目をクリックすることでアイコンの色が変化します。

  • 未チェック状態
  • チェック済み状態

Kappletsセットアップ作業の確認

Kappletsのセットアップで行った作業を確認します。

kapplets.warファイルとkappletsフォルダが以下のフォルダに格納されていることを確認します。
※ Tomcatのインストールフォルダが通常と異なる場合は適宜読み替えてください。

エクスプローラー: v11.5.0.7 以降
C:\Program Files\Apache Software Foundation\Tomcat 9.0\webapps
エクスプローラー: v11.5.0.5
C:\Program Files\Apache Software Foundation\＜ランダムな文字列＞\Tomcat 9.0\webapps

war-open

  • kapplets.warファイルとkappletsフォルダがあることを確認した

Kapplets用DBの作成作業の確認

Kapplets用DBの作成で行った作業を確認します。

利用するMySQLに「kapplets」のSCHEMAが正しく作られているかを確認します。

  1. MySQLにログインしてデータベースの確認を行います。

管理者権限でコマンドプロンプトを立ち上げます。
カレントディレクトリ移動 および MySQLにログイン するため、以下のコマンドを入力し、Enterを押します。
尚、コマンド内の 「mysql -u BasicRoboUser -p」 は「MySQLのインストール > アカウント作成」で設定したMySQL User Account 「UserName」に修正してください。
本書では以下のコマンド例で「UserName」を BasicRoboUser とします。

コマンドプロンプト MySQL 8.4
cd "C:\Program Files\MySQL\MySQL Server 8.4\bin" && mysql -u BasicRoboUser -p
img22

  1. パスワードを入力し、Enterを押します。
  1. Bizrobo! Kapplets のデータベースを確認します。以下のコマンドを入力し、Enterを押します。
コマンドプロンプト
SELECT SCHEMA_NAME, DEFAULT_CHARACTER_SET_NAME, DEFAULT_COLLATION_NAME
FROM INFORMATION_SCHEMA.SCHEMATA
WHERE SCHEMA_NAME IN ('kapplets');

Kappletsのデータベース名と文字コードが表示されます。

  1. MySQLからログアウトします。以下のコマンドを入力し、Enterを押します。
コマンドプロンプト
quit;

「Bye」と表示されたら、MySQLのデータベース作成は完了です。

  1. Workbenchを起動します
    Win + Qで検索ボックスを立ち上げ、MySQLを入力します。
    そして「MySQL Workbench」アプリをクリックします。
    workbench-search

  2. MySQL80に接続します
    ［MySQL80］の接続をクリックします。
    db-access

  3. 対象のSCHEMAを確認します
    「kapplets」SCHEMAのインフォメーションマークをクリックし、「Default collation」「Default characterset」が正しく設定されているか確認します。
    workbench-setting

  • 「kapplets」SCHEMAが存在し、「Default collation」に「utf8mb4_bin」、「Default characterset」に「utf8mb4」があることを確認した

Tomcatの設定作業の確認

Tomcatの設定で行った作業を確認します。

kapplets.xmlの設定

kapplets.xmlの格納と記述が正しく行えているか確認をします。
こちらの設定はアプリの動作に大きく影響しますので、設定に誤りがないか注意してください。

  1. 以下フォルダにkapplets.xmlが格納されていることを確認します。
    ※ Tomcatのインストールフォルダが通常と異なる場合は適宜読み替えてください。

    エクスプローラー: 11.5.0.7以降
    C:\Program Files\Apache Software Foundation\Tomcat 9.0\conf\Catalina\localhost
    エクスプローラー: v11.5.0.5
    C:\Program Files\Apache Software Foundation\＜ランダムな文字列＞\Tomcat 9.0\conf\Catalina\localhost

kappletsxml-make

  1. 記述内容に誤りがないか確認をします。
    ハイライトの箇所に正しい情報が設定されていない場合Kappletsにアクセスできなくなるのでご注意ください。

     1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
    <?xml version='1.0' encoding='utf-8'?>
<Context useHttpOnly="true" mapperContextRootRedirectEnabled="true">
    <!-- Default set of monitored resources -->
    <WatchedResource>WEB-INF/web.xml</WatchedResource>
    <Resource name="jdbc/kapow/kapplets"
              auth="Container"
              type="javax.sql.DataSource"
              initialSize="5"
              maxTotal="100"
              maxIdle="10"
              maxWaitMillis="-1"
              validationQuery="/* ping */"
              testOnBorrow="true"
              testWhileIdle="true"
              username="①DB ユーザー名"
              password="②DB のユーザーパスワード"
              driverClassName="com.mysql.cj.jdbc.Driver"
              url="jdbc:mysql://③DB のホスト名またはIPアドレス:④DBのポート番号/⑤Kappletsのスキーマ名?useUnicode=yes&amp;characterEncoding=UTF-8&amp;useSSL=false&amp;useCursorFetch=true&amp;defaultFetchSize=1000&amp;serverTimezone=GMT%2B9&amp;allowPublicKeyRetrieval=true" 
              factory="org.apache.tomcat.jdbc.pool.DataSourceFactory"/>
    <Environment name="spring.datasource.jndi-name" value="jdbc/kapow/kapplets" type="java.lang.String" override="false"/>
    <Environment name="spring.jpa.database-platform" value="org.hibernate.dialect.MySQL8Dialect" type="java.lang.String" override="false"/>
    <Environment name="kapplets.services.mc.connection.url" value="http://⑥MCのホスト名またはIPアドレス:⑦MCのポート番号/mc" type="java.lang.String" override="false"/>
    <Environment name="kapplets.services.mc.connection.service.kapplets-base-url" value="http://⑧Kappletsのホスト名またはIPアドレス:⑨Kappletsのポート番号/kapplets" type="java.lang.String" override="false"/>
    <Environment name="kapplets.services.mc.connection.service.mc-base-url" value="http://⑥MCのホスト名またはIPアドレス:⑦MCのポート番号/mc" type="java.lang.String" override="false"/>
    <Environment name="kapplets.app.default.language" value="ja" type="java.lang.String" override="false"/>
</Context>
No 項目 値
① DB ユーザー名 Kapplets SCHEMAにログインするユーザー名
② DB のユーザーパスワード 上記DB ユーザー名のパスワード
③ DB のホスト名 例　machine_name または 192.168.1.123
④ DBのポート番号 例　3306
⑤ MCのホスト名またはIPアドレス 例　machine_name または 192.168.1.123
⑥ MCのポート番号 例　8080
⑦ Kappletsのホスト名またはIPアドレス 例　machine_name または 192.168.1.123
⑧ Kappletsのポート番号 例　8080
  • kapplets.xmlが所定のフォルダ内に存在し、記述内容に誤りがないことを確認した

application.propertiesの設定(任意)

application.propertiesの設定を変更した場合は、以下確認作業を実施して下さい。application.propertiesの格納先は以下になります。
※ Tomcatのインストールフォルダが通常と異なる場合は適宜読み替えてください。

エクスプローラー: v11.5.0.7 以降
C:\Program Files\Apache Software Foundation\Tomcat 9.0\webapps\kapplets\WEB-INF\classes
エクスプローラー: v11.5.0.5
C:\Program Files\Apache Software Foundation\＜ランダムな文字列＞\Tomcat 9.0\webapps\kapplets\WEB-INF\classes

プロキシサーバーの有効化

「kapplets.services.mc.connection.proxy.enabled」の設定値が下記赤字の「true」に変更されているか確認します。

kapplets.services.mc.connection.proxy.enabled=true

182
183
184
185
186
187
188
kapplets.services.mc.connection.proxy.enabled=false
　
kapplets.services.mc.connection.proxy.host=localhost
kapplets.services.mc.connection.proxy.port=8888
kapplets.services.mc.connection.proxy.username=proxy-user
kapplets.services.mc.connection.proxy.password=
kapplets.services.mc.connection.proxy.enabled=true
  • 「kapplets.services.mc.connection.proxy.enabled」の設定値が「true」であることを確認した

反映時間を設定する

下記赤字2カ所の「秒数」が変更されているか確認をします。2カ所の「秒数」は同じ値を設定してください。

kapplets.services.mc.caching.descriptions.life-time=秒数
kapplets.services.mc.caching.robots.life-time=秒数

172
173
174
175
176
177
178
179
kapplets.services.mc.caching.mapping.size=40000
kapplets.services.mc.caching.mapping.life-time=21600
　
kapplets.services.mc.caching.descriptions.life-time=300
kapplets.services.mc.caching.descriptions.size=30000
　
kapplets.services.mc.caching.robots.life-time=300
kapplets.services.mc.caching.robots.size=30000
  • 同じ秒数を「kapplets.services.mc.caching.descriptions.life-time」と「kapplets.services.mc.caching.robots.life-time」に設定していることを確認した

セッションタイムアウトを設定する

下記赤字にある「セッションタイムアウト時間（分）」が変更されているか確認をします。

server.servlet.session.timeout=セッションタイムアウト時間（分）

51
52
53
54
55
56
57
58
59
60
61
################### spring sessions ######################
# Session store type.
spring.session.store-type=jdbc
# Session timeout. If a duration suffix is not specified, seconds will be used.
server.servlet.session.timeout=30m
# Database schema initialization mode.
spring.session.jdbc.initialize-schema=always
# Path to the SQL file to use to initialize the database schema.
spring.session.jdbc.schema=classpath:schema/kapplets/@@platform@@/create-session.sql
# Name of the database table used to store sessions.
#spring.session.jdbc.table-name=SPRING_SESSION
  • 「server.servlet.session.timeout」の設定を確認した

Kappletsの起動および認証・許可設定作業の確認

Tomcatの設定で作成したkapplets.xmlおよび、Kappletsの認証・許可設定で行った作業を確認します。Kappletsが正常起動し、かつ共有シークレットが設定されていることを確認します。

kapplets.xml確認のためのTomcat再起動について

kapplets.xmlを変更した場合、Tomcatを再起動することで反映されます。現在のkapplets.xmlで正常に動作することを確認するため、必ずTomcatを再起動してください。

  1. サービスからApache Tomcat 9.0を再起動します。 setvice-stop

  2. kappletsの画面を表示します。

    Kapplets URL
    http://<Kappletsのホスト名またはIPアドレス>:<Kappletsのポート番号>/kapplets

  3. MCのログイン画面が表示されますので、管理者ユーザーでログインします。 mc

  4. ログインに成功すると、kappletsの画面が表示されます。 kapplets-login

この際、以下の画面が表示された場合は共有シークレットが登録されていませんので、Kappletsの認証・許可設定を参照の上、共有シークレットを登録してください。 OAuth

  • Tomcatを再起動してもKappletsのサイトが表示されることを確認した
  • kappletsアクセス時に共有シークレットを求められないことを確認した

Kappletsが動作するために必要な設定の確認は以上になります。

初期設定作業の確認

初期設定で行った作業を確認します。

言語設定

利用したい言語に設定されているか確認をします。
こちらはユーザー単位での設定となります。

Kapplets 右上の［ユーザー名］＞「Settings（設定）」を選択すると言語設定画面が表示されますので利用したい言語になっているか確認します。

settings

  • 設定した言語で表示されることを確認した

ユーザーの作成

Kappletsユーザーを作成する場合はMC側とKapplets側の設定に分かれます。
順序通りに作成しないと認証ができないのでご注意ください。

MC側の設定

  1. MCにログインして対象のユーザーが作成されているか確認します。
    本手順書では「kapplets」を作成しています。
    mc-user

    • ユーザーが作成されていることを確認した

  2. ユーザーグループが作成されているか確認します。
    本手順書では「Kappletsユーザー」を作成しています。
    mc-usergroup

    • ユーザーグループが作成されている事を確認した

  3. プロジェクトの権限設定が適切に設定されていることを確認します。
    本手順書では「Kapplet User」を「Kappletユーザー」のユーザグループに設定しています。
    mc-project

    • プロジェクトの権限設定が正しいことを確認した

MC側の設定確認は以上になります。

Kapplets側の設定

  1. MCで作成されたユーザーで１度Kappletsにアクセスをして情報を反映する必要があります。正しく反映できていればKappletsにユーザーが存在しますので確認をします。
    管理者権限でKappletsにアクセスして確認してください。
    kapplets-user

    • ユーザーが反映されていることを確認した

  2. Kappletsに反映されたユーザーに対して権限が設定されているかを確認します。
    本手順書では「Kappletユーザー」のユーザーグループに対してグローバルメンバーの権限を「ユーザー」に設定しています。
    kapplets-usergroup

    • 権限設定が正しいことを確認した

Kapplets側の確認は以上になります。

以上の設定ができていれば「Kapplets」ユーザーがKappletsにアクセスできます。

作業完了確認は以上になります。