Jump to: navigation, search

Difference between revisions of "View Cache Launcher"

(→‎{{UBIK}} View Cache Launcher (VCL))
(→‎{{UBIK}} View Cache Launcher (VCL))
 
(6 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
={{UBIK}} View Cache Launcher (VCL)=
 
={{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.
+
The VCL is an installable Windows system service that can be used to automatically trigger one or more UBIK contexts(s) provided by a 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.
+
===Configuration===
  
−
The VCL is configured in “UBIK.VCL.Service.exe.config":
+
The VCL is configured via the UBIK.VCL.Service.exe.config file.
  
 
{| class="wikitable" | width = "100%"
 
{| class="wikitable" | width = "100%"
 
|-
 
|-
−
! Attribute!!Purpose!!Optional
+
! Attribute!!Purpose!!Optional!!Obsolete (since V4.8+)
 
|-
 
|-
−
| '''Protocol'''|| choose your wanted transport-protocol (https, http) ||  
+
| '''Protocol'''|| choose your wanted transport-protocol (https, http) || ||
 
|-
 
|-
−
| '''Url'''|| IURL of the webserver ||
+
| '''Url'''|| URL of the webserver || ||
 
|-
 
|-
−
| '''Port'''|| port which is assigned to the webserver ||
+
| '''Port'''|| port which is assigned to the webserver || ||
 
|-
 
|-
−
| '''Path'''|| specify the path where the CONTENT webservice is placed ||
+
| '''Path'''|| specify the path where the CONTENT webservice is placed || ||
 
|-
 
|-
−
| '''App'''|| application name of your use-case||
+
| '''App'''|| application name of your use-case|| ||
 
|-
 
|-
−
| '''Context'''|| context 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  ||
+
| '''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 |||
+
| '''OfflineCheckInterval'''|| specify the interval in seconds, how often the server-status is checked || ||
 
|-
 
|-
−
| '''LogPath'''|| specify the path where your logs should be placed ||  
+
| '''Inactive'''|| possibility to configure a timespan in which no rebuild is triggered (from;to) in (hh:mm;hh:mm) || X ||
 
|-
 
|-
−
| '''USAMUrl'''|| Webserver URL of the USAM ||
+
| '''LogPath'''|| specify the path where your logs should be placed || ||  
 
|-
 
|-
−
| '''USAMPort'''|| port which is assigned to the USAM webserver || X
+
| '''USAMUrl'''|| Webserver URL of the USAM ||  || X
 
|-
 
|-
−
| '''USAMProtocol'''|| choose your wanted transport-protocol (https, http) || X
+
| '''USAMPort'''|| port which is assigned to the USAM webserver ||  || X
 
|-
 
|-
−
| '''USAMPath'''|| specify the path where the USAM webservice is placed ||
+
| '''USAMProtocol'''|| choose your wanted transport-protocol (https, http) || || X
 
|-
 
|-
−
| '''USAMLogin'''|| specify the login name which is used for triggering the viewcache build ||  
+
| '''USAMPath'''|| specify the path where the USAM webservice is placed ||  || X
 
|-
 
|-
−
| '''USAMPwd'''|| specify the password which is used for triggering the viewcache build||
+
| '''USAMLogin'''|| specify the login name which is used for triggering the viewcache build ||   || X
 
|-
 
|-
−
| '''USAMDeviceName'''||  specify the device name which is used for triggering the viewcache build ||
+
| '''USAMPwd'''||  specify the password which is used for triggering the viewcache build||  || X
 +
|-
 +
| '''USAMDeviceName'''||  specify the device name which is used for triggering the viewcache build || || X
 
|-|-
 
|-|-
 +
| '''PushUrl'''||  Webserver URL of the PUSH || X || X
 +
|-
 +
| '''PushPort'''|| port which is assigned to the PUSH webserver || X || X
 +
|-
 +
| '''PushProtocol'''|| choose your wanted transport-protocol (https, http) || X || X
 +
|-
 +
| '''PushPath'''|| specify the path where the PUSH webservice is placed || X || X
 +
|-
 +
| '''Action'''|| Two options: ''ViewCacheUpdate'' (default value if the parameter is not set specifically); ''GetContent'' (can update one specific content object via an UID set with the Content parameter) || X ||
 +
|-
 +
| '''Content'''|| UID of a content object || X ||
 
|}
 
|}
  
Line 55: Line 68:
 
     <appSettings>
 
     <appSettings>
 
       <add key="Protocol" value="https"/>
 
       <add key="Protocol" value="https"/>
−
       <add key="Url" value="yourServerName"/>
+
       <add key="Url" value="127.0.0.1"/>
−
       <add key="Port" value="yourServerPort"/>
+
       <add key="Port" value="443"/>
−
       <add key="Path" value="yourServerPath"/>
+
       <add key="Path" value="UBIKService/CONTENT"/>
−
       <add key="App" value="yourApplicationName"/>
+
       <add key="App" value="APP_01"/>
−
       <add key="Context" value="yourContextName"/>
+
       <add key="Context" value="CXT_01"/>
−
       <add key="TriggerInterval" value="yourTriggerInterval" />
+
       <add key="TriggerInterval" value="3000" />
−
       <add key="OfflineCheckInterval" value="yourCheckingInterval" />
+
       <add key="OfflineCheckInterval" value="64" />
−
       <add key="LogPath" value="yourLogPath"/>     
+
       <add key="LogPath" value="C:\UBIK\VCL\log\log.txt"/>     
−
      <add key="USAMUrl" value="yourUSAMServerName"/>
+
−
      <add key="USAMPort" value="yourUSAMServerPort"/>
+
−
      <add key="USAMProtocol" value="https"/>
+
−
      <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 81: Line 87:
 
<add key="Protocol01" value="https" />
 
<add key="Protocol01" value="https" />
 
</source>
 
</source>
−
'''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.
+
'''Remark''': The number should be continuously 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 11:12, 4 August 2025

UBIK® View Cache Launcher (VCL)

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

Configuration

The VCL is configured via the UBIK.VCL.Service.exe.config file.

Attribute Purpose Optional Obsolete (since V4.8+)
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 X
USAMLogin specify the login name which is used for triggering the viewcache build X
USAMPwd specify the password which is used for triggering the viewcache build X
USAMDeviceName specify the device name which is used for triggering the viewcache build X
PushUrl Webserver URL of the PUSH X X
PushPort port which is assigned to the PUSH webserver X X
PushProtocol choose your wanted transport-protocol (https, http) X X
PushPath specify the path where the PUSH webservice is placed X X
Action Two options: ViewCacheUpdate (default value if the parameter is not set specifically); GetContent (can update one specific content object via an UID set with the Content parameter) X
Content UID of a content object 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="https"/>
      <add key="Url" value="127.0.0.1"/>
      <add key="Port" value="443"/>
      <add key="Path" value="UBIKService/CONTENT"/>
      <add key="App" value="APP_01"/>
      <add key="Context" value="CXT_01"/>
      <add key="TriggerInterval" value="3000" />
      <add key="OfflineCheckInterval" value="64" />
      <add key="LogPath" value="C:\UBIK\VCL\log\log.txt"/>    
    </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 continuously 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=28450"