API-icon.png

Contents

Start parameters of jBEAM

The following documentation gives an overview about the start parameter of jBEAM.

   

Load files on start

Open any data, project, script or layout file

ImportFile=<File>

Defines the path to a measurement data file (e.g. header file), project file or template, layout file, script file or multimedia file, which should be loaded on jBEAM startup. jBEAM tries to detect the file format automatically. The path to the file may be absolute or relative to the jBEAM working directory.

ImportFile="c:\measurement template.jbt"
ImportFile=c:\test.dat
ImportFile=scripts/autostart.groovy

Execute script

ScriptURL=<URL>

URL corresponds to a relative path to a file or an absolute path or URL to the script.
With relative paths, the startup directory of jBEAM is taken as the origin (CodeBase).

Beispiele:

ScriptURL=c:\test.bsh
ScriptURL=http://jbeam.de/test.bsh
ScriptURL=Unterordner/test.bsh

Execute import

ImportData="<import type='<Importerklasse>' name='<Importername>' src='<URL>' />"

The importer class corresponds to the classname of an importer in jBEAM.
The name of the importer corresponds to the name of the producer in jBEAM.
URL corresponds to a relative path to a file or an absolute path or URL to the script. With relative paths, the startup directory of jBEAM is taken as the origin (CodeBase).

Example:

ImportData="<import type='com.AMS.jBEAM.FileImport_Diadem' name='Importer' src='c:\test.dat' />"
ImportData="<import type='com.AMS.jBEAM.FileImport_Diadem' name='Importer' src='http://jbeam.de/test.dat' />"
ImportData="<import type='com.AMS.jBEAM.FileImport_Diadem' name='Importer' src='Unterordner/test.dat' />"

Example for several files:

ImportData="<Import type='com.AMS.jBEAM.FileImport_MDF' name='Importer_1' src='C:\test\test1.dat' />
<Import type='com.AMS.jBEAM.FileImport_MDF' name='Importer_2' src='C:\test\test2.dat' />
<Import type='com.AMS.jBEAM.FileImport_MDF' name='Importer_3' src='C:\test\test3.dat' />"

Example for ODS Databases:

ImportData="<import type=\"com.AMS.jBEAM.DB_ODS_Generic\" username=\"USERNAME\" password=\"=PASSWORD\" src=\"corbaname::1.2@my-server:2809/org/asam/ods/myDatabase#/[Environment]MDM/[Project]Projekt/[StructureLevel]MyLevel/[Test]VA_123/[TestStep]MyTestStep/[MeaResult]MyMeasurement.csv\"/>"

This string connects to the Server my-server:2809 at ORB /org/asam/ods/myDatabase using USERNAME and PASSWORD as login data and imports the measurement at the ASAM-Path "/[Environment]MDM/[Project]Projekt/[StructureLevel]MyLevel/[Test]VA_123/[TestStep]MyTestStep/[MeaResult]MyMeasurement.csv". It is also possible to provide a live session instead of server, username and password via the IOR string:

ImportData="<import type=\"com.AMS.jBEAM.DB_ODS_Generic\" username=\"USERNAME\" password=\"=PASSWORD\" src=\"corbaname:rir:/IOR:000000000000001f49444c3a6f72672f6173616d2f6f64732f416f53657373696f6e3a312e30000000000001000000000000009a00010200000000103139322e3136382e3130302e3233320032f3000000000045afabcb00000000204542051e00000001000000000000000200000008526f6f74504f41000000000d416f53657373696f6e393330000000000000000800000001000000b31400000000000002000000010000001c0000000005010001000000010001010900010109000000010501000100000026000000020002
#/[Environment]MDM/[Project]Projekt/[StructureLevel]MyLevel/[Test]VA_123/[TestStep]MyTestStep/[MeaResult]MyMeasurement.csv\"/>"

ProjectFileURL

ProjectfileURL=<URL>

URL corresponds to a relative path to a file or an absolute path or URL to the script.
With relative paths, the startup directory of jBEAM is taken as the origin (CodeBase).

Example:

ProjectfileURL=c:\test.jbs
ProjectfileURL=http://jbeam.de/test.jbs
ProjectfileURL=Unterordner/test.jbs

Openbin

Openbin="<File>"

File corresponds to the path of the binary project file.

Example:

Openbin=c:\test.jbs

PreferencesFile

Preferences="<File>"

File corresponds to a path to the jBEAM preferences file.
Defines the file that is used for loading and saving of jBEAM preferences.

Example:

PreferencesFile=c:\ jBEAM.preferences

OpenBeamMgc

OpenBeamMgc=<File>

File corresponds to a path to the BEAM project file (only read if openbin is not adjusted).

Example:

OpenBeamMgc=c:\test.bsm

Watch

Watch

The entry of the parameter name is evaluated as Watch = true. In this case, a Watcher is generated, which observes the BEAM project file for changes. (only relevant when a BEAM file is imported)

Example:

Watch

Printbin

Printbin

The entry of the parameter name is evaluated as Printbin = true. In this case, the jBEAM project file will be printed and the application will be closed (requires the parameter Openbin or OpenBeamMgc)

Example:

Printbin

Shell

Shell

The entry of the parameter name is evaluated as shell = true. In this case it will be showed that jBEAM was started from the shell.

Example:

Shell

Load layout

LayoutURL="<URL>"

URL corresponds to a relative path to a file or an absolute path or URL to the script.
With relative paths, the startup directory of jBEAM is taken as the origin (CodeBase).

Examples:

LayoutURL="c:\test.blf"
LayoutURL="http://jbeam.de/test.blf"
LayoutURL="Unterordner/test.blf"

EnCom

Connect to server

