Sample BackupRestore.ini
Use the BackupRestore.ini to specify default and custom settings that appear in the Backup and Restore Wizard, and when you run BackupRestore.exe from a command line. The BackupRestore.ini file is located in the iFIX LOCAL folder. If you installed iFIX to the default location, you can find the BackupRestore.ini in the C:\Program Files (x86)\Proficy\iFIX\LOCAL folder.
The BackupRestore.ini file can contain information in the following sections:
- [Version] – used to determine iFIX product version in archive header signature. This section is required. Do not change this value.
- [DefaultSubProject] – used to determine default sub-project paths for the Create New Project option in the Restore operation.
- [FactoryDefaultExtension] – used to determine which files are included in Factory Default settings.
- [WizardSettings] – used to determine file name and path (if it is different than your iFIX base path) of the Factory Default file when you select the "Restore default iFIX files before restoring your backup files" option during a Restore operation.
- [AddCustomExtension] – used if you want to include or exclude any additional files or file types in your custom backup. By default, the AddExtension feature is set to False. Set AddExtension to True to enable this feature. Each category has keys to include (xxxIncludeExtn=) and exclude (xxxxExcludeExtn=) files. The xxxxExcludeExtn key is used to exclude files from xxxxIncludeExtn key, not to exclude a default extension.
The entire key can be up to 2048 characters long, in total. If you exceed this length, for instance if the path is too long, an error message appears and the custom file or file extension is ignored when you attempt the backup.
IMPORTANT: Make sure that you do not include the same file or file extension (from the same location) in more than one category. If you back up the same file or file type in more than one category, you will experience issues restoring your files. Configure your custom settings carefully.
By default, TakeExtension is false. Set TakeExtension to True and execute a backup from the command line, specifying this INI file in order to backup only the specified files and/or extensions and to ignore the default extension list, which you can see in the UI. This can be used only when the user wants to backup specific files.
By default, the Backup and Restore application references the BackupRestore.ini file when it runs. If you want to change the name of the .INI file, you must run BackupRestore.exe with the /i command line option, and specify the file name of the custom .INI file. If you create a custom .INI file, it must follow the same format described above.
The following is an example of the BackupRestore.ini from the iFIX LOCAL folder that includes all four of the sections defined above:
;BackupRestore.ini - Customizing your BackupRestore.ini file
;
;[Version]
; Do not change the Version key.
; If you create your own .ini file using the /I option, this section and key are required.
;
;[DefaultSubProject]
; 1. If you select the "Create New Project" destination option,
; define the sub-project folders here.
; 2. If you use the /P option during backup, the sub-project folders defined here are archived.
; 3. If you use the /P option during restore, the archive files are restored to the sub-project
; folders defined here.
;
;[FactoryDefaultExtension]
; If you generate your own FactoryDefault file, use this section to define which files to
; include in your FactoryDefault backup.
;
;[WizardSettings]
; Use the FACTORYDEFAULT key in your FactoryDefault file when select the "Restore default
; iFIX files before restoring your backup files" option during a restore.
;
; The FACTORYDEFAULT_PATH key is used for your FactoryDefault file path. If this section is blank,
; your current BASEPATH is used.
; For example: FACTORYDEFAULT_PATH=C:\MySetting (do not add "\" at the end)
;
;[AddCustomExtension]
; If you like to add file type to custom backup, it allows you to define
; additional extension for each categories to include/exclude files to backup.
; To make it enabled, change AddExtension to True.
; AddExtension=TRUE
; Then, add file name or file type for specific key in categories. For example:
; [AddCustomExtension]
; AddExtension=TRUE
; PicIncludeExtn=*.bmp,*.jpg
; PicExcludeExtn=aaaa.bmp
;
; If you like to define specific file or file type to custom backup, it allows you to define
; extensions or actual file name for each categories. Default extension lists will be ignored.
; For example:
; [AddCustomExtension]
; TakeExtension=TRUE
; Database files (*.PDB,*.AAD), PDBPATH
; PDBIncludeExtn=TEST.PDB,AlarmAreas.AAD
; PDBExcludeExtn=
[Version]
Version=6.80
[DefaultSubProject]
LOCPATH=LOCAL
PDBPATH=PDB
NLSPATH=NLS
PICPATH=PIC
APPPATH=APP
HTCPATH=HTR
HTDPATH=HTRDATA
HTRDATA=HTRDATA
ALMPATH=ALM
RCMPATH=RCM
RCCPATH=RCC
AADPPATH=PDB
AADBPATH=PDB
ADDONPATH=ADDON
CFGPATH=CFG
[FactoryDefaultExtension]
ALM_EXTN=*.*
APP_EXTN=*.grf,*.tbx,sqlerr.txt
HTR_EXTN=*.csv
HTRDATA_EXTN=*.*
LOCAL_EXTN=*.json,CONFIGDB\*.json,UA\*.*,iFIX_OpcuaConfigService\*.pfx,OpcUaDefinitions.csv,Serverconfig.xml,Association.dat,RibbonAssociation.dat,default.fmt,FindReplace.csv,SystemTree.csv,default.qry,default.rft,default.srt,logmsg.tov,StandardCategories.txt,*.tbc,*.tbx,*.xbt,*.ico,*.bmp,*.ini,ImportToolbars.txt,autoStartKey.dat
PDB_EXTN=CGW.csv,Default.SM2,empty.pdb,*.tbl,iFixUaClient\*.json,*.json
PIC_EXTN=WizLayouts.tpl,*.fds,*.ftb,*.fxg,*.grf,*.SBL,*.BDF,*.odt,*.SVA,*.VGA,*.kmx,*.CSV,TS.ini
RCC_EXTN=*.*
RCM_EXTN=*.*
ADDON_EXTN=*.ini,*.tbc
CFG_EXTN=*.json,*.pfx
[WizardSettings]
FACTORYDEFAULT=FactoryDefault.IFD
FACTORYDEFAULT_PATH=
;
; CUstom extension
;
[AddCustomExtension]
AddExtension=FALSE
TakeExtension=FALSE
;
;Configuration files (*.SCU,*.INI,*.CFG), LOCPATH
SCUIncludeExtn=
SCUExcludeExtn=
;
;Picture files (*.GRF,*.FDS,*.FTB,*.LST), PICPATH
PicIncludeExtn=
PicExcludeExtn=
;
;Database files (*.PDB,*.AAD), PDBPATH
PDBIncludeExtn=
PDBExcludeExtn=
;
;Database ASCII files (*.GDB), PDBPATH
GDBIncludeExtn=
GDBExcludeExtn=
;
;Driver Configuration Binary files (*.*), PDBPATH
DrvIncludeExtn=
DrvExcludeExtn=
;
;Database/Driver CSV files (*.CSV), PDBPATH
DBCSVIncludeExtn=
DBCSVExcludeExtn=
;
;Historical Config files (.CFG,*.HGP,*.DAT), HTCPATH
HistConfigIncludeExtn=
HistCOnfigExcludeExtn=
;
;Tag Group files (*.TGD,*.TGS,*.TGE), PICPATH
TagGroupIncludeExtn=
TagGroupExcludeExtn=
;
;Recipe Control files (*.RCC,*.RCY), RCCPATH
RCPIncludeExtn=
RCPExcludeExtn=
;
;Master Recipe files (*.RCM,*.RCX), RCMPATH
RCMIncludeExtn=
RCMExcludeExtn=
;
;Application files (*.*), APPPATH
APPIncludeExtn=
APPExcludeExtn=
;
;Project Toolbar files(*.TBX,*.TBC), LOCPATH
ToolbarIncludeExtn=
ToolbarExcludeExtn=
;
;Event Schedule files (*.EVS), PDBPATH
ScheduleIncludeExtn=
ScheduleExcludeExtn=
;
;Project Global Definition Files(*.FXG), PICPATH
FXGIncludeExtn=
FXGExcludeExtn=
;
;Chart Group Wizard files(*.CSV), HTCPATH
CGWIncludeExtn=
CGWExcludeExtn=
;
;FIX32 Picture files(*.ODF,*.ODT,*.SBL), PICPATH
FIX32PicIncludeExtn=
FIX32PicExcludeExtn=
;
;FIX32 KeyMacro files(*.KMX), PICPATH
Fix32KMEIncludeExtn=
Fix32KMEExcludeExtn=
;
;Addon files(*.INI,*.TBC), ADDONPATH
AddonIncludeExtn=
AddonExcludeExtn=
;
;CFG files(*.*), CFGPATH
CfgIncludeExtn=
CfgExcludeExtn=
