The JSON File Format

Applies to: Jamroom 7.0+ Last verified: 2026-10-24
  • Two kinds of file

    Each JSON file is an encoded array of items of one kind. There are two kinds:

    • Members: profile and user pairs
    • Items: blogs, audio, videos and so on, each of one module

    Look at real files with Tools > Review Created JSONs on the Exporter.

  • Members

    • _profile_export_id and _user_export_id (required): a unique ID for each.
    • profile_name (required), user_name and user_email: without user_email, only a profile is created.
    • _profile_created, _profile_updated, _user_created, _user_updated: Unix timestamps. Default: now.
    • Any other profile_... or user_... key is added to the profile or the user.
    • _profile_file_(key) and _user_file_(key) are files to download, each with url, filename and extension. The key is the field, such as image.

    Defaults such as active and not pending are added for you.

  • Items

    • _export_id (required): a unique ID for the item.
    • _module (required): an active module, such as jrBlog.
    • _created, _updated: Unix timestamps. Default: now.
    • _owner_profile, _owner_user: the export IDs of the owner. Without them, the item has no owner.
    • Any other key with the module's prefix, such as blog_title, is added to the item.
    • _(prefix)_file_(key): a file to download, with url, filename and extension. _(prefix)_file_file_only copies a file without adding item keys.
  • Links between items

    • A value _getDSvalue,(module),(export id),(key) is replaced with that key of the item with that export ID in that module. Use it to point a comment at its parent item.
    • _selfDSvalue,... works the same, but after the item is created.
    • _scan_key lists the keys to scan for _getDSvalue.
    • _table:(module):(table) adds rows to a database table: an array of column names and values, which can also use _getDSvalue. With _table_only set, only the table rows are added.

Tags