Add Foreign Keys

Search Knowledge Base by Keyword

< Back

The ADDKEYS action adds Foreign Key constraints to the Staging Environment. It adds Foreign Key Constraints where:

  1. The Foreign Key is set to “Active” in the ForeignKeys sheet.
  2. The relevant Foreign Key table and Primary key table is set to “Active” in the Tables Sheet.

Note: constraints are not created for SoftKeys.

Note: ADDFKEYS can only be performed after ADDPKEYS has been performed.

The ADDFKEYS Action adds Foreign Key Constraints to the Staging Database.

These Foreign Key Constraints are specified in the ForeignKeys sheet that is populated by the GETKEYS action when preparing to run a SUBSET.

If you have run SUBSET and are happy with the results, you can then add your Foreign Keys using the ADDFFEYS Action.

This adds the Foreign Keys that are set to “Active” in the ForeignKeys sheet of the Control Spreadsheet.. Instructions for editing the ForeignKeys sheet are available here.

To run ADDFKEYS, open The VIP Server Controller from your desktop or start menu. You must open it as an administrator. If The VIP Server Controller is already running, make sure the relevant .vip workflows are Put in Memory. See this article for instructions.

Next, complete the mandatory parameters in the “Run Flow” tab. If working from a Config file created for the current Subset, you should only need to update the parAction argument and enter any additional optional parameters. You will need to update the location of the Subset Report and SQLActionsPath if these have changed. See this article for instructions on working with a Config file.

Specify “ADDFKEYS” for parACTION:

parAction=ADDFKEYS

Complete any optional parameters. See this Knowledge Base article for a full list of Arguments and example parameters.

Once you have parameterized the ADDFKEYS Action, make sure your Configuration Spreadsheet, Subset Report and Log file are all shut. Next, click “Create File” and then click “Start” to run the action.

In the output dialogue, you will see “Flow execution completed on remote server. Please check logs for details.” once the ADDFKEYS Action is complete”:

If you receive an error message in your output dialogue or log, please refer to this article to troubleshoot common issues. You can also run your Action on debug mode for a more detailed log. You can also check the Log File and Subset Report at this stage, to check that the Actions have performed correctly.

Next, check your Database to make sure the Foreign Keys constraints have been added.

If the Foreign Keys are incorrect, you can perform the DROFPKEYS Action to remove them and add a new set.

Note: You can only add Foreign Keys that are not already present in the target database. Otherwise the action will fail. If you need to first remove certain Foreign Keys, you can use the DROPFKEYS action or the composite DROPKEYS action.

Run ADDFKEYS from the Command Line

To run ADDFKEYS from the Command Line, first open your re-usable .cmd script in a text editor.

If you have already configured a .cmd script for one Subset Action and wish to edit and re-use that script, you should only need to set “ADDFKEYS” for “Action”.

Otherwise, configure all mandatory parameters in the .cmd script.

You can also specify optional parameters at this stage.

Make sure your Control Spreadsheet, the Subset Report, and any Log Files are closed.

Run the script to add the Foreign Keys.

Check the Log File and Subset Report at this stage, to check that the Actions have performed correctly.

Next, check your Database to make sure the Foreign Keys constraints have been added.

If the Foreign Keys are incorrect, you can perform the DROPFKEYS Action to remove them and add a new set.

Note: You can only add Foreign Keys that are not already present in the target database. Otherwise the action will fail. If you need to first remove certain Foreign Keys, you can use the DROPFKEYS action or the composite DROPKEYS action.