Skip to main content

REST APIの設定

REST APIをインストールしたら、必要に応じてさまざまな設定をすることができます。

REST APIのデータベースサーバー設定

REST APIがIncentivesデータベースサーバーと通信できるように、REST API設定ファイルを編集する必要があります。

  1. REST APIがインストールされている場所に移動します。

    デフォルトでは、C:\Program Files (x86)\Varicent SPM\RestAPIにインストールされます。

  2. RESTAPI.dbServers.configファイルを開き、databaseServersセクションで次のパラメーターを設定します。

    ヒント

    ほとんどのパラメーターは、defaults.jsonのパラメーターと一致します（ テナントサービスのSQL Serverへのアクセス設定を参照。 そのファイルを参照として使用し、これらのパラメーターをコピーして貼り付けることができます。

    ファイルパスの書き込み時には、REST API設定に1つのバックスラッシュ\、テナントサービス設定に2つのバックスラッシュ\\を使用します。

    パラメーター

    説明

    Name

    これは、SuperServerなどの任意の名前で、データベースサーバーを識別および区別することを目的としています。

    Address

    このアドレスは、データベースの場所を示します。アドレスには、次の形式を使用します。SERVER_NAME\\INSTANCE_NAME。SQL Serverがデフォルトのポート1433を使用しない場合、ポート番号をサーバーのアドレスフィールドに追加する必要があります（例：SERVER_NAME\\INSTANCE_NAME, PORT_NUMBER）。

    Type

    これは、使用しているデータベースのタイプです。

    SQL Server 2016を使用するには、すべての設定を、SQL Server 2014の使用時と同様に設定する必要があります。たとえば、使用しているデータベースがSQL Server 2016の場合は、sqlserver2014またはsqlserver2014unicodeを入力します。

    Username

    このパラメーターは手動で追加する必要があり、値はMicrosoft SQL Serverユーザーである必要があります。

    Password

    このパラメーターは手動で追加する必要があり、値はMicrosoft SQL Serverユーザーのパスワードである必要があります。

    DiskPath

    これは、データベースが作成され、保存される場所です。

    LogPath

    これは、ログファイルが作成され、保存される場所です。

    TimeoutSeconds

    これは、タイムアウトが発生するまでの秒数です。データベースのタイムアウトのデフォルトは90秒です。これは、アプリケーションがネットワークまたはサーバの問題を警告する前にクライアントが待機する最小時間です。計算時間が長いモデルでは、この時間を延長して、計算中にデータベースがタイムアウトするのを回避できます。

  3. ファイルを保存します。

REST APIのテナントサービス設定

REST APIのデータベースアクセスを設定した後、テナントサービスを設定します。

  1. REST APIがインストールされている場所に移動します。

    デフォルトでは、次の場所にインストールされます：C:\Program Files (x86)\Varicent SPM\RestAPI

  2. RESTAPI.appSettings.configファイルを開きます。

  3. BlacklistServices値をRedis Serverの接続に設定します。

    このBlacklistServices値は、管理者ユーザーのログアウトを追跡するために使用されます。値が正しく設定されていない場合、管理者ユーザーがログアウトすると、セッションに関連付けられたJWTがAPI呼び出しに引き続き使用されます。

  4. テナントサービス設定ファイルのAPI_KEY値と一致するSystemCallsSecretKey値を設定します。

  5. テナントサービス設定ファイルのJWT_KEY値と一致するMessageSecretKey値を設定します。

  6. テナントサービス設定ファイルのSCHED_KEY値と一致するSchedMessageSecretKey値を設定します。

  7. テナントサービス設定ファイルのTENANT_KEY値と一致するTenantSecretKey値を設定します。

  8. ファイルを保存します。

REST APIの保存済みインポート設定

REST APIのデータベースアクセスを設定した後、Incentives REST APIでインポートを保存する前に、保存済みインポートファイルを手動で設定する必要があります。

  1. REST APIがインストールされている場所に移動します。

    デフォルトでは、次の場所にインストールされます：C:\Program Files (x86)\Varicent SPM\RestAPI

  2. RESTAPI.appSettings.configファイルを開きます。

  3. Saved Import File Settingsセクションで、次のパラメーターを設定します。

    パラメーター

    説明

    ImportFileDirectory

    REST APIがインポートファイルを保存するネットワークまたは共有ドライブの場所。

    ImportFileUserName

    インポートファイルが保存されているネットワークまたは共有ドライブにアクセスできるユーザー名。

    ImportFileDomainName

    インポートファイルを保存するネットワークまたは共有ドライブのドメイン名。

    ImportFilePassword

    インポートファイルが保存されるネットワークまたは共有ドライブにアクセスできるユーザー名に関連付けられたパスワード。

  4. デフォルトでは、保存されたインポートは1つのフォルダに保存されます。この設定を変更して、複数の保存済みインポートフォルダを許可するには、IsSingleImportDirectory値をFALSEに変更します。

ImportFileDirectoryのデータフォルダを削除する

Varicent ICMは、ImportFileDirectoryフォルダにデータフォルダーを作成し、すべての受信ファイルを新しいデータフォルダにリダイレクトします。データフォルダーを削除し、以下の手順に従ってImportFileDirectoryフォルダから直接ファイルにアクセスできます。

  1. REST APIがインストールされている場所に移動します。

    デフォルトでは、次の場所にインストールされます。C:\Program Files (x86)\Varicent ICM\RestAPI

  2. RESTAPI.appSettings.configファイルを開きます。

  3. DisableDataFolderOnPremの値をfalseからtrueに変更します。

    <add key="DisableDataFolderOnPrem" value="true"/>

REST APIの追加設定

REST APIのデータベースアクセスを設定した後、さらにいくつかの設定を行う必要があります。

  1. REST APIがインストールされている場所に移動します。

  2. RESTAPI.appSettings.configファイルを開きます。

  3. ファイルのTenantServicesキーを検索し、localhostをテナントサービスがインストールされているサーバーのホスト名に変更します。

    完了すると、次のようになります。

    <add key="TenantServices" value="http://hostname:9101/services" />

  4. IsTenantServicesRunningキーを検索し、値を0から1に変更します。

    完了すると、次のようになります。

    <add key="IsTenantServicesRunning" value="1" />

  5. Hostキーを検索し、値をテナントサービスの場所に変更します。

    完了すると、次のようになります。

    <add key="Host" value="http://hostname:8080" />

  6. OnPremキーを検索し、値をtrueに変更します。

    完了すると、次のようになります。

    <add key="OnPrem" value="true" />

  7. ファイルを保存します。

インストールを続行するには、REST APIのHTTPS設定セクションを参照してください。