Client configuration (anytime.setup.config)
- Corentin Humbert
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 basic username/password to authenticate -->
<CertificateSettings />
<!-- 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:
Uninstall settings
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.
The BasicAuthSettings replaces the old SynchronizationLogin settings
Certificate-based authentication
Used to authenticate using an X.509 certiifcate installed on the user’s machine.
Settings:
StoreName: Specific value used to find the certificate on the user’s machine. If it’s a personal certificate, then the store name will beMy.StoreLocation: This is also used to find the certificate. In case of a user certificate, the location will beCurrentUser.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.
Settings:
ClientId: Client ID of the app. See: https://www.rfc-editor.org/rfc/rfc6749#section-2.2DeviceAuthorizationEndpoint: Endpoint to get the device and user codes (OAuth 2.0/devicecode)TokenEndpoint: Endpoint to get the OAuth 2.0 tokens (access, refresh, etc.)Scope: Scope of the device auth. See: https://www.rfc-editor.org/rfc/rfc6749#section-3.3RetryDelay: Time to wait (in milliseconds) between attempts to get OAuth 2.0 tokens from auth server.MaxRetryCount: Maximum number of attempts to get OAuth 2.0 tokens from the auth server.
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:
Settings:
ApplicationTitle: Text displayed in the application title barApplicationIconPath: Path of the icon file (must be .ico) used for the applicationPreSynchronizationEnabledPermissionsSynchronizationEnabledStopIISExpressAtExit: Whether IIS Express should be stopped when closing the desktop applicationMandatoryLanguage: A comma-seperated list of languages that should be installed in the applicationExternalDataSupplyer: Should only be used for debuggingMaxConnectionAttempts: Max number of attempts to reach the local WebViewer server after IIS restart before failingWaitTimeBetweenConnectionAttempts: Wait time (in milliseconds) between each attempt to reach the local WebViewer serverRequiredReachableHost: Used for restricting OAuth2 authentication to happen only if the host is reachable. If empty, the restriction is skipped.