Scripts

Note: The table in this page shows "No items found" if the asset contains no currently registered scripts.

Important: If the asset is muted, you will be not able to view this page. This page will be available again once the asset is unmuted.

The Scripts table shows all the scripts registered on this asset or otherwise available to this asset (whether automatically published when the asset registered or manually published, through the Axeda® Connected Product Management Applications). The Available Scripts module shows scripts registered with the asset but not yet published to that asset. The Agent Timers module shows any timers created for this asset; and the Agent Triggers module shows Agent-based triggers configured for the Agent on the asset.

Using the tools in this page, you can create scripts for this asset, register and unregister scripts for the asset, and more. You can assign scripts to dynamic timers defined for this asset, resulting in "dynamic scripts." The Agent will run these dynamic scripts, based on their individual schedules, as part of running any scripts created within its own configuration.

o Author - Applications username of the individual who created this script or blank, if the script was created by the asset (based on the Agent's project).

o Actions - tasks that can be performed on the script, including Schedule, Re-register, Run, Cancel, Disable, or Publish.

Procedures from this page

From this page, you can perform a variety of script-related tasks, including scheduling a script or assigning timers to scripts. .Click the title of a procedure to display it; click the title again to hide the procedure:

To filter the scripts table

1. Click Filters to show the filter boxes, if not shown.

2. To view all scripts registered on this asset, click Filter without typing any search values.

3. To perform a search of the Platform, do one or more of the following and then click Filter:

a. In the box above the Status column, select the script status for the script(s) you want to find.

b. In the box above the Name column, type all or part of the name of the script(s) you want to find. (The server will return all names that contain the characters you specified.)

c. In the box above the Author column, type all or part of the name of the individual who created the script(s). (The server will return all scripts with author names that contain the characters you specified.)

d. In the box above the Last result column, select the last result for the script(s) you want to find.

The Platform finds all scripts registered on this asset that contain the search value(s) defined per your criteria and shows them in the table.

To request the status of a registered script

When a script starts or stops running on an asset, the Axeda Gateway or Axeda Connector Agent running on that asset sends a status of all registered scripts to the Platform. This information is shown in the Last Result column on this page.

You can manually request the asset send its script status information by clicking Request Script Status in the table heading.

A message appears above the table, similar to "Processing your request for the status of all asset scripts."

When the asset next contacts the Platform, the asset receives the command and responds by sending a list of all scripts on the asset and the status of each.

To create a script

1. Below the table, click New Script.

The script wizard appears. You create the script information in this wizard, which prompts for the information required for the script.

2. Create the script in the Script wizard pages as prompted.

When the script is saved, it appears in the table with a status of "Waiting to register". When the asset next contacts the Platform, it receives this script action and registers the script: at that point the status changes to "Ready". If there is an error registering the script on the asset, you can attempt to re-register the script.

To specify a schedule for or assign a timer to a script

1. For a specific script, click Schedule in the Actions column.

If this option is not available, the script has a schedule for this asset already or there are no timers available for this asset. If there are no timers shown in this page, you may need to first create timers in the New Timer wizard.

The Assign timers to script page appears, showing all timers configured for this asset and available to the script for execution.

2. Create the schedules for the script by assigning and removing timers for the script.

When the script schedule settings are saved, the name of the script and $image\script_waitingenableicon.gif$ appear in the Timers page. When the asset next contacts the server, it registers the timer with this script schedule: at that point, the $image\script_waitingenableicon.gif$ is removed, indicating the timer is set to run assigned script(s).

To register scripts on the asset

The Available Scripts module shows any scripts available for registration on this asset (for example, scripts published for the model but not yet registered for this asset).

1. In the Available Scripts module, select View all.

2. In the displayed Available Scripts page, select all scripts you want to deploy or publish to the asset.

3. Click Deploy Selected Scripts. A message appears prompting you to confirm that you want to register the selected script(s) on the asset.

4. Click OK. The status for the scripts changes to "Waiting to register" (when the asset(s) next contact the Platform).

Also, when you save a new script to the asset, it is registered automatically with that asset.

Note: If you want to view and register a script on multiple assets, you can use the Configuration application, script manager.

To re-register a selected script

For a specific script, click Re-register in the Actions column. If this option is not available, the script is already registered for this asset.

The status for the script changes to "Waiting to register" (when the asset next contacts the Platform).

The script will be registered on the asset (at the registered path), and the Agent will run any register commands defined in the script sequence file. When the Agent finishes registering the selected scripts, it sends an updated list of all registered scripts.

To unregister and remove a script from the asset

You can select to unregister scripts on the asset. The script will be deleted on the asset (at the registered path), and the Agent will run any unregister commands defined in the script sequence file. When the Agent finishes unregistering the selected scripts, it sends an updated list of all registered scripts.

1. In the table, select the check box(es) for the script file(s) you want to unregister. To unregister all script files shown in this page (not necessarily the entire table), select the check box in the table heading. Note that you cannot unregister asset-based scripts.

2. Click Unregister Selected Scripts. A message appears prompting you to confirm that you want to unregister the selected scripts with the asset.

3. Click OK.

The status changes to "Waiting to unregister". When the asset next contacts the server, it receives this update and the Agent deletes the scripts: at that point the script is removed from the table and appears in the Available Scripts module.

To publish a selected script

For a specific script, click Publish in the Actions column. If this option is not available, the script is already published.

Now this script will be available for deployment to other assets of this same model (as shown in the Available Scripts module when you select those assets). When deployed to those assets, the script can be run on those assets and configured as a script action to run on an asset. (Scripts can also be published when created in the script wizard.)

To run a selected script

For a specific script, click Run in the Actions column. If this option is not shown, the script is already running or disabled.

The status changes to "Waiting to run". When the asset next contacts the Platform, it receives this update and the Agent starts the script on the asset. At this point, the status changes to "Running <current line> : <current command >".

When the Agent runs the script, it executes all commands defined in the script sequence file's [RUN] section: if there is no [RUN] section, all commands in the file are executed.

While a script is running the only action you can perform on that script is "Cancel".

To stop a script action on the asset

If you select to perform an action on an asset (from the Actions column) you can stop that action. You can stop a running script or stop a script that is registering, unregistering, or being disabled on the asset.

For a specific script, click Cancel in the Actions column. The Cancel action is shown only if there is a script action that you can cancel for the asset.

The status changes to "Ready" when the script action is stopped.

To disable a script

In the Actions column for the script you want to disable, select Disable.

The status changes to "Waiting to disable".

When the asset next contacts the Platform, it gets the action and disables the script and status changes to "Disabled" the next time the page is refreshed.

Scripts

Procedures from this page

Tips