Skip to content

Commit 47d89b1

Browse files
committed
Language ans style review
1 parent 9bb4351 commit 47d89b1

4 files changed

Lines changed: 40 additions & 28 deletions

File tree

content/en/docs/howto7/general/dev-best-practices.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -312,25 +312,28 @@ Complex processes and important business logic (like workflow processing or vali
312312

313313
#### 4.2.6 Validating Inputs in Microflows
314314

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.
316316

317317
##### 4.2.6.1 Implementing Validation Checks
318318

319319
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.
320320

321321
##### 4.2.6.2 Managing Unexpected Values
322322

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.
324324

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.
327329
{{% /alert %}}
328330

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
330334

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.
332336

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.
334337
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.
335338

336339
### 4.3 Warnings and Modeler Feedback

content/en/docs/howto8/general/dev-best-practices.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -331,25 +331,28 @@ Complex processes and important business logic (like workflow processing or vali
331331

332332
#### 4.2.6 Validating Inputs in Microflows
333333

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.
335335

336336
##### 4.2.6.1 Implementing Validation Checks
337337

338338
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.
339339

340340
##### 4.2.6.2 Managing Unexpected Values
341341

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.
343343

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.
346348
{{% /alert %}}
347349

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
349353

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.
351355

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.
353356
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.
354357

355358
### 4.3 Warnings and Studio Pro Feedback

content/en/docs/refguide/modeling/dev-best-practices.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -362,25 +362,28 @@ Complex processes and important business logic (like workflow processing or vali
362362

363363
#### 4.2.6 Validating Inputs in Microflows
364364

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.
366366

367367
##### 4.2.6.1 Implementing Validation Checks
368368

369369
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.
370370

371371
##### 4.2.6.2 Managing Unexpected Values
372372

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.
374374

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.
377379
{{% /alert %}}
378380

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
380384

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.
382386

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.
384387
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.
385388

386389
### 4.3 Workflows

content/en/docs/refguide9/modeling/dev-best-practices.md

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -362,25 +362,28 @@ Complex processes and important business logic (like workflow processing or vali
362362

363363
#### 4.2.6 Validating Inputs in Microflows
364364

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.
366366

367367
##### 4.2.6.1 Implementing Validation Checks
368368

369369
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.
370370

371371
##### 4.2.6.2 Managing Unexpected Values
372372

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.
374374

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.
377379
{{% /alert %}}
378380

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
380384

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.
382386

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.
384387
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.
385388

386389
### 4.3 Workflows

0 commit comments

Comments
 (0)