OTPByUCPFileValve

Valve for writing one-time passwords to file, based on template.

Properties

Name Description Default value Mandatory Supports property expansion
file_template Path to template file. resources/ucp_file_template.mustache No No
char_set Character set used when writing to the file. UTF-8 No No
file_prefix File name prefix. ucp- No No
file_suffix File name suffix. .txt No No
drop_folder Path to drop folder for the files. Yes No
generated_otp_name Item property containing the generated otp. generated_otp No No
recipient_param_name Property containing the recipient mobile number. mobile No Yes
userid_param_name Property containing the username. User-Name No Yes
wash_recipient_number If the mobile number should be washed (i.e. removal of whitespaces, - and other non-number characters). true No No
remove_leading_plus If the leading + character should be removed from the mobile number. false No No
recipient_prefix If the mobile number should be prepended with a country prefix, (example: +46). No No

Example Configuration 

{
        "name": "OTPByUCPFileValve",
        "config": { 
              "drop_folder":"/data/ucpfolder",
              "generated_otp_name":"generated_otp",
              "recipient_param_name":"othermobile",
              "userid_param_name":"{{request.username}}",
              "file_prefix":"ucp",
              "file_suffix":".txt",
              "recipient_prefix":"+46"
        }
}

In the example above the value for attribute othermobile has been picked up earlier in the flow.

The value for userid_param_name has been picked up from the request. Most common values are {{request.User-Name}} for RADIUS and {{request.username}} for HTTP.

Requirements

Item set must have at least one entry.