Installing OpenField in a Controlled Folder Access Environment

What is Controlled Folder Access?

Controlled folder access is typically a Windows security feature that prevents apps from writing to designated directories, unless the apps are explicitly allowed/trusted.

In the context of OpenField installer, this means the installer is not able to write to the Documents folder, which it requires to do to create the Catapult Sports folder.

For OpenField Console to operate, it must read and write to the Catapult Sports folder and it must be located in the Documents directory.

Controlled Folder Access can be managed in other forms outside of Windows via other 3rd party Anti-Virus applications.

Changes were made in OpenField Console version 3.8.0 and above to support the ability to install OpenField in a Controlled Folder Access environment.

Installing OpenField in a Controlled Folder Access Environment

Listed below is a recommended workflow to install OpenField in a Controlled Folder Access environment, for both a 'Fresh Install' of OpenField, as well as for updating a 'Pre-existing' install of OpenField.

A ‘Fresh Install’ is defined as an installation of OpenField Console where the Catapult Sports folder does not yet exist in the UserDocs directory.

Typically this is a new PC/machine requiring it’s first installation of OpenField Console.

A ‘Pre-existing install’ is defined as a machine that already contains a Catapult Sports folder in the UserDocs directory.

Fresh Install

1. Run the OpenField Console installer using the required (1a) install arguments and any of the optional (1b - 1d) install arguments
   
   

   a. Add the required --userDocsArg="<Path>" argument, replacing "<Path>" with the desired path to create the Catapult Sports folder into.
   
   The defined userDocsArg directory/path will have to be a location that is not controlled/restricted by the Controlled Folder Access.
   
   b. If necessary, add the --DisableExclusion=1 installer argument to remove the Powershell execution policy bypass
   
   c. If necessary, add the --InstallDelay=1 installer argument to add a dummy file into the installation process to delay the install and allow security softwares to scan an initial installation file
   
   d. To install silently, add any of the optional /Username="<Username>", /RegionIndex=<Region#>, /Silent OR /VerySilent, and /Suppressmsgboxes install arguments, replacing <Username> and <Region#> as appropriate.
   
   Example (installer executed from a command window):
   
   "OpenField 3.8.0 Beta Build #99 - Installer Release.exe" --userDocsArg="C:\Users\Catapult\AppData\Local" /Username="jack_vector" /RegionIndex=2 /Silent /Suppressmsgboxes
   
   
   
   

2. Manually copy the Catapult Sports folder from the defined --userDocsArg path to the UserDocs directory (Documents) on the PC.
   
   

   • In the example above, the Catapult Sports folder must be manually moved from the C:\Users\Catapult\AppData\Local directory to the C:\Users\Catapult\Documents directory.
     
     

3. Add OpenField.exe, Retriever.exe, Broadcaster.exe and python.exe as allowed apps through the Controlled Folder Access and any other scanning/AntiVirus software.
   
   
   • OpenField.exe & Broadcaster.exe are located in C:\Program Files\OpenField Release
     
     
   • Retriever.exe is located in  C:\Program Files\OpenField Release\RetrieverExe
     
     
   • python.exe is located in C:\Program Files\OpenField Release\RetrieverExe\PythonExe

Pre-Existing Install

1. Run the OpenField Console installer using any of the optional arguments:
   
   a. Guarantee the installer finds the UserDocs by defining it’s path with the --userDocsArg="<Path>" argument, replacing "<Path>" with the UserDocs path where the Catpault Sports folder is present (this is usually 'Documents').
   
   b. If necessary, add the --DisableExclusion installer argument to remove the Powershell execution policy bypass
   
   
   c.  If necessary, add the --InstallDelay=1 installer argument to add a dummy file into the installation process to delay the install and allow security softwares to scan an initial installation file
   
   d. Run the installer silently using /SILENT OR /VERYSILENT, /SUPPRESSMSGBOXES, and
   --IsControlledFolderAccess=1 install arguments
   
   Example:
   "OpenField 3.8.0 Beta Build #80072 - Installer Release (1).exe" --userDocsArg="C:\Users\Catapult\Documents" --IsControlledFolderAccess=1 /Silent /Suppressmsgboxes
   
   
   

How to Use Installer Arguments

• Running the Installer from a command window or PowerShell window, and appending the desired arguments in the command line
  
  
  
  
• Creating a shortcut of the Installer.exe and appending the desired arguments to the end of the Target in the Shortcut properties, then running the shortcut.
  

Installer Argument Definition and Syntax

• --userDocsArg="<Path>" argument
  • This argument is used to define the location where the installer will look for the Catapult Sports folder to read from, else create it if it does not exist
  • Syntax:
    Fresh Install: Replace <Path>with the path you wish to create the Catapult Sports folder
    Pre-existing Install: Replace <Path>with the UserDocs directory (Documents) where the Catapult Sports folder already exists
    
    
  • Examples:
    Fresh Install: --userDocsArg="C:\Users\Catapult\AppData\Local"
    Pre-existing Install: --userDocsArg="C:\Users\Catapult\Documents"
    
    
• /Username="<Username>" argument
  • This argument is used to pre-fill the Username field of the installer. This is most useful for a Fresh Install where this field typically needed to be entered manually.
    
  • Syntax: 
    Replace <Username> with the OpenField Account Username to be installed
    
    
  • Example:
    /Username="jack_vector"
    
    
• /RegionIndex=<Region#> argument
  • This argument is used to pre-fill the Region dropdown of the installer. This is most useful for a Fresh Install where this dropdown typically needed to be entered manually.
    
    
    
  • Syntax: 
    Replace <Region#> with the associated Region number of the Region OpenField Account to be installed:
    Region #:
    North America = 0 Europe = 1 Australasia = 2  China = 3
    
    
  • Example:
    Australasia Region: /RegionIndex=2

• --DisableExclusion=1argument
  • This argument is used to disable the Powershell execution policy bypass that is performed by default by the Installer, to execute the extracted Installer.exe from a temporary AppData path.
    
    
  • Syntax:
    Use --DisableExclusion=1to disable the Powershell execution policy bypass. By default the bypass will occur or if --DisableExclusion=0
    
    
    
• --InstallDelayargument
  • This argument is used to install OpenField Console with a dummy file 'Adummyfile.txt' as the first file to be installed. This is used to delay the OpenField installation process and allow security/threat protection software to scan an initial file prior to remaining files being installed.
    
    
  • Syntax:
    Use --InstallDelay=1to install OpenField with a dummy file. By default no dummy file will be installed or if --InstallDelay=0
    
    
• /SILENT,/VERYSILENT, /SUPPRESSMSGBOXESarguments
  • These arguments are used to run the installer silently
    
    

    /SILENT	Runs the installer in silent mode (The progress window is displayed)
    /VERYSILENT	Very silent mode. No windows are displayed.
    /SUPPRESSMSGBOXES	Suppress message boxes. Only has an effect when combined with ‘/SILENT’ and ‘/VERYSILENT’.

• --IsControlledFolderAccess=1 argument
  • This argument is used for Pre-existing installs to assist with a silent installation.
    It is used in combination with the /SILENT,/VERYSILENT, /SUPPRESSMSGBOXESarguments to help suppress some attempted write functions (which are blocked) of the installer that are not necessary for a Controlled Folder Access environment