ConnectTo="EnterpriseDataService:<Hostname oder IP-Adresse>[:<Port>][:<Synchronisationstyp>]“

Synchronization type corresponds [ALL_ITEMS|NO_ITEMS|CUSTOMIZE]: ALL_ITEMS: Synchronyses all data objects from server with the client NO_ITEMS: Leaves all data objects on the server, user has to subscribe data objects from server manuel CUSTOMIZE: Leaves all data objects on the server, a dialog for file choosing will be opened automatically

Examples:

ConnectTo="EnterpriseDataService:localhost:999"
ConnectTo="EnterpriseDataService:localhost"
ConnectTo="EnterpriseDataService:100.100.100.100:999"
ConnectTo="EnterpriseDataService:100.100.100.100:999:ALL_ITEMS"

Import on serverside

ServerDataImport="<Importerklasse>:<Importername>:<Importpfad>"

The importer class corresponds to the classname of an importer in jBEAM.
The name of the importer corresponds to the name of the producer in jBEAM.
The import path corresponds to a relative path to a file or an absolute path or URL to the script.
With relative paths, the startup directory of jBEAM is taken as the origin (CodeBase).

Examples:

ServerDataImport="com.AMS.jBEAM.FileImport_Diadem:My Diadem Importer:c:\test.dat"
ServerDataImport="com.AMS.jBEAM.FileImport_Diadem::Subfolder/test.dat"

Logging

For the logging control in jBEAM the settings of the following parameters are necessary: Logger, LoggerStartCondition, Logfile, LogLimit.

LoggerStartCondition

LoggerStartCondition="<STRING>"

STRING corresponds to a String with the following elements:
 “Disabled ” (no Logging)
 “Error” (serious error),
 “Warning” (Problem, which doesn´t abborts the execution of the application)
 “Info ” (News for user information)
 “Configuration” (Messages about configuration)
 “Fine” (Messages about debug)
 “Finer” (Finer messages about debug)
 “Finest ” (Finest messages about debug)

Example:

LoggerStartCondition="Warning"

LogFile

Logfile=<File>

File corresponds to a path to the log file. Instead to the console, it will be logged in this file.

Example:

Logfile = c:\temp.log 

LogLimit

LogLimit= "<Integer>"

Integer corresponds to the maximum length of a logging message.

Example:

LogLimit = "1000"

Others

Fullscreen-Mode

Fullscreen

The entry of the parameter name is rated as Fullscreen = true (start in fullscreen mode). By starting in normal mode, the parameter name hasn´t to be entered.

Examples:

Fullscreen

Help

help

The entry of the parameter name is rated as help= true. In this case, the starting parameters and their descriptions are outputted to help and jBEAM will be closed.

Example:

help

Language

Language="<STRING>"

The language of jBEAM is set with this parameter.
 STRING corresponds to a String with the following elements:
 “de_DE ” : German
 “en_EN” : English
 “ru_RU” : Russian
 “fr_FR” : French
 …
Default: System language (if supported), else English

Example:

Language="de_DE"

Licenseserver

LicenseServer=<SERVER:PORT>

The adress of a licenseserver is set with this parameter.

Example:

LicenseServer=localhost:4331

Mode

Mode="<STRING>"

STRING corresponds to a String with the following elements: “Desktop”, “Presentation”, "Viewer", "Service"
Defines the viewmode of jBEAM.

Example:

Mode="<STRING>"

MeasurementStatus

MeasurementStatus="<STRING>"

STRING status of the measurement(STARTED|PAUSED).

Example:

MeasurementStatus=STARTED

Service

Service="<STRING>"

STRING corresponds to the name of the service.
Service, which starts with jBEAM.

Example:

Service="EnterpriseDataService"

Mode

Mode="<STRING>"

STRING corresponds to a String with the following elements: “Desktop”, “Presentation”, "Viewer"
Defines the viewmode of jBEAM.

Example:

Mode="<STRING>"

WindowTitle

WindowTitle=<String>

Defines a own title of the jBEAM window.

Example:

WindowTitle="My own jBEAM-Title"

WindowWidth and WindowHeight

WindowWidth=<Integer>

Defines width and length of the jBEAM window. Values can be used as 1024, 1024px, 12.5% or 7.5cm. All compatible units can be used instead of 'cm' in example. 

Example:

WindowWidth=20

WindowLeftPosition and WindowTopPosition

WindowWidth=<Integer>

Defines position of the jBEAM window. Values can be used as 1024, 1024px, 12.5% or 7.5cm. All compatible units can be used instead of 'cm' in example.

Example:

WindowLeftPosition=100px

Datadepth

Datadepth=<Number>

All numeric arrays will be initialized with this parameter.
 Default: 100

Example:

Datadepth=500

Menubar

Menubar

jBEAM window with or without menubar. Menubar is only available in Desktop-Mode, i.e. if parameter Mode=Desktop is adjusted.

Example:

Menubar

AutomaticStart

AutomaticStart=<BOOLEAN>

BOOLEAN corresponds to a string of the following list: “true”, “false”
Specifies whether jBEAM should be started immediately after the applet.

Example:

AutomaticStart=false

ShowStartButton

ShowStartButton

The entry of the parameter name is rated as ShowStartButton = true.
 Displays a button to launch jBEAM. This parameter is only evaluated if AutomaticStart = false and this parameters are entered.

Example:

ShowStartButton

NewWindow

NewWindow

The entry of the parametername is evaluated as NewWindow = true.
 Starts jBEAM in an own window. If the parameter is not entered, jBEAM is started in the applet container.

Example:

NewWindow

See also

Copyright by Kistler Chemnitz GmbH 2021
XWiki Enterprise 4.4 - Documentation