Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 3 Next »

This page describes the various settings available in the anytime.setup.config file.

Base file structure:

<?xml version="1.0" encoding="utf-8"?>
<AnyTimeProfileDefinition xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:xsd="http://www.w3.org/2001/XMLSchema">
	
	<!-- Configure how Offline is installed -->
	<InstallSettings />
	
	<!-- Configure how Offline is uninstalled -->
	<UninstallSettings />
	
	<!-- Use an X.509 certificate from user machine to authenticate -->
	<CertificateSettings />
	
	<!-- Use an external provider with OAuth2 Device Grant support to authenticate -->
	<OAuth2DeviceSettings />
</AnyTimeProfileDefinition>

Install settings

<InstallSettings silent="false">
  <!-- Settings for the shortcuts that appear in Windows Start Menu -->
  <Shortcuts />

  <!-- To register AnyTime to the Windows programs list -->
  <ProgramEntryDefinition />
</InstallSettings>

For customers who do not wish to do any kind of customization when installing, it is possible to skip the installation mode popup by setting silent to true.

If this setting is missing from the configuration file, it will default to false.

Shortcuts

Used to customize the Windows Start Menu shortcut for the Offline applications.

<Shortcuts>
  <Application enabled="true">
    <Title>KLA VFI 2.0</Title>
    <Comment>KLA VFI Offline application</Comment>
  </Application>
  
  <Uninstaller enabled="false">
    <Title>KLA VFI 2.0 Uninstall</Title>
    <Comment>Uninstaller for the KLA VFI application</Comment>
  </Uninstaller>
</Shortcuts>

Windows programs list registration

It is possible to customize how the Offline Client appears in the Windows programs list. This can be achieved by configuring the <ProgramEntryDefinition> setting in anytime.setup.config.

Below is an example of how it looks like for KLA:

<!-- File: anytime.setup.config -->
<ProgramEntryDefinition>
  <Id>Signifikant_Offline</Id>
  <DisplayName>KLA VFI 2.0</DisplayName>
  <Publisher>Signifikant</Publisher>
  <DisplayVersion>2.0</DisplayVersion>
  <UrlInfoAbout>https://signifikant.se</UrlInfoAbout>
  <InstallLocation>C:\ProgramData\Signifikant\Assert AnyTime</InstallLocation>
  <UninstallString>"C:\ProgramData\Signifikant\Assert AnyTime\AssertAnyTime.Uninstall.exe"</UninstallString>
</ProgramEntryDefinition>

Uninstall settings

<UninstallSettings silent="true" />

Similarly to the silent install, it is possible to configure the Offline client so that it quietly uninstalls itself by skipping the “Feature Select Uninstall” dialog by settings silent to true.

If this setting is missing from the configuration file, it will default to false.

Authentication

Configure how the Offline app authenticates against the Synchronization API.

Make sure to have exactly ONE auth method enabled in configuration otherwise the app will fail with an error.

Basic authentication

This was the original way of authenticating with Offline.

<BasicAuthSettings enabled="true">
  <Username>Foo</Username>
  <Password>Bar</Password>
</BasicAuthSettings>

The BasicAuthSettings replaces the old SynchronizationLogin settings:

<!-- These are old settings that do not work anymore, dont use -->
<SynchronizationLoginEnabled>false</SynchronizationLoginEnabled>
<SynchronizationLogin>Foo</SynchronizationLogin>
<SynchronizationPassword>Bar</SynchronizationPassword>

Certificate-based authentication

Used to authenticate using an X.509 certiifcate installed on the user’s machine.

<CertificateSettings enabled="true">
  <StoreName>My</StoreName>
  <StoreLocation>CurrentUser</StoreLocation>
  <Issuer>kla-tencor</Issuer>
  <SubjectEmailDomains>kla-tencor.com,kla.com</SubjectEmailDomains>
</CertificateSettings>

Let’s go over the five different settings:

  • enabled: If true, the configured certificate will be used for authentication, otherwise, it will use the default basic authentication method (username/password)

  • StoreName: Specific value used to find the certificate on the user’s machine. If it’s a personal certificate, then the store name will be My.

  • StoreLocation: This is also used to find the certificate. In case of a user certificate, the location will be CurrentUser.

  • Issuer: The Certificate Authority (CA) responsible for issuing the certificate.

  • SubjectEmailDomains: A list of comma-separated domains that can suffix the user email

OAuth2 Device Grant authentication

This will allow the Offline app to authenticate using the OAuth 2.0 Device Authorization Grant which allows devices with an Internet connection but with no support for a browser to authenticate. It’s also widely used to authenticate desktop applications.

<OAuth2DeviceSettings enabled="true">
  <ClientId>MY_CLIENT_ID</ClientId>
  <DeviceAuthorizationEndpoint>MY_DEVICE_AUTH_ENDPOINT</DeviceAuthorizationEndpoint>
  <TokenEndpoint>MY_TOKEN_AUTH_ENDPOINT</TokenEndpoint>
  <!-- Scopes are separated by spaces, offline_access should be included to allow usage of refresh tokens -->
  <Scope>MY_API_SCOPE offline_access</Scope>
</OAuth2DeviceSettings>

The various settings should come from the Identity Provider.

Miscellaneous settings

These settings should be placed at the root of the file (under AnyTimeProfileDefinition and can be used to configure a variety of things:

<ApplicationTitle>KLA VFI</ApplicationTitle>
<ApplicationIconPath>Profile\KLA.ico</ApplicationIconPath>

<PreSynchronizationEnabled>true</PreSynchronizationEnabled>
<PermissionsSynchronizationEnabled>true</PermissionsSynchronizationEnabled>

<StopIISExpressAtExit>false</StopIISExpressAtExit>
<MandatoryLanguage>en-US</MandatoryLanguage>
<ExternalDataSupplyer>false</ExternalDataSupplyer>
  • No labels