Web Interfaces

60

The Web Interface is an application that allows you to control the most important helpdesk actions via a browser. A distinction is made between the //Helpdesk Web Interface //and the //Self Service Web Interface//. The difference between the two versions is that the Helpdesk Web Interface can only be used by helpdesk staff, while the Self Service Web Interface is available to all other employees.

8

9

The following distinguishing criteria are central to this:

10

11

|Helpdesk Web Interface|After login, this allows you to open all queries that are accessible via the ticket management administration (see the chapter on [[Administration>>doc:ACMP.69.ACMP-Solutions.Helpdesk.Ticket Management.Tickets verwalten.WebHome]]. In addition, you can view and edit tickets, create new ones, and add comments and close them. The knowledge base can also be used.

12

|Self Service Web Interface|After login, the user is displayed all the tickets they have created themselves in the Self Service Web Interface by default. This list can be changed using a standard query (see [[Standard query>>doc:.Einstellungen zum Web Interface.WebHome||anchor="HSelfServicequeries"]]). New tickets can be created and existing ones can be viewed. It is also possible to access the Knowledge Base.

13

14

= Installation, Configuration and updating of Web Interfaces =

15

16

If you haven't yet started the installation of one of the Web Interfaces, you can read [[here>>doc:ACMP.69.ACMP installieren.ACMP Zusatzkomponenten installieren.Helpdesk Web Interface installieren.WebHome]] about how a correct installation and update look like and which settings you need to configure.

17

18

= Authentication and Right Management =

== Authentication ==

Users can log in to the Web Interface in two ways: They can either log in with their ACMP account (see user management) or authenticate themselves to an Active Directory so that they are granted access. For the latter option, you must have specified an AD account. You can configure the authentication in the [[Settings>>doc:.Einstellungen zum Web Interface.WebHome||anchor="HLogin"]] (//System// > //Settings //> //Web Interface// > //Login// > //Authentication settings//).

23

24

Select one of the two options. Save your changes by clicking //Save //in the ribbon bar. The updated conditions will take effect the next time you log in.

25

26

[[Authentication settings>>image:69_Web Interface_Authentifizierungseinstellungen_654.png]]

27

28

== Right Management for the Helpdesk ==

29

30

In principle, rights for the Helpdesk and use of the Web Interface are assigned via [[User Management>>doc:ACMP.69.ACMP-Solutions.System.Benutzerverwaltung.WebHome]] (//System// > //User Management//). For maximum flexibility, there are three different points of contact where you can explicitly assign rights to Helpdesk users or employees.

31

32

=== Self Service permissions ===

33

34

Under [[Self Service permissions>>doc:.Einstellungen zum Web Interface.WebHome||anchor="HSelfServicepermissions"]] (//System// > //Settings //> //Web// //Interface// > //Self Service permissions//), you will find several rights relating to the self-service web interface and its end users. Tick all the permissions you want to allow. Subordinate rights (e.g. ‘"Change ticket category") can only be selected if the level above has been enabled. This allows you to customize the main rights to suit your circumstances and further restrict or extend the rights. Save your settings via the ribbon bar.

35

36

[[Self Service permissions>>image:69_Web Interface_Self Service Berechtigungen_887.png]]

37

38

=== Rights of an ACMP or helpdesk employee ===

39

40

As soon as you create a new user via user management or edit one at a later date, you will inevitably reach the point in the wizard in step three where you can define the rights. This allows you to set restrictions that then apply directly to the current selected ACMP User. This generally applies to all rights in ACMP, but special rights can also be assigned for the helpdesk and the web interface.

41

42

To do this, open the item //Helpdesk// > //Web Interface// in the list on the left. Here you can modify the visibility of data in the Helpdesk web interface so that the created user is not allowed to view comments on a ticket in the web interface or view any ticket attachments, for example. You can set restrictions by assigning these rights. In addition, you can also allow a user to change possible solution suggestions, if desired.

43

44

45

[[Select rights of User (Web Interface)>>image:69_Web Interface_Rechte des Benutzers_1156.png]]

46

47

To grant a user a right, you must tick the corresponding checkbox and continue with the wizard (//Next >//). On the next page ("Roles and Clients"), you must now assign the "Helpdesk" role to the ACMP User. Tick the corresponding checkbox so that the previously specified rights can be applied.

48

49

[[Select roles and tenants for the current user>>image:69_Web Interface_Rollen und Mandanten_720.png]]

50

51

Complete your work in the wizard and exit it by clicking //Finish//.

52

53

54

**Special feature of the "Visible in Self Service" option**

55

56

When writing comments in tickets and/or knowledge base articles, as well as when creating knowledge base articles, you will find the "Visible in Self Service" option in the top right-hand corner. This is a checkbox that you must tick manually each time to enable the option and make the comment or article globally visible in the web interface. Please note that the comment or article is only visible to ACMP users and self-service users who have the appropriate right (right: "View ticket web comments").

57

58

59

= Customizing of graphics and text elements =

60

61

If you would like to customize the Web Interfaces to match your corporate identity, both graphically and textually, you can do so in just a few simple steps. To do this, proceed as follows:

62

63

== Replacing graphics ==

64

65

~1. Open the Windows Explorer and navigate to the installation directory of the Web Interfaces. By default, this is //%Programfiles%\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\//

66

67

[[Folder with access to the graphics>>image:69_Web Interface_Ordner Grafiken austauschen_1012.png]]

68

69

The directory //App_Themes\ACMP\graphics //contains graphics that can be used in the web interfaces.

70

71

72

Please note that graphical customizations will be overwritten after an update of the Web Interfaces.

73

74

75

3. Replace the graphics as required (replace the logo via file, located at: App_Themes\ACMP\graphics\logo.svg).

76

When replacing graphics, ensure that you use the same names as the original graphics so that they can be read correctly.

77

78

79

== CSS customizations ==

80

81

82

Please note that no support is offered for changes made independently and individually created to the Custom.css file or for general CSS adjustments. The following section merely provides some notes should you wish to make your own changes.

83

84

85

In order to customize CSS, you must have the file ‘Custom.css’ in the “Styles” folder (C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\Styles). To do this, create the file in a text editor of your choice and make sure that the extension is ".css".

86

87

88

The Custom.css file should remain valid after an update. It is recommended to remove the file if possible problems arise.

89

90

91

The file is initially empty and must now be filled. You can insert new content, edit existing content and customize it. Then save the changes by clicking //Save//. The file is always loaded last for the web interface, which means that the entries in this file have the highest priority for individual adjustments.

92

93

94

**As a general rule, the Custom.css file is a file that advances the code and does not replace it!**

95

96

97

For example, if you want to revise the logo, you must overwrite ".site-logo":

.site-logo{

background: url("../App_Themes/ACMP/graphics/logo.svg") left top no-repeat;

102

width: var(--logo-width);

103

height: var(--header-height);

}

Any changes should be made in Custom.css. These changes will override existing settings.

[[Changes on the Custom.css>>image:69_Web Interface_Custom.css Datei_712.png]]

114

115

Take a look at the different .css files in the "Styles" folder for the various classes.

116

117

**Example "Colour changes"**: If you want to make changes to the colours, you should copy the corresponding variables from Theme.css and insert and customize them in Custom.css within a //:root { }// using tags.

118

119

[[Colour change of error colours within Custom.css>>image:69_Web Interface_Farbänderung der Error Farben_682.png]]

120

121

122

To change the colour, simply copy the relevant section. You do not need to copy the entire root tree in Custom.css.

123

124

125

== Customizing text colours ==

126

127

To customize text colours, follow these steps:

128

129

~1. Open the installation path (default: //%Program Files%\Aagon\ACMP Web Interfaces\Helpdesk Web Interface\App_Themes\ACMP//).

130

131

2. Now open the file //Custom.css// stored in this directory.

132

133

134

Please note that the file for single sign-on is stored separately (path: %Programfiles%\Aagon\ACMP Web Interfaces\SSO\App_Themes\ACMP).

135

136

137

Any changes must be made separately.

138

3. The file contains individual and “class”-based definitions for text display. Customize the colour for the respective area here by replacing the hexadecimal value.

.welcomeText {

color: #ff0000;

}

== Customizing texts ==

148

149

To change a text in the web interface, you must customize the corresponding .resx file. These can be found in the following paths and subfolders. Each file is available in three language versions (German, English and Czech).

150

151

* C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\App_GlobalResources

152

* C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\App_LocalResources

153

* C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\ErrorPages\App_LocalResources

154

* C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\Pages\App_LocalResources

155

* C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\Pages\Dialogs\App_LocalResources

156

* C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\Pages\imageuploader\App_LocalResources

157

* C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\Pages\UserControls\App_LocalResources

158

159

Open the resource file with a text editor (e.g. Notepad++) and customize the text as desired. Then save the file.

160

161

162

Once you have made the textual changes, you must restart IIS and clear the cache.

163

Do not forget to clear your browser cache as well so that the changes take effect.

Please note that you must always customize the respective files in the App_LocalResources path to the appropriate language. If you are using the web interface in English, you must customize the corresponding .resx file there and not just in the German file.

= Creating custom fields for the Self Service Web Interface =

172

173

As a help desk employee or administrator, you can create additional custom fields for the Self Service Web Interface that can or should be filled in by the ticket creator when creating a new ticket. This makes it possible to retrieve individual fields and information that can make your work easier.

174

175

If you would like to use the custom fields, navigate to //System //> //Settings //> //Custom Fields //> //Tickets// in the open ACMP Console. Follow the necessary steps to [[add a field>>doc:ACMP.69.ACMP-Solutions.System.Einstellungen.Benutzerdefinierte Felder.WebHome||anchor="HFelderhinzufFCgen"]]. Then save the newly created fields and switch to //Web Interface //> //Self Service Fields// in the system settings.

176

177

Open the folder hierarchy where you previously added the new field. Then either drag it to the right side with a mouse click or use the arrow for this purpose. For the fields on the right, you can also specify whether it is a mandatory field that the user must explicitly fill in in Self Service in order to create a ticket. Optionally, tick the box and save the changes in the ribbon bar. The next time you call up the Web Interface Self Service, your newly added fields will be taken into account when creating a new ticket.

author	version	line-number	content
		1	{{aagon.priorisierung}}
		2	60
		3	{{/aagon.priorisierung}}
		4
		5	{{aagon.floatingbox/}}
		6
		7	The Web Interface is an application that allows you to control the most important helpdesk actions via a browser. A distinction is made between the //Helpdesk Web Interface //and the //Self Service Web Interface//. The difference between the two versions is that the Helpdesk Web Interface can only be used by helpdesk staff, while the Self Service Web Interface is available to all other employees.
		8
		9	The following distinguishing criteria are central to this:
		10
		11	\|Helpdesk Web Interface\|After login, this allows you to open all queries that are accessible via the ticket management administration (see the chapter on [[Administration>>doc:ACMP.69.ACMP-Solutions.Helpdesk.Ticket Management.Tickets verwalten.WebHome]]. In addition, you can view and edit tickets, create new ones, and add comments and close them. The knowledge base can also be used.
		12	\|Self Service Web Interface\|After login, the user is displayed all the tickets they have created themselves in the Self Service Web Interface by default. This list can be changed using a standard query (see [[Standard query>>doc:.Einstellungen zum Web Interface.WebHome\|\|anchor="HSelfServicequeries"]]). New tickets can be created and existing ones can be viewed. It is also possible to access the Knowledge Base.
		13
		14	= Installation, Configuration and updating of Web Interfaces =
		15
		16	If you haven't yet started the installation of one of the Web Interfaces, you can read [[here>>doc:ACMP.69.ACMP installieren.ACMP Zusatzkomponenten installieren.Helpdesk Web Interface installieren.WebHome]] about how a correct installation and update look like and which settings you need to configure.
		17
		18	= Authentication and Right Management =
		19
		20	== Authentication ==
		21
		22	Users can log in to the Web Interface in two ways: They can either log in with their ACMP account (see user management) or authenticate themselves to an Active Directory so that they are granted access. For the latter option, you must have specified an AD account. You can configure the authentication in the [[Settings>>doc:.Einstellungen zum Web Interface.WebHome\|\|anchor="HLogin"]] (//System// > //Settings //> //Web Interface// > //Login// > //Authentication settings//).
		23
		24	Select one of the two options. Save your changes by clicking //Save //in the ribbon bar. The updated conditions will take effect the next time you log in.
		25
		26	[[Authentication settings>>image:69_Web Interface_Authentifizierungseinstellungen_654.png]]
		27
		28	== Right Management for the Helpdesk ==
		29
		30	In principle, rights for the Helpdesk and use of the Web Interface are assigned via [[User Management>>doc:ACMP.69.ACMP-Solutions.System.Benutzerverwaltung.WebHome]] (//System// > //User Management//). For maximum flexibility, there are three different points of contact where you can explicitly assign rights to Helpdesk users or employees.
		31
		32	=== Self Service permissions ===
		33
		34	Under [[Self Service permissions>>doc:.Einstellungen zum Web Interface.WebHome\|\|anchor="HSelfServicepermissions"]] (//System// > //Settings //> //Web// //Interface// > //Self Service permissions//), you will find several rights relating to the self-service web interface and its end users. Tick all the permissions you want to allow. Subordinate rights (e.g. ‘"Change ticket category") can only be selected if the level above has been enabled. This allows you to customize the main rights to suit your circumstances and further restrict or extend the rights. Save your settings via the ribbon bar.
		35
		36	[[Self Service permissions>>image:69_Web Interface_Self Service Berechtigungen_887.png]]
		37
		38	=== Rights of an ACMP or helpdesk employee ===
		39
		40	As soon as you create a new user via user management or edit one at a later date, you will inevitably reach the point in the wizard in step three where you can define the rights. This allows you to set restrictions that then apply directly to the current selected ACMP User. This generally applies to all rights in ACMP, but special rights can also be assigned for the helpdesk and the web interface.
		41
		42	To do this, open the item //Helpdesk// > //Web Interface// in the list on the left. Here you can modify the visibility of data in the Helpdesk web interface so that the created user is not allowed to view comments on a ticket in the web interface or view any ticket attachments, for example. You can set restrictions by assigning these rights. In addition, you can also allow a user to change possible solution suggestions, if desired.
		43
		44
		45	[[Select rights of User (Web Interface)>>image:69_Web Interface_Rechte des Benutzers_1156.png]]
		46
		47	To grant a user a right, you must tick the corresponding checkbox and continue with the wizard (//Next >//). On the next page ("Roles and Clients"), you must now assign the "Helpdesk" role to the ACMP User. Tick the corresponding checkbox so that the previously specified rights can be applied.
		48
		49	[[Select roles and tenants for the current user>>image:69_Web Interface_Rollen und Mandanten_720.png]]
		50
		51	Complete your work in the wizard and exit it by clicking //Finish//.
		52
		53	{{box}}
		54	Special feature of the "Visible in Self Service" option
		55
		56	When writing comments in tickets and/or knowledge base articles, as well as when creating knowledge base articles, you will find the "Visible in Self Service" option in the top right-hand corner. This is a checkbox that you must tick manually each time to enable the option and make the comment or article globally visible in the web interface. Please note that the comment or article is only visible to ACMP users and self-service users who have the appropriate right (right: "View ticket web comments").
		57	{{/box}}
		58
		59	= Customizing of graphics and text elements =
		60
		61	If you would like to customize the Web Interfaces to match your corporate identity, both graphically and textually, you can do so in just a few simple steps. To do this, proceed as follows:
		62
		63	== Replacing graphics ==
		64
		65	~1. Open the Windows Explorer and navigate to the installation directory of the Web Interfaces. By default, this is //%Programfiles%\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\//
		66
		67	[[Folder with access to the graphics>>image:69_Web Interface_Ordner Grafiken austauschen_1012.png]]
		68
		69	The directory //App_Themes\ACMP\graphics //contains graphics that can be used in the web interfaces.
		70
		71	{{aagon.infobox}}
		72	Please note that graphical customizations will be overwritten after an update of the Web Interfaces.
		73	{{/aagon.infobox}}
		74
		75	3. Replace the graphics as required (replace the logo via file, located at: App_Themes\ACMP\graphics\logo.svg).
		76	When replacing graphics, ensure that you use the same names as the original graphics so that they can be read correctly.
		77
		78
		79	== CSS customizations ==
		80
		81	{{aagon.warnungsbox}}
		82	Please note that no support is offered for changes made independently and individually created to the Custom.css file or for general CSS adjustments. The following section merely provides some notes should you wish to make your own changes.
		83	{{/aagon.warnungsbox}}
		84
		85	In order to customize CSS, you must have the file ‘Custom.css’ in the “Styles” folder (C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\Styles). To do this, create the file in a text editor of your choice and make sure that the extension is ".css".
		86
		87	{{aagon.infobox}}
		88	The Custom.css file should remain valid after an update. It is recommended to remove the file if possible problems arise.
		89	{{/aagon.infobox}}
		90
		91	The file is initially empty and must now be filled. You can insert new content, edit existing content and customize it. Then save the changes by clicking //Save//. The file is always loaded last for the web interface, which means that the entries in this file have the highest priority for individual adjustments.
		92
		93	{{box}}
		94	As a general rule, the Custom.css file is a file that advances the code and does not replace it!
		95	{{/box}}
		96
		97	For example, if you want to revise the logo, you must overwrite ".site-logo":
		98
		99	{{code}}
		100	.site-logo{
		101	background: url("../App_Themes/ACMP/graphics/logo.svg") left top no-repeat;
		102	width: var(--logo-width);
		103	height: var(--header-height);
		104	}
		105
		106	{{/code}}
		107
		108	{{aagon.warnungsbox}}
		109	Any changes should be made in Custom.css. These changes will override existing settings.
		110	{{/aagon.warnungsbox}}
		111
		112
		113	[[Changes on the Custom.css>>image:69_Web Interface_Custom.css Datei_712.png]]
		114
		115	Take a look at the different .css files in the "Styles" folder for the various classes.
		116
		117	Example "Colour changes": If you want to make changes to the colours, you should copy the corresponding variables from Theme.css and insert and customize them in Custom.css within a //:root { }// using tags.
		118
		119	[[Colour change of error colours within Custom.css>>image:69_Web Interface_Farbänderung der Error Farben_682.png]]
		120
		121	{{aagon.infobox}}
		122	To change the colour, simply copy the relevant section. You do not need to copy the entire root tree in Custom.css.
		123	{{/aagon.infobox}}
		124
		125	== Customizing text colours ==
		126
		127	To customize text colours, follow these steps:
		128
		129	~1. Open the installation path (default: //%Program Files%\Aagon\ACMP Web Interfaces\Helpdesk Web Interface\App_Themes\ACMP//).
		130
		131	2. Now open the file //Custom.css// stored in this directory.
		132
		133	{{aagon.infobox}}
		134	Please note that the file for single sign-on is stored separately (path: %Programfiles%\Aagon\ACMP Web Interfaces\SSO\App_Themes\ACMP).
		135	{{/aagon.infobox}}
		136
		137	Any changes must be made separately.
		138	3. The file contains individual and “class”-based definitions for text display. Customize the colour for the respective area here by replacing the hexadecimal value.
		139
		140	{{code}}
		141	.welcomeText {
		142	color: #ff0000;
		143	}
		144
		145	{{/code}}
		146
		147	== Customizing texts ==
		148
		149	To change a text in the web interface, you must customize the corresponding .resx file. These can be found in the following paths and subfolders. Each file is available in three language versions (German, English and Czech).
		150
		151	* C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\App_GlobalResources
		152	* C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\App_LocalResources
		153	* C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\ErrorPages\App_LocalResources
		154	* C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\Pages\App_LocalResources
		155	* C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\Pages\Dialogs\App_LocalResources
		156	* C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\Pages\imageuploader\App_LocalResources
		157	* C:\Program Files (x86)\Aagon\ACMP Web Interfaces\Helpdesk Webinterface\Pages\UserControls\App_LocalResources
		158
		159	Open the resource file with a text editor (e.g. Notepad++) and customize the text as desired. Then save the file.
		160
		161	{{aagon.infobox}}
		162	Once you have made the textual changes, you must restart IIS and clear the cache.
		163	Do not forget to clear your browser cache as well so that the changes take effect.
		164	{{/aagon.infobox}}
		165
		166	{{aagon.infobox}}
		167	Please note that you must always customize the respective files in the App_LocalResources path to the appropriate language. If you are using the web interface in English, you must customize the corresponding .resx file there and not just in the German file.
		168	{{/aagon.infobox}}
		169
		170
		171	= Creating custom fields for the Self Service Web Interface =
		172
		173	As a help desk employee or administrator, you can create additional custom fields for the Self Service Web Interface that can or should be filled in by the ticket creator when creating a new ticket. This makes it possible to retrieve individual fields and information that can make your work easier.
		174
		175	If you would like to use the custom fields, navigate to //System //> //Settings //> //Custom Fields //> //Tickets// in the open ACMP Console. Follow the necessary steps to [[add a field>>doc:ACMP.69.ACMP-Solutions.System.Einstellungen.Benutzerdefinierte Felder.WebHome\|\|anchor="HFelderhinzufFCgen"]]. Then save the newly created fields and switch to //Web Interface //> //Self Service Fields// in the system settings.
		176
		177	Open the folder hierarchy where you previously added the new field. Then either drag it to the right side with a mouse click or use the arrow for this purpose. For the fields on the right, you can also specify whether it is a mandatory field that the user must explicitly fill in in Self Service in order to create a ticket. Optionally, tick the box and save the changes in the ribbon bar. The next time you call up the Web Interface Self Service, your newly added fields will be taken into account when creating a new ticket.

Wiki source code of Web Interfaces