bw2:wfapiresponse_tool
Differences
This shows you the differences between two versions of the page.
|
bw2:wfapiresponse_tool [2024/12/20 12:50] dtucker created |
bw2:wfapiresponse_tool [2024/12/21 12:25] (current) dtucker |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| - | API Response | + | ======Introduction (API Response)====== |
| + | This page describes the use of the Bizweaver API Response Tool. | ||
| + | |||
| + | =====API Response Tool===== | ||
| + | The encryption tool is best used to encrypt data from a source (AWS, Versago) to your database. The functionality is used to store sensitive data in a database, or a file. | ||
| + | The tool accepts a string as input and encrypts it with a key you create. To view the string in clear text it must be decrypted with the same key. An encryption step can be added anywhere to a workflow. In the following illustration, | ||
| + | |||
| + | |||
| + | {{ : | ||
| + | =====Basic Configuration Steps to Encrypt===== | ||
| + | |||
| + | ===Example: | ||
| + | |||
| + | {{ : | ||
| + | |||
| + | - **Text** - this is the information you are passing into the tool to encrypt/ | ||
| + | - You can use step and user variables in this field. | ||
| + | - **Encryption / Decryption Key** - This is a key you assign. It can be anything you wish. | ||
| + | - to make it secure, it is recommended that the key is a mix of upper-case and lower-case characters and numbers | ||
| + | - **Command** - This determines if you want to encrypt or decrypt the data. | ||
| + | - 0 to Encrypt | ||
| + | - 1 to Decrypt | ||
| + | |||
| + | =====Basic Configuration Steps to Decrypt===== | ||
| + | |||
| + | ===Example: | ||
| + | |||
| + | {{ : | ||
| + | - **Text** - this is the information you are passing into the tool to encrypt/ | ||
| + | - You can use step and user variables in this field. | ||
| + | - Make sure you use the value you are wishing to decrypt | ||
| + | - **Encryption / Decryption Key** - Use the key you created initially to decrypt. | ||
| + | - **Command** - This determines if you want to encrypt or decrypt the data. | ||
| + | - 0 to Encrypt | ||
| + | - 1 to Decrypt | ||
| + | |||
| + | ====Encrypt Decrypt Variables==== | ||
| + | ^Name ^Description^ | ||
| + | |Command|This indicates the encryption key that was used| | ||
| + | |EncryptionKey|This indicates the encryption key that was used| | ||
| + | |InputText|This indicates the text that is entered in the Text field to be encrypted or decrypted| | ||
| + | |Value|This indicates the encrypted text decrypted or decrypted text encrypted| | ||
| + | |StepMessage|During a failure the reason for failure will be populated here| | ||
| + | |StepStatus|True or False| | ||
bw2/wfapiresponse_tool.1734717034.txt.gz · Last modified: 2024/12/20 12:50 by dtucker
Except where otherwise noted, content on this wiki is licensed under the following license: CC Attribution-Noncommercial 4.0 International
