Editor parameters

Below you can find all parameters that can be passed to the Kudo editor. If you are using the on premise installation, you can pass them as query parameter directly to the editor url (like http(s)://editorUrl/editor?file=…&server=…).

If you are using the SaaS version, you need to enclose the parameters in a generated apitoken that will be passed as query parameter (see Token Authentication).

General Parameters

• file: Identifier (file id) of designated file in backend system. It can be a name or an id, depending on implementation of the data backend (see https://graebert.atlassian.net/l/c/08zg4uzL )

• fileUrl (optinal insteal of file): URl to the file to open. Location has to public accessible and it is view access only. If both “file” and “fileUrl” parameters are passed, “file” is taken with priority.

• server: Url of the API server if one is used as data backend (see https://graebert.atlassian.net/l/c/08zg4uzL ). It is the API server, Kudo editor is talking to e.g. to download the file specified by “file” parameter.

• sessionId: a session id that is sent with each API request if an API server is used as data backend (see https://graebert.atlassian.net/l/c/08zg4uzL )

• locale: Set the user interface language

• access: Set the editing or view UI  (edit or view)

  • Note: access=view blocks storing any changes the user makes back to the storage. access=edit will automatically store changes on fixed intervals and on session close.

• mobile: Load a mobile friendly UI (false or true)

• debug: Provide debugging output and features (false or true)

• workspace: Override the default UI workspace used for editing UI (see https://graebert.atlassian.net/l/c/dw3cJ7cE )

• viewerWorkspace: Override the default UI workspace used for view UI (see https://graebert.atlassian.net/l/c/dw3cJ7cE )

• autosavedisabled: Disable automatic saving in edit session. Changes made to the drawing are not saved unless SAVE command is executed explicitly.

• modelBackgrndColorWhite: modelBackgrndColorWhite=true is work for by-default background color white even server not available, sessionId should be available to work this parameter.

Additional Saas Version Parameters

• auth: application/partner id associated with the partner (see https://graebert.atlassian.net/l/c/i0rxQnuX ) - automatically added according your x-api-key when generating apitoken (see Token Authentication)

• userId: partner defined user id of the user that is calling the editor url - mandatory to pass to facility counting of distinct users