Wiki source code of ACMP Agent

Last modified by Sabrina V. on 2026/07/23 13:05

version	line-number	content
1.1	1	{{aagon.floatingbox/}}
	2
121.1	3	The agent is deployed to the network clients directly from the ACMP Console. It is required to send Client Commands directly to a client and to maintain continuous communication between the client and the server.
1.1	4
106.1	5	= ACMP Kiosk =
	6
121.1	7	On this page, you can configure the ACMP Kiosk.
106.1	8
121.1	9	[[Settings (ACMP Kiosk)>>image:ACMP Settings.png\|\|alt="Einstellungen: ACMP Kiosk"]]
106.1	10
121.1	11	In the //General// section, you specify the icon properties. You have the following three options:
106.1	12
121.1	13	\|(% style="width:253px" %)Option\|(% style="width:1111px" %)Description
	14	\|(% style="width:253px" %)Do not display a tray icon\|(% style="width:1111px" %)As a result, your users will not see a tray icon for either the ACMP Kiosk or the Command Launcher
	15	\|(% style="width:253px" %)Display ACMP Kiosk Tray Icon\|(% style="width:1111px" %)This causes the ACMP Kiosk tray icon to be displayed, replacing the Command Launcher.
106.1	16
	17	= Agent Task =
	18
121.1	19	In this section, you can configure the scope of the software scanner and file scanner.
106.1	20
121.1	21	== Software scanner ==
106.1	22
121.1	23	The software scanner assists you in using [[Licence Management>>doc:ACMP.610.ACMP-Solutions.Lizenzmanagement.WebHome]].
106.1	24
121.1	25	You can specify whether the software scanner should ignore updates and system components during the scan. This will reduce the number of results accordingly. You can also specify whether to enable the search for user-specific setup and uninstallation paths. This option is disabled by default. Once activated, the uninstall string will be displayed in the [[Client Details>>doc:ACMP.610.ACMP-Solutions.Client-Management.Abfrageverwaltung.Abfragen auswerten.WebHome\|\|anchor="HOpenandworkwithClientDetails"]].
106.1	26
121.1	27	== File Scanner ==
106.1	28
121.1	29	The File Scanner can also assist you with [[Licence Management>>doc:ACMP.610.ACMP-Solutions.Lizenzmanagement.WebHome]], since not all applications leave an entry in the client’s software.
106.1	30
	31	{{aagon.infobox}}
121.1	32	During activation of the search function, please note that this involves user-specific data as defined by the GDPR.
106.1	33	{{/aagon.infobox}}
	34
121.1	35	Specify whether %WinDir% should be included in the scan. This option is disabled by default during installation. Additionally, specify the file extensions you want to scan for. Here, you can expand the scan to include the following file extensions:
106.1	36
	37	* .exe
	38	* .dll
	39	* .sys
	40	* .jar
	41
121.1	42	Now specify additional devices to be scanned. You have the following options:
106.1	43
121.1	44	* Fixed devices
	45	* Include USB devices
	46	* Removable data drives
	47	* Include USB devices
106.1	48
121.1	49	= General =
106.1	50
121.1	51	== Agent Installation and Network Account ==
106.1	52
121.1	53	On this page, you first specify the agent installation and network identification account. Here, you can access existing global accounts, create new ones, or specify a specific account. To do so, enter the username and corresponding password in the appropriate fields.
110.1	54
121.1	55	[[System settings (Agent)>>image:68_System_ACMP Agent_Allgemein.png\|\|alt="Systemeinstellungen: ACMP Agent"]]
110.1	56
121.1	57	You can specify that the system first check whether the specified account has sufficient rights for installation on all computers found on the network. To do this, select the “Check rights on target computers” checkbox.
110.1	58
	59	{{aagon.infobox}}
