Synchra.24
menu_bookDocumentation
Practical guides for setup and development

Find guides for getting started, building workflows and adding your own tools to your company workspace.

folderEmbedded services

Importing and exporting ZIP templates

Local ZIP templates: format, settings, restrictions, import and export.

Machine translation

In the web version, open Administrator → Services → New Service → From the ZIP template. Select the archive. The application will check it and show the ID and version of the template, the name, purpose, height of the widget, authority and access in the web version. The name can be changed before creation. Need a license Applications, access to the admin panel and the right admin_edit_provider_services; An AI license is not required.

Button Create a service creates a separate embedded service with a new token and draft v1. Old services are not replaced, even if the name or ID of the template match. The sources are opened on the HTML tab, without automatic code execution. Check the code and settings, use the preview if necessary, and click separately To publish. Employees are selected anew in the access settings. Events, artifacts, and secret variables are not created during import.

Package format, version 1

service.json
index.html
style.css
script.js

One shared folder is allowed, for example my-service/service.json. Paths to files They are considered relative to the configuration folder and may contain nested directories. There must be exactly one configuration.

{
  "format": "synchra.service-template",
  "schema_version": 1,
  "template": {
    "id": "com.example.stock",
    "version": "1.0.0",
    "description": "Компактный виджет склада"
  },
  "service": {
    "name": "Склад",
    "icon": "msInventory_2",
    "permission": "warehouse_view",
    "web_enabled": true,
    "purpose": "dashboard_widget",
    "widget_height_mobile": 100,
    "widget_height_web": 280,
    "widget_full_bleed": false
  },
  "files": {
    "html": "index.html",
    "css": "style.css",
    "js": "script.js"
  }
}
  • format and schema_version define the package format, and template.id and template.version — the identity and version of the template itself. These are different versions. Exporting the editor creates a local identifier local.service and the version 1.0.0; before distributing, set your own ID and version. Repeated import always creates a copy, without automatically updating the installed services.
  • template.id: 3-128 lowercase Latin letters, numbers, dots, _, -, begins with a letter. The version has the form 1.0.0, a suffix is allowed, for example 1.0.0-beta.1. The description is optional, up to 2000 characters.
  • service.name required, 2-100 characters and up to 200 bytes UTF-8. Other settings are optional: default icon msWebAsset, authorization is empty, web access is disabled, assignment service, both heights 0 (standard values), widget_full_bleed: false (with title and indentation), widget_auto_height: false (height manually). Optional field widget_auto_height accepts true or false: when true The widget size is determined by the content on both platforms, and the manual heights are saved to return to the previous mode. The setting is transferred when importing, exporting, and installing from the store. Field widget_full_bleed optional, accepts only true or false and it is saved when exporting and importing the ZIP template. All supported widget assignments and the standard height limits described above are acceptable.
  • The icon must be from the general list of the application. Authority — lowercase Latin letters and _. You can not transfer token, provider_id, allowed_users, publication flags and other fields of the installed service: unknown configuration fields are rejected.
  • files.html, files.css, files.js they are required and point to different UTF-8 files. Suitable for HTML .html/.htm, for CSS .css, for JavaScript .js/.jsx/.mjs. The HTML fragment itself is a body, as in the editor. JSX is saved without prior conversion, React and the SDK provide the engine.

Limitations and errors

ZIP to 6 MiB, sources before 5 MiB of serialized JSON, configuration up to 64 KiB. Up to 32 entries in total, along with catalogs, the total declared unpacked size is up to 5 MiB + 192 KiB. In addition to the four main files allowed README.md, LICENSE and LICENSE.txt next to the configuration. Official .DS_Store and records __MACOSX/ They are ignored, but they are taken into account in the general size and number of records limits. Embedded images, arbitrary resources, and npm packages are not imported yet; images can be included as data:.

Regular ZIP with STORE/DEFLATE, without password, ZIP64, multiple volumes and symbolic links are supported. Paths are relative, in Latin, without .., backslashes and absolute addresses. Duplicate names, including case-only differences, are rejected. For the code and configuration, UTF-8, actual size, and CRC are checked; unpacking is limited even if the size in the ZIP directory is incorrect. The server repeats the check of the source archive and verifies the rights before unpacking. If the verification error occurs, the service is not created.

An old ZIP with only three sources is not considered a template. Unpack it and use the old one. Downloading code from files, or add service.json the format is higher. The import does not run the code; execution occurs only upon subsequent explicit preview or use of the published service.

Local templates and store

The ZIP template creates a separate copy of the service without any connection to the seller's updates. The store installs a verified version of the product and supports subsequent updates. When importing a local archive, you need to check and configure the service yourself.

To transfer, select the ZIP file in the import window, check the template information, and click Create a service. If the archive does not fit, the system will show the reason; no new service is created.