XML-file parameters reference guide

Contents

Axxon PSIM base

XML file	Parameter	Available values	Default	Product version	Parameter in effect
<Archive storage drive>:\VIDEO\Settings.xml	RotateAngle	0, 90, 180, 270	0		Sets the rotation angle of video image in the archive. If the rotation angle is specified in the video camera settings (see Configuring a rotation angle of video image), then this parameter is set automatically in Settings.xml file. In Axxon player the archive is rotated at the specified angle when being played back or exported
<Archive storage drive>:\VIDEO\Settings.xml	SyncedTime	Date and time in the following format: DD-MM-YY hh:mm:ss	-		Shows time of last import from edge storage as DD-MM-YY hh:mm:ss The import is performed from the time specified in the parameter if the number of hours does not exceed the time set by IpStorageSyncDepthHours registry key (see Registry keys reference guide). The parameter can be changed by UPDATE_TIME command (see IPSTORAGE Edge storage)
C:\ProgramData\elasticsearch-5.2.2\config\elasticsearch.yml	http.port	0 - 65536	9200	Axxon PSIM 1.0.0 and later	The parameter sets the port occupied by Elastic Search search engine. The value is to be the same as one specified in the cam_title.run.config file (see below)
<Axxon PSIM installation>\Modules\cam_title.run.config	ElasticSearchPort	0 - 65536	9200		The parameter sets the port Axxon PSIM sends data for Elastic Search search engine to. The value is to be the same as one specified in the elasticsearch.yml file (see above)
<Axxon PSIM installation>\HostSettings.xml	DNS	-	-	-	This file stores the addresses of DNS servers specified using the Advanced Setup utility (see The Settings panel of the DNS section)
<Axxon PSIM installation>\Modules\cam_title.run.config	SearchIndex	True, False	False	Axxon PSIM 1.0.0 and later	Enables the use of the Elastic Search search engine for titles search. True – Elastic Search is in use False – Elastic Search is not in use

WEB Report System PSIM