121.1	60	If the ACMP Server is installed on an operating system newer than Windows Server 2003, the specified account is also used for network discovery. This account must therefore have sufficient rights for RPC and for scanning the network.
110.1	61	{{/aagon.infobox}}
	62
	63
	64
121.1	65	== Agent Installation Folder ==
110.1	66
121.1	67	Specify the storage location for the ACMP Agent files. After installation, this is also where you’ll find CommandLauncher.exe, which you can use to launch the Client Command Launcher and execute Client Commands as an alternative to the tray icon.
110.1	68
121.1	69	== Client Settings ==
	70
	71	To uniquely identify computers on the network, ACMP offers various options for Windows and Unix clients. Select the value that is unique on your network.
	72
110.1	73	* Windows Clients:
	74	** Computer SID
121.1	75	** Computer Name
	76	** Primary MAC
	77	** SMBIOS system UUID
110.1	78	* Unix Clients:
121.1	79	** Machine ID
	80	** Computer Name
	81	** Primary MAC
110.1	82
	83	{{aagon.warnungsbox}}
121.1	84	If the selected value is ambiguous, scan data from another Client will be overwritten, and your database will become corrupted.
110.1	85	{{/aagon.warnungsbox}}
	86
121.1	87	== Online Status ==
110.1	88
121.1	89	The online status feature allows you to define a time period for all client-based queries, which is displayed in the Query Management interface. Here, you can specify the number of minutes after which the client’s last contact with the ACMP Server is no longer considered online. The default value is 60 minutes. Active Clients that are displayed as online in the Query are marked with a green dot; Offline Clients are displayed with a gray icon. Manual Clients, OSC, etc., are not considered online Clients and are displayed without an icon.
110.1	90
121.1	91	If you want to verify the Clients’ online status, you must enable the corresponding checkbox. Only then will the ACMP Agent contact the ACMP Server at the interval you specified.
110.1	92
121.1	93	== Job Execution Mode ==
110.1	94
121.1	95	The job execution mode allows you to configure how jobs should behave once their start condition is met. This currently applies only to jobs of the types “Windows Update Management,” “Managed Software,” and “BitLocker.” Choose between the two available options, //Always// and //Only when changes are applied//:
110.1	96
121.1	97	\|Option\|Description\|Example
	98	\|Always\|In this mode, the job always runs as soon as the start condition for that job is met. A Job Log is always generated.\|A Managed Software job will not make any changes on a client if the same version of the software included in the Managed Software job is already installed. The job log created for this simply indicates that the job ran but that no changes were made.
	99	\|Only when changes are applied\|With this option enabled, the job is executed, and a Job Log is created only if the job also performed an update (either for Managed Software or a Windows Update).\|With this configuration, there will be no Job Log, since no “actual execution” took place—the software did not need to be updated.
110.1	100
121.1	101	[[Job Execution Mode for the Start Conditions>>image:69_Einstellungen ACMP Agent_Job-Ausführungsmodus_749.png]]
113.1	102
10.2	103
	104
121.1	105	= Login History and Primary User =
10.2	106
121.1	107	In general, you can designate one contact as the primary user for each client. Designating a primary user is generally helpful for quickly determining, in day-to-day operations, which user primarily uses a client. Additionally, designating a primary user is mandatory if you wish to claim the //[[secondary usage right>>doc:ACMP.610.ACMP-Solutions.Lizenzmanagement.Lizenzen.WebHome]] //for a client.
	108
	109	There are two ways to designate a primary user for a client: You can either designate the primary user manually or enable automatic primary user detection so that the primary user is determined automatically and dynamically based on logins to the client.
	110
