waitUntil and drillDownAndWaitUntil

waitUntil

Live Sample · GitHub

This mechanism is useful for implementing long-running operations where the user needs to be informed about the progress and its outcome.

How does it look?

Without custom messageWith Success and In progress custom messageWith Timeout custom message

PostAction.waitUntil(
    MyExampleDTO_.statusResponse, 
    StatusEnum.DONE)                
   .timeoutMaxRequests(6)          
   .timeout(Duration.ofSeconds(12))  
   .inProgressMessage("In Progress custom message")  
   .successMessage("Success custom message")       
   .timeoutMessage("Timeout custom message")      
   .build()

Parameters of waitUntil:

• (Required) Field to check for the condition: MyExampleDTO_.statusResponse — This is the field that will be checked for the condition. It can be of type boolean, string, Dictionary, Enum, LOV. Field that will be compared to the expected value.This field must be (may be hidden) in the on the screen.

• (Required) Expected value: StatusEnum.DONE — This is the value the frontend will wait for in the statusResponse field. When the field matches this value, the waiting dialog will be closed.

Additional Configuration:

• (Optional) Maximum number of requests: timeoutMaxRequests(6) — This is the maximum number of requests the frontend will make to the backend to check the condition. If the condition is not met after 6 requests, a timeout will be triggered. By default, timeoutMaxRequests is set to 3.

• (Optional) Timeout: timeout(Duration.ofSeconds(12)) — The total time during which the frontend will wait for the condition to be met. In this case, it is 12 seconds. The time between requests is calculated as total time / number of requests. Here, the interval between requests will be 12 seconds / 6 requests = 2 seconds. By default, timeout is set to 5 seconds.

• (Optional) In-progress message: inProgressMessage("In Progress custom message") — This is a custom message that will be displayed on the frontend while waiting for the condition to be met. By default, a standard message is displayed: Operation in progress.
• (Optional) Success message: successMessage("Success custom message") — This is a custom message that will be displayed when the condition is met (i.e., when statusResponse equals StatusEnum.DONE). By default, the standard message is not displayed.
• (Optional) Timeout message: timeoutMessage("Timeout custom message") — This is a custom message that will be displayed if the condition is not met before the timeout expires (i.e., after 6 requests within 12 seconds). By default, the standard message is not displayed.

How it works:

• The frontend starts making requests to the backend at intervals of 2 seconds (12 seconds / 6 requests).
• On each request, the value of the statusResponse field is checked.
• If the field becomes equal to StatusEnum.DONE, the Success custom message is displayed, and the process completes.
• If the condition is not met after 6 requests, the Timeout custom message is displayed, and the process ends due to a timeout.
• During the execution of the requests, the In Progress custom message is displayed.

How to add?

Example

Step1 Add PostAction.waitUntil to corresponding VersionAwareResponseService.

       @Override
       public Actions<MyExampleDTO> getActions() {
           return Actions.<MyExampleDTO>builder()
                   .create(crt -> crt.text("Add"))
                   .save(sv -> sv.text("Save"))
                   .cancelCreate(ccr -> ccr.text("Cancel").available(bc -> true))
                   .delete(dlt -> dlt.text("Delete"))
                   .action(act -> act
                           .action("searchData", "Search data")
                           .scope(ActionScope.RECORD)
                           .invoker((bc, dto) -> {
                               MyEntity myEntity  = repository.findById(bc.getIdAsLong()).orElseThrow();
                               myEntity.setStatusResponse(StatusEnum.IN_PROGRESS);
                               repository.save(myEntity);
                               findInExternalSystemAsync(bc, dto);
                               return new ActionResultDTO<MyExampleDTO>().setAction(
                                       PostAction.waitUntil(
                                                       MyExampleDTO_.statusResponse,
                                                       StatusEnum.DONE)
                                               .timeoutMaxRequests(6).timeout(Duration.ofSeconds(12)).build());
                           })
                   ).build();
       }

Live Sample · GitHub

drillDownAndWaitUntil

Live Sample · GitHub This method is useful for scenarios where you need to navigate to a screen, wait for a specific condition (e.g., a status change), and provide feedback to the user during the process.

Creates a post-action that performs a INNER drill-down and then waits until a specified condition is met.

How does it look?

Without custom messageWith Success and In progress custom messageWith Timeout custom message

PostAction.drillDownAndWaitUntil(
    "/screen/myexample/view/myexampleresultform/" +
    CxboxMyExampleController.myexample + "/" + myEntity.getId(),
    CxboxMyExampleController.myexample,
    MyExampleDTO_.statusResponse,
    StatusEnum.DONE
)
.inProgressMessage("In Progress custom message")
.successMessage("Success custom message")
.timeoutMessage("Timeout custom message")
.timeoutMaxRequests(6)
.timeout(Duration.ofSeconds(12))
.build();

