Examples of business object customizations

This example creates a business object for the Name_Note table and exercises the business object with a query.

1. From the Staff site, go to RiSE > Business Object Designer.
2. Select New > Design Business Definition. The New Object window is displayed.

Note: When creating a new Business Object, ensure you add the new Business Object in the Design Business Object Definition folder only. Do not create subfolders in the Design Business Object Definition folder.

3. Enter Name_Note as the Name for this example.
4. Click Create Object.
5. (Database tab) Click Add. A window listing all the iMIS database tables appears.
Click for details
1. Select the Name_Note table and click OK. The Name_Note table is added to the Tables field, and its columns are added to the Available Columns field.
2. In the Available Columns field, select all the columns except Name_Note.TIME_STAMP, which is used for iBO concurrency, and does not apply to this example.
3. Click Add as Properties.
4. Click Save.
6. On the (Properties tab), examine the automatically generated entries on the Description, Type, Display, and Value tabs.
Click for details
• (Properties tab > Definition sub-tab) For the following properties, verify the Available to Query Builder and Automatically Include in Queries options are checked:
  • ID
  • NOTE
  • NOTE_NUM
  • PURPOSE
7. Click Save and then Close.
8. Click Publish.
9. Click OK and then Close.
10. Create a new query in a working folder.
Click for details
1. From the Staff site, go to RiSE > Intelligent Query Architect.
2. Select the folder Scratch.
3. Select New > Query.
4. Enter a Name for this query.
5. (Define tab > Sources sub-tab) Click Add Source.
6. In the Document Browser, go to $/Common/Business Objects.
7. Select Name_Note. Click OK to add it to the Query Sources list.
8. (Define tab > Display sub-tab) The four columns in the display set are selected.
9. Click Save As. On the Document Saver window, enter Name_Note query as the name for this query.
10. Click OK.
11. Click Run to see the sample output.
11. Generate extended results
Click for details
1. (Define tab > Sources sub-tab) Click Add Source.
2. In the Document Browser, go to $/Common/Business Objects.
3. Select Name_Note. Click OK to add it to the Query Sources list.
4. Add the Name table to the business object, display FULL_NAME in the query results, and republish.
5. In BOD, Edit the Name_Note business object. Select Database, and add the Name table to the Tables list. Add Name_Note.ID=Name.ID to the Joins list, by selecting the columns from the left and right drop-down lists.
6. Select Columns, select Name.FULL_NAME, and add a property for the column.
7. On the (Properties tab), select the Display sub-tab.
8. Add FullName to the Display Set.
9. Select Save, Close, Build, and Publish.
12. In IQA, open the query for this business object.
13. On the (Sources tab), click the Remove icon to remove the existing source.
14. Click Add Source and re-add Name_Note.

Note: Business object changes aren’t automatically reflected in queries that use them.

15. On the (Display tab), change the order to have Id and Full Name first. Use the Refresh button as you go to confirm the order. Save the query.
16. Select Run to see the query results.
17. On the (Summary tab), switch to Advanced mode to see the SQL for the query.

The following example changes a display property on the Campaign object and shows the change from the application.

1. From the Staff site, go to Community > Manage marketing campaigns > Define campaigns.
2. Select a campaign. Note the values for Name and Campaign Code. These values come from the business object.
3. Go to RiSE > Business Object Designer.
4. Select the Campaign object.
5. Click Edit.
6. (Properties tab) Select the Name property.
7. (Properties tab > Display sub-tab) Change the Prompt for Field entry to the Campaign Name.
8. (Properties tab > Display sub-tab) Change the Description to the Campaign Description.
9. Click Save, and then Close.
10. Click Publish.
11. Click OK, and then Close.
12. Go to Community > Manage marketing campaigns > Define campaigns.
13. Select the campaign from Step 1. Note the values for Name and Campaign Code.

This example creates, builds, and publishes business objects for all user-defined tables set up in iMIS Customer Management. It edits one of the business objects, changing display set and prompt entries, and tests the new business object in IQA.

1. From the iMIS Desktop, go to Customers, select Set up module > General and click Additional Windows. The Customer Setup window appears.
2. Verify that the Defined Tables list contains the Name_Demo table. This table (included in the demo database) is used in this example.
3. Close the Customer Setup window.
4. From the Staff site, go to Settings > Utilities > User defined tables. The Auto-Generate Business Objects from User-Defined Tables window is displayed.
5. Click Build All. Wait for iMIS to generate business objects. The Build Results field will display a log of the business objects that were built, compiled, and published.
6. Verify that Name_Demo is listed in the Build Results field.
7. Go to RiSE > Business Object Designer.
8. Select the Name_Demo object.
9. Click Edit. The Name_Demo object is displayed.
10. (Properties tab) Verify that a Property Name value exists for each column in the Name_Demo table.
11. Add the ID, Spouse, and School_Attended properties to the object's display set. Change the displayed caption for School_Attended property:
Click for details
1. (Properties tab > Display sub-tab) In the Property Name area, select the row containing the ID property. The values shown in the Display sub-tab change to the defined display set values for the ID property.
2. (Properties tab) > (Definition sub-tab) select the Automatically Include in Queries? checkbox.
3. Repeat steps a through b for the Spouse and School_Attended properties.
4. (Definition tab) In the Default Display Property? List, select ID.
5. (Properties tab > Display sub-tab) For the School_Attended property, change the Prompt for Field value from School _Attended to Alma Mater.
12. Click Save and wait a moment for your changes to be saved to the business object.
13. Click Publish. A results window is displayed, listing any messages and errors.
14. Ensure that the business object published without errors. Click Close.

Note: Rerunning the Build All command in the Auto-Generate Business Objects from User-Defined Tables window will cause your changes to be overwritten and lost. The business objects for user-defined tables are recreated by that operation.

15. Go to RiSE > Intelligent Query Architect.
16. Select New > Query.
17. Create a new query named New Query.
18. (Sources tab) Click Add Source.
19. Select Name_Demo.
20. Click OK.
21. Click Save to save the query.
22. Click Run. The result set for the query is displayed. Notice that the three columns shown in the query result set match the three properties that you defined for the business object's display set.
23. Modify the query to return only those records that contain non-null values for either Alma Mater or Spouse. Creating an OR evaluation like this requires you to define two separate filter sets:
Click for details
1. Click Define.
2. (Filters tab) Select Advanced in the Mode drop-down list.
3. Select Spouse in the Property drop-down list.
4. Select Not Empty in the Comparison drop-down list.
5. Click the Add Line icon +. The filter is added to the filter set.
6. Click Add Filter. A new filter set is added below the first filter set.
7. Select Or in the drop-down list to the left of the Property column header.
8. Repeat steps c through e in the new filter set to add the Alma Mater property and specify a Not Empty comparison value.
24. Click Save to save the query.
25. Click Run. The result set for the query is displayed. Notice that the result set for the query now contains only those records that contain values for Alma Mater or Spouse.