XML file	Parameter	Available values	Default	Product version	Parameter in effect
<Axxon PSIM installation directory>\Modules\Wt2\Web.config	CamMonitorShift	-5000 - 5000	0	1.0.0 and later	Sets shifting of video start while report viewing in milliseconds: >0 – video will start later than time specified in a report <0 – video will start earlier than time specified in a report
	WorkThroughGateway	true, false	false	1.0.0 and later	Enables receiving video from Gateway while viewing video for POS reports and for Face module report. A Gateway is selected authomatically.
	CommandTimeout	Time in seconds	200	1.0.0 and later	Enables setting the timeout in seconds, during which waiting for data retrieval and report generation should occur.
	PersonNameLength	>=0	-	1.0.0 and later	By default, the parameter is not added to the file (corresponds to value 1). Add it to the <appSettings> section in the following format: <add key = "PersonNameLength" value = "5" /> The parameter limits the user's patronymic to the number of characters specified in the value parameter for Access Manager and Time&Attendance reports. Example (if value = "5"): Ivanoff Peter Alex. If value = "0", the full name is displayed completely, without abbreviations. Example: Ivanoff Peter Alexandrovich.
	PersonNameIncludesId	0, 1	-	1.0.0 and later	By default, the parameter is not added to the file (corresponds to value 0). Add it to the <appSettings> section in the following format: <add key = "PersonNameIncludesId" value = "1" /> The parameter allows enabling display of the user ID in parentheses after the user full name in the Access Manager and Time&Attendance reports. value = "1" - the user ID in parentheses is displayed after the user full name. Example: Ivanoff Peter Alexandrovich (1) value = "0" - the user ID is not displayed.
	SweatheartingEnabled	0, 1	0	1.0.0 and later	Enables the Sweethearting report.
	SweatheartingAddItemPosFunctionNumber	>=0	-	1.0.0 and later	Sets the Adding product to document function number from the dbo.FuncDic table, which is necessary for the Sweethearting report proper operation.
	SweatheartingBeginReceiptPosFunctionNumber	>=0	-	1.0.0 and later	Sets the function number used as the receipt beginning from the dbo.FuncDic table.
	SweatheartingEndReceiptPosFunctionNumber	>=0	-	1.0.0 and later	Sets the function number used as the receipt ending from the dbo.FuncDic table.
	SweatheartingFilterByReceiptIntervals	0, 1	0	1.0.0 and later	Enables the sweethearting events filtering so that only the events which occured while the receipt was open were displayed in the Sweethearting report.
	SweatheartingAddTimeoutMs	>=0	500	1.0.0 and later	Sets the timeout between the sweethearting detector event and the POS event. If this timeout is exceeded, the sweethearting event is added to the Sweethearting report.
	SweatheartingBeepEnabled	0, 1	0	1.0.0 and later	Disables the sound notification about new events in the Sweethearting report.
	SweatheartingStepCount	>=0	1000	1.0.0 and later	Sets the required number of the events which should be preloaded on the first Sweethearting report launch.
	SweatheartingPreloadDays	>=0	140	1.0.0 and later	Sets the required number of days the events from which should be displayed on the first Sweethearting report launch.
	EnablePasskindReport	true, false	false	1.0.0 and later	Activates an Issued pass cards report.
	lpServerUrl	IP address of the http://localhost:[port]/[object] form	http://localhost:22441/core	1.0.0 and later	Sets the IP address of the server the data from which is used to build reports. http://localhost:22441/core—address for the Access Manager reports. The port number is determined by the Restport key, the default is 22441. http://localhost:10001/lprserver—address for the AUTO reports. The port number is determined by the URMLPR\Restport key, the default is 10001. http://localhost:10000/firserver—address for the reports using the Face Recognition Server. The port number is determined by the FRS\Restport key, the default is 10000. See also Registry keys reference guide
	PsimVideoStreamNumber	0-4	0	1.0.0 and later	Sets the required camera stream number in live video reports (0 is the first camera stream).
	ShowIconNewCashier	true, false	true	1.0.0 and later	Highlights the new cashier's name in POS reports with the asterisk and the different color (the new cashiers are those who work less than a number of days specified in the CountDaysNewCashier key).
	CountDaysNewCashier	>=0	30	1.0.0 and later	Sets the number of days within which the cashier is considered a new one (the key is used together with the ShowIconNewCashier key).
	QueueLengthDelta	0, 0.5	0.5	1.0.0 and later	Sets the values threshold that are included into the table reports by Queue Length detectors: 0 - values equal to 0 and greater are included in the report. 0.5 - only the values greater than 0.5 are included in the report.
	GenderAnalyticsUrl	IP address	http://localhost:10000/firserver	1.0.0 and later	Sets the address of the server where the Face Recognition Server is located (see Configuring the Gender analytics report).
	ReportSystemHost	IP address	localhost	1.0.0 and later	Sets the address of the server on which the Axxon PSIM software package is located. It is necessary for the Face recognition report (see Face recognition report) and Report by employee passes with photo (see Report by employee passes with photo).
<Axxon PSIM installation directory>\Modules\Wt2\App_Data\Settings\DateFormat.config	ServerDateTimeFormat	Date and time format	d MMMMM yyyy HH:mm:ss	1.0.0 and later	Sets the date and time format in General Reports (see Configuring the date and time format in General Reports).
<Axxon PSIM installation directory>\Modules\Wt2\App_Data\Mail\web.config	<configuration><system.net><mailSettings><smtp> from	String	-	-	Email address from which the auto-generated reports will be sent (see Configuring the SMTP Server).
	<configuration><system.net><mailSettings><smtp> host	String	-	-	SMTP Server name (see Configuring the SMTP Server).
	<configuration><system.net><mailSettings><smtp> password	String	-	-	Password of the account used for sending the messages to SMTP Server (see Configuring the SMTP Server).
	<configuration><system.net><mailSettings><smtp> port	>=0	25	-	Port number used by SMTP Server (see Configuring the SMTP Server).
	<configuration><system.net><mailSettings><smtp> userName	String	-	-	Name of account used for sending the messages to SMTP Server (see Configuring the SMTP Server).
	<configuration><system.net><mailSettings><smtp> enableSsl	true, false	false	-	Enables the SSL encoding to connect to the SMTP Server (see Configuring the SMTP Server).
