Jump to: navigation, search

Difference between revisions of "View Cache Launcher"

(→‎{{UBIK}} View Cache Launcher (VCL))
 
(18 intermediate revisions by 3 users not shown)
Line 3: Line 3:
 
The VCL is an installable windows system service which can be used to automaically trigger one or more UBIK contexts(s) provided by an UBIK IIS service to build up its view cache.
 
The VCL is an installable windows system service which can be used to automaically trigger one or more UBIK contexts(s) provided by an UBIK IIS service to build up its view cache.
  
−
After unpacking the VCL binaries and config-files, move the files to a directory where the local system account (or the specified one configured to run the VCL service) is allowed to execute it.
+
After unpacking the VCL binaries and config-files, move the files to a directory where the local system account (or the specified one configured to run the VCL service) is allowed to execute the "install.bat". This file installs the UBIK.VCL.Service.exe as a service.
  
−
The VCL is configured in “UBIK.VCL.exe.config":
+
The VCL is configured in “UBIK.VCL.Service.exe.config":
  
−
* StatusURI: configure the service IP, the webservice path, appand context according to the installed UBIK-configuration on the IIS.
+
{| class="wikitable" | width = "100%"
−
* TriggerUri: see StatusURI
+
|-
−
* TriggerInterval: when the viewcache is already active, refresh it at least after this interval.
+
! Attribute!!Purpose!!Optional
−
* OfflineCheckInterval: when the viewcache can not be contacted or is offline, retry to trigger the viewcache at least after this time interval.
+
|-
 +
| '''Protocol'''|| choose your wanted transport-protocol (https, http) ||
 +
|-
 +
| '''Url'''|| URL of the webserver ||
 +
|-
 +
| '''Port'''|| port which is assigned to the webserver ||
 +
|-
 +
| '''Path'''|| specify the path where the CONTENT webservice is placed ||
 +
|-
 +
| '''App'''|| application name of your use-case||
 +
|-
 +
| '''Context'''|| context name of your use-case||
 +
|-
 +
| '''TriggerInterval'''|| specify the interval in seconds how often a viewcache rebuild is triggered  ||
 +
|-
 +
| '''OfflineCheckInterval'''|| specify the interval in seconds how often the server-status is checked |||
 +
|-
 +
| '''Inactive'''|| possibility to configure a timespan in which no rebuild is triggered (from;to) in (hh:mm;hh:mm) || X
 +
|-
 +
| '''LogPath'''|| specify the path where your logs should be placed ||
 +
|-
 +
| '''USAMUrl'''||  Webserver URL of the USAM || X
 +
|-
 +
| '''USAMPort'''|| port which is assigned to the USAM webserver || X
 +
|-
 +
| '''USAMProtocol'''|| choose your wanted transport-protocol (https, http) || X
 +
|-
 +
| '''USAMPath'''|| specify the path where the USAM webservice is placed ||
 +
|-
 +
| '''USAMLogin'''|| specify the login name which is used for triggering the viewcache build ||
 +
|-
 +
| '''USAMPwd'''||  specify the password which is used for triggering the viewcache build||
 +
|-
 +
| '''USAMDeviceName'''||  specify the device name which is used for triggering the viewcache build ||
 +
|-|-
 +
| '''PushUrl'''||  Webserver URL of the USAM || X
 +
|-
 +
| '''PushPort'''|| port which is assigned to the USAM webserver || X
 +
|-
 +
| '''PushProtocol'''|| choose your wanted transport-protocol (https, http) || X
 +
|-
 +
| '''PushPath'''|| specify the path where the USAM webservice is placed || X
 +
|-
 +
|}
  
 
===Example===
 
===Example===
Line 21: Line 64:
 
     </startup>
 
     </startup>
 
     <appSettings>
 
     <appSettings>
−
       <add key="StatusUri" value="https://10.0.0.100/CLIENT/UBIK/CONTENT/UbikContent.svc/GetViewStateInformation/APP_001/CXT_001" />
+
       <add key="Protocol" value="yourWantedTransportProtocol"/>
−
       <add key="TriggerUri" value="https://10.0.0.100/CLIENT/UBIK/CONTENT/UbikContent.svc/TriggerViewStateUpdate/APP_001/CXT_002" />
+
      <add key="Url" value="yourServerName"/>
−
       <add key="TriggerInterval" value="7200" />
+
      <add key="Port" value="yourServerPort"/>
−
       <add key="OfflineCheckInterval" value="60" />
+
      <add key="Path" value="yourServerPath"/>
−
       <add key="LogPath" value="D:\UBIK\LOG\VCL\log.txt"/>
