Simply right-clicking the mouse either on the relevant Text-to-Software field or a component contained in that field will give access to most of the commands that will be needed.
NOTE! To ensure that an application adopts any changes made in Text-to-Software, upload the changes before opening the application and save your application when exiting.
To reduce the number of steps to add a requirement, a requirement can also be added to a use case by highlighting the use case in the Software Lifecycle field, then typing the name of the requirement in the Requirement field. Then click the Add button. The requirement will automatically be added to the selected use case.
NOTE! Text-to-Software is intended to make programming easier. It was built to capture as much information as possible so that later it is clear what was intended in the first place. Therefore, it is a best practice to add a description in the Description field for every use case and requirement created.
Working with Elements
Reminder! Elements are the basic building blocks of applications made with Text-to-Software. An element is anything and everything that is seen and not seen in an application. In Text-to-Software, every element is associated with a requirement in a use case. To make an element, create a requirement in a use case, and then create the associated element to respond to that requirement.
Elements may become any part of an application. Therefore, in order to make one of these other components, it must first be created as an element and then turned into that component.
NOTE! In order to reduce confusion and to be able to navigate an application more easily, give each element a unique name.
There are three ways to create an element and steps for how to do it:
1. Writing text in the Requirement Description field related to a particular requirement
Highlight and right click to select Convert to…
2. Highlighting a Use Case
Right-click and select Use Cases>Instantiate
3. Having Text-to-Software automatically create them from a text document using either Full or Semi Auto Mode
When converting text from the Requirement Description box into elements, right-clicking in the Requirement Description field can be quite useful.
The following table outlines the commands to reverse engineer elements and groups from text in the Description field.
Once elements have been created, then they can be further worked with by right-clicking in the Elements box.
* A sub-group requires a transition in order to link it to the parent group. Because transitions are managed at the state level, in order to turn an element into a sub-group, a state and an activity must already exist that have the parent group included. If these do not already exist, you may either first create them manually, or you will be prompted by Text-to-Software to create them automatically when you select to undertake this action.
Working with Groups
Reminder: You group elements so that they appear on a screen together. Sub-groups can also be created, which are groups within groups.
The following table outlines the right-click commands to work with groups.
Groups can also be created from requirements text in the Description box by using the Import WordDoc function in the Project Lifecycle menu (Text-to-Software>Import Word Doc).
Working with Activities
NOTE! When creating activities, name them beginning with a verb that describes what the activity does. For instance, an activity that contained the XYZ group would be called Manage XYZ.
Working with States (User Interface Screens)
Reminder! When adding an activity to a screen or state, it means that the groups that activity contains will be displayed on that screen in the application. For a screen to be displayed in your application, it has to contain at least one activity.
Once elements have been defined, which elements are put together in the same group, and what groups make up each of the activities, it can then be decided on which screen of the final application those activities will show up.
When a screen or state is first created, its status is that of “Visible”. In order for it not to appear in an application, its status must be changed to “Invisible”. To do this, right click on the screen in the Screens box and select Make Invisible.
NOTE! For ease of reference, name screens with the same or similar name to their corresponding activity and parent group.
The following table outlines the commands available in the States field related to working with screens or states.
NOTE! A state should only contain one activity, which should only contain one group (plus related subgroups). Think of each state in an application as being a single group or “form” for users to complete. When the user is completing the form, they are completing the activity on that screen.
Working with User Interface Transitions
Reminder! Transitions on the user interface create movement from one screen to another.
When creating sub-groups (or Make member of…) Text-to-Software will automatically set-up the appropriate transition from the group to the sub-group. It will also automatically create a transition from one screen to the one before and the one after it. New transitions can then be added or existing ones removed or renamed.
Because transitions link two user interface screens or states, they are usually created from the States field. Even when right-clicking in the Transitions field, Text-to-Software will require that the state from which to start the transition be selected.
User Interface Transition Commands
Once transitions have been defined between user interface screens, they can be renamed and deleted then from the Transition field.
NOTE! When adding the Navigator field to each group, it automatically creates the Navigator Smart Part on each screen. It is on the Navigator that the user interface transition buttons will appear.
Creating and editing User Interface Transitions to facilitate navigation within an application
1. Upload the application to the server.
2. Click the hyperlink to open the web interface and also view using SageTea Browser. The screen will appear empty, because there are currently no records in the database.
3. Click the + button to generate the first Monthly Mine Reclamation Report record.
4. Give the record a name. Note the transition button on the Navigator portion of the screen.
5. Click the button and note to where it transitions and if this is the correct destination, based on the name of the button. If the transition is correct, then verify the other transitions. If a transition is not correct, then:
6. Close the application.
7. Return to the Text-to-Software Requirements Tab.
8. Highlight the “departure” screen and then the transition to rename.
9. Rename the transition to the destination location.
10. Upload the application to the server.
11. Test the transition button.
12. Repeat steps 6 to 11 as required. At this point, if you don’t like the way the elements are laid out on the screens, you can go back in to the group and re-order them using the “change element order” in groups, and/or the smart parts editor (horizontal/new line). You can also drag and drop the element to the desired location within Groups.
Additional points to remember:
• Remember to close the application before making changes in Text-to-Software, or they will not be saved.
• When making changes to a group, right click and click on Add to Activity, so that the changes are carried through to the activities and screens as well.
• Every time a change is made to the application, remember to upload it to the server before previewing. Inform your instructor once you are finished.
Working with User Interface Events and Actions
Events define under what conditions transitions occur and actions define what happens when the transition occurs.
An event can be initiated by a user (such as a button click) or by the system (such as a timer counting down). Actions define what happens when a state transition occurs. When setting up a transition in the user interface view, events and actions will be defined automatically.
Associating an Image or Screenshot to a use case
To associate an image or screenshot to a use case, an image can be uploaded to the Image or Screenshot field. This can be particularly useful when working with legacy systems, and want to have a reference back to what the different components of that system looked like. It can also be useful to include the business logic diagrams for specific use cases.
To upload an image to the Image or Screenshot field, follow these steps:
1. Click and highlight the associated use case
2. Right-click on the name of the Use Case
3. Select Images in the dropdown box
4. Select Edit Image and then a dialogue box opens
5. Select the image to be uploaded
6. Click the Accept button
7. Resize, if necessary (optional)
8. Click Yes in “Updated Image for Selected Element” dialogue box.