Versions Compared

Version Old Version 10 New Version Current
Changes made by

Helen Gosper

Denise McGettigan

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
maxLevel3

Info
iconfalse
titleRelated articles
Specifying 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

When you are adding a file, directory or SQL data item to Sync, you can specify parameters to use the Sync file for multiple organizations in Phocas. The parameters are passed to Sync

, with the result that the same

and as a result, the information structure is sent to

a different organisationSelect

other organizations. 

Data item types that reference parameters

  • SQL
  • File
  • Directory.

Defining parameters

  1. In Sync, select the Parameters tab

in Sync

  1. .

  2. Click Add.

  3. Enter the parameter name

and its /value pair, noting that:

  1. . Parameter names are alphanumeric only. Special characters

can not

  1. cannot be used.

  2. Enter a value. Values can not contain

other

  1. parameters.

Values can not contain double quotes

  1. Double quotes cannot be used.

Image Removed Parameter substitution
  1. Image Added

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

Image Removed

Connection details

Image Removed

Using parameters as values in supported types

Example of use: Connection string 

Image Added

Example of use: SQL

Image Added

Parameter substitution in scheduled Syncs

You can substitute different values for defined

parameter

parameters via scheduled Syncs (SyncCLI).

Individual parameters

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“

* The

Note if a parameter name contains spaces, it must also be quoted:

“-p:My Server” “localhost”

“-p:Test Database” “Testing”

 

Example format for

using

substituted 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“

“DatabaseServer“

-p:database "

phocas_testing_sales

Sales2016"

-"p:db table"

entity_1

"Sales Customers"

-p:columns "

cat_3,cat_4,cat_5"

 

Example of a scheduled Sync substituting a number of

ID, Address"

Multiple parameters

You can substitute several parameters for a range of data items

(formatted for readability):-r

.

Image Added

These multiple parameters can be entered in the Arguments field in a scheduled task:

Code Block
-r "c:\temp\new sync\multipleparameters.sync"
 -user "
phocas
John User" -password "
phocas
myPassword" -service "http://
localhost
company.example.com" -source "
SyncParamsFile
Sales"
 -p:server "
localhost
DatabaseServer"
 -p:database "
phocas_testing_sales"
Sales2016" "-p:
My source 
db table"
"entity_1"
 "Sales Customers" -p:columns "
cat_3,cat_4,cat_5"
ID, Address" "-p:sales directory" "C:\temp\Sales"

bits

invalid parameters?

names/values - alphanumeric. special characters?

  • Ability to specify parameters that can be used in SQL queries, connection strings and file paths.
    1. Parameters are specified by using handlebars {{variable}}.
  • Parameters can be configured in a parameter tab (last tab) which takes name value pairs.
    1. Parameter names and values are edited within the table.
    2. Parameter name is alphanumeric. No special characters allowed.
    3. Values can not contain other parameters.
    4. Values can not contain double quotes.
  • Parameters can be specified as arguments for SyncCLI.
    1. Parameters specified by /p:name=value.
    • Datasource name, service URL, username and password can be specified as arguments for SyncCLI.
  • /source:data source name
  • /service:service URL
  • /username:username
    • /password:password
     -p:filePath "C:\temp\Customers.txt"

     

    Iterations

    The Iterations option in the Sync setup is an advanced option that we recommend you use in consultation with a Phocas consultant. It’s useful in the case of multiple customer data sources, particularly multiple ERPs, linked to one Phocas site. Typically, these data sources are identical, except for having unique credentials and one or more different parameter values. As the setup is almost the same for each source, you can add iterations to the Sync process. This iterative approach removes the need for separate configuration files and makes the Sync setup quicker and less complex.

    Each time Sync is triggered, all items are processed for each iteration, in order, with the default parameters being overridden by the iteration parameters.

    image-20240611-030630.pngImage Added

    On this page

    Table of Contents
    maxLevel3