83.1	111	{{aagon.infobox}}
121.1	112	Please note that to view the login history, you need a user who has the appropriate right. You can assign and enable this right via [[User Management>>doc:ACMP.610.ACMP-Solutions.System.Benutzerverwaltung.WebHome]] (//Rights of User// > //Client Management// > Query Management > Client Details > Open Client Details > “View Client Login History”).
83.1	113	{{/aagon.infobox}}
	114
121.1	115	[[Required rights in user management for using the sign-in history>>image:68_Benutzerverwaltung_Rechte des Benutzers Anmeldeverlauf_988.png]]
87.1	116
10.2	117
	118
121.1	119	== Manually Designating a Primary User ==
10.2	120
121.1	121	You can manually designate a primary user in the Client Details. To do this, you must first open a client using a Query and then [[display the Client Details>>doc:ACMP.610.ACMP-Solutions.Client-Management.Abfrageverwaltung.Abfragen auswerten.WebHome\|\|anchor="HOpenandworkwithClientDetails"]].
10.2	122
121.1	123	Within the Client Details, navigate to the //Linked Contacts// entry. There, all contacts currently linked to the client are displayed. The following functions are available in the detail view of the linked contacts:
10.2	124
121.1	125	\|=Function\|=Description
	126	\|Add a shortcut \|Click this button to open the contact list. From this list, you can then select a contact to link to the client.
	127	\|Delete a shortcut\|You can use this button to remove a contact that has already been linked.
	128	\|Reset the primary user\|This button deletes the currently active primary user. The Client will then no longer have a primary user.
10.2	129
121.1	130	You can now select which of the linked contacts should be the client's primary user. To do so, check the checkbox in the //Primary User// column next to the specific contact.
20.1	131
121.1	132	[[Manually Setting the Primary User in Client Details>>image:68_System_ACMP Agent_Manueller Hauptbenutzer.png\|\|alt="Manuelle Festlegung des Hauptbenutzers in den Client Details"]]
10.2	133
	134
121.1	135
	136	== Automatic Primary User Detection ==
	137
	138	With automatic primary user detection, it is possible to automatically and dynamically determine a client’s primary user based on logins to that client. To do this, there are two linked functions in the ACMP Console’s system settings—“Login History” and “Primary User”—that must be enabled for automatic primary user detection.
	139
10.2	140	(% class="box infomessage" %)
	141	(((
	142	[[image:https://doc.aagon.com/bin/download/XWiki/Aagon Infobox/WebHome/Information.svg\|\|alt="Hinweis" height="32" width="32"]] Hinweis:
	143
121.1	144	Both functions are disabled by default for privacy reasons.
10.2	145	)))
	146
121.1	147	=== Enable Login History Tracking ===
10.2	148
121.1	149	By enabling the first function, //Scan Login History//, logins can be tracked and saved. Only “real” logins are counted - that is, Windows logins in which a full session is established. Both RDP sessions and local logins are tracked.
10.2	150
11.1	151	(% class="box" %)
	152	(((
121.1	153	Example: For example, it is not considered a login when a user logs back into the Client after the screen has been locked.
11.1	154	)))
	155
121.1	156	After activation, you can view the client's login history in the Client Details under the //Software //> //Operating System //folder in the //Login History //entry. Please note that the data for the login history is retrieved via the System Scanner. This means that the login history can only be stored for clients that were detected via the ACMP Agent or the OneScanClient.
11.1	157
121.1	158	[[A Client's Login Process>>image:Anmeldeverlauf_Hauptbenutzer.png\|\|alt="Anmeldeverlauf eines Clients"]]
20.1	159
121.1	160	For all clients that were added in other ways, a login history cannot be generated. Accordingly, the primary user must still be set manually, even if the clients are not explicitly on the blacklist.
	161	You can also specify in the settings how many days after they are created the recorded login histories should be deleted by a server job.
11.1	162
121.1	163	{{aagon.infobox}}
	164	Information that has already been deleted from the login history cannot be restored or added later.
11.1	165
121.1	166	Example: If data is deleted after 90 days by default and the settings are temporarily changed to 30 days, the data that has already been deleted as a result will not be restored if the 90-day retention period is subsequently reinstated.
	167	In this case, it will take up to 60 days for the data set to return to the intended retention period.
	168	{{/aagon.infobox}}
	169
11.1	170	{{aagon.infobox}}
121.1	171	If you have many clients and your system retains login histories for a long time, large amounts of data may accumulate, which can slow down your system. Therefore, you should not set the number of days before login histories are deleted to be too high.
11.1	172	{{/aagon.infobox}}
	173
121.1	174	=== Enable Setting the Primary User ===
11.1	175
121.1	176	The activation of the second function, //Automatically Set Primary User//, automatically designates a user as the primary user after a specified number of consecutive logins. You can set the number of consecutive logins required in the settings.
11.1	177
31.1	178	{{aagon.warnungsbox}}
121.1	179	The calculation of the primary user is not triggered directly by a user login, but takes place 10 minutes after the first login. Therefore, there may be a delay between logins and the designation of the primary user.
31.1	180	{{/aagon.warnungsbox}}
11.1	181
121.1	182	Static or dynamic blacklisting allows you to exclude specific clients from this automatic process. To do this, you can either statically add selected clients to the list of clients without a primary user in the settings, or [[apply filter options>>doc:ACMP.68.ACMP-Solutions.Client-Management.Abfrageverwaltung.Abfragen erstellen.Filteroptionen anwenden.WebHome]] to dynamically manage clients without a primary user.
31.1	183
11.1	184	{{aagon.infobox}}
121.1	185	Login history tracking is also activated even if the client is excluded from automatic primary user detection due to blacklisting.
11.1	186	{{/aagon.infobox}}
	187
121.1	188	[[Enable Automatic Primary User Detection>>image:68_System_ACMP Agent_Haupbenutzer automatischen setzen.png\|\|alt="Automatische Hauptbenutzererkennung aktivieren"]]
20.1	189
121.1	190	Once you have enabled automatic primary user detection, the //Linked Contacts// entry in the Client Details will display a banner at the bottom of the window indicating that the primary user for the selected client is set automatically. The client also detects and remembers the user type. If the user is an Active Directory user, the user’s contact is automatically listed as a linked contact and set as the primary user.
11.1	191
	192	{{aagon.infobox}}
121.1	193	Automatic contact linking works only for AD users. Other user types are not linked.
11.1	194	{{/aagon.infobox}}
	195
121.1	196	[[Display of the automatically linked primary user in the Client Details>>image:68_System_ACMP Agent_Hauptbenutzer_verknüpft.png\|\|alt="Anzeige des automatisch verknüpften Hauptbenutzers in den Client Details"]]
20.1	197
121.1	198	Once automatic primary user detection is enabled, you can no longer reset or manually change the primary user. You can still manually add new Shortcuts and delete manually added Shortcuts, provided that the linked contact is not the primary user.
11.1	199
121.1	200	= Remote Desktop Services =
1.1	201
121.1	202	Here you can define how data collected from Remote Desktop connections is handled.
1.1	203
	204	{{figure}}
54.1	205	[[image:68_System_Einstellungen_RemotedesktopDienste_1327.png\|\|alt="Remotedeskotp Dienste.PNG" data-xwiki-image-style-alignment="center"]]
1.1	206
	207	{{figureCaption}}
121.1	208	Remote Desktop Services settings
1.1	209	{{/figureCaption}}
	210	{{/figure}}
	211
	212
	213
121.1	214	== Cleaning Up Collected Data ==
1.1	215
121.1	216	By default, data collected by the ACMP Agent via Remote Desktop connections is deleted after 180 days.
1.1	217
121.1	218	== Data Collection Methods ==
1.1	219
121.1	220	When the ACMP Agent logs in via Remote Desktop, you can choose which method to use for data collection. You can select one of the following three options:
	221
	222	* Never send collected data
	223	* Send only if the client has Remote Desktop Services installed
	224	* Always send collected data
	225
	226	By default, the “Send only if the client has Remote Desktop Services installed” option is selected.
	227
	228