.. _auto_simlytiks_create_from_file:

*CREATES A SIMLYTIKS FROM FILE*
===============================

Uploads a Simlytiks configuration file to the platform and registers it as a named Simlytiks instance. Use this worker to programmatically import a pre-built Simlytiks definition into a project without going through the UI.

When to use
-----------

Tagged: ``dashboard``, ``file-upload``, ``import``, ``simlytiks``, ``user``.

Inputs
------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20 20 20

   * - Label
     - ID
     - Type
     - Default
     - Required
     - Description
   * - Simlytiks File
     - simlytiks_file
     - file
     - —
     - ✓
     - The Simlytiks definition file (e.g. a .simlytiks or JSON export) to be uploaded and registered; required.
   * - Name
     - name
     - text
     - —
     - ✓
     - Human-readable display name for the newly created Simlytiks instance; required and must be unique within the target project.
   * - Tags
     - tags
     - text
     - —
     - 
     - Optional comma-separated tags to attach to the Simlytiks instance for search and filtering; leave blank if no tagging is needed.
   * - Description
     - description
     - textarea
     - —
     - 
     - Optional free-text description of the Simlytiks instance's purpose or contents; leave blank to omit a description.
   * - Project ID
     - project_id
     - remote_lookup
     - —
     - 
     - Project under which the Simlytiks instance will be registered; resolved via remote lookup (primaryKey: remote_lookup_projects); defaults to null, which typically targets the current active project.

Outputs
-------

.. list-table::
   :header-rows: 1
   :widths: 20 20 20 20

   * - Label
     - ID
     - Type
     - Description
   * - Simlytiks DB
     - simlytiks_id
     - integer
     - Integer primary key of the newly created Simlytiks record in the SimlytiksDB; can be passed downstream to workers that reference or open a specific Simlytiks instance.

Disciplines
-----------

- data.io.file
- platform.dashboard

.. raw:: html

   <hr style="margin-top:2em">
   <p style="font-size:11px;color:#888">
   Auto-generated from <code>platform</code> schema. Worker id: <code>simlytiks_create_from_file</code>. Schema hash: <code>a50db5b16ede</code>. Hand-curated docs in <code>workerexamples/</code> override this page when present.
   </p>