common/scripts

(inner) scriptKillAll() → {number}

Terminate all scripts that are executing.

Example

// Start multiple scripts using scriptRun
scriptRun('runApp1', 'runAppjs1.js');
scriptRun('runApp2', 'runAppjs2.js');
scriptRun('runApp3', 'runAppjs3.js');

// Kill all running scripts
var ret = scriptKillAll();
if (ret !== -1) {
    print("Congratulations, this API executes successfully.\nReturn value: " + ret);
} else {
    print("Sorry! " + lastError() + "\nReturn value: " + ret);
}

// Operation Result (on success):
Congratulations, this API executes successfully.
Return value: 0

Returns:

(inner) scriptList() → {Array|null}

Retrieves a list of all currently running scripts that were launched using scriptRun().

Each entry in the returned list contains metadata about the running script:

• name (string): The alias name assigned in scriptRun(name, scriptFile)
• id (number): A unique ID representing the running instance
• path (string): The full file path of the script being executed

Example

// Start a script with an alias
scriptRun('TEST1', 'testScript.js');

// Retrieve the list of currently running scripts
var list = scriptList();
if (list != null) {
    for (let i = 0; i < list.length; i++) {
        print("scriptList name: " + list[i].name);
        print("scriptList ID: " + list[i].id);
        print("scriptList Path: " + list[i].path);
    }
} else {
    print("No Script!!!!");
}

// Example Output (if a script is running):
// scriptList name: TEST1
// scriptList ID: 1562329959238
// scriptList Path: C:\Users\sigma\Documents\Scripts\testScript.js

Returns:

(inner) scriptRun(name, scriptFile, argumentsopt) → {number}

Run the script file.
Run the specified script file, which can be used to run multiple scripts at the same time. The script file can be either a JS file or an SCP file.

Supports:
scriptRun(name, scriptFile)
scriptRun(name, scriptFile, arguments)

Description of the script path:

• Absolute path:
  Specify the absolute path to scriptFile, which is the full path to the file.
• Relative path:
  There are two kinds of relative paths, one is the user predefined path, and the other is the default path of the Total Control script.
  1. User predefined path:
     If the user's script has the following definition: define('scriptPath', 'c:\File');
  2. Total Control environment variable path:
     If the user does not define scriptPath in the script, it will be searched by the environment variable TCSCRIPTPATH. If there is a corresponding JS or SCP file in the path, if it is, execute it;
  3. Total Control script default path ("&lt:My Documents>/Scripts"):
     If the scriptPath is not defined in the user's script and the corresponding file is not found in the path specified by the environment variable TCSCRIPTPATH, it will be found in the default path "&lt:My Documents>/Scripts" of the Total Control script to see if there is a corresponding JS or SCP file. If yes, execute it, if not, exit execution;

Note:
Execute the script to find the path of the script in the following order:

• If it is an absolute path, execute the specified script and report an error if it does not exist.
• If it is a relative path, first find the script file under the user's predefined path, then find the script file under the path of the Total Control environment variable, and finally find the script under the default path of the Total Control script. If the script is still not found in the default path of the Total Control script. , return an error message;

Examples

// Example 1: Run a script using absolute path
var ret = scriptRun('fileBinaryReader1', 'E:/File/JScripts/Public/fileBinaryReader.js');
if (ret > 0) {
    print("script run id: " + ret);
} else {
    print(lastError());
}

// Example 2: Run a script using relative path with predefined scriptPath
define('scriptPath', 'E:/File/JScripts/Public/');
var ret = scriptRun('fileBinaryReader2', 'fileBinaryReader.js');
if (ret > 0) {
    print("script run id: " + ret);
} else {
    print(lastError());
}

// Example 3: Run a script with arguments (e.g., rename a device)
var args = {
  arguments: [1, 'mobile2', 'test.js'],  // Positional arguments
  deviceName: 'mobile1'                  // Custom parameter
};
var ret = scriptRun('setMobileName', 'setName.js', args);
if (ret > 0) {
    print("script run id: " + ret);
} else {
    print(lastError());
}

// The contents of setName.js:
var device = Device.searchObject(tcConst.DevSelectOne);
var ret = device.setName(arguments[1]);
if (ret == 0) print("Successfully set the phone name");
else print(lastError());

If it executes successfully, it will return:
script run id :1537301948136

Parameters:

Returns:

// Run a script with alias "TEST1"
scriptRun('TEST1', 'testScript.js');

// Get the script task execution status
var status = scriptWait("TEST1");
print(status);

// If it executes successfully, it will return:
-1

var { setScriptFileName } = require('sigma/common/scripts');
setScriptFileName("login");

setSigmaConstItemId(12345);

// Example 1: Load from absolute path
tcLoad("E:/File/JScripts/Public/fileBinaryReader.js");
tcLoad("E:/File/JScripts/Public/fileBinaryReader.class");


// Example 2: Load from user-defined path
define("scriptPath", "E:/File/JScripts/Public/");
tcLoad("fileBinaryReader.js");
tcLoad("fileBinaryReader.class");


// Example 3: Load from TCSCRIPTPATH environment variable
// If TCSCRIPTPATH is set to "E:/File/"
tcLoad("fileBinaryReader.js");
tcLoad("fileBinaryReader.class");


// Example 4: Load from default Total Control script directory (<My Documents>/Scripts)
tcLoad("fileBinaryReader.js");
tcLoad("fileBinaryReader.class");