Introduction
If you want users to be able to create a record in a child entity via a series of steps, you can add a child step in a wizard form.
This example creates a wizard, configures it with steps, adds a child step, and enables opening the wizard with the Preview button. Alternatively, you can also open the wizard using a form button.
Prerequisites
The active form must already exist.
|
Quick Steps |
| 1 |
Click the Create New File icon, select the Object Type, then select the Form Type |
| 2 |
Enter the details, then click Finish |
| 3 |
Create three wizard steps |
| 4 |
Select the first step |
| 5 |
Open the Entity Attributes tab, then add the controls |
| 6 |
Select the second step |
| 7 |
In the Entity Attributes tab, open lstOrderDetails and add the controls |
| 8 |
Configure the Action Group properties for the second step |
| 9 |
Create a child step |
| 10 |
Select the child step |
| 11 |
Add the controls |
| 12 |
Enter the New button details |
| 13 |
Configure the Action Group properties for the child step |
| 14 |
Configure the other properties for the Previous button |
| 15 |
Configure the child step properties |
| 16 |
Go back to the second step, then add a Wizard Add New Child button to the step |
| 17 |
Update the properties |
| 18 |
Select the third step, then add the controls |
| 19 |
Configure the Action Group properties for the third step |
| 20 |
Configure the Finish button |
| 21 |
Save the form |
| 22 |
Open the desired form |
| 23 |
Add an Open button |
| 24 |
Enter the details, then click OK |
| 25 |
Configure the Open button |
| 26 |
Save the form |
Detailed Steps
Step 1. Click the Create New File icon, select the Object Type, then select the Form Type.
This opens a drop down from which you can select an object to begin with. You are creating a wizard form.
Step 2. Enter the details, then click Finish.
You have to give the wizard a name and enter which entity and module to use with the form.
After clicking Finish, the wizard form exists and is ready for configuration.
Step 3. Create three wizard steps.
The wizard will have as many steps as you choose to create.
One default new step is already available when you create the new wizard form. To add a new step, place your cursor in the step where you want to insert a new step and select Add
Wizard Step.
Step 4. Select the first step.
Step 5. Open the Entity Attributes tab, then add the controls.
You can add controls from the Entity Attributes tab.
Step 6. Select the second step.
Step 7. In the Entity Attributes tab, open lstOrderDetails and add the controls.
lstOrderDetails is the property from which you can add controls for order details.
Make sure a one to many relationship exists between those entities.
Step 8. Configure the Action Group properties for the second step.
The properties to update are:
- Previous Action: If set to True, Xelence adds the Previous button to the step.
- Next Action: If set to True, Xelence adds the Next button to the step.
The order in which the properties are set decides the placement of buttons in the step.
Step 9. Create a child step.
The wizard will have as many child steps as you create.
To add a new child step, place your cursor in the step where you want to insert a new child step and select Add Wizard Child Step.
Step 10. Select the child step.
Step 11. Add the controls.
Step 12. Enter the New button details.
Enter the Related Control: The grid the button affects.
Step 13. Configure the Action Group properties for the child step.
Set the Previous Action property to True.
Step 14. Configure the other properties for the Previous button.
Set the Save property to True.
Step 15. Configure the child step properties.
Update the Previous Button Text: This is the text that will be visible in the application. In this case, it is "Done".
Step 16. Go back to the second step, then add a Wizard Add New Child button to the step.
Step 17. Update the properties.
Update the Landing Child Step: It is the programmatic ID for the child step to which the system will navigate when the button is clicked.
Step 18. Select the third step and add the controls.
Step 19. Configure the Action Group properties for the third step.
The properties to update are:
- Previous Action: If set to True, Xelence adds the Previous button to the step.
- Finish Action: If set to True, Xelence adds the Finish button to the step. This button saves the data the user enters here and closes the wizard, then navigates to the newly created record.
Step 20. Configure the Finish button.
Unlike the other buttons on the wizard, this button navigates to a different form, so it needs an Active Form. In this case, it is wfmOrderMaintenance.
Also, configure the navigation parameter for the maintenance form. In this case, it is OrderId.
Step 21. Save the form.
Step 22. Open the desired form.
This is the form the user will be able to launch the wizard from. This example uses the Order Lookup form.
Step 23. Add an Open button.
This button will launch the wizard.
Step 24. Enter the details, then click OK.
The ID and text should be unique and descriptive. The Active Form opens the wizard when the user clicks the button.
Also, configure the related control for the button. In this case, it is OrderId.
Step 25. Configure the Open button.
Configure the related control for this button. In this case, it is grvResult.
Step 26. Save the form.
Then, run the Preview. Xelence displays the form output. You can test your updated settings.
When you have previewed your form, it should look something like this. You can open the wizard from the lookup form and navigate through the wizard, including using the child step to add data to the parent step.
When you click Finish, the wizard opens the record you updated.
What are the improvements over S3 Version 6?
Related Articles
Configure Wizard Steps
This post is part of the Wizard Form topic. Click here to open the Wizard Form Overview.
#Xelence
#Forms