getRequiredConfigurationFields (context)
|
Function Declaration |
|
|
Type |
Function |
|
Description |
Provides a list of configuration fields, which the user must complete to use the other plug-in functions. The plug-in provides all functions with the user-supplied values for these fields in the input property of the respective context for the function. To define each configuration field line, see addConfigurationField. |
|
Returns |
void |
|
Input Parameters |
RequiredConfigurationFieldsContext |
Example
getRequiredConfigurationFields: function (context) {
//Connection details
context.output.addConfigurationField({type:"TEXT", label:"URL", dataName:"url"});
context.output.addConfigurationField({type:"TEXT", label:"Username", dataName:"username"});
context.output.addConfigurationField({type:"PASSWORD", label:"Password", dataName:"password"});
context.output.addConfigurationField({type:"TEXT", label:"Host Key", dataName:"hostKey"});
context.output.addConfigurationField({type:"TEXT", label:"Host Key Type", dataName:"hostKeyType"});
context.output.addConfigurationField({type:"TEXT", label:"Port", dataName:"port"});
//File download details
context.output.addConfigurationField({type:"TEXT", label:"Download Filename", dataName:"filename"});
context.output.addConfigurationField({type:"TEXT", label:"Download Directory", dataName:"directory"});
context.output.addConfigurationField({type:"TEXT", label:"Download Timeout", dataName:"timeout"});
context.output.addConfigurationField({type:"TEXT", label:"Bank statement format", dataName:"format"});
},
For more details, see addConfigurationField.