Skip to content

Tenant Management Function: Background Server Script

Overview

This function executes "Server Script" in the background at the specified timing.

Notes

  1. Please note that depending on the processing of the background server script to be executed, it may cause a load on the entire tenant.

Limitations

  1. This function can only be set by "Privileged User".
  2. When the shared check box is checked, the Run Now button is disabled and the background server script will not be executed.

Prerequisites

  1. This function requires the BackgroundServerScript parameter in Script.json to be enabled.

Server Script Tab

Only "Privileged User" will have the Server Script tab displayed next to the General tab on the Tenant Management screen as shown below. You can set the background server script here.
Tenant management screen with the Server Script tab next to the General tab

Setting Procedure

Set up the background server script with the following procedure.

  1. Click Create New.

  2. In the displayed dialog, set the advanced settings for the background server script.
    Dialog for the advanced settings of a background server script

    Column name Description
    ID This is the ID of the background server script. The ID is automatically generated.
    Execution User Click the column and set the user who executes the script from the displayed dialog.
    Run now This button executes the background server script immediately.
    Title Set the title of the background server script.
    Name Sets the name of the background server script.
    Server Script Set the content of the background server script.
    Disable Checking the checkbox disables the background server script.
    Share Checking the checkbox loads the code set at the beginning of other background server scripts.
    Schedule Set the timing for executing the background server script. For details, see Schedule Settings below.

  3. Click Add.

  4. Click Update at the bottom of the screen.

Schedule Settings

Specify the execution timing of the target background server script. Set the schedule by the following procedure.

  1. Click Create New Schedule.

  2. In the displayed dialog, set the schedule advanced settings.
    Dialog for the schedule advanced settings of a background server script

    Column name Description
    Name Set the name of the schedule.
    Period Type Set one of Hourly / Daily / Weekly / Monthly / Once only.
    Time Zone Set the time zone that will be the basis for the schedule.
    Hourly Set the minute to execute. Can be set in 5-minute intervals.
    Daily Set the time to execute.
    Weekly Set the week and time to execute.
    Monthly Set the month, day and time to execute.
    Once only Set the start date and time to execute only once.

  3. Click Add.