Being able to specify the parameters that can be used in SQL queries, connection strings and file paths allows you to use a single Sync file for multiple 'organisations' in Phocas. These parameters are passed to Sync, with the result that the same information structure is sent to a different organisation.
Data item types that reference parameters
- SQL
- File
- Directory
Defining parameters
Select the Parameters tab in Sync.
Defined parameters can be referenced by supported data item types as substitution values. For example, a SQL data item can have the majority of its properties defined by parameters:
Parameters
Connection details
Substitute parameters
You can substitute different values for defined parameter via scheduled Syncs (SyncCLI). To substitute a parameter value, the “-p” switch is used followed by the parameter name and quoted value. The quoted value is only used for the duration of the session i.e. the original value defined in Sync remains unchanged.
-p:parameterName “newValue”
-p:server ”localhost“
* Note if a parameter name contains spaces, it must also be quoted:
“-p:My Server” “localhost”
“-p:Test Database” “Testing”
The format for using parameters:
Path to sync file:
-r "c:\temp\new sync\sqlparameters.sync"
Server connection switches:
-user "phocas"
-password "phocas"
-service "http://localhost"
-source "ParametersBro"
Substituted Parameters
-p:server: “localhost“
-p:database "phocas_testing_sales"
-p:table "entity_1"
-p:columns "cat_3,cat_4,cat_5"
Example of a scheduled Sync substituting a number of parameters for a range of data items (formatted for readability):
-r "c:\temp\new sync\multipleparameters.sync"
-user "phocas" -password "phocas" -service "http://localhost" -source "SyncParamsFile"
-p:server "localhost"
-p:database "phocas_testing_sales"
"-p:My source table" "entity_1"
-p:columns "cat_3,cat_4,cat_5"
"-p:sales directory" "C:\temp\Sales"
-p:filePath "C:\temp\Customers.txt"