+
      <add key="App" value="yourApplicationName"/>
 +
      <add key="Context" value="yourContextName"/>
 +
      <add key="TriggerInterval" value="yourTriggerInterval" />
 +
      <add key="OfflineCheckInterval" value="yourCheckingInterval" />
 +
       <add key ="Inactive" value = "01:45;05:15"/>
 +
      <add key="LogPath" value="yourLogPath"/>   
 +
      <add key="USAMUrl" value="yourUSAMServerName"/>
 +
      <add key="USAMPort" value="yourUSAMServerPort"/>
 +
      <add key="USAMProtocol" value="yourWantedTransportProtocol"/>
 +
      <add key="USAMPath" value="yourUSAMServerPath"/>
 +
       <add key="USAMLogin" value="yourLoginName"/>
 +
       <add key="USAMPwd" value="yourLoginPassword"/>
 +
       <add key="USAMDeviceName" value="yourDeviceName"/>
 
     </appSettings>
 
     </appSettings>
 
</configuration>
 
</configuration>
Line 34: Line 89:
 
Please duplicate the entries used and add a number suffix. Here is an example:
 
Please duplicate the entries used and add a number suffix. Here is an example:
 
<source lang="xml">
 
<source lang="xml">
−
<add key="StatusUri1" value="https://10.0.0.100/UBIK/PROJECT01/CONTENT/UbikContent.svc/GetViewStateInformation/APP_001/CXT_001" />
+
<add key="Protocol" value="https" />
−
<add key="StatusUri2" value="https://10.0.0.100/UBIK/PROJECT01/CONTENT/UbikContent.svc/GetViewStateInformation/APP_001/CXT_002" />
+
<add key="Protocol01" value="https" />
 
</source>
 
</source>
−
etc.
+
'''Remark''': The number should be continously incremented by one, if there is a number missing in-between (-> e.g. Protocol, Protocol01, Protocol03,..), the last executed will be Protocol01.

Latest revision as of 14:28, 22 January 2021

UBIK® View Cache Launcher (VCL)

The VCL is an installable windows system service which can be used to automaically trigger one or more UBIK contexts(s) provided by an UBIK IIS service to build up its view cache.

After unpacking the VCL binaries and config-files, move the files to a directory where the local system account (or the specified one configured to run the VCL service) is allowed to execute the "install.bat". This file installs the UBIK.VCL.Service.exe as a service.

The VCL is configured in “UBIK.VCL.Service.exe.config":

Attribute Purpose Optional
Protocol choose your wanted transport-protocol (https, http)
Url URL of the webserver
Port port which is assigned to the webserver
Path specify the path where the CONTENT webservice is placed
App application name of your use-case
Context context name of your use-case
TriggerInterval specify the interval in seconds how often a viewcache rebuild is triggered
OfflineCheckInterval specify the interval in seconds how often the server-status is checked
Inactive possibility to configure a timespan in which no rebuild is triggered (from;to) in (hh:mm;hh:mm) X
LogPath specify the path where your logs should be placed
USAMUrl Webserver URL of the USAM X
USAMPort port which is assigned to the USAM webserver X
USAMProtocol choose your wanted transport-protocol (https, http) X
USAMPath specify the path where the USAM webservice is placed
USAMLogin specify the login name which is used for triggering the viewcache build
USAMPwd specify the password which is used for triggering the viewcache build
USAMDeviceName specify the device name which is used for triggering the viewcache build
PushUrl Webserver URL of the USAM X
PushPort port which is assigned to the USAM webserver X
PushProtocol choose your wanted transport-protocol (https, http) X
PushPath specify the path where the USAM webservice is placed X

Example

<?xml version="1.0" encoding="utf-8" ?>
<configuration>
    <startup>
        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5.1" />
    </startup>
    <appSettings>
      <add key="Protocol" value="yourWantedTransportProtocol"/>
      <add key="Url" value="yourServerName"/>
      <add key="Port" value="yourServerPort"/>
      <add key="Path" value="yourServerPath"/>
      <add key="App" value="yourApplicationName"/>
      <add key="Context" value="yourContextName"/>
      <add key="TriggerInterval" value="yourTriggerInterval" />
      <add key="OfflineCheckInterval" value="yourCheckingInterval" />
      <add key ="Inactive" value = "01:45;05:15"/>
      <add key="LogPath" value="yourLogPath"/>    
      <add key="USAMUrl" value="yourUSAMServerName"/>
      <add key="USAMPort" value="yourUSAMServerPort"/>
      <add key="USAMProtocol" value="yourWantedTransportProtocol"/>
      <add key="USAMPath" value="yourUSAMServerPath"/>
      <add key="USAMLogin" value="yourLoginName"/>
      <add key="USAMPwd" value="yourLoginPassword"/>
      <add key="USAMDeviceName" value="yourDeviceName"/>
    </appSettings>
</configuration>

Configure more than one service and/or context to be updated

Please duplicate the entries used and add a number suffix. Here is an example:

<add key="Protocol" value="https" />
<add key="Protocol01" value="https" />

Remark: The number should be continously incremented by one, if there is a number missing in-between (-> e.g. Protocol, Protocol01, Protocol03,..), the last executed will be Protocol01.

Retrieved from "https://wiki.augmensys.com/index.php?title=View_Cache_Launcher&oldid=22962"