<Axxon PSIM installation directory>\Modules\Wt2\App_Data\Settings\Settings.config	CurrencyFormat	String	₽	1.0.0 and later	Sets the currency display format for the report by the number of goods with specific action.
	IsPersianLanguageUse	true, false	false	1.0.0 and later	Enables the numbers filtering using the Persian alphabet and numbers. Note. If this key is set to true, then the IsArabicLanguageUse key should be set to false.
	IsArabicLanguageUse	true, false	false	1.0.0 and later	Enables the numbers filtering using the Arabic alphabet and numbers. Note. If this key is set to true, then the IsPersianLanguageUse key should be set to false.

FACE PSIM

XML file	Parameter	Available values	Default	Parameter in effect
<Directory of the Axxon PSIM software installation>\Modules\face_client.run.config	ProblemImages	Path to a folder	None	Specifies the path to the folder for storing images which have been skipped (there are 2 or more faces in the image, or the face was not recognized due to the poor image quality) during the automatic adding of faces from the folder (see Adding images to the reference face database). The specified folder will be created automatically. Note. If %USER% is specified in the parameter value, the images which haven't been added to the database will be stored in the folder: C:\Users\%LOGGED_USER%\AppData\Local\AxxonSoft\FacePSIM\ProblemImages\
	Timeout	>=0	60000	Specifies the waiting timeout for the face search results in milliseconds
	Port	>=0	10000	Specifies the TCP port for face_client.run
	RemoteUrl	IP address	none	Specifies the sending address of the HTTP POST request. It is used for the images transfer to an external system (see Configuring the images transfer to an external system)
	AnalitycTimeout	>=0	1000000	Specifies the time in milliseconds for refreshing the analytical data in the Face recognition and search interface object. When the time expires, the Operation has timed out error will be displayed (see Viewing the analytical data)
	PasserByFramesPerCamera	>=0	10	Specifies the maximum number of comparison results for one camera. A value of 0 means that the number of comparisons is unlimited
	HideViewButton	true, false	False	Hides the “View” button from the interface for monitoring of captured and recognized faces (see Monitoring of captured and recognized faces)
	SimpleMode	true, false	False	Enables the Simple mode of monitoring, which makes the upper part of the Face recognition and search interface window hidden, and such operations as working with the reference face database, face searching in the video archive, and some others unavailable (see Enabling the Simple mode of captured and recognized faces monitoring)
	AutoFollowTimeSeconds	>=0	120	Specifies the time in seconds after which the Follow new faces checkbox will be set automatically, if it is unset. The 0 value means that the checkbox will not be set automatically (see Monitoring of captured and recognized faces)
	CounterRowCount	>=0	0	Specifies the maximum number of rows (unique faces) in the generated report on analytical data (see Viewing the analytics). The 0 value means there is no limit
	HideCheckBoxPSIMPerson	true, false	False	Hides the Create a user in the PSIM database checkbox and assigns a unique Person_ID to each face when adding it to the reference face database (see Adding images to the reference face database)
	HideResultsWithoutImages	true, false	False	Hides the face search results with the face images damaged due to the emergency shutdown of the FACE PSIM server
<Directory of the Axxon PSIM software installation>\Modules64\firserver_replicate.run.config	LogBadImages	true, false	False	Enables saving "bad" photos of faces when the Face database replication module is used (see Face database replication). Photos of faces which could not be added will be saved on the main Server in the folder <Directory of the Axxon PSIM software installation>\Modules64\Firserver_replicate_problem_images

Axxon Player

XML file	Parameter	Available values	Default	Parameter in effect
<Axxon PSIM installation directory>\Tools\Axxon_player.xml	Most of the parameters are filled in automatically in the Axxon Player interface. Below are the options that are not available in the interface
	Render	0, 1	1	Sets the type of render: 0 − rendering is performed in OpenGL 1 − rendering is performed in Direct3d

Page tree

Documentation for Axxon PSIM 1.0.0-1.0.1.

Axxon PSIM base

WEB Report System PSIM

FACE PSIM

Axxon Player