UBIK Enterprise Service - Revision history

NWE: /* Configuring {{UBIK}} EnterpriseService */

2025-03-18T16:04:16Z

‎Configuring {{UBIK}} EnterpriseService

MHM: /* UBIK.EnterpriseService.BasicClient.App */

2025-03-18T14:39:52Z

‎UBIK.EnterpriseService.BasicClient.App

MHM: /* UBIK.EnterpriseService.BasicClient.App */

2025-03-18T14:38:25Z

‎UBIK.EnterpriseService.BasicClient.App

NWE: /* UBIK.EnterpriseService.BasicClient.App */

2024-11-28T11:08:25Z

‎UBIK.EnterpriseService.BasicClient.App

MHM: /* Configuring {{UBIK}} EnterpriseService */

2022-12-27T08:58:54Z

‎Configuring {{UBIK}} EnterpriseService

MHM at 12:24, 23 December 2022

2022-12-23T12:24:31Z

NWE: /* Logging */

2022-12-21T16:50:44Z

‎Logging

NWE at 16:50, 21 December 2022

2022-12-21T16:50:09Z

NWE: /* Logging */

2022-12-21T16:49:32Z

‎Logging

NWE at 16:46, 21 December 2022

2022-12-21T16:46:51Z

@@ Line 173: / Line 173: @@
 * WebInterfacePort: The default is “8000”.
 * WebInterfaceHost: The default is http://localhost.
 <source lang="xml">
@@ Line 183: / Line 187: @@
      <add key="WebInterfacePort" value="1" />
      <add key="WebInterfaceHost" value="1" />
    </appSettings>
 </configuration>k

@@ Line 135: / Line 135: @@
 * PathToBasicEnterpriseServiceRequestJsonFileList: Path to a file containing paths (separated by line breaks). The paths should lead to files as described above, in the order they should be processed.
-The minimum value for RepeateEveryMinutes is 0. If it is configured with 0, the task will be executed continously without any delay.
+{{Hint|The minimum value for RepeateEveryMinutes is 0. If it is configured with 0, the task will be executed continously without any delay.}}
+{{Hint|Since UBIK 4.9 Release 10013 the RepeateEveryMinutes parameter is changed to type of double. It is possible to configure a value < 1 now (e.g. 0.3 for 18 seconds).}}
 Since UBIK 4.9 Release 10013 the RepeateEveryMinutes parameter is changed to type of double.
 It is possible to configure a value < 1 now (e.g. 0.3 for 18 seconds).
 [[Category:Enterprise service|Enterprise Service]]

@@ Line 134: / Line 134: @@
 </source>
 * PathToBasicEnterpriseServiceRequestJsonFileList: Path to a file containing paths (separated by line breaks). The paths should lead to files as described above, in the order they should be processed.
 [[Category:Enterprise service|Enterprise Service]]

@@ Line 103: / Line 103: @@
 Another possibility is to use UBIK.EnterpriseService.BasicClient.App which is a stand-alone application that uses the aforementioned library internally. This application can be used in the Windows Task Scheduler to schedule executions. In order to use this application you will need to configure it in its accompanying UBIK.EnterpriseService.BasicClient.App.exe.config file. This xml file has an “appSettings” section with three entries:
 * BaseAddress: This is the base address on which the EnterpriseService hosts its WebInterface. You can find it in the appsettings section (WebInterfacePort & WebInterfaceHost) in the UBIK.EnterpriseService.exe.config file of your EnterpriseService installation path. The default value is http://localhost:9000
-* PathToBasicEnterpriseServiceRequestJsonFile: This is a file path to a json file that contains all parameters needed to execute a task. As an example:
+* PathToBasicEnterpriseServiceRequestJsonFile: This is a file path to a json file that contains all parameters needed to execute one or more tasks. As an example:
 <source lang="javascript">
