Chat with us, powered by LiveChat Skip to main content
Echo360 Status:

EchoInk: Creating a Module and module.json File

Amanda Leibovich
  • Created:
  • Updated:

This article describes how to create the basic module structure and a module.json file.

The Module Directory

  1. Create the basic module structure, as follows: BasicModuleStructure.png
  2. If your module will contain a widget, also create a widgets subdirectory when you add the patterns subdirectory, and a subdirectory for the widget’s files. BasicModuleStructureSubdirectories.png

  3. Complete the module.json file. See the instructions in the next section.

    EchoInk recommends placing a single widget in a module to maintain independent versioning per widget.

  4. Add either non-widget patterns or a widget with its associated pattern to the module. See the Add a pattern and Add a widget and a widget pattern topics.

The module.json File

Each module must contain a module.json file. This file provides Inkling with metadata about the module, helping uniquely identify it.

The example below shows the fields EchoInk recommends adding to this file, and the table below provides details.

  1. Open the module.json file that you created in the previous section in a text editor.
  2. Add the following fields and set their values to the required values for the module. ModuleJSONFileExample.png
  3. Verify that you have correctly formatted this file, as follows:
    • All keys and values must be enclosed within straight quotes.
    • All lines must end with a comma, except for the last line.
    • All values must be in lowercase, with the exception of displayName values.
    • Version numbers must be three-digit numbers separated by periods.
FieldRequired?Description
nameYes

String that uses only alphanumeric lowercase characters, underscores, and hyphens, and does not exceed a maximum of 30 characters.

Each module in your organization must have a unique name.

organizationYes

Short version of your organization's name; also called organization code.

Contact your EchoInk Module Administrator or EchoInk representative for the correct value for this field.

versionYesString that must comply with the Semantic Versioning Specification.
displayNameRecommendedString that identifies the module in the Module Management Interface; supports uppercase and lowercase characters. Generally, it is a well-formatted version of the name field. Although displayName values do not need to be unique, we recommend making them descriptive to enable easy module identification.