/// <summary>
/// Commit the changes to memory, save the configuration settings to disk and create a backup.
/// </summary>
/// <param name="sender"></param>
/// <param name="e"></param>
private void SaveConfigurationFileToolStripMenuItem_Click(object sender, EventArgs e)
{
#region root path file
// Update the paths in memory
GlobalParameters.OutputPath = textBoxOutputPath.Text;
GlobalParameters.ConfigurationPath = textBoxConfigurationPath.Text;
var localEnvironment = (KeyValuePair <TeamWorkingEnvironment, string>)comboBoxEnvironments.SelectedItem;
GlobalParameters.WorkingEnvironment = localEnvironment.Key.environmentKey;
GlobalParameters.WorkingEnvironmentInternalId = localEnvironment.Key.environmentInternalId;
// Save the paths from memory to disk.
UpdateRootPathFile();
#endregion
// Make sure the new paths as updated are available upon save for backup etc.
// Check if the paths and files are available, just to be sure.
FileHandling.InitialisePath(GlobalParameters.ConfigurationPath);
FileHandling.InitialisePath(GlobalParameters.OutputPath);
TeamConfiguration.CreateDummyEnvironmentConfigurationFile(GlobalParameters.ConfigurationPath + GlobalParameters.ConfigFileName + '_' + GlobalParameters.WorkingEnvironment + GlobalParameters.FileExtension);
ValidationSetting.CreateDummyValidationFile(GlobalParameters.ConfigurationPath + GlobalParameters.ValidationFileName + '_' + GlobalParameters.WorkingEnvironment + GlobalParameters.FileExtension);
JsonExportSetting.CreateDummyJsonConfigurationFile(GlobalParameters.ConfigurationPath + GlobalParameters.JsonExportConfigurationFileName + '_' + GlobalParameters.WorkingEnvironment + GlobalParameters.FileExtension);
// Create a file backup for the configuration file
try
{
TeamUtility.CreateFileBackup(GlobalParameters.ConfigurationPath + GlobalParameters.ConfigFileName + '_' + GlobalParameters.WorkingEnvironment + GlobalParameters.FileExtension);
richTextBoxInformation.Text = "A backup of the current configuration was made at " + DateTime.Now + " in " + textBoxConfigurationPath.Text + ".\r\n";
}
catch (Exception)
{
richTextBoxInformation.Text = "TEAM was unable to create a backup of the configuration file.";
}
// Update the in-memory variables for use throughout the application, to commit the saved changes for runtime use.
// This is needed before saving to disk, as the EnvironmentConfiguration Class retrieves the values from memory.
UpdateConfigurationInMemory();
// Save the information
LocalTeamEnvironmentConfiguration.SaveConfigurationFile();
parentFormMain.RevalidateFlag = true;
}
/// <summary>
/// This method will load an existing configuration file and display the values on the form, or create a new dummy one if not available.
/// </summary>
/// <param name="chosenFile"></param>
private void LocalInitialiseConnections(string chosenFile)
{
// If the config file does not exist yet, create it by calling the EnvironmentConfiguration Class.
if (!File.Exists(chosenFile))
{
TeamConfiguration.CreateDummyEnvironmentConfigurationFile(chosenFile);
}
// Open the configuration file
var configList = new Dictionary <string, string>();
var fs = new FileStream(chosenFile, FileMode.Open, FileAccess.Read);
var sr = new StreamReader(fs);
try
{
string textline;
while ((textline = sr.ReadLine()) != null)
{
if (textline.IndexOf(@"/*", StringComparison.Ordinal) == -1 && textline.Trim() != "")
{
var line = textline.Split('|');
configList.Add(line[0], line[1]);
}
}
sr.Close();
fs.Close();
// Databases
if (configList["MetadataConnectionId"] != null)
{
var metadataKey = TeamConfiguration.ConnectionDictionary[configList["MetadataConnectionId"]];
comboBoxMetadataConnection.SelectedIndex = comboBoxMetadataConnection.FindStringExact(metadataKey.ConnectionKey);
}
Enum.TryParse(configList["EnvironmentMode"], out EnvironmentModes environmentMode);
if (environmentMode == EnvironmentModes.PhysicalMode)
{
radioButtonPhysicalMode.Checked = true;
}
if (environmentMode == EnvironmentModes.VirtualMode)
{
radioButtonVirtualMode.Checked = true;
}
//DWH settings
textBoxHubTablePrefix.Text = configList["HubTablePrefix"];
textBoxSatPrefix.Text = configList["SatTablePrefix"];
textBoxLinkTablePrefix.Text = configList["LinkTablePrefix"];
textBoxLinkSatPrefix.Text = configList["LinkSatTablePrefix"];
textBoxDWHKeyIdentifier.Text = configList["KeyIdentifier"];
textBoxEventDateTime.Text = configList["EventDateTimeStamp"];
textBoxLDST.Text = configList["LoadDateTimeStamp"];
textBoxExpiryDateTimeName.Text = configList["ExpiryDateTimeStamp"];
textBoxChangeDataCaptureIndicator.Text = configList["ChangeDataIndicator"];
textBoxRecordSource.Text = configList["RecordSourceAttribute"];
textBoxETLProcessID.Text = configList["ETLProcessID"];
textBoxETLUpdateProcessID.Text = configList["ETLUpdateProcessID"];
textBoxStagingAreaPrefix.Text = configList["StagingAreaPrefix"];
textBoxPSAPrefix.Text = configList["PersistentStagingAreaPrefix"];
textBoxPresentationLayerLabels.Text = configList["PresentationLayerLabels"];
textBoxTransformationLabels.Text = configList["TransformationLabels"];
textBoxSourceRowId.Text = configList["RowID"];
textBoxRecordChecksum.Text = configList["RecordChecksum"];
textBoxCurrentRecordAttributeName.Text = configList["CurrentRecordAttribute"];
textBoxAlternativeRecordSource.Text = configList["AlternativeRecordSource"];
textBoxHubAlternativeLDTSAttribute.Text = configList["AlternativeHubLDTS"];
textBoxSatelliteAlternativeLDTSAttribute.Text = configList["AlternativeSatelliteLDTS"];
textBoxLogicalDeleteAttributeName.Text = configList["LogicalDeleteAttribute"];
//Checkbox setting based on loaded configuration
CheckBox myConfigurationCheckBox;
if (configList["AlternativeRecordSourceFunction"] == "False")
{
myConfigurationCheckBox = checkBoxAlternativeRecordSource;
myConfigurationCheckBox.Checked = false;
textBoxAlternativeRecordSource.Enabled = false;
}
else
{
myConfigurationCheckBox = checkBoxAlternativeRecordSource;
myConfigurationCheckBox.Checked = true;
}
if (configList["AlternativeHubLDTSFunction"] == "False")
{
myConfigurationCheckBox = checkBoxAlternativeHubLDTS;
myConfigurationCheckBox.Checked = false;
textBoxHubAlternativeLDTSAttribute.Enabled = false;
}
else
{
myConfigurationCheckBox = checkBoxAlternativeHubLDTS;
myConfigurationCheckBox.Checked = true;
}
if (configList["AlternativeSatelliteLDTSFunction"] == "False")
{
myConfigurationCheckBox = checkBoxAlternativeSatLDTS;
myConfigurationCheckBox.Checked = false;
textBoxSatelliteAlternativeLDTSAttribute.Enabled = false;
}
else
{
myConfigurationCheckBox = checkBoxAlternativeSatLDTS;
myConfigurationCheckBox.Checked = true;
}
//Radiobutton setting for prefix / suffix
RadioButton myTableRadioButton;
if (configList["TableNamingLocation"] == "Prefix")
{
myTableRadioButton = tablePrefixRadiobutton;
myTableRadioButton.Checked = true;
}
else
{
myTableRadioButton = tableSuffixRadiobutton;
myTableRadioButton.Checked = true;
}
//Radiobutton settings for on key location
RadioButton myKeyRadioButton;
if (configList["KeyNamingLocation"] == "Prefix")
{
myKeyRadioButton = keyPrefixRadiobutton;
myKeyRadioButton.Checked = true;
}
else
{
myKeyRadioButton = keySuffixRadiobutton;
myKeyRadioButton.Checked = true;
}
//Radiobutton settings for PSA Natural Key determination
RadioButton myPsaBusinessKeyLocation;
if (configList["PSAKeyLocation"] == "PrimaryKey")
{
myPsaBusinessKeyLocation = radioButtonPSABusinessKeyPK;
myPsaBusinessKeyLocation.Checked = true;
}
else
{
myPsaBusinessKeyLocation = radioButtonPSABusinessKeyIndex;
myPsaBusinessKeyLocation.Checked = true;
}
// Also commit the values to memory
UpdateConfigurationInMemory();
richTextBoxInformation.AppendText(@"The file " + chosenFile + " was uploaded successfully.\r\n");
}
catch (Exception ex)
{
richTextBoxInformation.AppendText("\r\n\r\nAn error occurred while loading the configuration file. The original error is: '" + ex.Message + "'");
}
}
public FormMain()
{
InitializeComponent();
// Set the version of the build for everything
const string versionNumberForTeamApplication = "v1.6.3";
Text = "TEAM - Taxonomy for ETL Automation Metadata " + versionNumberForTeamApplication;
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Information, $"The TEAM root path is {GlobalParameters.RootPath}."));
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Information, $"The TEAM script path is {GlobalParameters.ScriptPath}."));
richTextBoxInformation.AppendText("Initialising the application.\r\n\r\n");
// Root paths (mandatory TEAM directories)
// Make sure the application and custom location directories exist as per the start-up default.
try
{
LocalTeamEnvironmentConfiguration.InitialiseEnvironmentPaths();
}
catch (Exception ex)
{
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Error, $"An error was encountered while creating the standard TEAM paths: \r\n\r\n{ex}"));
}
#region Load the root path configuration settings (user defined paths and working environment)
// Load the root file, to be able to locate the (customisable) configuration file.
// This file contains the configuration directory, the output directory and the working environment.
string rootPathFileName = GlobalParameters.CorePath + GlobalParameters.PathFileName + GlobalParameters.FileExtension;
try
{
LocalTeamEnvironmentConfiguration.LoadRootPathFile(rootPathFileName, GlobalParameters.ConfigurationPath, GlobalParameters.OutputPath);
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Information,
$"The core configuration file {rootPathFileName} has been loaded."));
}
catch
{
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Error,
$"The core configuration file {rootPathFileName} could not be loaded. Is there a Configuration directory in the TEAM installation location?"));
}
// Environments file
string environmentFile = GlobalParameters.CorePath + GlobalParameters.JsonEnvironmentFileName + GlobalParameters.JsonExtension;
try
{
TeamEnvironmentCollection.LoadTeamEnvironmentCollection(environmentFile);
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Information,
$"The environment file {environmentFile} has been loaded."));
}
catch
{
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Error,
$"The environment file {environmentFile} could not be loaded. Does the file exists in the designated (root) location?"));
}
#endregion
#region Check if user configured paths exists (now that they have been loaded from the root file), and create dummy Configuration and Validation files if necessary
// Configuration Path
try
{
FileHandling.InitialisePath(GlobalParameters.ConfigurationPath);
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Information, $"The user defined configuration path {GlobalParameters.ConfigurationPath} is available."));
}
catch
{
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Error, "The directories required to operate TEAM are not available and can not be created. Do you have administrative privileges in the installation directory to create these additional directories?"));
}
// Output Path
try
{
FileHandling.InitialisePath(GlobalParameters.OutputPath);
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Information, $"The user defined output path {GlobalParameters.OutputPath} is available."));
}
catch
{
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Error, "The directories required to operate TEAM are not available and can not be created. Do you have administrative privileges in the installation directory to create these additional directories?"));
}
// Create a dummy configuration file if it does not exist.
var configurationFileName =
GlobalParameters.ConfigurationPath +
GlobalParameters.ConfigFileName + '_' +
GlobalParameters.WorkingEnvironment +
GlobalParameters.FileExtension;
try
{
if (!File.Exists(configurationFileName))
{
TeamConfiguration.CreateDummyEnvironmentConfigurationFile(configurationFileName);
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Information, $"A new configuration file {configurationFileName} was created."));
}
else
{
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Information, $"The existing configuration file {configurationFileName} was detected."));
}
}
catch
{
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Error, $"An issue was encountered creating or detecting the configuration paths for {configurationFileName}."));
}
// Create a default validation file if the file does not exist as expected.
var validationFileName =
GlobalParameters.ConfigurationPath +
GlobalParameters.ValidationFileName + '_' +
GlobalParameters.WorkingEnvironment +
GlobalParameters.FileExtension;
try
{
ValidationSetting.CreateDummyValidationFile(validationFileName);
}
catch
{
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Error, $"An issue was encountered creating or detecting the configuration paths for {validationFileName}."));
}
// Create a default json configuration file if the file does not exist as expected.
var jsonConfigurationFileName =
GlobalParameters.ConfigurationPath +
GlobalParameters.JsonExportConfigurationFileName + '_' +
GlobalParameters.WorkingEnvironment +
GlobalParameters.FileExtension;
try
{
JsonExportSetting.CreateDummyJsonConfigurationFile(jsonConfigurationFileName);
}
catch
{
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Error, $"An issue was encountered creating or detecting the configuration paths for {jsonConfigurationFileName}."));
}
#endregion
// Load the connections file for the respective environment.
var connectionFileName =
GlobalParameters.ConfigurationPath +
GlobalParameters.JsonConnectionFileName + '_' +
GlobalParameters.WorkingEnvironment +
GlobalParameters.JsonExtension;
TeamConfiguration.ConnectionDictionary = TeamConnectionFile.LoadConnectionFile(connectionFileName);
#region Load configuration file
// Load the available configuration file into memory.
var configurationFile = GlobalParameters.ConfigurationPath + GlobalParameters.ConfigFileName + '_' + GlobalParameters.WorkingEnvironment + GlobalParameters.FileExtension;
try
{
// Load the configuration file.
TeamConfiguration.LoadTeamConfigurationFile(configurationFile);
GlobalParameters.EnvironmentMode = TeamConfiguration.EnvironmentMode;
// Retrieve the events into the main event log.
GlobalParameters.TeamEventLog.MergeEventLog(TeamConfiguration.ConfigurationSettingsEventLog);
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Information, $"The user configuration settings ({configurationFile}) have been loaded."));
}
catch
{
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Error, $"An issue was encountered loading the user configuration file ({configurationFile})."));
}
#endregion
//FormBase.EnvironmentVersion.GetEnvironmentVersionsFromFile(Path.GetDirectoryName(configurationFile));
TeamVersionList.LoadVersionList(GlobalParameters.CorePath + GlobalParameters.VersionFileName + GlobalParameters.JsonExtension);
// Load the pattern definition file.
try
{
GlobalParameters.PatternDefinitionList = LoadPatternDefinition.DeserializeLoadPatternDefinition(GlobalParameters.LoadPatternPath + GlobalParameters.LoadPatternDefinitionFile);
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Information, "The pattern definition file was loaded successfully."));
}
catch
{
GlobalParameters.TeamEventLog.Add(Event.CreateNewEvent(EventTypes.Error, "An issue was encountered loading the pattern definition file."));
}
// Report the events (including errors) back to the user
int errorCounter = 0;
foreach (Event individualEvent in GlobalParameters.TeamEventLog)
{
if (individualEvent.eventCode == (int)EventTypes.Error)
{
errorCounter++;
}
}
if (errorCounter > 0)
{
richTextBoxInformation.AppendText(
$"{errorCounter} error(s) have been found at startup. Please check the Event Log in the menu.\r\n\r\n");
}
TestConnections();
//Startup information
richTextBoxInformation.AppendText("\r\nApplication initialised - the Taxonomy of ETL Automation Metadata (TEAM). \r\n");
richTextBoxInformation.AppendText("Welcome to version " + versionNumberForTeamApplication + ".\r\n\r\n");
labelWorkingEnvironment.Text = GlobalParameters.WorkingEnvironment; //+"("+GlobalParameters.WorkingEnvironmentInternalId+")";
labelEnvironmentMode.Text = GlobalParameters.EnvironmentMode.ToString();
}