Back-end configuration

When you need to define custom settings, such as color profiles or paths to assets, you need to configure the Preflight Tool backend in the AppSettings.config file. For example, to apply a specific color profile to print files, set new values to the CmykProfileFilePath and GrayscaleProfileFilePath keys.

<appSettings>
  <add key="DisableFinishEndpoint" value="true"/>
  <add key="FileSystemProviderPath" value="./App_Data/files"/>
  <add key="CacheDirectoryPath" value="./App_Data/Cache"/> 

  <add key="FontsDirectoryPath" value="./App_Data/fonts"/>
  <add key="ColorProfilesDirectoryPath" value="./App_Data/ColorProfiles/"/>
  <add key="MockupsDirectoryPath" value="./App_Data/mockups"/>
  <add key="TempDataDirectoryPath" value="./App_Data/temp"/>
  <add key="ApiSecurityKey" value=""/>

  <add key="GrayscaleProfileFilePath" value="./App_Data/colorProfiles/defaultGrayscaleProfile.icm"/>
  <add key="CmykProfileFilePath" value="./App_Data/colorProfiles/defaultCmykProfile.icm"/>

  <add key="ServerBaseUrl" value=""/>
  <add key="FallbackFonts" value=""/>

  <!-- Configure DesignManager as asset storage -->
  <add key="AssetStorageApiKey" value="ApiKey" />
  <add key="AssetStorageEndpoint" value="http://localhost:56416/" />
  <add key="AssetStorageTenantId" value="6" />
  <add key="AssetStorageColorProfiles" value="false" />
  <add key="AssetStorageFonts" value="false" />
  <add key="AssetStorageStates" value="false" />
  <add key="AssetProcessorApiKey" value="" />
  <add key="AssetProcessorEndpoint" value="" />
  <add key="SaveStateRetryCount" value="3"/>

  <add key="MessageBusRabbitMQ" value=""/>
  <add key="MessageBusAzureServiceBus" value=""/>
</appSettings>	

Now, let's learn how you can configure the Preflight Tool using these parameters.

Name	Description	Possible values
DisableFinishEndpoint	If `true`, disables the `finish` endpoint, which includes hi-res rendering, and the client will receive a `403` response when attempting to access it. By default, this value is `true`.	boolean
FileSystemProviderPath	The storage of user files and the resulting JPG and PDF images. The default value is `"./App_Data/files"`.	folder path
CacheDirectoryPath	The location of the application path. The default value is `"./App_Data/Cache"`.	folder path
FontsDirectoryPath	The folder containing fonts that will be used for processing PSD files. The default value is `"./App_Data/fonts"`.	folder path
ColorProfilesDirectoryPath	The folder containing color profiles. The default value is `"./App_Data/ColorProfiles/"`.	folder path
MockupsDirectoryPath	The folder containing mockup images. The default value is `"./App_Data/mockups/"`.	folder path
TempDataDirectoryPath	The temporary folder. The default value is `"./App_Data/temp/"`. Important! You must grant the Modify* permission to this folder to the application pool in which the Preflight Tool is running.*	folder path
ApiSecurityKey	A unique API key for using the REST API. This value is an arbitrary string.	string
GrayscaleProfileFilePath	The path to the grayscale profile.	file path
CmykProfileFilePath	The path to the CMYK profile.	file path
ServerBaseUrl	A direct URL to your server. You can specify this parameter if your server runs behind a firewall. This URL will be used in links to previews and hi-res images. By default, this value is an empty string, and the URL is retrieved from IIS settings.	string
FallbackFonts	The PostScript name of the font to substitute a missing font with. If this value is an empty string, then this tool throws an exception when it meets an unknown font in a user's file.	string
AssetStorageApiKey	A unique API key to access the asset storage. This value is an arbitrary string.	string
AssetStorageEndpoint	The link to the asset storage. For example, `"http://localhost:56416/"`.	string
AssetStorageTenantId	The tenant identifier in the asset storage.	number
AssetStorageColorProfiles	If `true`, uses the color profiles defined in the asset storage. The default value is `false`.	boolean
AssetStorageFonts	If `true`, uses the fonts defined in the asset storage. The default value is `false`.	boolean
AssetStorageStates	If `true`, saves the state file as a private asset in asset storage. If `false`, saves to disk.	boolean
AssetProcessorApiKey	API key for the asset processor.	string
AssetProcessorEndpoint	URL of the asset processor gateway in the current environment.	string
SaveStateRetryCount	Number of save retry attempts. Default: `3`.	number
MessageBusRabbitMQ	Connection parameters of RabbitMQ. This string must be specified when you use the RabbitMQ message bus to get notifications about changing the content of the asset storage. For example, `"Host=localhost;VirtualHost=/;Username=guest;Password=guest"`.	string
MessageBusAzureServiceBus	Connection parameters of AzureServiceBus. This string must be specified when you use the AzureService message bus to get notifications about changing the content of the asset storage.	string

note

If you do not define color profiles that should be used in color management, then the Preflight Tool applies the following default profiles:

SWOP (Coated) 20%, GCR, Medium profile for CMYK
Dot Gain 30% profile

Was this page helpful?