|
|
| |
OpenXPKI::Server::Workflow::Activity::Tools::Datapool::SetEntry(3) |
User Contributed Perl Documentation |
OpenXPKI::Server::Workflow::Activity::Tools::Datapool::SetEntry(3) |
OpenXPKI::Server::Workflow::Activity::Tools::Datapool::SetEntry
Sets an entry in the Datapool.
In the activity definition, the following parameters must be set. The syntax
using the ds_ prefix is deprecated, use the _map syntax to load
key and value from the context. It is not allowed to mix prefixed and
non-prefixed parameters!
- namespace
- The namespace to use for storing the key-value pair. Generally speaking,
there are no rigid naming conventions. The namespace sys, however,
is reserved for internal server and system related data.
- encrypt
- A boolean value that specifies whether the value of the entry is to be
encrypted. [optional - default is 0]
- force
- Causes the set action to overwrite an existing entry.
- expiration_date
- Sets expiration date of the datapool entry to the specified value. The
value should be a time specification recognized by OpenXPKI::DateTime
autodetection. (such as '+000001', which means one day), a terse data or
epoch. See OpenXPKI::DateTime::get_validity for details.
- key
- The value used as datapool key, use _map syntax to use values from
context!
- value
- The actual value written to the datapool, use _map syntax to use
values from context! If the value is an empty string, the item is deleted
from the datapool. If the value is not a scalar you must set the
serialize attribute to enable automatic serialization, otherwise
the call will fail with an error.
- pki_realm
- The realm of the datapool item to load, default is the current realm.
Note: For security reasons it is not allowed to load
items from other realms except from special system realms. The
only system realm defined for now is _global which is available
from all other realms.
- serialize
- Boolean, if set the value is serialized so it is possible to store
non-scalar items in the datapool.
The workflow action requires two parameters that are passed via the workflow
context. The names are set above with the key and value
parameters.
set_puk_in_datapool:
class: OpenXPKI::Server::Workflow::Activity::Tools::Datapool::SetEntry
param:
namespace: puk_namespace
_map_key: $token_id
_map_value: $_puk
encrypt: 1
force: 1
expiration_date: "+10"
Visit the GSP FreeBSD Man Page Interface. Output converted with ManDoc. |