Skip to main content

Extension Creation

Object Package​

Step 1: Create an object package​

Create an object package by setting the package type to General and providing the basic details, such as the name, description, selected organization, and storage. Then, click Submit. The object package is created.

Step 2: Create a line item​

Click Create Item, select General, and then click Submit. Enter the name, description, required metadata, and select the database to create a line item for the respective object package. Then, click Submit. The object package line item is created.

Step 3: Metadata​

Click Metadata, enter the property name and description, select the data type, choose the required options, and then click Update.

Step 4: Function​

The Function tab is used to view, create, and manage custom backend logic or functions associated with the selected object or package.

Standard Package​

Step 1: Create a standard package​

Create a standard package with the package type set to "General" and enter basic details such as name, description, selected organization, and storage. Then, click Submit.

Standard Package is Created.

Step 2: Create a line item​

Click on Create Item, select General, and click Submit.

Create a line item for the respective standard package by providing the name and description. Add configurations with the required configuration types corresponding to the organization, package, or both. Then, click Submit. Standard package line item is created.

configurations​

  • Config Type – identifies the configuration scope, such as Org or Package.
  • Config Key – identifies the configuration parameter, such as GetAll....
  • Config Value – stores the actual value for the parameter.
  • Field Type – defines how the value is represented or selected.
  • Config Actions – defines what action can be performed with the configuration.
  • Dependency – specifies whether the configuration depends on another value.
  • Allowed Actions – controls what users can do with the configuration.

Purpose​

The main purpose is to make a standard package configurable and reusable across different extension.

Template Package​

Step 1: Create a Template Package​

Create a Template Package by setting the package type to General and entering the basic details, such as the name, description, selected organization, and storage. Then, click Submit.

The Template Package is created.

Step 2: Create a Line Item​

Click Create Line Item, select General, and then click Submit. Create a Line Item for the respective Template Package by providing the name, description, and tags.

Step 3: Screens​

The Screens section contains three options:

  • Pages
  • Screens
  • Wizards

Pages​

Pages are created to map screens. Pages can be created using the following page types:

  • Meta
  • HTML
  • Form.io
  • SurveyJS
  • React Hook

Creating Pages​

Meta Page:​

Click Create Page, enter the page name, select Meta as the page type, and choose the device type. Select the required page document, which is available from the bundle uploaded during bundle creation. Then, create the page.

HTML Page:​

Enter the page name, select HTML as the page type, and choose the device type. Write the required HTML code and click Create. Alternatively, click the Event Code Snippet button to generate a code snippet by selecting the appropriate data package.

Form.io Page:​

Enter the page name, select Form.io as the page type, and choose the device type. Drag and drop the predefined fields, such as Text Area, Number, Email, and Text Field.

Configure the required properties for each field, including:

  • Display
  • Data
  • Validation
  • API
  • Conditions
  • Logic
  • Layout

Then, create the page.

SurveyJS Page:​

Enter the page name, select SurveyJS as the page type, and choose the device type. Configure the required survey details and click Create to create the page.

React Hook Page:​

Enter the page name, select React Hook as the page type, and choose the device type. Enter the form title, configure the required values, and click Create. The page will then be created.

Screens​

Click Create Screen, select the object type, choose the page to be mapped, enter the screen name, and click Create. The selected page will be mapped to the screen.

You can also configure participant permissions for each screen.

Step 4: Move to the "Spaces" tab​

  • Enable Spaces and Visualizations as required.
  • Under Overlays, add the necessary custom pages and tags.
  • Under Hierarchies, go to the Custom Page tab and add custom pages and tags.
  • Under Canvas Actions, add the required custom pages and tags.

Finally, click Submit.

Step 5: Create an Assign Package​

Create an Assign Package for the previously created Template Package by clicking on Actions. Enter the name and description, then proceed to the Assign Packages screen.

Click the Add button, select the Application, select Package, Packages will be added in the list , click on close and then click Submit.

Application package line item is updated.

Step 6: Export and local publish​

click the package option and choose export and do the local publish

Data Package​

Step 1: Create a Data Package​

Create a Data Package by setting the package type to Data and entering the basic details, such as Name, Description, Selected Organization, and Storage. Then, click Submit.

The Data Package is successfully created.

Step 2: Create a Line Item​

Click Create Item, select General, and then click Submit. Create a Line Item for the respective Data Package by providing the Name and Description.

  • Navigate to the Documents tab and click Upload.
  • Select the required File and click Upload.
  • The Document Record will be listed after the file is uploaded.
  • Repeat the process to upload additional files.
  • Click Submit to complete the process.

The Data Package Line Item is successfully created.

Repeat the same process to create multiple Data Packages as required.

Content Package​

Step 1: Create a Content Package​

Create a Content Package by setting the package type to General and entering the basic details, such as Name, Description, Selected Organization, and Storage. Then, click Submit.

The Content Package is successfully created.

Step 2: Create a Line Item​

Click Create Item, select General, and then click Submit. Create a Line Item for the respective Content Package by providing the Name and Description.

  • Navigate to the Documents tab and click Upload.
  • Select the required File and click Upload.
  • The Document Record will be listed after the file is uploaded.
  • Repeat the process to upload additional files.
  • Click Submit to complete the process.

The Content Package Line Item is successfully created.

Repeat the same process to create multiple Content Packages as require

Application Package​

Step 1: Create an application package​

Create an application package with the package type set to "General" and enter basic details such as name, description, selected organization, and storage. Then, click Submit. Application Package is Created.

Step 2: Create a line item​

Click on Create Item, select General, and click Submit.

  • Create a line item for the respective application package by providing the name, description, and device types. Then, click Submit.
  • Application package line item is created.

Step 3: Create the new business object​

click the business object and click create button to create the new business object. Enter the name and description, click screen tab, choose the template package from drop down, based on the chosen package screens created in the package need to be listed in the dropdown and select the screen. Click add screen and enable the menu checkbox, click submit and click update.

Step 4: Roles​

Steps to Create a Role​

  1. Click Create to open the Create Role window.
  2. In the License Roles field, select the appropriate license role from the available options, such as:
    • Site Admin
    • Admin
    • Editor
    • Viewer
    • Guest
  3. Enter the Name and Description, select the Override checkbox if you want to override the default role configuration.
  4. Click Create to save new role and click submit.

Step 5: Menu Manager​

  • Navigate to the Menu Manager tab, click Create Menu, enter the Menu Name, and configure options such as Override, Default Launch, and Active, if required.
  • Select the appropriate Business Object, Menu Type, and Screen, and assign the required Roles that should have access to the menu.
  • Select the supported Devices on which the menu should be available, such as Web Desktop, Oculus, RealWear, Hololens, iOS, Magic Leap, Android, or Windows.
  • Click Update to save the main menu.
  • Click Create Sub Menu, enter the Menu Name, and configure the required options, such as Override, Default Launch, and Active.
  • Select whether the sub menu should open a Screen or an External URL.
  • Select the appropriate Business Object, Menu Type, and Screen. If External URL is selected, provide the required URL instead.
  • Add the required Menu Input Tags, select the Devices on which the sub menu should be available, and assign the required Roles that should have access to the sub menu.
  • Click Update to save the sub menu

Step 6: Assign Package​

  • Create an Assign Package for the previously created Template Package by clicking on Actions. Enter the name and description, then proceed to the Assign Packages screen.
  • Click the Add button, select the Application, select Package, Packages will be added in the list , click on close and then click Submit.
  • Application package line item is updated

Export Application Package​

select the created Application package, click on actions, choose export, select the bundle type, select the build type click on next, click on next and then click on Submit.