The preferences for the Discngine LiveDesign Connector are available under Discngine LiveDesign Connector.
Configuration
Name | Required | Default | Description |
---|---|---|---|
DefaultDocumentPathOrId | df7b5c3b-935c-4dde-b102-54f44b3b6a6b | When set, specify the Spotfire template that will be opened as an empty document in the LiveDesign Connector. | |
DefaultExportDataTableName | LiveReport Data | When set, define the default name of the data table where the LiveReport data is exported from the gadget or LiveDesign Connector. | |
DefaultLibraryPath | ✓ | When set, only the templates in the specified folder and its children will be available in the gadget. | |
ExportInMemory | True | This defines whether the LiveDesign export is done "in process" or "out of process". Change it if you encountered issues related to RDKit. Warning: the "out of process" export is less performant than the "in process" export: it may be necessary to increase the export timeout. | |
ExportTimeoutInSeconds | 360 | The timeout in seconds for the export. | |
GadgetAutoLoadTemplate | False | When true, templates are automatically opened in the gadget according to the automatic opening convention. | |
GadgetDefaultPageTitle | "[Default]" | The page that will be opened with Spotfire light interface when the Spotfire templateis automatically opened in the gadget. | |
ImportInChi | False | When true, a "Structure <InChi>" column containing the InChi of the compound will be generated during export. | |
ImportLiveReportImage | False | Deprecated. When true, a "Structure <LiveReport Image>" column containing the Image of the compound in the LiveReport will be generated during export. | |
ImportMolFile | False | When true, a "Structure <MOLFILE>" column containing the MOLFILE of the compound will be generated during export. | |
ImportPNG | False | When true, a "Structure <PNG>" column containing the PNG of the compound will be generated during export. | |
ImportSmiles | False | When true, a "Structure <Smiles>" column containing the SMILES of the compound will be generated during export. | |
LicenseKey | ✓ | The license key provided by Discngine. | |
LiveDesignServerUrl | ✓ | The default LiveDesign server URL which will be used to prefill the data source connection screen. | |
LiveDesignVersion | 8.9 | Deprecated. Specify the version of the LiveDesign API to use. See the compatibility article. Needed if the UsePython is set to true. | |
PeriodBeforeExpiration | The number of days you want to be warned before the license expires. | ||
PythonVersion | 3.9 | Deprecated. Specifies the version of the python runtime to use. 3.9 and 2.7 are supported. | |
TempFolder | If set to a full path value, it will define the temporary folder used during the export process to generate intermediate files. See below for how to use this preference. | ||
UsePython | False | Deprecated. If set to true it activates the old way to interact with LiveDesign (using the python API). In this case, you need to set the right LiveDesignVersion flag. |
Details about the TempFolder preference
By default, the Spotfire LiveDesign Connector performs certain operations by writing temporary files to the standard temporary folder of the account running Spotfire:
- in the Analyst, it uses the
%TMP%
folder defined for the user profile - in the Web Player, it will use the standard temp folder for the service account
Sometimes you may want or need to ignore this default behavior, because:
- you do not want to use the system temp volume
- you are using kerberos + impersonation and need to set up a custom folder where users will have write access
To do this, you need to:
- set up a shared folder on the network that will be accessible from your users' workstations and their Windows accounts AND from your Web Player server and its service account
- ensure that the Web Player service account and all Spotfire user accounts that use the LiveDesign connector have read/write/modify access
- set up the full path in the tempfolder preference
- restart both Spotfire Analyst and concerned Web Player service instance
Note: several messages are displayed in the Web Player and Analyst logs to help you diagnose any problems.
Advanced
Name | Required | Default | Description |
---|---|---|---|
AttachmentDownloadTimeoutInSeconds | 360 | The timeout in seconds to download a file coming from a LiveDesign freeform column of type file or image and imported into Spotfire. | |
DebugMode | False | When true, the LiveDesign Server URL can be changed from the LiveDesign Connector panel and additional options currently under development are available in the LiveDesign DataSource. | |
ExtraCharactersToEscape | The list of special characters that needs to be escaped in the column names. | ||
GetLiveReportLibraryProjectBatchSize | 100 | Size of the request batch done to retrieve list of LiveReports by projects. | |
GetLiveReportMetadataTimeoutInSeconds | 360 | The timeout in seconds for retrieval of the LiveReport and LiveReport's columns metadata. | |
GetLiveReportsLibraryTimeoutInSeconds | 360 | The timeout in seconds for retrieval of the template list from the Spotfire library. | |
MaximumAttachmentSizeInMegaBytesForDownloadThroughLiveDesignUrl | 30 | The file size threshold in megabytes (MB) used to decide the downloading behavior in Web Player for a file coming from a LiveDesign freeform column of type file or image and imported into Spotfire. Below this threshold, the file is downloaded from within the Spotfire interface and no further authentication to LiveDesign is required. Above this threshold, the file is downloaded from a new browser tab and authentication to LiveDesign is required. | |
RunModelTimeoutInSeconds | 720 | The timeout in seconds for running a LiveDesign model. |