Note |
---|
The Shopping client module of the 1E Client replaces the Shopping Agent used by versions of Shopping before v5.5. When the 1E Client starts, if the Shopping module is enabled the 1E Client will automatically remove any previous installation of the 1E Shopping Agent. The Shopping client module is not supported on:
|
Shopping client settings
The table below lists the settings required to enable the Shopping client required for integration with Shopping v5.5 or later. The Shopping client module must be enabled on all Windows computers that will connect to the Shopping self-service portal.
Multiexcerpt include | ||||
---|---|---|---|---|
|
Shopping module setting | Installation default | Description | |||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Module.Shopping.Enabled
| false | Set the value to true to enable the Shopping module. The default value is false.
| |||||||||||||||||||||||
Module.Shopping.AlternativeUrls
| (blank) | Optional. A list of URLs from which the Shopping module allows launching the WSA wizard. This setting is typically used to launch WSA from a ServiceNow application such as 1E Service Catalog Connect. Multiple URLs should be separated by pipe characters. For example The Shopping client requests this value from the Shopping Central website (admin console setting: AlternativeUrls ). If the request is successful the website value takes precedence even if blank, otherwise the local setting is used. | |||||||||||||||||||||||
Module.Shopping.FirefoxSupportEnabled
| (blank) | Optional. If this setting is not specified the value defaults to false. This value must be set to true if LocalHostUrl is set to https and Firefox is being used to browse to the Shopping website, or to launch the WSA wizard from Shopping or third party websites like ServiceNow. When set to true, the Shopping client set the Mozilla preference security.enterprise_roots.enabled=true which allows Firefox to see the Shopping client certificates in the Windows certificate store. You can see this setting in Firefox about:config. The Shopping client requests this value from the Shopping Central website (admin console setting: Firefox support enabled). If the request is successful the website value takes precedence even if blank, otherwise the local setting is used. | |||||||||||||||||||||||
Module.Shopping.InitializationFailureSleepSecs
| 30 | This setting controls the time the client waits before attempting to connect to the website specified in 151426268Module.Shopping.ShoppingCentralUrl. If the client module fails to connect during startup, it does not initialize, and will retry at gradually increasing intervals until it is able to connect. Range is 10 to 900, default is 30. The log file may show this setting as InitializationRetryIntervalSecs. | |||||||||||||||||||||||
Module.Shopping.LocalhostUrl
| (blank) |
| |||||||||||||||||||||||
Module.Shopping.ShoppingCentralUrl= https://tachyon.acme.local/Shopping allows the client to successfully connect to the Tachyon website which then rejects the request, and the local value of LocalhostUrl is then used. To ensure this works, the specified website must reject the request with a 404 error, and not redirect, prompt or provide invalid data.Module.Shopping.LoopbackExemptionEnabled
| false |
| |||||||||||||||||||||||
Module.Shopping.ShoppingCentralUrl
| (blank) | The URL that the Shopping client module uses to connect to the Shopping Central website. Failure to connect causes the client to fail to initialize and retry connection later.
| |||||||||||||||||||||||
Module.Shopping.SsoEnabled
| false |
|
Information provided by the Shopping client
The following localhost API calls can be entered directly in a browser on a device that has the Shopping client module of the 1E Client enabled and correctly configured.
If the Shopping Central website binding is https then the localhost URL must also be https, otherwise it can http or https.
When using an Edge or Metro versions of Internet Explorer browser, you must set Module.Shopping.LoopbackExemptionEnabled=true.
MachineId
The following table shows example details sent by the Shopping client to the Shopping Central server. The client makes a localhost API call MachineId API to get the details, and then uses a server API call to post them to the Shopping Central website, which creates or updates the machine details in the Shopping database and returns the MachineId GUID from the database. Details are shown in the 1E.Client.log
.
This call is made when a user browses to the Shopping Web Portal, and the website uses the loopback feature to query the local computer.
You can test this by entering http://localhost:8000/ShoppingClientAgent/MachineInfo/MachineId
directly in a browser.
Attribute | Description | Example |
---|---|---|
HostName | Computername | ACME-WIN1001 |
HostDomainName | Computer's NetBIOS Domain Name | ACME |
AssignedSite | Configuration Manager client Site code | CM1 |
MacAddress | Computer's MAC Address | 20-68-9D-5B-EB-73 |
OSVersion | OS Version | 10.0.15063 |
OSArchitecture | OS Architecture | 64-bit |
OSRole | The role of the OS. Values are:
| 1 |
SccmVersion | Configuration Manager client version | 5.00.9012.1020 |
UniqueId | Configuration Manager client GUID | GUID:04804aed-922c-4a4b-9f41-eab6592e7d83 |
IntuneDeviceId | Intune Device Id | 02c967b2-de4d-5ac1-859c-a15cb11b7638 |
TenantId | Tenant Id | 6babcaad-604b-40ac-a9d7-9fd97c0b779f |
TenantName | Tenant Name | ACME |
Fqdn
The following example is JSON returned by the Shopping client when the Fqdn API call is made by Windows Servicing Assistant and 1E Virtual Assistant. Details are shown in the 1E.Client.log
.
You can test this by entering http://localhost:8000/ShoppingClientAgent/MachineInfo/Fqdn
into a browser.
Code Block |
---|
{"Fqdn":"1EUKCOL1184.ACME.local"} |
Checking loopback exemption on Microsoft Edge and Metro Internet Explorer browsers
The following is valid only for Windows 8, 8.1, 10 and Windows Server 2012 R2 and later.
When LoopbackExemptionEnabled=true the Shopping client will create exemptions for installed browsers on startup, and delete them when shutting down.
To check or verify exemptions, open a command-prompt as administrator on the computer you want to check, then run the following command.
Code Block |
---|
CheckNetIsolation LoopbackExempt -s |
Output should be:
If either of these items are missing, you can manually add them by executing the following commands. Quotes may be required around the name of the app.
For IE:
Code Block |
---|
CheckNetIsolation LoopbackExempt -a -n=windows_ie_ac_001 |
For Edge:
Code Block |
---|
CheckNetIsolation LoopbackExempt -a -n=Microsoft.MicrosoftEdge_8wekyb3d8bbwe |
Removing
To remove an individual exemption, use -d instead of -a, for example:
Code Block |
---|
CheckNetIsolation LoopbackExempt -d -n=Microsoft.MicrosoftEdge_8wekyb3d8bbwe |
The exemption from loopback restrictions can also be removed for all installed apps by using the following command:
Code Block |
---|
CheckNetIsolation LoopbackExempt –c |
More information
For more information from Microsoft about CheckNetIsolation please refer to: https://docs.microsoft.com/en-us/previous-versions/windows/apps/hh780593(v=win.10).