Example of deploying and running a file from the File Repository (MSI file)

1

2

160

= Initial situation =

8

9

During the course of a normal working day, you often need to deploy new software to your company's employees. You can either manually distribute the installation resources to each individual client or you can simply deploy the files as a client command so that everyone can access them.

10

11

In this example you will learn how to deploy an MSI file to Clients. For example, the 7-Zip file compressor will be uploaded and made available via your Agent. There are several ways in which you can distribute such a file. At this point we will only show you how to do this using ACMP's File Repositories. The file repository ensures that all employees receive the resource despite different or changing locations. Proceed as follows:

== Select Script ==

1. Navigate to the //Client Commands// > //Create// module.

16

1. Click //Add// on the ribbon bar. The Client Command Editor will open and you will need to decide whether it is a Console or Client Script. In this case select Client Script.

17

18

== Uploading files to the File Repository ==

19

20

(% class="wikigeneratedid" %)

21

To start working on the Client Command, you must first place the installation resource in the File Repository.

22

23

1. Open the File Repository from the Command List ([[image:image-20230809131053-1.png]]).

24

1. Click on the File Repository column to open the subfolders.

25

1. Select the //Private //folder.

26

27

28

It is important that you select the //Private// directory as the installation resource should only be used for the Client Command.

29

30

31

4. Add the file to the Private File Repository by clicking on the corresponding icon ([[image:image-20230809131133-3.png]]).

32

5. A dialogue will open. Select the installation resource you wish to make available in the Client Commands. In this example, 7-Zip is used.

33

6. Double click to load the MSI file.

34

A progress bar will appear to inform you of the progress. In this example, the 7x2201-x64.msi file from 7-Zip has been successfully loaded into the file repository.

7. Click //Close//.

(% style="text-align:center" %)

39

[[image:65_Use Case Client Commands_Installationsressource im File Repository hinterlegen.png]]

40

41

42

Store the installation resource in the file repository

== Insert and customise Command //Download File// ==

47

48

1. Navigate to the Command List and select //File Repository// > //Download File//.

49

1. Double click to open the Command.

50

1. Under //Select File(s)//, click the icon to the right of the fields.

51

1. Open the added file (7x2201-x64.msi) in the File Repository under the //Private// directory by ticking the box in front of the file. The //File Repository//, //Private// and //7x2201-x64.msi// items should now be checked.

52

1. Click //Close// to return to the previous window.

53

1. Navigate to //Save as//. Here you can either select the path where the file is to be saved from the icon to the right of the fields. Alternatively, you can use the //%PROJECTDIR%// variable.

54

55

56

PROJECTDIR is a temporary variable that creates a directory during the execution of the Client Command and automatically deletes it after the Client Command has finished. This causes files to be downloaded into the PROJECTDIR.

57

58

59

7. Access the %PROJECTDIR% variable using CTRL + Space.

60

8. Switch to the //General //tab.

61

9. Enter a new description of the action, e.g. "Download 7-Zip to %PROJECTDIR%".

62

10. Finish your work on the Command by clicking //OK//.

63

64

65

(% style="text-align:center" %)

66

[[image:65_Use Case Client Commands_Datei herunterladen.png]]

Download file

== Inserting and editing the //Install MSI package //Command ==

74

75

1. Load the //Install MSI Package// (MSI) Command into the script by double-clicking it in the Command List, just like the previous Commands.

76

1. Click the //Browse// icon in the //Package// area.

77

1. Select the 7-Zip installation file and click //Open//.

78

1. Remove the path except for the filename and replace it with the %PROJECTDIR% variable. To do this, select the %PROJECTDIR% variable with CTRL + space. You should now see "%PROJECTDIR%7z2201-x64.msi".

79

80

81

There must be no backslash between the variable and the filename, as all directory variables in ACMP end with a backslash.

82

83

84

5. Check the //'Always installed elevated' registry keys// under the policies.

85

6. Click //OK// to close the Command.

86

87

88

(% style="text-align:center" %)

89

[[image:65_Use Case Client Commands_MSI Paket installieren.png]]

Install MSI package

== Inserting and editing the //Run Client Task //Command ==

97

98

You can add this Command to your Client Command to start the software scanner immediately. This ensures that the new software is immediately inventoried and available in the console.

99

100

1. Select //ACMP// > //Run Client Task// from the Command List.

101

1. Open the //General// tab.

102

1. In the //Description of action field//, enter a name, e.g. „Run software scanner as a scheduled task“.

103

