Skip to main content

Sandbox Mode

What is Sandbox​

A sandbox in Pia allows automation engineer to create automation packages in isolation from live mode. In fact, you can only create a package, activity or form when you are in a sandbox!

With a sandbox, automation engineers can create packages in isolation, having only the activities and forms required for the development of a single package. The feature named "sandbox mode" is available on the left navigation menu and appears as follows: sandbox-mode.png

Using the settings icon, you can manage a list of sandboxes and create a new sandbox.

When in a sandbox, the following experiences are unique to that sandbox:

  • Using the Package Editor, you can only view and save packages for the sandbox you have selected.
  • Using the Form Editor, you can only view and save packages for the sandbox you have selected.
  • Using the Activity Editor, you can only view and save packages for the sandbox you have selected.
  • Using the Client Dashboard the client tags, package configuration and global configuration options are all specific to that sandbox.
  • Using the Live Packages view, you can only see packages which you are running inside that sandbox.
  • Using the Pia Chatbot, while in sandbox mode, you can only see packages which are available inside that sandbox .

Differences Between Sandbox and Live Mode​

There are also some minor differences in functionality between sandbox mode and live mode:

  • In sandbox mode, you cannot use scheduled packages - if you attempt to schedule a package with a cron expression, it simply will not execute. Scheduled packages will only work when in live mode. If you want to test a package that you will later schedule, use the "Test Execute" function or add conditions for Pia Chatbot so you can use it in Pia for testing.
  • Certain other conditions will be restricted in sandbox mode. To understand more about specific restrictions, navigate to the article for the relevant condition.
  • Sandbox mode does not have versions functionality. Live mode is the only place where you can view and restore the previous version of a package, activity or form.
  • Certain restrictions to the automations you can execute apply in sandbox mode. These restrictions are built into the system to ensure that you can safely create automations without executing commands on client agents. Refer to the Whitelist Feature.

How to use a Sandbox​

Once you have created a sandbox, you can create new packages, forms and activities directly or copy them from live mode and other sandboxes.

Often, the process for developing changes to an existing package (i.e. one you have previously published) involves:

  1. Navigate to the package you wish to modify in live mode.
  2. Select "Copy to Sandbox" in the toolbar at the top of the editor.
  3. Select the sandbox you wish to copy to and click Go.
  4. You will be prompted with a list of associated forms and activities which will be copied into the sandbox. If you already have forms and activities of the same name in the sandbox, Pia will do a comparison and give you an option of overriding changes if required.
  5. You will be redirected to the sandbox where the package has been copied. You can make changes here.

Once you are finished development of a package in sandbox mode, you can use the "Promote to Live" feature to publish and "Activate" the package.