License configuration in the settings.js file

Overview

Many settings within Configuration applications can be edited by changing the values in the settings.js file.

Refresh your browser after editing this file to see the changes.

Folder Location (default): Program Files (x86)\Virtual Hold Technology\VirtualHoldPub\ConfigurationManagement

File Name: settings.js

This is a sample file. Depending on the application you are updating, you may see additional settings.

module.exports = {
  // URLs for top-level navigation
  launchpad: {
    configurationManagementUrl: window.location.origin + '/ConfigurationManagement/#/',
    reportsUrl: window.location.origin + '/Reports',
    usersUrl: window.location.origin + '/Users',
    databaseUrl: window.location.origin + '/ConfigurationManagement/#/',
    dashboardUrl: window.location.origin + '/Dashboard/',
    eyeQueueUrl: window.location.origin + '/EyeQueue/home.aspx',
    launchpadUrl: window.location.origin + '/launchpad',
    systemManagementUrl: window.location.origin + '/SystemManagement/#/',
    licensingUrl: window.location.origin + '/licensing/#/',
    profileHelpUrlPrefix: 'https://insight.vhtcx.com/Callback/CX_Platform/',
    conversationBridgeUrl: 'https://conversationbridge.vhtcx.com/#/sign-in',
    helloUrl: 'http://helloapp.vhtcx.com'
  },

  configApi: {
    // The base URL for the API (in production would include hostname and base path)
    endpoint: window.location.protocol + '//' + window.location.hostname + ':8001'
  },

  configTranslationAPI: {
    endpoint: window.location.origin + '/ConfigurationTranslationAPI'
  },

  authApi: {
    // API endpoint for auth API (used for validating token)
    endpoint: window.location.protocol + '//' + window.location.hostname + ':2800',
    // URL sign-out for EyeQueue
    signOutUrl: window.location.origin + '/EyeQueue/Logout.aspx',
    ttl: {hours: 12}
  },

  basic: {
    // The name that shows in the header of the site
    brandName: 'Virtual Hold Technology',
    // URL for the launchpad
    launchpadUrl: window.location.origin + '/launchpad/#'
  },

  managementApi: {
    // API endpoint for the System Management API
    endpoint: window.location.protocol + '//' + window.location.hostname + ':8000',
    // How often to call out to the API and get new data
    pollingRate: { seconds: 5 }
  },

  managementGatewayApi: {
    // API endpoint for the Management Gateway API
    endpoint: window.location.protocol + '//' + window.location.hostname + ':8012',
    // How often to call out to the API and get new usage data
    pollingRate: { seconds: 3}
  },

  iFrameUrls: {
    userSettingsUrl: window.location.origin + '/EyeQueue/UserSettings.aspx'
  }
};

},{}],"user-config":[function(require,module,exports){
var uiCompCfg = require("./..\\bower_components\\ui-components\\scripts\\config\\dist");

module.exports = $.extend(true, uiCompCfg, {
  // additional production-only config can be added here
});

},{"./..\\bower_components\\ui-components\\scripts\\config\\dist":1}]},{},[]);

Section: launchpad

This section's settings build the navigation used in the Launchpad applications.

Configuration settings Description Configuration options
configurationManagementUrl The URL for the coordinating page. This URL is set based on the data provided during the installation process.
reportsUrl
usersUrl
databaseUrl
dashboardUrl
eyeQueueUrl
launchpadUrl
systemManagementUrl

licensingUrl

Only applies to Callback version 8.6.2 or later

profileHelpUrlPrefix
conversationBridgeUrl
helloUrl

Section: configApi

Configuration settings Description Configuration options
endpoint The URL for the Configuration Management API, including the port number. This URL is set based on the data provided during the installation process.

Section: configurationTranslationAPI

Settings used by the new Configuration page and Smart Rules Engine.

Configuration settings Description Configuration options
endpoint The URL for the ConfigurationTranslationAPI. This URL is set based on the data provided during the installation process.

Section: authApi

Configuration settings Description Configuration options
endpoint The URL for the Authorization API, including the port number. This URL is set based on the data provided during the installation process.
signInUrl The URL to which the user will be redirected if their session times out. The URL is set based on the data provided during the installation process.
ttl Time in which the logged in session will expire due to inactivity

Format: {timeframe:number}

Timeframe Options: days, hours, minutes, seconds

Default: {days: 30}

Section: basic

Configuration settings Description
Configuration Settings Description Configuration Options
brandName Company/organization name that displays in the top banner in Configuration Management. This is set based on the data provided during the installation process.
launchpadUrl The URL for the Launchpad page. This is set based on the data provided during the installation process.

Section: managementApi

Configuration settings Description Configuration options
endpoint The URL where the System Management Server is installed, including the port number. This URL is set based on the data provided during the installation process.
pollingRate The time interval, in seconds, at which the UI page is updated with new data from the API. Default is 5 seconds.

Section: managementGatewayApi

Settings used by the new Licensing Page. This API configures the LicenseServer.

Configuration settings Description Configuration options
endpoint The URL for the managementGatewayAPI including the port number The URL is set based on the data provided during the installation process.
pollingRate The time interval, in seconds, at which the UI page is updated with new usage data from the API Default is 3 seconds

Section: iFrameUrls

Legacy EyeQueue pages use these settings to import pages into the new Configuration.

Configuration settings
Varied, depending on which application values you are editing.