Jump to: navigation, search

Difference between revisions of "View Cache Launcher"


({{UBIK}} View Cache Launcher (VCL))
Line 5: Line 5:
 
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.exe as a service.
 
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.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 (typically: https) ||
 +
|-
 +
| ''-Url''|| IP-adress of your webserver ||
 +
|-
 +
| ''-Port''|| port which is assigned to the webserver ||
 +
|-
 +
| ''-Path''|| specify the path where the CONTENT webservice is placed ||
 +
|-
 +
| ''-App''|| app name of your database ||
 +
|-
 +
| ''-Context''|| context name of your database ||
 +
|-
 +
| ''-TriggerInterval'|| specify an interval in milliseconds ||
 +
|-
 +
| ''-OfflineCheckInterval''|| specify an interval in milliseconds which controls ? |||
 +
|-
 +
| ''-LogPath''|| specify the path where your logs should be placed ||
 +
|-
 +
| ''-USAMUrl''||  ? ||
 +
|-
 +
| ''-USAMPort''|| ? ||
 +
|-
 +
| ''-USAMPath''|| ? ||
 +
|-
 +
| ''-USAMLogin''|| state the user name that allows to login ||
 +
|-
 +
| ''-USAMPwd''||  state the belonging password from your given user name ||
 +
|-
 +
| ''-USAMDeviceName''|| state a device name ||
 +
|-|-
 +
|}
  
 
===Example===
 
===Example===
Line 21: Line 52:
 
     </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="https"/>
       <add key="TriggerUri" value="https://10.0.0.100/CLIENT/UBIK/CONTENT/UbikContent.svc/TriggerViewStateUpdate/APP_001/CXT_002" />
+
      <add key="Url" value="10.0.0.100"/>
       <add key="TriggerInterval" value="7200" />
+
       <add key="Port" value="888"/>
 +
      <add key="Path" value="CLIENT/UBIK/CONTENT"/>
 +
      <add key="App" value="APP_001"/>
 +
      <add key="Context" value="CXT_001"/>
 +
       <add key="TriggerInterval" value="1800" />
 
       <add key="OfflineCheckInterval" value="60" />
 
       <add key="OfflineCheckInterval" value="60" />
       <add key="LogPath" value="D:\UBIK\LOG\VCL\log.txt"/>
+
       <add key="LogPath" value="D:\UBIK\LOG\VCL\log.txt"/>   
 +
      <add key="USAMUrl" value="C:\my_sandbox\UBIK.VCL.LOG\log.txt"/>
 +
      <add key="USAMPort" value="C:\my_sandbox\UBIK.VCL.LOG\log.txt"/>
 +
      <add key="USAMPath" value="CLIENT/UBIK/USAM"/>
 +
      <add key="USAMLogin" value="ubik"/>
 +
      <add key="USAMPwd" value="****"/>
 +
      <add key="USAMDeviceName" value="satellite"/>
 
     </appSettings>
 
     </appSettings>
 
</configuration>
 
</configuration>
Line 34: Line 75:
 
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.
+
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.

Revision as of 10:57, 23 July 2020

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.exe as a service.

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

Attribute Purpose Optional
-Protocol' choose your wanted transport-protocol (typically: https)
-Url IP-adress of your webserver
-Port port which is assigned to the webserver
-Path specify the path where the CONTENT webservice is placed
-App app name of your database
-Context context name of your database
-TriggerInterval' specify an interval in milliseconds
-OfflineCheckInterval specify an interval in milliseconds which controls ?
-LogPath specify the path where your logs should be placed
-USAMUrl  ?
-USAMPort  ?
-USAMPath  ?
-USAMLogin state the user name that allows to login
-USAMPwd state the belonging password from your given user name
-USAMDeviceName state a device name

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="https"/>
      <add key="Url" value="10.0.0.100"/>
      <add key="Port" value="888"/>
      <add key="Path" value="CLIENT/UBIK/CONTENT"/>
      <add key="App" value="APP_001"/>
      <add key="Context" value="CXT_001"/>
      <add key="TriggerInterval" value="1800" />
      <add key="OfflineCheckInterval" value="60" />
      <add key="LogPath" value="D:\UBIK\LOG\VCL\log.txt"/>    
      <add key="USAMUrl" value="C:\my_sandbox\UBIK.VCL.LOG\log.txt"/>
      <add key="USAMPort" value="C:\my_sandbox\UBIK.VCL.LOG\log.txt"/>
      <add key="USAMPath" value="CLIENT/UBIK/USAM"/>
      <add key="USAMLogin" value="ubik"/>
      <add key="USAMPwd" value="****"/>
      <add key="USAMDeviceName" value="satellite"/>
    </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" />

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.