# VIKTOR Documentation - [VIKTOR Documentation](/index.md) ## search - [Search the documentation](/search.md) ## docs ### api API - [API](/docs/api.md): API #### rest REST API - [REST API](/docs/api/rest.md): REST API ##### jobs-delete Cancel the job by its id. This endpoint can be used to cancel a running app job. - [Cancel Job by Id](/docs/api/rest/jobs-delete.md): Cancel the job by its id. This endpoint can be used to cancel a running app job. ##### jobs-read Get the job by its id. This endpoint can be used to check on the status and contents of a job. Jobs can have - [Get Job by Id](/docs/api/rest/jobs-read.md): Get the job by its id. This endpoint can be used to check on the status and contents of a job. Jobs can have ##### statistics-details-audit-events Retrieve or export audit events within a specified time window. - [Get Audit Events within a Time Window](/docs/api/rest/statistics-details-audit-events.md): Retrieve or export audit events within a specified time window. ##### statistics-details-daily-developer-logins Retrieve or export daily developer logins within a specified time window. - [Get Daily Developer Logins within a Time Window](/docs/api/rest/statistics-details-daily-developer-logins.md): Retrieve or export daily developer logins within a specified time window. ##### statistics-details-daily-user-logins Retrieve or export daily user login details within a time window. - [Get Daily User Logins within a Time Window](/docs/api/rest/statistics-details-daily-user-logins.md): Retrieve or export daily user login details within a time window. ##### statistics-details-monthly-active-developers Retrieve or export monthly active developers within a specified time window. - [Get Monthly Active Developers within a Time Window](/docs/api/rest/statistics-details-monthly-active-developers.md): Retrieve or export monthly active developers within a specified time window. ##### statistics-details-monthly-active-users Retrieve or export monthly active users within a specified time window. - [Get Monthly Active Users within a Time Window](/docs/api/rest/statistics-details-monthly-active-users.md): Retrieve or export monthly active users within a specified time window. ##### statistics-list Returns the environment activity data as grouped by statistics scope (users, developers or workspaces). - [Get Environment Activity Data](/docs/api/rest/statistics-list.md): Returns the environment activity data as grouped by statistics scope (users, developers or workspaces). ##### viktor-api - [VIKTOR API](/docs/api/rest/viktor-api.md) ##### workspaces-activate Activate the workspace. This sends a signal to scale up the app version runners, making sure that there is an app replica available to process jobs. - [Activate the Workspace](/docs/api/rest/workspaces-activate.md): Activate the workspace. This sends a signal to scale up the app version runners, making sure that there is an app replica available to process jobs. ##### workspaces-app-version-settings Returns the workspace app version settings. - [Get Workspace Settings](/docs/api/rest/workspaces-app-version-settings.md): Returns the workspace app version settings. ##### workspaces-assets Download an asset from workspace context, such as an image in the parametrization. - [Download Workspace Asset](/docs/api/rest/workspaces-assets.md): Download an asset from workspace context, such as an image in the parametrization. ##### workspaces-entities-create Create an entity. - [Create Entity](/docs/api/rest/workspaces-entities-create.md): Create an entity. ##### workspaces-entities-delete Delete and entity by its id. - [Delete Entity by Id](/docs/api/rest/workspaces-entities-delete.md): Delete and entity by its id. ##### workspaces-entities-download Returns the download URL for the content of a file entity (only for file entity types). - [Get download url for content of file entity.](/docs/api/rest/workspaces-entities-download.md): Returns the download URL for the content of a file entity (only for file entity types). ##### workspaces-entities-entities-create Create a child entity. - [Create a Child Entity](/docs/api/rest/workspaces-entities-entities-create.md): Create a child entity. ##### workspaces-entities-entities-read Get all child entities of an entity by parent entity id. - [Get all Child Entities](/docs/api/rest/workspaces-entities-entities-read.md): Get all child entities of an entity by parent entity id. ##### workspaces-entities-jobs Creates a Job. For the simplest computation flow, set `poll_result=false` or do not include it in the payload. - [Create a Job](/docs/api/rest/workspaces-entities-jobs.md): Creates a Job. For the simplest computation flow, set `poll_result=false` or do not include it in the payload. ##### workspaces-entities-list Get all entities. - [Get all Entities](/docs/api/rest/workspaces-entities-list.md): Get all entities. ##### workspaces-entities-messages Fetch system and user messages within an editor session. User should have at least `READ` permission on the entity to fetch messages. - [Get Editor Session Messages](/docs/api/rest/workspaces-entities-messages.md): Fetch system and user messages within an editor session. User should have at least `READ` permission on the entity to fetch messages. ##### workspaces-entities-parametrization Blocking endpoint to get parametrization as resolved by the app. - [Send Parametrization Job](/docs/api/rest/workspaces-entities-parametrization.md): Blocking endpoint to get parametrization as resolved by the app. ##### workspaces-entities-parent Get the parent entity. - [Get Parent of an Entity](/docs/api/rest/workspaces-entities-parent.md): Get the parent entity. ##### workspaces-entities-permission-groups Get all permission groups of an entity by entity id. - [Get all Permission Groups of an Entity](/docs/api/rest/workspaces-entities-permission-groups.md): Get all permission groups of an entity by entity id. ##### workspaces-entities-read Get a single entity by its id. - [Get Entity by Id](/docs/api/rest/workspaces-entities-read.md): Get a single entity by its id. ##### workspaces-entities-session Create an editor session for the corresponding entity. - [Create a new Editor Session](/docs/api/rest/workspaces-entities-session.md): Create an editor session for the corresponding entity. ##### workspaces-entities-siblings Get siblings of an entity by its id. - [Get Siblings of an Entity](/docs/api/rest/workspaces-entities-siblings.md): Get siblings of an entity by its id. ##### workspaces-entities-update Update entity by its id. - [Update Entity by Id](/docs/api/rest/workspaces-entities-update.md): Update entity by its id. ##### workspaces-entity-types-entities-read Get all entities of an entity type. - [Get All Entities of an Entity Type](/docs/api/rest/workspaces-entity-types-entities-read.md): Get all entities of an entity type. ##### workspaces-entity-types-entity-types Get all child entity types of an entity type. - [Get all Child Entity Types of an Entity Type](/docs/api/rest/workspaces-entity-types-entity-types.md): Get all child entity types of an entity type. ##### workspaces-entity-types-list Get all entity types. - [Get all Entity Types](/docs/api/rest/workspaces-entity-types-list.md): Get all entity types. ##### workspaces-entity-types-read Get an entity type by its id. - [Get Entity Type by Id](/docs/api/rest/workspaces-entity-types-read.md): Get an entity type by its id. ##### workspaces-entity-types-upload Upload an entity of the corresponding file entity type. - [Upload an Entity of File Entity Type](/docs/api/rest/workspaces-entity-types-upload.md): Upload an entity of the corresponding file entity type. ##### workspaces-files-create Create a new file object in the scope of an entity or session. Subsequently, the `temp_upload_url` and `temp_upload_data` from the response need to be used to upload the file itself. - [Create File](/docs/api/rest/workspaces-files-create.md): Create a new file object in the scope of an entity or session. Subsequently, the `temp_upload_url` and `temp_upload_data` from the response need to be used to upload the file itself. ##### workspaces-files-delete Delete a file by its id. - [Delete File by Id](/docs/api/rest/workspaces-files-delete.md): Delete a file by its id. ##### workspaces-files-download Download a file by its id. - [Download File by Id](/docs/api/rest/workspaces-files-download.md): Download a file by its id. ##### workspaces-files-list List all files in the scope. - [List All Files](/docs/api/rest/workspaces-files-list.md): List all files in the scope. ##### workspaces-files-read Get a file by its id. - [Get File by Id](/docs/api/rest/workspaces-files-read.md): Get a file by its id. ##### workspaces-files-uploaded Viktor collects the metadata of a file and makes it available for usage in file field when this signal is called by the client. - [Send Uploaded Signal for a File by Id](/docs/api/rest/workspaces-files-uploaded.md): Viktor collects the metadata of a file and makes it available for usage in file field when this signal is called by the client. ##### workspaces-groups-list Returns current user's groups or all groups if the user is admin. - [Get All Workspace Groups](/docs/api/rest/workspaces-groups-list.md): Returns current user's groups or all groups if the user is admin. ##### workspaces-groups-permissions Returns the permissions assigned to a group, including permitted actions per permission object. **ONLY FOR ADMINS** - [Get Group Permissions by Id](/docs/api/rest/workspaces-groups-permissions.md): Returns the permissions assigned to a group, including permitted actions per permission object. **ONLY FOR ADMINS** ##### workspaces-groups-read Returns a single group if the current user belongs to the group or is an administrator. - [Get Workspace User Group by Id](/docs/api/rest/workspaces-groups-read.md): Returns a single group if the current user belongs to the group or is an administrator. ##### workspaces-list List the workspaces for the current user, depending on user role and access. - [Get All Workspaces](/docs/api/rest/workspaces-list.md): List the workspaces for the current user, depending on user role and access. ##### workspaces-read Returns a single workspace by id. - [Get Workspace by Id](/docs/api/rest/workspaces-read.md): Returns a single workspace by id. ##### workspaces-users-current Returns the logged-in user's workspace specific fields. - [Get Current User in the Workspace](/docs/api/rest/workspaces-users-current.md): Returns the logged-in user's workspace specific fields. ##### workspaces-users-export Returns a CSV-file export of all Users in the workspace. Excludes Organization Admins. - [Export Workspace Users](/docs/api/rest/workspaces-users-export.md): Returns a CSV-file export of all Users in the workspace. Excludes Organization Admins. ##### workspaces-users-list Lists all the users that have access to the workspace. - [List Users in the Workspace](/docs/api/rest/workspaces-users-list.md): Lists all the users that have access to the workspace. #### sdk API - [SDK API](/docs/api/sdk.md): API ##### handling-entity-data Read, create and modify entity data using the SDK API - [Handling entity data](/docs/api/sdk/handling-entity-data.md): Read, create and modify entity data using the SDK API ##### running-entity-computation Run an entity computation using the SDK API - [Running an entity computation](/docs/api/sdk/running-entity-computation.md): Run an entity computation using the SDK API ### app-builder Create apps in minutes using our AI-assisted app builder - [App Builder [BETA]](/docs/app-builder.md): Create apps in minutes using our AI-assisted app builder ### create-apps Learn how to create apps through tutorials, how-to guides and examples - [Develop apps](/docs/create-apps.md): Learn how to create apps through tutorials, how-to guides and examples #### automated-testing Continuous testing using automated tests - [Automated testing](/docs/create-apps/automated-testing.md): Continuous testing using automated tests ##### mocking How to use Mocking in tests - [Mocking](/docs/create-apps/automated-testing/mocking.md): How to use Mocking in tests #### development-tools-and-tips ##### ci Setting up CI/CD for automated testing/deploying of your VIKTOR app on the remote Git repository - [Continuous Integration/Deployment](/docs/create-apps/development-tools-and-tips/ci.md): Setting up CI/CD for automated testing/deploying of your VIKTOR app on the remote Git repository ##### environment-variables Configuring app secrets through custom environment variables - [Environment variables](/docs/create-apps/development-tools-and-tips/environment-variables.md): Configuring app secrets through custom environment variables ##### ide Configuring your favorite code editor for writing apps with VIKTOR - [Code editor](/docs/create-apps/development-tools-and-tips/ide.md): Configuring your favorite code editor for writing apps with VIKTOR ##### interactive-debugging Setting up and using interactive debugging in your code editor - [Interactive debugging](/docs/create-apps/development-tools-and-tips/interactive-debugging.md): Setting up and using interactive debugging in your code editor ##### keep-a-changelog Tracking app changes and versions by keeping a changelog - [Keeping a changelog](/docs/create-apps/development-tools-and-tips/keep-a-changelog.md): Tracking app changes and versions by keeping a changelog ##### private-packages Use private packages in your published app - [Use private packages](/docs/create-apps/development-tools-and-tips/private-packages.md): Use private packages in your published app ##### system-dependencies Use system packages in your published app - [Use system dependencies](/docs/create-apps/development-tools-and-tips/system-dependencies.md): Use system packages in your published app ##### use-python-packages Add Python packages to requirements.txt - [Use Python packages](/docs/create-apps/development-tools-and-tips/use-python-packages.md): Add Python packages to requirements.txt #### documents-and-spreadsheets Documents & spreadsheets - [Documents & spreadsheets](/docs/create-apps/documents-and-spreadsheets.md): Documents & spreadsheets ##### converting-to-pdf Converting Word, Excel or SVG files to PDF - [Converting to PDF](/docs/create-apps/documents-and-spreadsheets/converting-to-pdf.md): Converting Word, Excel or SVG files to PDF ##### merging-pdf-files Merging PDFs into a single file - [Merging PDF files](/docs/create-apps/documents-and-spreadsheets/merging-pdf-files.md): Merging PDFs into a single file ##### spreadsheet-calculator Performing a calculation using a spreadsheet without macros - [Spreadsheet calculator](/docs/create-apps/documents-and-spreadsheets/spreadsheet-calculator.md): Performing a calculation using a spreadsheet without macros ##### spreadsheet-templater Filling a spreadsheet from a template - [Spreadsheet templater](/docs/create-apps/documents-and-spreadsheets/spreadsheet-templater.md): Filling a spreadsheet from a template ##### text-file-templater Generating a text-file by filling variables in a template - [Text-file templater](/docs/create-apps/documents-and-spreadsheets/text-file-templater.md): Generating a text-file by filling variables in a template ##### word-file-templater Filling a Word-file from a template - [Word-file templater](/docs/create-apps/documents-and-spreadsheets/word-file-templater.md): Filling a Word-file from a template #### inform-end-user ##### dashboard Show a welcome text on the dashboard - [Dashboard welcome text](/docs/create-apps/inform-end-user/dashboard.md): Show a welcome text on the dashboard ##### output-field Add an output field to the parametrization - [Output field](/docs/create-apps/inform-end-user/output-field.md): Add an output field to the parametrization ##### show-message Raising an error or showing a message to the user - [Show a message to the user](/docs/create-apps/inform-end-user/show-message.md): Raising an error or showing a message to the user ##### static-image Add static images to the parametrization - [Static image](/docs/create-apps/inform-end-user/static-image.md): Add static images to the parametrization ##### text-blocks Add static text blocks to the parametrization - [Text blocks](/docs/create-apps/inform-end-user/text-blocks.md): Add static text blocks to the parametrization ##### tooltips Tooltips - [Tooltips](/docs/create-apps/inform-end-user/tooltips.md): Tooltips #### layout-and-styling Layout & styling - [Layout & styling](/docs/create-apps/layout-and-styling.md): Layout & styling ##### adjust-parametrization-width Adjust the parametrization width - [Adjust the parametrization width](/docs/create-apps/layout-and-styling/adjust-parametrization-width.md): Adjust the parametrization width ##### dashboard Dashboard - [Dashboard](/docs/create-apps/layout-and-styling/dashboard.md): Dashboard ##### entity-navigation Navigation inside a workspace - [Navigation inside a workspace](/docs/create-apps/layout-and-styling/entity-navigation.md): Navigation inside a workspace ##### manual-line-break Add a manual line break between fields in the parametrization - [Manual line break](/docs/create-apps/layout-and-styling/manual-line-break.md): Add a manual line break between fields in the parametrization ##### pages Organizing the editor using pages - [Creating pages](/docs/create-apps/layout-and-styling/pages.md): Organizing the editor using pages ##### steps Dictate a workflow in the editor using steps - [Creating steps](/docs/create-apps/layout-and-styling/steps.md): Dictate a workflow in the editor using steps ##### style-text Style text using Markdown - [Style / format text using Markdown](/docs/create-apps/layout-and-styling/style-text.md): Style text using Markdown ##### tabs-and-sections Organizing the editor using tabs & sections - [Creating tabs & sections](/docs/create-apps/layout-and-styling/tabs-and-sections.md): Organizing the editor using tabs & sections #### managing-files How to use the correct method for your file - [Managing files](/docs/create-apps/managing-files.md): How to use the correct method for your file ##### downloading-files Handling downloading of files by the user - [Downloading files](/docs/create-apps/managing-files/downloading-files.md): Handling downloading of files by the user ##### modify-files How to use the correct method for your file - [Modifying files](/docs/create-apps/managing-files/modify-files.md): How to use the correct method for your file ##### uploading-files Handling uploading of files by the user - [Uploading files](/docs/create-apps/managing-files/uploading-files.md): Handling uploading of files by the user #### other-topics ##### date-dependent-params Using date-dependent params - [Using date-dependent params](/docs/create-apps/other-topics/date-dependent-params.md): Using date-dependent params ##### processing-gef-files Using off-the-shelve geotechnical functions from the viktor.geo module - [Processing GEF files](/docs/create-apps/other-topics/processing-gef-files.md): Using off-the-shelve geotechnical functions from the viktor.geo module ##### share-using-api Share data between entities using the API - [Share data between entities using the API](/docs/create-apps/other-topics/share-using-api.md): Share data between entities using the API #### references ##### cli Using VIKTOR's command-line interface - [Command-line interface (CLI)](/docs/create-apps/references/cli.md): Using VIKTOR's command-line interface - [Changelog](/docs/create-apps/references/cli/changelog.md): All notable changes to the VIKTOR CLI will be documented in this file. ##### sdk SDK reference - [SDK](/docs/create-apps/references/sdk.md): SDK reference ##### viktor-config-toml Setting high level app specifications using the viktor.config.toml file - [viktor.config.toml](/docs/create-apps/references/viktor-config-toml.md): Setting high level app specifications using the viktor.config.toml file #### results-and-visualizations Show results and create visualizations - [Results & visualizations](/docs/create-apps/results-and-visualizations.md): Show results and create visualizations ##### data-and-tables Present data and tables in a view - [Show data & tables](/docs/create-apps/results-and-visualizations/data-and-tables.md): Present data and tables in a view ##### hide-view Hide a view depending on other fields - [Hide a view](/docs/create-apps/results-and-visualizations/hide-view.md): Hide a view depending on other fields ##### html Show HTML (web) content in a view - [Show HTML](/docs/create-apps/results-and-visualizations/html.md): Show HTML (web) content in a view ##### images Show an image in a view - [Show an image](/docs/create-apps/results-and-visualizations/images.md): Show an image in a view ##### map Displaying features on a map - [Display a map](/docs/create-apps/results-and-visualizations/map.md): Displaying features on a map ##### optimization-routine Perform an optimization routine using the OptimizationButton - [Perform an optimization routine](/docs/create-apps/results-and-visualizations/optimization-routine.md): Perform an optimization routine using the OptimizationButton ##### plots-charts-graphs Show plots, charts & graphs in a view - [Show plots, charts & graphs](/docs/create-apps/results-and-visualizations/plots-charts-graphs.md): Show plots, charts & graphs in a view ##### report Display a report in a view - [Display a report](/docs/create-apps/results-and-visualizations/report.md): Display a report in a view ##### show-summary Summarizing an entity - [Show a summary](/docs/create-apps/results-and-visualizations/show-summary.md): Summarizing an entity ##### storing-results Storing results - [Storing results](/docs/create-apps/results-and-visualizations/storing-results.md): Storing results ##### threed-model Show a geometric 3D model in a view - [Show a 3D model](/docs/create-apps/results-and-visualizations/threed-model.md): Show a geometric 3D model in a view #### software-integrations VIKTOR's integrations with 3rd party software - [Software integrations](/docs/create-apps/software-integrations.md): VIKTOR's integrations with 3rd party software ##### autodesk-platform-services Connecting to Autodesk Platform Services using OAuth 2.0 - [Autodesk Platform Services](/docs/create-apps/software-integrations/autodesk-platform-services.md): Connecting to Autodesk Platform Services using OAuth 2.0 ##### axisvm Creating and running an AxisVM model - [AxisVM](/docs/create-apps/software-integrations/axisvm.md): Creating and running an AxisVM model ##### databricks Connecting to databricks - [Databricks](/docs/create-apps/software-integrations/databricks.md): Connecting to databricks ##### dfoundations Creating and running a D-Foundations model - [D-Foundations](/docs/create-apps/software-integrations/dfoundations.md): Creating and running a D-Foundations model ##### dgeostability Running a D-Geo Stability model - [D-Geo Stability](/docs/create-apps/software-integrations/dgeostability.md): Running a D-Geo Stability model ##### dsettlement Creating and running a D-Settlement model - [D-Settlement](/docs/create-apps/software-integrations/dsettlement.md): Creating and running a D-Settlement model ##### dsheetpiling Running a D-Sheet Piling model - [D-Sheet Piling](/docs/create-apps/software-integrations/dsheetpiling.md): Running a D-Sheet Piling model ##### dstability Running a D-Stability model - [D-Stability](/docs/create-apps/software-integrations/dstability.md): Running a D-Stability model ##### dynamo-nodes Integrate using VIKTOR nodes in Dynamo - [Dynamo Nodes [BETA]](/docs/create-apps/software-integrations/dynamo-nodes.md): Integrate using VIKTOR nodes in Dynamo ##### dynamo Integrate with Dynamo Sandbox - [Dynamo Sandbox](/docs/create-apps/software-integrations/dynamo.md): Integrate with Dynamo Sandbox ##### etabs-and-sap2000 This guide provides the necessary context and file templates to facilitate the integration process of ETABS and SAP2000. - [ETABS and SAP2000](/docs/create-apps/software-integrations/etabs-and-sap2000.md): This guide provides the necessary context and file templates to facilitate the integration process of ETABS and SAP2000. ##### excel Running an Excel-sheet with macros - [Excel](/docs/create-apps/software-integrations/excel.md): Running an Excel-sheet with macros ##### generic Running a Generic integration - [Other Software](/docs/create-apps/software-integrations/generic.md): Running a Generic integration ##### geolib Using the GEOLIB package and running a model - [GEOLIB](/docs/create-apps/software-integrations/geolib.md): Using the GEOLIB package and running a model ##### grlweap Running a GRLWEAP model - [GRLWEAP](/docs/create-apps/software-integrations/grlweap.md): Running a GRLWEAP model ##### idea Creating and running a IDEA StatiCa Concrete model - [IDEA StatiCa Concrete](/docs/create-apps/software-integrations/idea.md): Creating and running a IDEA StatiCa Concrete model ##### matlab Running a Matlab integration - [Matlab](/docs/create-apps/software-integrations/matlab.md): Running a Matlab integration ##### plaxis Using the PLAXIS package and running a model - [PLAXIS](/docs/create-apps/software-integrations/plaxis.md): Using the PLAXIS package and running a model ##### revit Running an Autodesk Revit integration - [Autodesk Revit](/docs/create-apps/software-integrations/revit.md): Running an Autodesk Revit integration ##### rfem Running an RFEM model - [RFEM 5](/docs/create-apps/software-integrations/rfem.md): Running an RFEM model ##### rhino-grasshopper Running a Rhino / Grasshopper integration - [Rhino / Grasshopper](/docs/create-apps/software-integrations/rhino-grasshopper.md): Running a Rhino / Grasshopper integration ##### robot Running an Autodesk Robot Structural Analysis model - [Robot Structural Analysis](/docs/create-apps/software-integrations/robot.md): Running an Autodesk Robot Structural Analysis model ##### scia Creating and running a SCIA Engineer model - [SCIA Engineer](/docs/create-apps/software-integrations/scia.md): Creating and running a SCIA Engineer model ##### staadpro Creating and running a Bentley STAAD.Pro integration - [STAAD.Pro](/docs/create-apps/software-integrations/staadpro.md): Creating and running a Bentley STAAD.Pro integration ##### tekla Running a Tekla Structures integration - [Tekla Structures](/docs/create-apps/software-integrations/tekla.md): Running a Tekla Structures integration #### user-input User input, fields and buttons - [User input, fields and buttons](/docs/create-apps/user-input.md): User input, fields and buttons ##### action-buttons Adding buttons to enable user actions - [Action buttons](/docs/create-apps/user-input/action-buttons.md): Adding buttons to enable user actions ##### entity-selection Selecting entities made easy with these fields - [Entity selection](/docs/create-apps/user-input/entity-selection.md): Selecting entities made easy with these fields ##### geometry-selection Let the user select geometry objects from a geometry model - [Geometry selection](/docs/create-apps/user-input/geometry-selection.md): Let the user select geometry objects from a geometry model ##### hide-field Hide a field depending on other fields - [Hide a field](/docs/create-apps/user-input/hide-field.md): Hide a field depending on other fields ##### input-validation Validate user input and provide helpful guidance - [Input validation](/docs/create-apps/user-input/input-validation.md): Validate user input and provide helpful guidance ##### llm-chat Enable the potential of LLM in your app - [LLM Chat](/docs/create-apps/user-input/llm-chat.md): Enable the potential of LLM in your app ##### map-features Let the user draw geo-objects on a map - [Map features](/docs/create-apps/user-input/map-features.md): Let the user draw geo-objects on a map ##### numeric-input Adding number fields - [Numeric input](/docs/create-apps/user-input/numeric-input.md): Adding number fields ##### options-and-selections Adding options & selection fields - [Options & selections](/docs/create-apps/user-input/options-and-selections.md): Adding options & selection fields ##### other-fields DateField, toggle, and more... - [Other fields](/docs/create-apps/user-input/other-fields.md): DateField, toggle, and more... ##### read-only-fields Provide additional context using non-editable fields - [Read-only fields](/docs/create-apps/user-input/read-only-fields.md): Provide additional context using non-editable fields ##### set-params-using-button Setting params with a button - [Set params using a button](/docs/create-apps/user-input/set-params-using-button.md): Setting params with a button ##### tables-and-arrays Group input fields using tables & arrays - [Tables & arrays](/docs/create-apps/user-input/tables-and-arrays.md): Group input fields using tables & arrays ##### textual-input Adding text fields - [Textual input](/docs/create-apps/user-input/textual-input.md): Adding text fields ##### upload-files Upload file(s) using a field - [Upload files](/docs/create-apps/user-input/upload-files.md): Upload file(s) using a field ### faq Find answers to some common problems - [Frequently Asked Questions](/docs/faq.md): Find answers to some common problems ### getting-started Get started with VIKTOR - [Get started with VIKTOR](/docs/getting-started.md): Get started with VIKTOR #### fundamentals Explanations of fundamental VIKTOR concepts - [Fundamentals](/docs/getting-started/fundamentals.md): Explanations of fundamental VIKTOR concepts ##### app-types Discover different types of apps - [App types](/docs/getting-started/fundamentals/app-types.md): Discover different types of apps ##### basic-app-structure Define a controller and parametrization in app.py - [Basic app structure](/docs/getting-started/fundamentals/basic-app-structure.md): Define a controller and parametrization in app.py ##### call-flow Understanding VIKTOR's app code execution flow - [App code execution flow](/docs/getting-started/fundamentals/call-flow.md): Understanding VIKTOR's app code execution flow ##### entities-and-entity-types Understanding the differences between an entity and an entity type - [Entity vs. entity type](/docs/getting-started/fundamentals/entities-and-entity-types.md): Understanding the differences between an entity and an entity type #### installation Install VIKTOR and activate your account - [Install VIKTOR](/docs/getting-started/installation.md): Install VIKTOR and activate your account ##### cloud-based-development Installing VIKTOR using a cloud-based development environment - [Cloud-based development](/docs/getting-started/installation/cloud-based-development.md): Installing VIKTOR using a cloud-based development environment ##### installation-using-docker Installing VIKTOR using the Docker isolation mode - [Install VIKTOR with Docker](/docs/getting-started/installation/installation-using-docker.md): Installing VIKTOR using the Docker isolation mode ##### local-development-venv Install VIKTOR and activate your account - [Install VIKTOR](/docs/getting-started/installation/local-development-venv.md): Install VIKTOR and activate your account ##### restart-install-workflow How to install restart the installation workflow when installing existing account on new device VIKTOR - [Restart installation](/docs/getting-started/installation/restart-install-workflow.md): How to install restart the installation workflow when installing existing account on new device VIKTOR #### starter-guide Create your first VIKTOR app by following step-by-step instructions - [Starter guide](/docs/getting-started/starter-guide.md): Create your first VIKTOR app by following step-by-step instructions #### whats-next Learn more about VIKTOR or start developing your own app - [What's next?](/docs/getting-started/whats-next.md): Learn more about VIKTOR or start developing your own app ### manage-apps Learn more about how to manage your apps - [Manage apps](/docs/manage-apps.md): Learn more about how to manage your apps #### access-management How to configure access and roles within VIKTOR - [Access Management](/docs/manage-apps/access-management.md): How to configure access and roles within VIKTOR #### activity-dashboard Get insights into activity within your organization - [Activity Dashboard](/docs/manage-apps/activity-dashboard.md): Get insights into activity within your organization #### enterprise-it Using VIKTOR within an enterprise IT environment - [Enterprise IT](/docs/manage-apps/enterprise-it.md): Using VIKTOR within an enterprise IT environment #### organization-setting Organization wide settings on the platform - [Organization Settings](/docs/manage-apps/organization-setting.md): Organization wide settings on the platform #### regional-hosting Storing data in your desired region - [Regional hosting](/docs/manage-apps/regional-hosting.md): Storing data in your desired region #### single-sign-on Setting up single sign-on for (the users of) your VIKTOR app - [Single Sign On (SSO)](/docs/manage-apps/single-sign-on.md): Setting up single sign-on for (the users of) your VIKTOR app #### software-integrations Installing and operating external integrations - [Software integrations](/docs/manage-apps/software-integrations.md): Installing and operating external integrations #### workspaces-and-apps Setting up and customizing workspaces and apps - [Workspaces and apps](/docs/manage-apps/workspaces-and-apps.md): Setting up and customizing workspaces and apps ### publish-apps Publish your VIKTOR app - [Publishing an app](/docs/publish-apps.md): Publish your VIKTOR app #### backward-compatibility Making sure an update of your app does not break compatibility - [Backward compatibility](/docs/publish-apps/backward-compatibility.md): Making sure an update of your app does not break compatibility #### continuous-deployment Setting up automated deployment of your VIKTOR app on the remote Git repository - [Continuous Deployment (CD)](/docs/publish-apps/continuous-deployment.md): Setting up automated deployment of your VIKTOR app on the remote Git repository #### limits Understanding the limits applied on production environments - [Platform limits](/docs/publish-apps/limits.md): Understanding the limits applied on production environments #### upgrade-viktor-version Upgrade the VIKTOR SDK version in requirements.txt - [Upgrade VIKTOR version](/docs/publish-apps/upgrade-viktor-version.md): Upgrade the VIKTOR SDK version in requirements.txt ### tutorials Use one of our Tutorials to improve your skills - [Tutorials](/docs/tutorials.md): Use one of our Tutorials to improve your skills #### app-type-editor Learn how to create an editor-type app - [Creating an editor-type app](/docs/tutorials/app-type-editor.md): Learn how to create an editor-type app #### app-type-simple Learn how to create a simple-type app - [Creating a simple-type app](/docs/tutorials/app-type-simple.md): Learn how to create a simple-type app #### app-type-tree Learn how to create an app implementing a more complex entity type hierarchy - [Creating a tree-type app](/docs/tutorials/app-type-tree.md): Learn how to create an app implementing a more complex entity type hierarchy #### automatic-reporting Follow along and learn how to automatically generate a report in a VIKTOR app - [Tutorial - Automatic reporting](/docs/tutorials/automatic-reporting.md): Follow along and learn how to automatically generate a report in a VIKTOR app #### basic-3d-model This tutorial shows an example of how to visualize 3D models in a VIKTOR application. - [Tutorial - Create an interactive 3D building](/docs/tutorials/basic-3d-model.md): This tutorial shows an example of how to visualize 3D models in a VIKTOR application. #### etabs-getting-started Follow along and learn how to automatically Post-Processing ETABS Data with Plotly and Pandas in a VIKTOR app. - [Your first ETABS app](/docs/tutorials/etabs-getting-started.md): Follow along and learn how to automatically Post-Processing ETABS Data with Plotly and Pandas in a VIKTOR app. #### integrate-dynamo This tutorial shows an example of how to parametrically influence Dynamo models in a VIKTOR app - [Tutorial - Integrate Dynamo](/docs/tutorials/integrate-dynamo.md): This tutorial shows an example of how to parametrically influence Dynamo models in a VIKTOR app #### integrate-etabs-sap2000 This tutorial provides an example of generating and visualizing a 3D structure in ETABS and SAP2000, integrated within a VIKTOR app. - [Tutorial - Integrate ETABS and SAP2000](/docs/tutorials/integrate-etabs-sap2000.md): This tutorial provides an example of generating and visualizing a 3D structure in ETABS and SAP2000, integrated within a VIKTOR app. #### integrate-grasshopper This tutorial shows an example of how to parametrically integrate Rhino/Grasshopper models in a VIKTOR app - [Tutorial - Integrate Rhino/Grasshopper](/docs/tutorials/integrate-grasshopper.md): This tutorial shows an example of how to parametrically integrate Rhino/Grasshopper models in a VIKTOR app #### integrate-scia Learn how to create and run a SCIA model within a VIKTOR app - [Tutorial - Creating and analyzing a SCIA model](/docs/tutorials/integrate-scia.md): Learn how to create and run a SCIA model within a VIKTOR app #### integrate-staadpro This tutorial shows an example of how to parametrically integrate STAAD pro workflows in a VIKTOR app - [Tutorial - Integrate STAAD.Pro](/docs/tutorials/integrate-staadpro.md): This tutorial shows an example of how to parametrically integrate STAAD pro workflows in a VIKTOR app #### interactive-maps This tutorial shows an example of how to visualize data an on interactive map using VIKTOR - [Tutorial - Create an interactive map](/docs/tutorials/interactive-maps.md): This tutorial shows an example of how to visualize data an on interactive map using VIKTOR #### intermediate-3d-model This tutorial shows an example of how to generate and visualise 3D models in a VIKTOR app - [Tutorial - 3D models](/docs/tutorials/intermediate-3d-model.md): This tutorial shows an example of how to generate and visualise 3D models in a VIKTOR app #### plots-and-data Follow along and learn how to visualise and summarise data using Plotly and Pandas. - [Tutorial - Data Analysis with Plotly and Pandas](/docs/tutorials/plots-and-data.md): Follow along and learn how to visualise and summarise data using Plotly and Pandas. #### process-etabs-data Follow along and learn how to automatically Post-Processing ETABS Data with Plotly and Pandas in a VIKTOR app. - [Tutorial - Post-process ETABS data](/docs/tutorials/process-etabs-data.md): Follow along and learn how to automatically Post-Processing ETABS Data with Plotly and Pandas in a VIKTOR app. #### process-staad-data Follow along and learn how to automatically Post-Process STAAD.Pro Data with Pandas in a VIKTOR app. - [Tutorial - Post-process STAAD.Pro data](/docs/tutorials/process-staad-data.md): Follow along and learn how to automatically Post-Process STAAD.Pro Data with Pandas in a VIKTOR app. #### python-script-to-app Follow along and learn how to convert your Python project to a VIKTOR app - [How to convert a Python Project to a VIKTOR app](/docs/tutorials/python-script-to-app.md): Follow along and learn how to convert your Python project to a VIKTOR app #### spreadsheet-calculator Follow along and learn how to automatically generate an Excel spreadsheet in a VIKTOR app which will present the results of a simple beam analysis - [Tutorial - Spreadsheet Calculator](/docs/tutorials/spreadsheet-calculator.md): Follow along and learn how to automatically generate an Excel spreadsheet in a VIKTOR app which will present the results of a simple beam analysis #### visual-builder This tutorial shows how to use the Visual Builder. - [Tutorial - Using the Visual Builder](/docs/tutorials/visual-builder.md): This tutorial shows how to use the Visual Builder. ### use-apps How to use VIKTOR apps - [Use apps](/docs/use-apps.md): How to use VIKTOR apps #### integrate-app Integrate your VIKTOR app in other software using the API - [Integrate your app in other software](/docs/use-apps/integrate-app.md): Integrate your VIKTOR app in other software using the API ### welcome VIKTOR is a platform for creating powerful and user-friendly web apps, all with pure Python! Create apps to automate - [VIKTOR documentation](/docs/welcome.md): VIKTOR is a platform for creating powerful and user-friendly web apps, all with pure Python! Create apps to automate ### whats-new Find the latest updates and features here! - [What's new - July](/docs/whats-new.md): Find the latest updates and features here! #### all-updates If you missed any updates, you can find them here! - [All updates](/docs/whats-new/all-updates.md): If you missed any updates, you can find them here! #### changelog-cli If you missed any updates, you can find them here! - [Changelog](/docs/whats-new/changelog-cli.md): If you missed any updates, you can find them here! #### changelog-sdk If you missed any updates, you can find them here! - [Changelog](/docs/whats-new/changelog-sdk.md): If you missed any updates, you can find them here! ## sdk ### 13 #### api VIKTOR SDK API reference - [SDK Reference](/sdk/13/api.md): VIKTOR SDK API reference ##### api-v1 viktor.api_v1 - [viktor.api_v1](/sdk/13/api/api-v1.md): viktor.api_v1 ##### core viktor.core - [viktor.core](/sdk/13/api/core.md): viktor.core ##### errors viktor.errors - [viktor.errors](/sdk/13/api/errors.md): viktor.errors ##### external - [viktor.external.axisvm](/sdk/13/api/external/axisvm.md): viktor.external.axisvm - [viktor.external.dfoundations](/sdk/13/api/external/dfoundations.md): viktor.external.dfoundations - [viktor.external.dgeostability](/sdk/13/api/external/dgeostability.md): viktor.external.dgeostability - [viktor.external.dsettlement](/sdk/13/api/external/dsettlement.md): viktor.external.dsettlement - [viktor.external.dsheetpiling](/sdk/13/api/external/dsheetpiling.md): viktor.external.dsheetpiling - [viktor.external.dstability](/sdk/13/api/external/dstability.md): viktor.external.dstability - [viktor.external.dynamo](/sdk/13/api/external/dynamo.md): viktor.external.dynamo - [viktor.external.etabs](/sdk/13/api/external/etabs.md): viktor.external.etabs - [viktor.external.excel](/sdk/13/api/external/excel.md): viktor.external.excel - [viktor.external.external_program](/sdk/13/api/external/external-program.md): viktor.external.external_program - [viktor.external.generic](/sdk/13/api/external/generic.md): viktor.external.generic - [viktor.external.grasshopper](/sdk/13/api/external/grasshopper.md): viktor.external.grasshopper - [viktor.external.grlweap](/sdk/13/api/external/grlweap.md): viktor.external.grlweap - [viktor.external.idea](/sdk/13/api/external/idea.md): viktor.external.idea - [viktor.external.matlab](/sdk/13/api/external/matlab.md): viktor.external.matlab - [viktor.external.plaxis](/sdk/13/api/external/plaxis.md): viktor.external.plaxis - [viktor.external.python](/sdk/13/api/external/python.md): viktor.external.python - [viktor.external.revit](/sdk/13/api/external/revit.md): viktor.external.revit - [viktor.external.rfem](/sdk/13/api/external/rfem.md): viktor.external.rfem - [viktor.external.robot](/sdk/13/api/external/robot.md): viktor.external.robot - [viktor.external.sap2000](/sdk/13/api/external/sap2000.md): viktor.external.sap2000 - [viktor.external.scia](/sdk/13/api/external/scia.md): viktor.external.scia - [viktor.external.spreadsheet](/sdk/13/api/external/spreadsheet.md): viktor.external.spreadsheet - [viktor.external.tekla](/sdk/13/api/external/tekla.md): viktor.external.tekla - [viktor.external.word](/sdk/13/api/external/word.md): viktor.external.word ##### geo viktor.geo - [viktor.geo](/sdk/13/api/geo.md): viktor.geo ##### geometry viktor.geometry - [viktor.geometry](/sdk/13/api/geometry.md): viktor.geometry ##### parametrization viktor.parametrization - [viktor.parametrization](/sdk/13/api/parametrization.md): viktor.parametrization ##### result viktor.result - [viktor.result](/sdk/13/api/result.md): viktor.result ##### testing viktor.testing - [viktor.testing](/sdk/13/api/testing.md): viktor.testing ##### utils viktor.utils - [viktor.utils](/sdk/13/api/utils.md): viktor.utils ##### views viktor.views - [viktor.views](/sdk/13/api/views.md): viktor.views #### changelog SDK version history - [Changelog](/sdk/13/changelog.md): SDK version history #### upgrades SDK deprecations with upgrade steps and planned removal - [Upgrades](/sdk/13/upgrades.md): SDK deprecations with upgrade steps and planned removal #### v13-to-v14 Guide on how to migrate from VIKTOR SDK v13 to v14 - [Migrate (v13 to v14)](/sdk/13/v13-to-v14.md): Guide on how to migrate from VIKTOR SDK v13 to v14 ### api VIKTOR SDK API reference - [SDK Reference](/sdk/api.md): VIKTOR SDK API reference #### api-v1 viktor.api_v1 - [viktor.api_v1](/sdk/api/api-v1.md): viktor.api_v1 #### core viktor.core - [viktor.core](/sdk/api/core.md): viktor.core #### errors viktor.errors - [viktor.errors](/sdk/api/errors.md): viktor.errors #### external ##### axisvm viktor.external.axisvm - [viktor.external.axisvm](/sdk/api/external/axisvm.md): viktor.external.axisvm ##### dfoundations viktor.external.dfoundations - [viktor.external.dfoundations](/sdk/api/external/dfoundations.md): viktor.external.dfoundations ##### dgeostability viktor.external.dgeostability - [viktor.external.dgeostability](/sdk/api/external/dgeostability.md): viktor.external.dgeostability ##### dsettlement viktor.external.dsettlement - [viktor.external.dsettlement](/sdk/api/external/dsettlement.md): viktor.external.dsettlement ##### dsheetpiling viktor.external.dsheetpiling - [viktor.external.dsheetpiling](/sdk/api/external/dsheetpiling.md): viktor.external.dsheetpiling ##### dstability viktor.external.dstability - [viktor.external.dstability](/sdk/api/external/dstability.md): viktor.external.dstability ##### dynamo viktor.external.dynamo - [viktor.external.dynamo](/sdk/api/external/dynamo.md): viktor.external.dynamo ##### etabs viktor.external.etabs - [viktor.external.etabs](/sdk/api/external/etabs.md): viktor.external.etabs ##### excel viktor.external.excel - [viktor.external.excel](/sdk/api/external/excel.md): viktor.external.excel ##### external-program viktor.external.external_program - [viktor.external.external_program](/sdk/api/external/external-program.md): viktor.external.external_program ##### generic viktor.external.generic - [viktor.external.generic](/sdk/api/external/generic.md): viktor.external.generic ##### grasshopper viktor.external.grasshopper - [viktor.external.grasshopper](/sdk/api/external/grasshopper.md): viktor.external.grasshopper ##### grlweap viktor.external.grlweap - [viktor.external.grlweap](/sdk/api/external/grlweap.md): viktor.external.grlweap ##### idea viktor.external.idea - [viktor.external.idea](/sdk/api/external/idea.md): viktor.external.idea ##### matlab viktor.external.matlab - [viktor.external.matlab](/sdk/api/external/matlab.md): viktor.external.matlab ##### plaxis viktor.external.plaxis - [viktor.external.plaxis](/sdk/api/external/plaxis.md): viktor.external.plaxis ##### python viktor.external.python - [viktor.external.python](/sdk/api/external/python.md): viktor.external.python ##### revit viktor.external.revit - [viktor.external.revit](/sdk/api/external/revit.md): viktor.external.revit ##### rfem viktor.external.rfem - [viktor.external.rfem](/sdk/api/external/rfem.md): viktor.external.rfem ##### robot viktor.external.robot - [viktor.external.robot](/sdk/api/external/robot.md): viktor.external.robot ##### sap2000 viktor.external.sap2000 - [viktor.external.sap2000](/sdk/api/external/sap2000.md): viktor.external.sap2000 ##### scia viktor.external.scia - [viktor.external.scia](/sdk/api/external/scia.md): viktor.external.scia ##### spreadsheet viktor.external.spreadsheet - [viktor.external.spreadsheet](/sdk/api/external/spreadsheet.md): viktor.external.spreadsheet ##### tekla viktor.external.tekla - [viktor.external.tekla](/sdk/api/external/tekla.md): viktor.external.tekla ##### word viktor.external.word - [viktor.external.word](/sdk/api/external/word.md): viktor.external.word #### geo viktor.geo - [viktor.geo](/sdk/api/geo.md): viktor.geo #### geometry viktor.geometry - [viktor.geometry](/sdk/api/geometry.md): viktor.geometry #### parametrization viktor.parametrization - [viktor.parametrization](/sdk/api/parametrization.md): viktor.parametrization #### result viktor.result - [viktor.result](/sdk/api/result.md): viktor.result #### testing viktor.testing - [viktor.testing](/sdk/api/testing.md): viktor.testing #### utils viktor.utils - [viktor.utils](/sdk/api/utils.md): viktor.utils #### views viktor.views - [viktor.views](/sdk/api/views.md): viktor.views ### changelog SDK version history - [Changelog](/sdk/changelog.md): SDK version history ### upgrades SDK deprecations with upgrade steps and planned removal - [Deprecations & Upgrades](/sdk/upgrades.md): SDK deprecations with upgrade steps and planned removal ### v13-to-v14 Guide on how to migrate from VIKTOR SDK v13 to v14 - [Migrate (v13 to v14)](/sdk/v13-to-v14.md): Guide on how to migrate from VIKTOR SDK v13 to v14