Using and setting variables in your packages

Using and setting variables in your package

You can use variables in most components and fields of a package. You cannot use, for example, variables in the limit component or in alias fields.
Variable values are expressions so you can use functions and operators to assign dynamic values to your variables.

You can use three types of variables:

  • User variables that you define. You also set the default value.
  • System variables for which you can change the default value. See list here.
  • Variables predefined by Xplenty, whose values are set by the system when the job is run. See list here.

Using variables in a variable or a field:

In the required field, type $ followed by the variable name. For example, if the variable name is country, type $country. Note that variables are simply substituted with their values. Therefore if you use a variable where a string value is expected, you should enclose it in single quotes, as in this example: SUBSTRING('$country',3,5)

Setting variable values in your package

Set user and system variable default values in the package designer. If required, you can override these default values when you run a job through the UI (see Running jobs), the scheduler or the API.

To modify a system variable default value in the package:

  1. Click ... (More options), then click Set variables ...
  2. Click system variables.
  3. Type a new default value in the relevant text box.
You can also use the following in system variable values:
  • Predefined variables
  • Another system variable that is listed before the system variable whose value you're editing.

To define a user variable and set its value:
  1. Click ... (More options), then click Set variables ...
  2. On the user variables tab, type a name and a default value in the relevant text boxes.
  3. Add additional variables as required.
You can also use the following in user variable values:
  • Predefined variables
  • System variables
  • Another user variable that is listed before the user variable whose value you're editing.

Creating packages

  1. Creating a new package
  2. Create a package from a template
  3. Working in the package designer
  4. Using Components: Facebook Ads Insights Source (Beta)
  5. Using components: File Storage Source
  6. Using components: Database Source
  7. Using components: Google AdWords Source
  8. Using components: NetSuite Source
  9. Using Components: Google Analytics Source
  10. Using Components: Google BigQuery Source
  11. Using components: Google Cloud Spanner Source
  12. Using Components: Bing Ads Source
  13. Using components: MongoDB Source
  14. Using components: Amazon Redshift Source
  15. Using Components: Rest API Source
  16. Using Components: Salesforce Source
  17. Using components: Select
  18. Using components: Sort
  19. Using components: Rank
  20. Using components: Limit
  21. Using components: Sample
  22. Using components: Join
  23. Using components: Cross Join
  24. Using components: Clone
  25. Using components: Cube and Rollup
  26. Using components: Union
  27. Using components: Filter
  28. Using Components: Window
  29. Using components: Assert
  30. Using components: Aggregate
  31. Using components: Distinct
  32. Using components: File Storage Destination
  33. Using components: Amazon Redshift Destination
  34. Using Components: Salesforce Destination
  35. Using components: Google BigQuery Destination
  36. Using components: Google Cloud Spanner Destination
  37. Using components: Database Destination
  38. Using components: MongoDB Destination
  39. Using components: Snowflake Destination (beta)
  40. Using and setting variables in your packages
  41. System and pre-defined variables
  42. Validating a package
  43. Using pattern-matching in source component paths
  44. Using ISO 8601 string functions
  45. Using Expressions in Xplenty
  46. Xplenty Functions

Feedback and Knowledge Base