Directory Structure

Important Directories

This reference document details the main directory structures of the extracted BAL-MCS-ClientServer-<version>-distribution.zip file.

Ensure that MCS is installed correctly.

If you haven’t done so, execute the relevant runMCS_Display and runMCS_Server scripts (located in the GNDSW/MCS_Display and GNDSW/MCS_Server directories, respectively) to generate several directories.

Refer to the MCS Getting Started Guide for further information about installing MCS.

The GNDSW Directory

The GNDSW is the root directory and contains the files for the MCS Display and Server. It contains the following subdirectories:

GNDSW Directory Structure
Directory Explanation

Documentation

Contains the MCS documentation.

Groovy

Contains API documentation for Groovy scripting.

MCS_Display

Contains the files for the MCS client.

MCS_Server

Contains the files for the MCS server.

python

API documentation, source code, example scripts for Python.

The MCS_Display Directory

The MCS_Display directory contains files for the MCS client.

MCS_Display Directory Structure
Directory Explanation

configs

Contains the display.properties file used to configure the MCS client

Refer to the MCS Configurable Options reference document for further information about MCS client configurations.

data

Contains the MCS client logs

layouts

Contains the saved MCS layouts

mod

Required .JAR files for the MCS client

The MCS_Server Directory

The MCS_Server directory contains the files for the MCS server.

MCS_Server Directory Structure
Directory Explanation

configs

Contains the calibration, security associations, check, and configuration files.

Refer to the MCS Configurable Options reference document for further information about MCS server file configurations.

data

Contains the MCS server logs

ground_schedule_watch

The default directory location where the MCS server will poll (if configured) for new Ground Schedule Groovy scripts. Accepted updates are placed in a digested subdirectory. Rejected updates are placed in a rejected subdirectory.

Refer to the External Ground Schedule Polling section of the MCS User Manual for further information about ground schedule polling.

incoming_procedures

A polling directory used to check for new procedures

licence

Contains the MCS server licence and additional licencing files.

mod

Required .JAR files for the MCS server

scripts

Internal Groovy scripts directory including examples

Important Files

This is the possible file structure for the MCS client and server.

Some files may not be present in the directory structure until their respective services are started.

Important MCS_Display Files

Refer to the MCS client directory structure below:

MCS_Display File Structure
File Default Location Explanation

display.properties

MCS_Display/configs

Stores the current state of the MCS client. Updated on shutdown and reloaded at startup. Can be used to configure the MCS client.

system.csv

MCS_Display/data/archive

Logs originating from the MCS client rather than the onboard flight software (OBSW). These could be anything from connection failures to reports on how the ground schedule is being executed. If the behaviour of MCS is amiss, the first place to look would be the system logs.

event.csv

MCS_Display/data/archive

Logged Events generated by OBSW Components. Contains OBSW Component and source references.

debug.csv

MCS_Display/data/archive

These logs show debug information specific to the OBSW. These logs should show data at a higher level of detail than event logs.Contains OBSW Component and source references. If something is going wrong with the OBSW, you should examine the debug logs to determine the cause of the problem.

*.layout

MCS_Display/layouts

MCS client layout definition files (in XML format). Layouts can be imported and exported from an MCS configuration file to avoid you having to edit them in-place.

Important MCS_Server Files

Refer to the MCS server directory structure below:

MCS_Server File Structure
File Default Location Explanation

mcs.properties

MCS_Server/configs

Can be used to configure the MCS server.

Refer to the MCS Configurable Options reference document for further information about MCS server configurations.

system_<timestamp>.CSV

MCS_Server/data/archive

System log messages: should include WARN or ERROR messages for any problems detected by the MCS server at runtime.

event_<timestamp>.CSV

MCS_Server/data/archive

Event messages received from the OBSW.

debug_<timetsamp>.CSV

MCS_Server/data/archive

Debug messages received from the OBSW.

cfdp_filestore/

MCS_Server

Directory containing files downloaded using CFDP, arranged in <asset>/<target> directories.

cfdp_parts/

MCS_Server/data

Incomplete CFDP files generated during transfers.

ldt_parts/

MCS_Server/data

Incomplete LDT files generated during transfers.

*.groovy

MCS_Server/scripts

Example MCS files used for internal scripting.

hkLogs/

MCS_Server

Default location for CSV Archive files if CSV Logging is enabled (e.g. via Archiver Management view in MCS Display). This location can be overridden by a csvLogging_directory setting in the mcs.properties file. Sent and received Packets and received Beacon contents (Aggregation values) are saved in this location, if CSV logging is enabled.

active_activities/

MCS_Server/data

Contains json files with information on currently running Activities - for example, incomplete CFDP transfers.

licence.properties

MCS_Server/licence

The Nalpeiron licence file

Nalpeiron licencing is only available in MCS >V22.2.

Must contain a licenceCode key or the value netseat when using a local licence server. Other values can be left with their default values.

BAL_MCS_Licence.licence

MCS_Server/licence

A legacy licence file used in MCS <V22.2.

.cache, *.lic, *.log, *.sinfo

MCS_Server/licence

Various files populated by Nalperion when a licence is used. Provide these files to Bright Ascension customer support if you encounter errors in the MCS terminal output.