Example: Create environment files to capture extDB changes

Log in to Bravura Security Fabric Front-end (PSF) as superuser .

Click Manage External Data Store.

Navigate to the table in question. This might take some guess work until you find the table and rule responsible for the configuration you're trying to alter. For this example, since email settings need to be altered, it’s a good guess to check the hid_policy_wfemail table.

Identify the row you want to override, and note the value of its ComponentOwnerFQN field. For this example, the first rule in this table, where EventID = _DEFAULT_POLICY , shows SendSMTP and WriteFile columns set to True . Scrolling over to the ComponentOwnerFQN field shows it is configured by the Functional.hid_policy_wfemail component. This means the override needs to be applied to the Functional.hid_policy_wfemail component.

Navigate to the \<instance>\component\default\functional\hid_policy_wfemail directory.

Open and inspect manifest.xml for configdata entries.

From the entries, we find the configdata entry shows:

<configdata component="Functional.hid_policy_wfemail.model.PolicyWFEmail">
	<filename>data\events.csv</filename>
</configdata>

From the placement within configdata entries, it is shown that the file providing configuration information is \data\ events.csv . This information is now used to start building a structure for the dev environment file.

Navigate to your \<instance> directory.

If an \<instance>\environments folder does not currently exist in the instance directory, create one.

Inside the \environments directory, open an appropriate application (like Notepad++ ) to create a new file called xyz-dev.json.

This will act as the dev environment file. If this file exists already, you only need to add to it.

Edit the xyz-dev.json file and add the three keys to indicate the component directories by entering the following:

{
	"Scenario": {},
	"Functional": {},
	"Data": {}
}

Now that there is a basic skeleton, it is known that the component of interest is in the \Functional directory, so the override is added under the " Functional " key so the file now looks like:

{
	"Scenario": {},
	"Functional": {
		"hid_policy_wfemail": {}
	},
	"Data": {}
}

The file being overridden from the component now needs to be specified. It was determined above to be \data\ events.csv, so that is added next.

{
	"Scenario": {},
	"Functional": {
		"hid_policy_wfemail": {
			"data\\events.csv": {}
		}
	},
	"Data": {}
}

Writing overrides for .csv files is similar to how overrides are written for .json files, but for .csv files the specific rows being altered need to be identified in the environment file. For this example, the row in the events.csv file where EventID = _DEFAULT_POLICY is being overridden, so the number of this row needs to be recorded in the environment file.

To find the number of the row, open the \<instance>\component\Default\Functional\hid_policy_wfemail\data\ events.csv file and see which line EventID = _DEFAULT_POLICY .

Viewing the file shows the line with EventID = _DEFAULT_POLICY happens to be the first item in the .csv . To specify the row in the environment file, its index (zero-indexed) needs to be added followed by the fields you want to override for that row. Since EventID = _DEFAULT_POLICY is the first row in the .csv , it has an index of ’0’. The xyz-dev.json environment file then looks like:

{
	"Scenario": {},
	"Functional": {
  	"hid_policy_wfemail": {
			"data\\events.csv": {
				"[0]": {
				}
			}
		}
	},
	"Data": {}
}

The Functional.hid_policy_wfemail component by default configures both SendSMTP and WriteFile values to be set to True . Since the development environment is supposed to send emails to file only, the override required is setting the SendSMTP field to FALSE . The environment file override entry in xyz-dev.json then becomes:

{
	"Scenario": {},
	"Functional": {
		"hid_policy_wfemail": {
			"data\\events.csv": {
				"[0]": {
					"SendSMTP": "FALSE"
				}
			}
		}
	},
	"Data": {}
}

With this change, when the xyz-dev.json environment is loaded before installing the Functional.hid_policy_wfemail component, the first row of the hid_policy_wfemail policy table is configured with SendSMTP = FALSE . Thus, overriding the default value of SendSMTP = TRUE from the events.csv file.

Navigate to your \<instance> directory.

If an \<instance>\environments folder does not currently exist in the instance directory, create one.

Inside the \environments directory, open an appropriate application (like Notepad++ ) to create a new file called xyz-prod.json.

This will act as our prod environment file. If this file exists already, you only need to add to it.

Navigate to the \<instance> directory and create the \ environments directory.

Copy your xyz-dev.json file into that directory.

Launch a command prompt as an Administrator and navigate to the \<instance> directory.

Run the command:

instance.bat

Navigate to the \<instance>\script directory.

Load the environment file by running the commands:

manage_components.py load 
manage_components.py env load xyz-dev

While still in the \<instance>\script directory, list the components by running the command (note: the component is case sensitive):

Manage_components.py install Functional.hid_policy_wfemail

You know the command has run successfully if the command prompt shows the built and installed skins.

Additionally, you can check the hid_policy_wfemail ExtDB table entries:

Verify that the SendSMTP value has been configured as FALSE by checking the value in the hid_policy_wfemail EXTdb table:

1. Log in to Bravura Security Fabric as superuser .

2. Click Manage External Data Store.

3. Navigate to the hid_policy_wfemail table.

4. Review the first rule in the table where EventID = _DEFAULT_POLICY and ensure that the value for SendSMTP = FALSE.