1. Return to the //Details// tab.

104

1. Under //Run as a scheduled task//, select the software scanner. This will inventory the system and update the newly added software in the console.

1. Click //OK//.

(% style="text-align:center" %)

109

[[image:65_Use Case Client Commands_Software Scanner als geplante Aufgabe ausführen.png]]

110

111

112

Execute software scanner as scheduled execution

Save your Client Command. Depending on the size of your environment, you may wish to give it a suitable name so that you can easily find it again. This example is called "7-Zip 7x2201-x64 Installation" and is made up of the name of the software and the version number.

117

118

119

(% style="text-align:center" %)

120

[[image:65_Use Case Client Commands_Übersicht exemplarische Bereitstellung und Ausführung einer Datei über das File Repository (MSI-Datei)_1377.png]]

121

122

123

Client Commands - Execute: Exemplary provision and execution of a file via the file repository (MSI file)

== Running through Client Command phases ==

128

129

Finally, the Client Commands must go through the [[//Test//>>doc:ACMP.65.ACMP-Solutions.Client Commands.Client Command testen.WebHome]], [[//Synchronize//>>doc:ACMP.65.ACMP-Solutions.Client Commands.Client Command synchronisieren.WebHome]], [[//Release//>>doc:ACMP.65.ACMP-Solutions.Client Commands.Client Command freigeben.WebHome]] and [[//Execute//>>doc:ACMP.65.ACMP-Solutions.Client Commands.Client Command ausführen.WebHome]] phases before they can be used. You can then distribute and run the 7-Zip software installation resource to your Clients.

Wiki source code of Exemplarische Bereitstellung und Ausführung einer Datei über das File Repository (MSI-Datei)

Navigation

author	version	line-number	content
		1	{{aagon.priorisierung}}
		2	160
		3	{{/aagon.priorisierung}}
		4
		5	{{aagon.floatingbox/}}
		6
		7	= Initial situation =
		8
		9	During the course of a normal working day, you often need to deploy new software to your company's employees. You can either manually distribute the installation resources to each individual client or you can simply deploy the files as a client command so that everyone can access them.
		10
		11	In this example you will learn how to deploy an MSI file to Clients. For example, the 7-Zip file compressor will be uploaded and made available via your Agent. There are several ways in which you can distribute such a file. At this point we will only show you how to do this using ACMP's File Repositories. The file repository ensures that all employees receive the resource despite different or changing locations. Proceed as follows:
		12
		13	== Select Script ==
		14
		15	1. Navigate to the //Client Commands// > //Create// module.
		16	1. Click //Add// on the ribbon bar. The Client Command Editor will open and you will need to decide whether it is a Console or Client Script. In this case select Client Script.
		17
		18	== Uploading files to the File Repository ==
		19
		20	(% class="wikigeneratedid" %)
		21	To start working on the Client Command, you must first place the installation resource in the File Repository.
		22
		23	1. Open the File Repository from the Command List ([[image:image-20230809131053-1.png]]).
		24	1. Click on the File Repository column to open the subfolders.
		25	1. Select the //Private //folder.
		26
		27	{{aagon.infobox}}
		28	It is important that you select the //Private// directory as the installation resource should only be used for the Client Command.
		29	{{/aagon.infobox}}
		30
		31	4. Add the file to the Private File Repository by clicking on the corresponding icon ([[image:image-20230809131133-3.png]]).
		32	5. A dialogue will open. Select the installation resource you wish to make available in the Client Commands. In this example, 7-Zip is used.
		33	6. Double click to load the MSI file.
		34	A progress bar will appear to inform you of the progress. In this example, the 7x2201-x64.msi file from 7-Zip has been successfully loaded into the file repository.
		35	7. Click //Close//.
		36
		37	{{figure}}
		38	(% style="text-align:center" %)
		39	[[image:65_Use Case Client Commands_Installationsressource im File Repository hinterlegen.png]]
		40
		41	{{figureCaption}}
		42	Store the installation resource in the file repository
		43	{{/figureCaption}}
		44	{{/figure}}
		45
		46	== Insert and customise Command //Download File// ==
		47
		48	1. Navigate to the Command List and select //File Repository// > //Download File//.
		49	1. Double click to open the Command.
		50	1. Under //Select File(s)//, click the icon to the right of the fields.
		51	1. Open the added file (7x2201-x64.msi) in the File Repository under the //Private// directory by ticking the box in front of the file. The //File Repository//, //Private// and //7x2201-x64.msi// items should now be checked.
		52	1. Click //Close// to return to the previous window.
		53	1. Navigate to //Save as//. Here you can either select the path where the file is to be saved from the icon to the right of the fields. Alternatively, you can use the //%PROJECTDIR%// variable.
		54
		55	{{aagon.infobox}}
		56	PROJECTDIR is a temporary variable that creates a directory during the execution of the Client Command and automatically deletes it after the Client Command has finished. This causes files to be downloaded into the PROJECTDIR.
		57	{{/aagon.infobox}}
		58
		59	7. Access the %PROJECTDIR% variable using CTRL + Space.
		60	8. Switch to the //General //tab.
		61	9. Enter a new description of the action, e.g. "Download 7-Zip to %PROJECTDIR%".
		62	10. Finish your work on the Command by clicking //OK//.
		63
		64	{{figure}}
		65	(% style="text-align:center" %)
		66	[[image:65_Use Case Client Commands_Datei herunterladen.png]]
		67
		68	{{figureCaption}}
		69	Download file
		70	{{/figureCaption}}
		71	{{/figure}}
		72
		73	== Inserting and editing the //Install MSI package //Command ==
		74
		75	1. Load the //Install MSI Package// (MSI) Command into the script by double-clicking it in the Command List, just like the previous Commands.
		76	1. Click the //Browse// icon in the //Package// area.
		77	1. Select the 7-Zip installation file and click //Open//.
		78	1. Remove the path except for the filename and replace it with the %PROJECTDIR% variable. To do this, select the %PROJECTDIR% variable with CTRL + space. You should now see "%PROJECTDIR%7z2201-x64.msi".
		79
		80	{{aagon.infobox}}
		81	There must be no backslash between the variable and the filename, as all directory variables in ACMP end with a backslash.
		82	{{/aagon.infobox}}
		83
		84	5. Check the //'Always installed elevated' registry keys// under the policies.
		85	6. Click //OK// to close the Command.
		86
		87	{{figure}}
		88	(% style="text-align:center" %)
		89	[[image:65_Use Case Client Commands_MSI Paket installieren.png]]
		90
		91	{{figureCaption}}
		92	Install MSI package
		93	{{/figureCaption}}
		94	{{/figure}}
		95
		96	== Inserting and editing the //Run Client Task //Command ==
		97
		98	You can add this Command to your Client Command to start the software scanner immediately. This ensures that the new software is immediately inventoried and available in the console.
		99
		100	1. Select //ACMP// > //Run Client Task// from the Command List.
		101	1. Open the //General// tab.
		102	1. In the //Description of action field//, enter a name, e.g. „Run software scanner as a scheduled task“.
		103	1. Return to the //Details// tab.
		104	1. Under //Run as a scheduled task//, select the software scanner. This will inventory the system and update the newly added software in the console.
		105	1. Click //OK//.
		106
		107	{{figure}}
		108	(% style="text-align:center" %)
		109	[[image:65_Use Case Client Commands_Software Scanner als geplante Aufgabe ausführen.png]]
		110
		111	{{figureCaption}}
		112	Execute software scanner as scheduled execution
		113	{{/figureCaption}}
		114	{{/figure}}
		115
		116	Save your Client Command. Depending on the size of your environment, you may wish to give it a suitable name so that you can easily find it again. This example is called "7-Zip 7x2201-x64 Installation" and is made up of the name of the software and the version number.
		117
		118	{{figure}}
		119	(% style="text-align:center" %)
		120	[[image:65_Use Case Client Commands_Übersicht exemplarische Bereitstellung und Ausführung einer Datei über das File Repository (MSI-Datei)_1377.png]]
		121
		122	{{figureCaption}}
		123	Client Commands - Execute: Exemplary provision and execution of a file via the file repository (MSI file)
		124	{{/figureCaption}}
		125	{{/figure}}
		126
		127	== Running through Client Command phases ==
		128
		129	Finally, the Client Commands must go through the [[//Test//>>doc:ACMP.65.ACMP-Solutions.Client Commands.Client Command testen.WebHome]], [[//Synchronize//>>doc:ACMP.65.ACMP-Solutions.Client Commands.Client Command synchronisieren.WebHome]], [[//Release//>>doc:ACMP.65.ACMP-Solutions.Client Commands.Client Command freigeben.WebHome]] and [[//Execute//>>doc:ACMP.65.ACMP-Solutions.Client Commands.Client Command ausführen.WebHome]] phases before they can be used. You can then distribute and run the 7-Zip software installation resource to your Clients.