--- title: "Release Note: DJServer - v5.5.12.3 - 15/05/2023" slug: "release-note-djserver-v55123-15052023" updated: 2023-05-26T09:49:33Z published: 2023-05-26T09:49:33Z canonical: "docs.datajet.app/release-note-djserver-v55123-15052023" --- > ## Documentation Index > Fetch the complete documentation index at: https://docs.datajet.app/llms.txt > Use this file to discover all available pages before exploring further. # Release Note: DataJet v5.5.13.1 - 13/05/2023 ## Overview The key features of this release are: - Single Sign On support for OKTA - Increased Debugging and Logging features - Upgraded plugin architecture and default plugins - Enhancement to Remote File management ### Administration - [OKTA integration](/v1/docs/release-note-djserver-v55123-15052023#okta-integration) - [Backup method requires "targetProject"](/v1/docs/release-note-djserver-v55123-15052023#backup-method-requires) - [FIX: Changes to System Info error handling](/v1/docs/release-note-djserver-v55123-15052023#bug-fixes) - [Switchable Logging for Server API calls](/v1/docs/release-note-djserver-v55123-15052023#switchable-logging-for-server-api-calls) - [Changes to Job Window Cancel](/v1/docs/release-note-djserver-v55123-15052023#changes-to-job-window-cancel) - [Script name added to Script Execution History](/v1/docs/release-note-djserver-v55123-15052023#script-name-added-to-script-execution-history) - ["Enable Script" text command](/v1/docs/release-note-djserver-v55123-15052023#) ### Scripting - [Script Editor: preview](/v1/docs/release-note-djserver-v55123-15052023#script-editor-preview) - [New system variables: %CURRENT_PROJECT% and %CALLING_PROJECT%](/v1/docs/release-note-djserver-v55123-15052023#new-system-variables-current_project-and-calling_project) - [Script Editor: view resolved script](/v1/docs/release-note-djserver-v55123-15052023#script-editor-view-resolved-script) - [ExecuteStoredScript: optional debug flag](/v1/docs/release-note-djserver-v55123-15052023#executestoredscript-optional-debug-flag) - [Script Logs output to provided filename](/v1/docs/release-note-djserver-v55123-15052023#script-logs-output-to-provided-filename) ### API - [New method: OpenTargetProject](/v1/docs/release-note-djserver-v55123-15052023#new-api-methods) - [New method : CreateTargetProject](/v1/docs/release-note-djserver-v55123-15052023#new-api-methods) - [New method: DropTargetProject](/v1/docs/release-note-djserver-v55123-15052023#new-api-methods) - [New method: MoveFields](/v1/docs/release-note-djserver-v55123-15052023#new-api-methods) - [New Method: SetHiddenTables](/v1/docs/release-note-djserver-v55123-15052023#new-api-methods) ### Engineering and Analytics - [Extended Totals in Multi-Function Profiles](/v1/docs/release-note-djserver-v55123-15052023#extended-totals-in-multifunction-profiles) - [Quantiles: ability to reverse labels](/v1/docs/release-note-djserver-v55123-15052023#quantiles-ability-to-reverse-labels) - [MakeKeyTable filter support](/v1/docs/release-note-djserver-v55123-15052023#makekeytable-filter-support) ### Modelling - [Plugins can auto open a report on completion](/v1/docs/release-note-djserver-v55123-15052023#plugins-can-auto-open-a-report-on-completion) - [Control of Plugin menu location](/v1/docs/release-note-djserver-v55123-15052023#control-of-plugin-menu-location) - [New Plugin: Scan rank](/v1/docs/release-note-djserver-v55123-15052023#new-plugin-scan-rank) - [Model Setup List selections](/v1/docs/release-note-djserver-v55123-15052023#model-setup-list-selections) - [Updates to 2d and 3d cluster modelling](/v1/docs/release-note-djserver-v55123-15052023#updates-to-2d-and-3d-cluster-modelling) - ["Help" section support for Plugins](/v1/docs/release-note-djserver-v55123-15052023#) ### DataBase Build, Export and Management - [FIX: Export formats persisted for no-state users](/v1/docs/release-note-djserver-v55123-15052023#bug-fixes) - [CopySourceTable accepts field list](/v1/docs/release-note-djserver-v55123-15052023#copysourcetable-accepts-field-list) - [Project menu "Set Table Visibility"](/v1/docs/release-note-djserver-v55123-15052023#project-menu) - [Metadata support for CopySourceTable](/v1/docs/release-note-djserver-v55123-15052023#metadata-support-for-copysourcetable) - [New Remote Files dialog](/v1/docs/release-note-djserver-v55123-15052023#new-remote-files-dialog) ### General Desktop UI - [Drag and Drop script file from Windows Explorer into Script Editor](/v1/docs/release-note-djserver-v55123-15052023#drag-and-drop-script-file-from-windows-explorer-into-script-editor) - [FIX: ScriptEditor support for underscores in names](/v1/docs/release-note-djserver-v55123-15052023#bug-fixes) - [Additional highlighting on actions that will drop projects](/v1/docs/release-note-djserver-v55123-15052023#additional-highlighting-on-actions-that-will-drop-projects) ## Breaking Changes ### OKTA integration From version 5.5.13.1 onwards, DataJet provides support for Single Sign On. DataJet Administrator should now be used to manage users, groups and realms. Users must be configured in the DataJet Administrator to be able to login to DataJet. For more information on DataJet Administrator, see "[Using the DataJet Administrator"](/v1/docs/using-the-datajet-administrator). Versions v5.5.13.1 or higher of DataJet's Desktop Client will be needed to login to DataJet. Using an earlier version will result in a failed login. ### Backup method requires "targetProject" The [Backup](https://portal.document360.io/v1/docs/backup) method stores the Mongo data for the specified project in a zip file so that it can be restored or imported back into a realm. Previously the method ran against the active project. This has now been changed to require "targetProject to be specified." Any existing calls to Backup which do not have targetProject in them will fail as a result. Old Method: ```json { "method": "Backup", "path": "%DATAPATH%mybackup.zip", "project": "Demonstration" } ``` New Method: ```json { "method": "Backup", "path": "%DATAPATH%Backups", "description": "Backup Existing Project", "targetProject": "MainProject1", "system": false, "project": "TestProject" } ``` ### Mongo DB DataJet v5.5.13.1 now requires MongoDB v5.0 or higher. ## BUG Fixes | Fix to Admin \| System Information : Additional exception handling to prevent freezing when Context menu is open. | | --- | | Export formats persist for no-state users: Some export formats (e.g., delimiter) were not preserved between export instances. | | Script Editor support for underscores in object names: Previously some underscores were stripped from lists of tables and fields. | ## Feature Details ### Switchable Logging for Server API calls Detailed server logging can be turned on or off using the Desktop | Admin | Command Interface window. See [Command Line](/v1/docs/command-line) for more information. ### "Enable Script" text command Ability to force the re-enabling of Script Editor. See [Command Line](/v1/docs/command-line) for more information. ### Changes to Job Window Cancel Models can now be cancelled from the job window. To cancel a job, right click the job and select the Cancel Model option. ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684240475366.png) See [Jobs](/v1/docs/jobs) for more information. ### Script name added to Script Execution History History for Plugins, Stored Scripts and scripts executed using ExecuteScript is accessible from Desktop | Script | Execute. The display now includes the name of the executed script: ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684251837932.png) ### Script Editor: Preview Script Editor now allows a preview of resolved variables to be viewed. Use [CTRL ^ L ] to bring up the Script Variables window: ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684252624609.png) Select the preview tab to see the preview for the currently selected method. Alternatively, right-click on a method and choose Preview: ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684252769925.png) Note that %DATAPATH% and %DSTAMP% are not resolved in preview. This is by design. ### Script Editor: view resolved script It is now possible to view a fully resolved script in the Supplementary Script Viewer. To view a resolved script, select Script Editor | File | View Resolved Script. When viewing a resolved script in the Supplementary viewer, File | Save As will be enabled, allowing a copy of the resolved script to be made. See [System Variables](/v1/docs/system-variables) and [Defines](/v1/docs/defines) for more information. ### New system variables: %CURRENT_PROJECT% and %CALLING_PROJECT% %CURRENT_PROJECT% and %CALLING_PROJECT% can be access from within script logging commands such as LogWrite, LogDataSetCount etc. This can be useful when nesting scripts and/or projects via Stored Scripts and [ExecuteStoredScript](/v1/docs/executestoredscript) to test that project variables are being correctly used in child scripts. See [System Variables](/v1/docs/system-variables) for more information. ### ExecuteStoredScript: optional debug flag Putting **"debug": true** into ExecuteStoredScript will output details of variables that have been passed into the child script into the script log (Note - the script log is found in **Admin | Remote Files | Team Export | djscriptlogs** ) . This can be useful for debugging nested scripts, for example in a scenario where a Master script is calling multiple separate Load Scripts for different data sources. In the example below, DaughterProject:ChildScript is called, and the variables "%LoadProjectName%" and "%CallingScript% are passed through to the script: ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684257455330.png) Within the script (DaughterProject:ChildScript ), 2 variables are declared in the DEFINES section of the script: - %LoadProjectName% - %ActiveScript% ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684257472025.png) In the log, details of what was passed and what was kept can be seen: ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684257487342.png) The example above shows that there are 3 classes of variable: - Declared Variable - Variables declared in the child script - Passed Overwrite Variable - Variables defined in the child script and in ExecuteStoredScript.   The declared variable will be overwritten - Passed Additional Variable - Variable defined in ExecuteStoredScript, but not declared in child script. ### Script Logs output to provided filename Script Logs can be started via the StartErrorLog method. The output will be stored in the djscriptlogs sub-folder of the Team Export Folder ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684258350523.png) ```json { "method": "StartErrorLog", "filename": "ScriptLog_%DSTAMP%", "mailTo": [ "me@email.com" ], "project": "DaughterProject" } ``` ### New API methods The following new API methods have been added | Category | Method | Description | | --- | --- | --- | | Project | [OpenTargetProject](/v1/docs/opentargetproject) | Opens a project using a name that is not modified by ScriptEditor | | Project | [CreateTargetProject](/v1/docs/createtargetproject) | Creates a project using a name that is not modified by ScriptEditor | | Project | [DropTargetProject](/v1/docs/droptargetproject) | Drops a project using a name that is not modified by ScriptEditor | | Data Model | [MoveFields](/v1/docs/movefields) | Moves fields from a source table into a new table. | | Data Model | [SetHiddenTables](/v1/docs/sethiddentables) | Controls which tables are visible/hidden. See [Set Table Visibility](/v1/docs/set-table-visibility) for more information. | ### Extended Totals in Multi-Function Profiles Increased ability to calculate totals in Multi-Function Profiles. Use Options | Extended Totals to turn on totals. If a total is not valid for the column then it will be blank. ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684330651020.png) ### Quantiles: ability to reverse labels The numbering of Quantile Bins can now be reversed. ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684331203737.png) ### MakeKeyTable filter support It is now possible to apply a filter to a fields before using it to make a Key Table. The filter will be applied to the field, and then the FirstDiscrete will be run against the filtered field to obtain the list of unique values from which to form the Key Table: ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684349926338.png) ### Changes to Plugins #### Plugins can auto open a report on completion If a plugin or extension creates a report as part of its processing, adding the following onView segment at the end of the plugin script will cause the report to be automatically opened ```json "onView": [ { "action": "OpenReport", "report": "%MODEL% Non Linear Regression" } ] ``` #### Control of Plugin menu location Plugins can be accessed from the following locations: - Analytics | Extensions - Engineering | Extensions - Modelling Edit the "classification" key of the Plugin script to control plugin location: ```json { ... "classification": "ANALYTICS", ... } ``` #### New Plugin: Scan rank ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684350179203.png) ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684350367590.png) #### Model Setup List selections It is now possible to add list selections to Plugin Dialog variable input. To do so, specify a type of "choice" and include the "options" key: ```json { "variable": "%METHOD%", "name": "Method", "type": "choice", "options": [ "KMEANS", "SPECTRAL", "AGGLOMERATIVE" ], "description": "Clustering Method" } ``` ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684352442759.png) #### Updates to 2d and 3d cluster modelling #### "Help" section support for Plugins Plugin dialogs now support an inline Help comment, as well as a link to an external help page. Use the "help" and "helpURL" keys to configure plugin help. ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684397355608.png) #### CopySourceTable accepts field list [CopySourceTable](/v1/docs/copysourcetable) allows a table to be moved or copied between projects on the same realm. If "allFields" is false, then "fields" array can be used to specify the list of fields to move or copy. ```json { "method": "CopySourceTable", "sourceProject": "LoadProject1", "table": "DATA_CUST", "targetName": "DATA_CUST_ARCHIVE", "allFields": false, "fields": [ "customer_key", "address_line1", "address_line2", "dj_dt_timestamp", "email", "phone" ], "description": "Removed Fields", "moveFiles": true, "project": "ArchiveProject1" } ``` ### Project menu "Set Table Visibility" It is possible to hide tables within a project by using Project | Set Table Visibility. See [SetHiddenTables](/v1/docs/sethiddentables) for more information. ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684352773676.png) ### Metadata support for CopySourceTable If Metadata has been applied to a table in its source location, the metadata will be brought with the table as part of [CopySourceTable](/v1/docs/copysourcetable). See [Getting Started - Categories and Metadata](/v1/docs/getting-started-categories-and-metadata) for more information on Metadata. ### New Remote Files dialog A new version of the [Remote Files](/v1/docs/remote-file-manager) dialog is available. This has a tree-view, and allows a user to see Script Logs. ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684408843156.png) ### Drag and Drop script file from Windows Explorer into Script Editor Drag a valid Script Editor script directly from Windows Explorer and drop onto Script Editor to view the file. ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684409287281.png) ### Additional highlighting on actions that will drop projects Highlighting has changed on actions that will cause projects to be dropped: ![](https://cdn.document360.io/73b6469b-c1e4-47e9-aa65-986c8ebd17ca/Images/Documentation/image-1684411012601.png) ### ## Related - [Using the DataJet Administrator](/using-the-datajet-administrator.md) - [System Variables](/system-variables.md) - [DEFINES](/defines.md) - [ExecuteStoredScript](/executestoredscript.md) - [Command Line](/command-line.md) - [Backup](/backup.md) - [Restore](/restore.md) - [SystemRestore](/systemrestore.md)