+{
-   "SSPI": false,
+   "Tasks": [
-  "SQLUser": "user",
-  "SQLPassword": "pwd#1",
+      "ClassFullname": "namespace1.class1",
-  "SQLServer": "augserver",
+      "MethodName": "method1",
-  "SQLInitialCatalog": "UBIK.DEV",
+      "MethodParameterPathFullName": "pathToFileContainingAnyJson1"
-  "MethodFullName": "Namespace.Class.Method",
+            //No parameters required if method is like below:
-   "MethodParametersAsJson": "{
+            //public void Run(IExecutionRequest executionRequest, UBIKEnvironment ubikEnvironment) { ... }
-					\"MyNumberProperty\": 4,
+    },
-					\"MyStringProperty\": \"TESTDATENBANK\"
-				}"
+      "ClassFullname": "namespace2.class2",
+}
-OR
+[[Category:Enterprise service|Enterprise Service]]
+[[Category:Interfacing|Enterprise Service]]
-−
-  "SSPI": false,
-  "SQLUser": "tony",
-  "SQLPassword": "blabla",
-  "SQLServer": "augserver",
-  "SQLInitialCatalog": "UBIK.DEV",
-  "MethodName": "Run",
-  "ClassFullname": "TotalPlugin.OperatorRoundInstanceArchivist",
-  "MethodParametersAsJson": "" //No parameters required if method is like below:
-                               //public void Run(IExecutionRequest executionRequest, UBIKEnvironment ubikEnvironment){ ... }
-−
-−
-</source>
-* PathToBasicEnterpriseServiceRequestJsonFileList: It may seem overly complicated to add a file path that contains itself again paths to the actual request-files. But if someone wants to enqueue a couple of tasks this file will become utterly cluttered. Also it orders the task requests.
 ==== Own Implementation ====

@@ Line 173: / Line 173: @@
      <add key="ConsoleRunMode" value="1" />
      <add key="CommandFileAction" value="0" />
      <add key="ExecuteWebInterface" value="1" />
      <add key="WebInterfacePort" value="1" />
@@ Line 194: / Line 195: @@
 |-
 |}
 === Enterprise Service Task Execution Mode ===
 For special cases the {{UBIK}} EnterpriseService can be executed as a simple task. The reason to run it as a task can be for troubleshooting or for the case some referenced components cannot be run in service mode (e.g. Microsoft Office etc.). To be executed as a Task, the Enterprise Service .exe-File has to be started with the command line option "-tray". There will be a tray icon shown in the Windows Tray. Right-Clicking the tray icon opens the menu, where the user can start, stop, pause, or continue the enterprise service. Please note that starting the enterprise service as a task requires an active user session in order to be executed.
 == Logging ==

@@ Line 186: / Line 186: @@
 Especially for complex interfacing tasks, good logging is paramount.
-The [https://wiki.augmensys.com/index.php?title=Configuration_Files Logging Configuration] can be used to specify the target file and log level.
+The [https://wiki.augmensys.com/index.php?title=Configuration_Files Logging Configuration] can be used to specify the target folder, log level, etc.
 Log entries are really your best way to find out what happens during the execution of an Enterprise Service task. They are also much more versatile than any UI we could provide. So even though it looks cumbersome, logs can help you a lot after you get used to them!
@@ Line 195: / Line 195: @@
 * For every log entry, create a randomly generated large number for finding the correct place in the code later. The random number helps you avoiding to maintain an incremental log ID list.
+[[Category:Enterprise service|Enterprise Service]]
+[[Category:Interfacing|Enterprise Service]]
 == See also ==

← Older revision		Revision as of 16:46, 21 December 2022
Line 183:		Line 183:
	For special cases the {{UBIK}} EnterpriseService can be executed as a simple task. The reason to run it as a task can be for troubleshooting or for the case some referenced components cannot be run in service mode (e.g. Microsoft Office etc.). To be executed as a Task, the Enterprise Service .exe-File has to be started with the command line option "-tray". There will be a tray icon shown in the Windows Tray. Right-Clicking the tray icon opens the menu, where the user can start, stop, pause, or continue the enterprise service. Please note that starting the enterprise service as a task requires an active user session in order to be executed.		For special cases the {{UBIK}} EnterpriseService can be executed as a simple task. The reason to run it as a task can be for troubleshooting or for the case some referenced components cannot be run in service mode (e.g. Microsoft Office etc.). To be executed as a Task, the Enterprise Service .exe-File has to be started with the command line option "-tray". There will be a tray icon shown in the Windows Tray. Right-Clicking the tray icon opens the menu, where the user can start, stop, pause, or continue the enterprise service. Please note that starting the enterprise service as a task requires an active user session in order to be executed.

		+	== Logging ==
		+	Especially for complex interfacing tasks, good logging is paramount.

		+	Log entries are really your best way to find out what happens during the execution of an Enterprise Service task. They are also much more versatile than any UI we could provide. So even though it looks cumbersome, logs can help you a lot after you get used to them!

		+	Our best practice recommendation is:
		+	* In the custom code executed by the Enterprise Service, do very detailed logging in critical places (e.g., conditional actions depending on runtime input), especially for exceptional cases (missing or unexpected parameters).
		+	* This detailed logging can be done with log level "Verbose". This way, you can switch it on and off on demand, for debugging - without filling the hard disk with irrelevant logs in production.
		+	* For every log entry, create a randomly generated large number for finding the correct place in the code later. The random number helps you avoiding to maintain an incremental log ID list.

	== See also ==		== See also ==