You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: content/en/docs/howto7/general/dev-best-practices.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -312,25 +312,28 @@ Complex processes and important business logic (like workflow processing or vali
312
312
313
313
#### 4.2.6 Validating Inputs in Microflows
314
314
315
-
When microflows are invoked from the client side, it is important to validate the inputs. By having validations, you prevent incorrect, inappropriate, or potentially harmful data from being used in your microflow's and can protect yourself against security vulnerabilities. The following best practices contribute to the integrity and validation of inputs in your microflows.
315
+
When microflows are invoked from the client side, it is important to validate the inputs. By having validations, you prevent incorrect, inappropriate, or potentially harmful data from being used in your microflows. This protects your application against security vulnerabilities. The following presents the best practices regarding the integrity and validation of inputs in your microflows.
316
316
317
317
##### 4.2.6.1 Implementing Validation Checks
318
318
319
319
Adding validation checks is vital for ensuring that input data conforms to the expected data type, format, range, or other application-specific constraints. For instance, if a numeric input is expected within a defined range, validation checks should confirm that the input is indeed numeric and falls within the specified range.
320
320
321
321
##### 4.2.6.2 Managing Unexpected Values
322
322
323
-
When building microflows, it's important to account for the potential occurrence of unexpected values. These could be empty values, or values outside the expected range or format. This also includes ensuring read-only attributes only contain expected values.
323
+
When building microflows, it is important to account for the potential occurrence of unexpected values. These could be empty values, or values outside the expected range or format. It is also important to ensure that read-only attributes only contain expected values.
324
324
325
-
{{% alert color="warning" %}}
326
-
We strongly recommend adding validation to all microflows inputs, including read-only attributes. We also recommend avoiding storing intermediary values in attributes (such as a “TotalPrice”), and instead calculate these when needed to ensure the correct value.
325
+
{{% alert color="info" %}}
326
+
We strongly recommend adding validation checks to all microflows inputs, including read-only attributes.
327
+
328
+
We also recommend avoiding storing intermediary values in attributes (such as, *TotalPrice*). Instead, calculate these values when needed to ensure you have the correct values.
327
329
{{% /alert %}}
328
330
329
-
Microflows should incorporate mechanisms to detect such anomalies, and respond suitably – this might involve returning an error message to the user or executing a fallback operation.
331
+
Microflows should incorporate mechanisms to detect unexpected values and respond suitably – this might involve returning an error message to the end-user or executing a fallback operation.
332
+
333
+
##### 4.2.6.3 Updating Validation Logic Regularly
330
334
331
-
##### 4.6.2.3 Updating Validation Logic Regularly
335
+
As the application evolves, the validation logic within microflows should be updated accordingly to reflect changes in business logic or data models. This regular review and update of validation checks ensures that microflows remain secure and function correctly over time.
332
336
333
-
As the application evolves, the validation logic within microflows should be updated accordingly to reflect changes in business logic or data models. This regular review and update of validation checks will ensure that microflows remain secure and function correctly over time.
334
337
By prioritizing the validation of inputs in microflows, you not only enhance the security of your application, but also ensure a more predictable and stable user experience. This practice underscores the development of reliable and robust applications.
Copy file name to clipboardExpand all lines: content/en/docs/howto8/general/dev-best-practices.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -331,25 +331,28 @@ Complex processes and important business logic (like workflow processing or vali
331
331
332
332
#### 4.2.6 Validating Inputs in Microflows
333
333
334
-
When microflows are invoked from the client side, it is important to validate the inputs. By having validations, you prevent incorrect, inappropriate, or potentially harmful data from being used in your microflow's and can protect yourself against security vulnerabilities. The following best practices contribute to the integrity and validation of inputs in your microflows.
334
+
When microflows are invoked from the client side, it is important to validate the inputs. By having validations, you prevent incorrect, inappropriate, or potentially harmful data from being used in your microflows. This protects your application against security vulnerabilities. The following presents the best practices regarding the integrity and validation of inputs in your microflows.
335
335
336
336
##### 4.2.6.1 Implementing Validation Checks
337
337
338
338
Adding validation checks is vital for ensuring that input data conforms to the expected data type, format, range, or other application-specific constraints. For instance, if a numeric input is expected within a defined range, validation checks should confirm that the input is indeed numeric and falls within the specified range.
339
339
340
340
##### 4.2.6.2 Managing Unexpected Values
341
341
342
-
When building microflows, it's important to account for the potential occurrence of unexpected values. These could be empty values, or values outside the expected range or format. This also includes ensuring read-only attributes only contain expected values.
342
+
When building microflows, it is important to account for the potential occurrence of unexpected values. These could be empty values, or values outside the expected range or format. It is also important to ensure that read-only attributes only contain expected values.
343
343
344
-
{{% alert color="warning" %}}
345
-
We strongly recommend adding validation to all microflows inputs, including read-only attributes. We also recommend avoiding storing intermediary values in attributes (such as a “TotalPrice”), and instead calculate these when needed to ensure the correct value.
344
+
{{% alert color="info" %}}
345
+
We strongly recommend adding validation checks to all microflows inputs, including read-only attributes.
346
+
347
+
We also recommend avoiding storing intermediary values in attributes (such as, *TotalPrice*). Instead, calculate these values when needed to ensure you have the correct values.
346
348
{{% /alert %}}
347
349
348
-
Microflows should incorporate mechanisms to detect such anomalies, and respond suitably – this might involve returning an error message to the user or executing a fallback operation.
350
+
Microflows should incorporate mechanisms to detect unexpected values and respond suitably – this might involve returning an error message to the end-user or executing a fallback operation.
351
+
352
+
##### 4.2.6.3 Updating Validation Logic Regularly
349
353
350
-
##### 4.6.2.3 Updating Validation Logic Regularly
354
+
As the application evolves, the validation logic within microflows should be updated accordingly to reflect changes in business logic or data models. This regular review and update of validation checks ensures that microflows remain secure and function correctly over time.
351
355
352
-
As the application evolves, the validation logic within microflows should be updated accordingly to reflect changes in business logic or data models. This regular review and update of validation checks will ensure that microflows remain secure and function correctly over time.
353
356
By prioritizing the validation of inputs in microflows, you not only enhance the security of your application, but also ensure a more predictable and stable user experience. This practice underscores the development of reliable and robust applications.
Copy file name to clipboardExpand all lines: content/en/docs/refguide/modeling/dev-best-practices.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -362,25 +362,28 @@ Complex processes and important business logic (like workflow processing or vali
362
362
363
363
#### 4.2.6 Validating Inputs in Microflows
364
364
365
-
When microflows are invoked from the client side, it is important to validate the inputs. By having validations, you prevent incorrect, inappropriate, or potentially harmful data from being used in your microflow's and can protect yourself against security vulnerabilities. The following best practices contribute to the integrity and validation of inputs in your microflows.
365
+
When microflows are invoked from the client side, it is important to validate the inputs. By having validations, you prevent incorrect, inappropriate, or potentially harmful data from being used in your microflows. This protects your application against security vulnerabilities. The following presents the best practices regarding the integrity and validation of inputs in your microflows.
366
366
367
367
##### 4.2.6.1 Implementing Validation Checks
368
368
369
369
Adding validation checks is vital for ensuring that input data conforms to the expected data type, format, range, or other application-specific constraints. For instance, if a numeric input is expected within a defined range, validation checks should confirm that the input is indeed numeric and falls within the specified range.
370
370
371
371
##### 4.2.6.2 Managing Unexpected Values
372
372
373
-
When building microflows, it's important to account for the potential occurrence of unexpected values. These could be empty values, or values outside the expected range or format. This also includes ensuring read-only attributes only contain expected values.
373
+
When building microflows, it is important to account for the potential occurrence of unexpected values. These could be empty values, or values outside the expected range or format. It is also important to ensure that read-only attributes only contain expected values.
374
374
375
-
{{% alert color="warning" %}}
376
-
We strongly recommend adding validation to all microflows inputs, including read-only attributes. We also recommend avoiding storing intermediary values in attributes (such as a “TotalPrice”), and instead calculate these when needed to ensure the correct value.
375
+
{{% alert color="info" %}}
376
+
We strongly recommend adding validation checks to all microflows inputs, including read-only attributes.
377
+
378
+
We also recommend avoiding storing intermediary values in attributes (such as, *TotalPrice*). Instead, calculate these values when needed to ensure you have the correct values.
377
379
{{% /alert %}}
378
380
379
-
Microflows should incorporate mechanisms to detect such anomalies, and respond suitably – this might involve returning an error message to the user or executing a fallback operation.
381
+
Microflows should incorporate mechanisms to detect unexpected values and respond suitably – this might involve returning an error message to the end-user or executing a fallback operation.
382
+
383
+
##### 4.2.6.3 Updating Validation Logic Regularly
380
384
381
-
##### 4.6.2.3 Updating Validation Logic Regularly
385
+
As the application evolves, the validation logic within microflows should be updated accordingly to reflect changes in business logic or data models. This regular review and update of validation checks ensures that microflows remain secure and function correctly over time.
382
386
383
-
As the application evolves, the validation logic within microflows should be updated accordingly to reflect changes in business logic or data models. This regular review and update of validation checks will ensure that microflows remain secure and function correctly over time.
384
387
By prioritizing the validation of inputs in microflows, you not only enhance the security of your application, but also ensure a more predictable and stable user experience. This practice underscores the development of reliable and robust applications.
Copy file name to clipboardExpand all lines: content/en/docs/refguide9/modeling/dev-best-practices.md
+10-7Lines changed: 10 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -362,25 +362,28 @@ Complex processes and important business logic (like workflow processing or vali
362
362
363
363
#### 4.2.6 Validating Inputs in Microflows
364
364
365
-
When microflows are invoked from the client side, it is important to validate the inputs. By having validations, you prevent incorrect, inappropriate, or potentially harmful data from being used in your microflow's and can protect yourself against security vulnerabilities. The following best practices contribute to the integrity and validation of inputs in your microflows.
365
+
When microflows are invoked from the client side, it is important to validate the inputs. By having validations, you prevent incorrect, inappropriate, or potentially harmful data from being used in your microflows. This protects your application against security vulnerabilities. The following presents the best practices regarding the integrity and validation of inputs in your microflows.
366
366
367
367
##### 4.2.6.1 Implementing Validation Checks
368
368
369
369
Adding validation checks is vital for ensuring that input data conforms to the expected data type, format, range, or other application-specific constraints. For instance, if a numeric input is expected within a defined range, validation checks should confirm that the input is indeed numeric and falls within the specified range.
370
370
371
371
##### 4.2.6.2 Managing Unexpected Values
372
372
373
-
When building microflows, it's important to account for the potential occurrence of unexpected values. These could be empty values, or values outside the expected range or format. This also includes ensuring read-only attributes only contain expected values.
373
+
When building microflows, it is important to account for the potential occurrence of unexpected values. These could be empty values, or values outside the expected range or format. It is also important to ensure that read-only attributes only contain expected values.
374
374
375
-
{{% alert color="warning" %}}
376
-
We strongly recommend adding validation to all microflows inputs, including read-only attributes. We also recommend avoiding storing intermediary values in attributes (such as a “TotalPrice”), and instead calculate these when needed to ensure the correct value.
375
+
{{% alert color="info" %}}
376
+
We strongly recommend adding validation checks to all microflows inputs, including read-only attributes.
377
+
378
+
We also recommend avoiding storing intermediary values in attributes (such as, *TotalPrice*). Instead, calculate these values when needed to ensure you have the correct values.
377
379
{{% /alert %}}
378
380
379
-
Microflows should incorporate mechanisms to detect such anomalies, and respond suitably – this might involve returning an error message to the user or executing a fallback operation.
381
+
Microflows should incorporate mechanisms to detect unexpected values and respond suitably – this might involve returning an error message to the end-user or executing a fallback operation.
382
+
383
+
##### 4.2.6.3 Updating Validation Logic Regularly
380
384
381
-
##### 4.6.2.3 Updating Validation Logic Regularly
385
+
As the application evolves, the validation logic within microflows should be updated accordingly to reflect changes in business logic or data models. This regular review and update of validation checks ensures that microflows remain secure and function correctly over time.
382
386
383
-
As the application evolves, the validation logic within microflows should be updated accordingly to reflect changes in business logic or data models. This regular review and update of validation checks will ensure that microflows remain secure and function correctly over time.
384
387
By prioritizing the validation of inputs in microflows, you not only enhance the security of your application, but also ensure a more predictable and stable user experience. This practice underscores the development of reliable and robust applications.
0 commit comments