Versions Compared

Key

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

...

Licenses

Status
colourYellow
titleCOMMUNITY
,
Status
colourBlue
titleENTERPRISE
,
Status
colourPurple
titleCORPORATE

Since

Status
colourGreen
titleVERSION 6.0

Table of Contents

Introduction

The property store is a data repository in PIPEFORCE to save all your customization and application data. You can upload, download and delete resources from the property store using pipeline commands or the online low-code workbench. Required license:

Status
colourBlue
titleENTERPRISE
or
Status
colourYellow
titlepartner
Since version:
Status
colourGreen
titleVersion 6.0

Table of Contents

What is the Property Store and a Property?

The property strore is a built-in object database provided by PIPEFORCE where you can save configurations, custom values or application data.

Each entry -code workbench.

What is a Property?

Each entry stored in the property store is called a property and . It has a unique key.

Properties in the property store are structured in an hierarchical way whereas the key of a property is also its path in the tree structure. Here is an example of such a key of a property:

...

This will show you all available property.* pipeline commands and their description in the terminal.Another possibility terminal.

Another possibility (only:

Status
colourBlue
titleENTERPRISE
,
Status
colourPurple
titleCORPORATE
) to see the documentation of available commands is to go to this url:

Code Block
https://portal-NAMESPACE.pipeforce.net

and go to Commands (replace NAMESPACE by your real namespace). In the search box type-in property.

...

This will list all available commands to manage properties in the property store. Click on such a command to get details about it or to execute it online.

If you want to manage the property store from your local command line, you can call any of these commands also using the CLI:

Code Block
pi command COMMAND_NAME PARAM1=VALUE1 PARAM2=VALUE2

See Command Line Interface (CLI) for more details about using the CLIsuch a command to get details about it or to execute it online.

Create a new property

To create a new property, you need to use the command property.schema.put.

...

See this link of your instance for details about this command (replace NAMESPACE by your real namespaceonly:

Status
colourBlue
titleENTERPRISE
,
Status
colourPurple
titleCORPORATE
):
https://portal-NAMESPACE.pipeforce.net/#/pipeform?pipe=property.schema.put

...

Note: The property must already exist before you set its value using. So use property.schema.put to define the property and then property.put to set its value.

...

See this link of your instance for details about this command (replace NAMESPACE by your real namespacethis command (only:

Status
colourBlue
titleENTERPRISE
,
Status
colourPurple
titleCORPORATE
):
https://portal-NAMESPACE.pipeforce.net/#/pipeform?pipe=property.put

...

Info

Why are there two different commands to create a property and set its value?
Because there are two different security levels with permissions. Those users who are able to change the value of a property with property.put not always have the permission to create a new property using property.schema.put. Having two commands allows it to differentiate in a pipeline what a user can do since in PIEPFORCE PIPEFORCE any command can have assigned different permissions.

...

See this link of your instance for details about this command (replace NAMESPACE by your real namespaceonly:

Status
colourBlue
titleENTERPRISE
,
Status
colourPurple
titleCORPORATE
):
https://portal-NAMESPACE.pipeforce.net/#/pipeform?pipe=property.schema.delete

...

Find here more about pipelines: Pipelines & Commands https://logabit.atlassian.net/wiki/spaces/DEVEX/pages/785088596

Each property name corresponds with the name of the pipeline and contains as value the pipeline configuration. For example:

...

See here how to setup such a customization workspace: Local Low-Code Workspace

See here for a getting started guide how to setup the CLI and use the local workspace: https://logabit.atlassian.netnull/pages/createpage.action?spaceKey=DEVEX&title=Getting%20Started%20-%20Basics&linkCreation=true&fromPageId=988807265 .

Working with Visual Studio Code

...