Attach a script file to a file synchronized MID Server

  • Release version: Xanadu
  • Updated August 1, 2024
  • 3 minutes to read

    • You can attach a script file to synchronize to a connected MID Server.

    Before you begin

    Role required: admin
    Set-up indicator for security phaseEnsure that the MID Server can connect to elements inside and outside your networkDownload and install the MID Server on a Linux or Windows hostConfigure your MID ServerConfigure MID Server securityEnsure that the MID Server can connect to elements inside and outside your networkDownload and install the MID Server on a Linux or Windows hostConfigure your MID ServerConfigure MID Server security

    About this task

    Use file synchronization to make script files available on a connected MID Server. The files on the instance and the MID Server stay synchronized, so there is no need for the MID Server to download the whole file. File synchronization also helps prevent updates you make in those script files from being overwritten during an instance upgrade.

    You can attach multiple files, but the last attached file gets synchronized to the MID Server. If you delete the attachment, the script file becomes inactive, and the synchronized file is deleted from the MID Server.

    Procedure

    1. Navigate to All > MID Server > Script Files.
    2. Open the file to which you would like to attach the script file, or click New to create a new file.
    3. Select Use attachment, and then click the paperclip icon to add the attachment.
      When Use attachment is checked, an attached script file overrides the script contained in the Script field. If this check box is cleared, the script in the Script field is used instead of the attachment.

      The script file attachment name must match the MID Server script file name, since the record can contain other attachments.

    4. Click Update to initiate the synchronization process.
      Ensure that the file name matches the script name. If you receive the error message: File type not permitted or mime type does not match the file content, request that your administrator turn off mime type validation on attachments. The system property glide.security.file.mime_type.validation controls this setting.

    How script file synchronization works on the MID Server

    Script files attached to a record stay synchronized with a connected MID Server.

    Script files synchronized with the MID Server are stored on the instance in the MID Server Script File [ecc_agent_script_file] table, which you can access in the MID Server > Script Files module.

    When the MID Server first connects to the instance, the instance creates a directory called \scripts in the MID Server root. The instance then creates a parent directory in the path \scripts\<parent name> using definitions from the ecc_agent_script_file table. Finally, the instance creates the script files themselves inside the parent directory using the records from the ecc_agent_script_file table.

    The record for the parent directory looks like this:


    MID Server script file

    The instance creates each script file in the parent directory on the MID Server using the record Name from the ecc_agent_script_file table as the file name and the Script field payload as the file contents. A script file record looks like this:


    script file example
    The synchronization of the script file continues to work as if the script was manually added to the form.

    See Attach a script file to a file synchronized MID Server for instructions on how to attach a script file.

    Note:
    The MID Server Script File [ecc_agent_script_file] table is domain separated. You can create versions of these policies that only a MID Server from the same domain can use. For instructions, see Set up domain separation for MID servers.