Parameters of drillDownAndWaitUntil:

• (Required) Path to the screen: "/screen/myexample/view/myexampleresultform/" + CxboxMyExampleController.myexample + "/" + myEntity.getId() — This is path to the screen where will navigate.

• (Required) Business component to check for the condition: CxboxMyExampleController.myexample — This is a business component where the field to be compared with the expected value will be checked. This business component must be (may be hidden)in the on the screen to which the transition is made.

• (Required) Field to check for the condition: MyExampleDTO_.statusResponse — This is the field that will be checked for the condition. It can be of type boolean, string, Dictionary, Enum, LOV. Field that will be compared to the expected value.This field must be (may be hidden) in the on the screen.

• (Required) Expected value: StatusEnum.DONE — This is the value the frontend will wait for in the statusResponse field. When the field matches this value, the waiting dialog will be closed.This field must be (may be hidden) in the on the screen to which the transition is made.

Additional Configuration:

• (Optional) Maximum number of requests: timeoutMaxRequests(6) — This is the maximum number of requests the frontend will make to the backend to check the condition. If the condition is not met after 6 requests, a timeout will be triggered. By default, timeoutMaxRequests is set to 3.
• (Optional) Timeout: timeout(Duration.ofSeconds(12)) — The total time during which the frontend will wait for the condition to be met. In this case, it is 12 seconds. The time between requests is calculated as total time / number of requests. Here, the interval between requests will be 12 seconds / 6 requests = 2 seconds. By default, timeout is set to 5 seconds.
• (Optional) In-progress message: inProgressMessage("In Progress custom message") — This is a custom message that will be displayed on the frontend while waiting for the condition to be met. By default, a standard message is displayed: Operation in progress.
• (Optional) Success message: successMessage("Success custom message") — This is a custom message that will be displayed when the condition is met (i.e., when statusResponse equals StatusEnum.DONE). By default, the standard message is not displayed.
• (Optional) Timeout message: timeoutMessage("Timeout custom message") — This is a custom message that will be displayed if the condition is not met before the timeout expires (i.e., after 6 requests within 12 seconds). By default, the standard message is not displayed.

How it works:

• The frontend navigates to the specified screen (/screen/myexample/view/myexampleresultform/...). The In Progress custom message is displayed.
• It starts checking the statusResponse field in MyExampleDTO_ for the value StatusEnum.DONE.
• The frontend makes up to 6 requests at intervals of 2 seconds (12 seconds total).
• If the condition is met: The Success custom message is displayed, and the process ends.
• If the condition is not met after 6 requests: The frontend navigates to the specified screen (/screen/myexample/view/myexampleresultform/...). The Timeout custom message is displayed, and the process ends due to a timeout.

How to add?

Example

Step1 Add PostAction.drillDownAndWaitUntil to corresponding VersionAwareResponseService.

       @Override
       public Actions<MyExampleDTO> getActions() {
           return Actions.<MyExampleDTO>builder()
                   .create(crt -> crt.text("Add"))
                   .save(sv -> sv.text("Save"))
                   .cancelCreate(ccr -> ccr.text("Cancel").available(bc -> true))
                   .delete(dlt -> dlt.text("Delete"))
                   .action(act -> act
                           .action("createAndSearch", "Create and search")
                           .scope(ActionScope.BC)
                           .invoker((bc, dto) -> {
                               MyEntity myEntity = new MyEntity();
                               myEntity.setStatusResponse(StatusEnum.IN_PROGRESS);
                               repository.save(myEntity);
                               findInExternalSystemAsync(myEntity,dto);
                               return new ActionResultDTO<MyExampleDTO>().setAction(
                                       PostAction.drillDownAndWaitUntil(
                                                       "/screen/myexample/view/myexampleresultform/" +
                                                               CxboxMyExampleController.myexample + "/" + myEntity.getId(),
                                                       CxboxMyExampleController.myexample,
                                                       MyExampleDTO_.statusResponse,
                                                       StatusEnum.DONE
                                               )
                                               .timeoutMaxRequests(6).timeout(Duration.ofSeconds(12)).build());
                           })
                   )
                   .action(act -> act
                           .scope(ActionScope.RECORD)
                           .action("gotofind", "Go to Find")
                           .invoker((bc, dto) -> {
                               return new ActionResultDTO<MyExampleDTO>().setAction(
                                       PostAction.drillDown(
                                               DrillDownType.INNER,
                                               "/screen/myexample/view/myexampleform"
                                       ));
                           })
                   )
                   .build();
       }

Live Sample · GitHub