System Designer reference

This section details all of the tasks that can be performed in the nio System Designer, and is organized by context:

It can help you answer questions about what you can do in each level of the System Designer as you navigate from creating a system, to editing an instance name, to deleting a block.


System

Systems are the largest container for projects in the nio System Designer.

Systems are created in the System Designer to contain instances (running installations) of the nio Platform.

Create a system

  1. From the System Designer (https://app.n.io/design), click the add new system card to create a new nio system.
  2. Complete the create new system modal:

    • In the system name box, enter a name for your system.
    • In the template dropdown, you can keep the default blank system or select a system template.
    • Click accept.

     

System edit, share, delete

Once you create a nio system, you can edit, share or delete that system by clicking the design icon in the app switcher.

When you hover over each system card, you will see the system toolbar that can perform the following tasks:

Icon Label Description
edit Edit system name. View Pubkeeper configuration information.
share Share system. This option is only available to teams within an organization. Read more information about system sharing here.
delete Delete system. Instances must be deleted first.

Instance

Instances are running versions of nio.

Instances are created inside a system and contain services.

Create an instance in the cloud

To enter the system context, select the system card from the grid or click the breadcrumb.

  1. Click add instance.
  2. Check the cloud instance checkbox.
  3. Complete the add instance modal:
    • In the instance name box, enter a meaningful name.
  4. Click accept.

Connect to a local instance

To enter the system context, select the system card from the grid or click the breadcrumb.

  1. Click add instance.
  2. Check the local instance checkbox.
  3. Complete the add instance modal:
    • instance name: enter a meaningful name.
  4. The rest of the text inputs will be pre-filled with default values that you may edit if necessary.
  5. Click accept.


[info] Instance names

Instance names cannot contain spaces or underscores.

Instance edit, save, delete

Once you create an instance, you can enter the instance context by clicking the instance name in the instance list or in the breadcrumb above the contextual toolbar.

In the instance context you will see the the instance toolbar and can perform the following tasks:

Icon Label Description
edit Edit instance name and set environment variables.
save Save instance.
delete Delete instance.

[info] Environment variables

The environment variables section in the edit instance modal window can be used to set instance-wide variables. This is useful for storing values such as API keys/secrets or other variables that you do not want to hardcode directly into block properties.

Only admin-level users can view/edit the values of the environment variables in the edit instance modal.

More information about environment variables can be found here: docs.n.io/instances/environment-variables.html.


Service

A nio service is a user-configurable signal path that connects a collection of blocks so they can work together to perform a desired task or service.

Services are created inside an instance and contain blocks.

Create a service

Select the name of the instance in the left navigation panel or on the breadcrumb above the contextual toolbar.

  1. Click create new service.
  2. Complete the create new service modal:
    • In the service name box, enter a meaningful name.
    • Leave the service type as Service.
  3. Click accept.

[info] Service names

Service names cannot contain the following characters: * | \ / : ” <> / ?

Service edit, save, start/stop, auto-start, revert, clone, delete

Once you create a service, you can enter the service context by clicking the service name in the service list or by double clicking the service in the canvas.

In the service context you will see the the service toolbar that can perform the following tasks:

Icon Label Description
edit Edit service name and color.
save Save service.
start/stop Toggle to start and stop service.
auto-start on/off Toggle Auto-Start on and off. Default is on.
revert Revert changes to service.
clone Clone service.
delete Delete service.

Connect/disconnect blocks

The signal paths between blocks are part of the service-level configuration. If you change the connections between your blocks, you will need to save your service in the service toolbar.

To connect two blocks, click and drag the output terminal of one block and release the connector on the input terminal of the next block.

To disconnect, click the input terminal of the block receiving signals and drag and release the connector anywhere on the canvas.

View logs

Logs show the output of a running service.

To view the logger panel, click anywhere on the canvas to deselect the blocks and enter the service context.

  1. Click start on the toolbar to run your service.
  2. Click open logger panel to view the logs.


Blocks

Blocks are the units of work inside a nio service.

Add a block

Click the service name in the service list or on the breadcrumb above the contextual toolbar to enter the service context.

In the block library search box, enter a block type name.

[info] Block library tabs

Notice that as you type, the list of installed blocks is filtered. A block can be displayed under one or more tabs.

  • The available tab contains block types that are available, but may or may not have not been installed.
  • The installed tab contains block types that have been downloaded and installed. The most frequently used blocks come pre-installed in your system.
  • The configured tab contains blocks that have already been installed, named, and configured.
  1. Drag the block type to the canvas.
  2. In the block configuration window, fill out any of the block properties you need and click accept.

[info] Block names

In nio versions less than 3.0, block names cannot be edited after creation.

Block edit, command, delete

Once you have added a block, you can enter the block context by clicking the block.

In the block context you will see the the block toolbar that can perform the following tasks:

Icon Label Description
edit Edit block configuration.
command Command block.
delete Delete block.

Delete a configured block

  1. Search for the configured block in the block library.
  2. Click the vertical ellipsis menu and select delete.
  3. If the block in use warning is displayed, click got it! and delete the block from all services before deleting the configured block.
  4. Click delete in the block confirmation modal window.

Configure blocks

  1. Double-click the block to view the block configuration modal.
  2. Enter the required parameters.
  3. Click accept.

results matching ""

    No results matching ""