Using Business Objects

everything within is driven by business objects creating business objects creating a business object from the configuration console, select build > business objects the application displays the business objects workspace from the right panel in the create an object pane, select new object the application displays the business object create new page choose an option stand alone business object a simple business object where you can define business object fields once created, you can extend it refer to creating a stand alone business object docid\ prrpnuvje8dmzc oaqymn group business object a business object that is the base for a group of related business objects it defines the properties which are common to the business objects in the group refer to creating a group business object docid\ prrpnuvje8dmzc oaqymn extension to group business object a business object that extends the properties and behavior of another business object you can add specific properties and business rules refer to creating an extension to existing business objects docid\ prrpnuvje8dmzc oaqymn materialized view business object a complex type of business object once created, you can set up to update data from different sources refer to creating a materialized view business object docid\ prrpnuvje8dmzc oaqymn creating a stand alone business object from the configuration console, select build > business objects the application displays the business objects workspace from the right panel in the create an object pane, select new object the application displays the business object create new page select stand alone business object the business object create new page appears under the details tab, enter information into the fields field description business object a unique name for this business object the name is stored in the database display name a unique display name for this business object this name appears to users in the application description a brief description of the purpose of the business object default form optional the default form for this business object choose from the drop down list you cannot set a default form until you have created at least one form for this business object refer to using forms docid 5dd6rlsb123v5tlqc9wfn default search optional the default saved search for this business object choose from the drop down list you cannot set a default saved search until you have created at least one saved search for this business object refer to creating a saved search docid\ vwinwjbf5brjccioresmm if there is already a default saved search for the business object for a role, that takes precedence over the value entered in this field for users logged in as that role contract memberships contracts we recommend that you do not use this option we will remove this option in a future release external object synchronization external defines if this is an external business object, which means that the data comes from an external application for more information about using external business objects, refer to using web services with external data sources docid\ pxnp3x0zsnymycwgcpxn9 this property is available only when you create the business object you cannot apply this property to an existing business object you cannot set an existing business object to external; instead, create a new business object synchronized (only shown if you checked external ) specifies if you can use a cached version of the data if you check this option, the application retains a cache of the external data and uses that if you do not check this option, the application always goes to the external application and uses that data external primary key (only shown if you checked external ) the primary key used by the external application you cannot specify this field when you originally create the external business object you first need to add the primary key field to the business object (refer to creating a field docid\ hadincbaizda7r5lyceuu ) and then come back to this page and set this value to the new field that you created when you create the field to be used as the external primary key, ensure that you check unique you can also create an index and use that as the external primary key refer to adding indexes docid\ wjo94k2x6emphr1cmtgo refresh interval (only shown if you checked synchronized ) the time, in minutes, after which the application tries to refresh the data from the external application this value must be less than or equal to the value of the time to live parameter on premise users can change the minimum and maximum values of this parameter by updating the web config file; however, the minimum value cannot be less than one minute time to live (only shown if you checked synchronized ) the time, in minutes, that the data has left before you must refresh the data if the data is older than this value, the application does not let you use it or save any business objects that use this data the application displays a message that the data is stale and you must refresh it usage qualifiers commonly used shows this business object on the business objects workspace under change control when working with a business object derived from the ci and frs cicomponents business objects, check to allow its configuration baseline attributes to be copied pure validation object specifies if this is a pure validation object, which indicates that the given business object is used primarily to drive the drop down fields in other business objects special purpose fields primary key uniquely identifies the definition record you must have one and only one primary key field per business object the field must contain a value (null is not allowed) the values must be unique the application automatically sets the primary key to recid refer to indexing business objects docid\ wjo94k2x6emphr1cmtgo for information about indexing display a field to show with this business object for example, you can select createdby to show in conjunction with the incident business object state the field to use for driving the lifecycle of the processes in the business object when the object is assigned a certain status, for example, certain business rules might be executed type selector the type selector choose a field from the drop down list to facilitate the extension of the business object you must select a field to permit a business object to extend transaction audit log audit create/update/delete events adds information from this business object to the audit log each time a business object record is created, modified, or deleted select save the application creates the business object, including the following default fields createdby createddatetime lastmodby lastmoddatetime lastsyncdatetime (only for external business objects) readonly recid to automatically create a workspace for this business object, select auto generate ui the application displays the name dialog box enter a name for the layout (or use the application generated name), then select ok a new form, list, and layout is created, as indicated by the corresponding tab labels to modify these, refer to using forms docid 5dd6rlsb123v5tlqc9wfn , working with lists docid 5sknnbwacog7kx6hee5ts , and using layouts docid\ fuvwvqr6w3d1sxqeogpyx select save business object tabs the following tabs are generated with this business object details the main page of the business object includes name, description, primary key identifier, and other basic information fields information about the types of fields stored in a business object refer to working with fields docid 0j8v1vxsnconit0dpqmtn relationships and named relationships when a business object must include information from another business object, create a relationship between the business objects refer to relationship types docid\ szcp qyw98hbg7iwleeu2 each relationship contains a parent business object (the center of the relationship) and a child object that assists a parent object by supplying it with additional data forms a graphical display used to present and capture field information one or many forms compose a record refer to using forms docid 5dd6rlsb123v5tlqc9wfn lists a tabular display for viewing multiple records at once columns represent the fields for each record refer to working with lists docid 5sknnbwacog7kx6hee5ts layouts a collection of forms, tabs, lists, and controls that displays a parent record and its child records the parent record displays as a form with its child records usually displayed as a series of tabs refer to using layouts docid\ fuvwvqr6w3d1sxqeogpyx business rules governs events based on user input forms business rules define triggering events, actions triggered by an event, and characteristics of user input forms pertaining to the business object refer to using business rules docid\ a5ujt2tbpnhh zdyrll2w workflows workflows organize one or more business processes (sets of activities that perform a specific task) and are triggered by a user action, a time based event, or additional business process refer to using workflows docid\ p4kb1hcf81wnxmoqhbcjs search defines how search results from a link field selector are displayed sets up advanced search fields for users to search refer to configuring search settings docid 5kwxiv6vha rq7b fqtra erd an entity relationship diagram refer to using an entity relationship diagram (erd) docid\ veyldxytfk0do cr8opwl saved searches lists the saved searches associated with this business object refer to using a saved search docid\ vwinwjbf5brjccioresmm quick actions opens the quick action center and lists the quick actions associated with this business object refer to using quick actions docid\ qc7s yrfjjgp1ybk v 1s templates lists the quick action templates associated with this business object pick lists lists the pick lists associated with this business object refer to accessing a pick list docid\ m0dqgjwohw5tbwrbrjumj roles lists the roles associated with this business object refer to working with roles docid\ rw3tvl9kqwmniw3mxhalp indexes displays the indexes refer to indexing business objects docid\ wjo94k2x6emphr1cmtgo audit store changes made to the records in this business object the audit history for an individual record is then displayed as a tab refer to accessing the audit history docid\ suej5xmlyduoz68lbfgae permissions creating a group business object a group business object consists of an abstract base type and one or more derived types a configuration item is one example of a group business object type the configuration item group subtypes, such as workstations, servers, printers, and so on, derive fields and relationships from the configuration item base type this allows you, for example, to use a search to gather information about all the derived business objects and display them in a list or on a dashboard for example, printer, workstation, server, and so on are all separate business objects without connecting these different business objects under a group, you cannot search across, or list these business objects together connecting them to the group business object as derived business objects allows you to do this in past releases it was sometimes possible to use abstract base type in business logic, without defining any derived types beginning with release 2016 1, this is no longer allowed from the configuration console, select build > business objects the application displays the business objects workspace from the right panel in the create an object pane, select new object the application displays the business object create new page select group business object the application displays the business object create new page under the details tab, enter information into the fields field description business object a unique name for this business object the name is stored in the database display name a unique display name for this business object this name appears to users in the application description a brief description of the purpose of the business object default form optional the default form for this business object choose from the drop down list you cannot set a default form until you have created at least one form for this business object refer to using forms docid 5dd6rlsb123v5tlqc9wfn default search optional the default saved search for this business object choose from the drop down list you cannot set a default saved search until you have created at least one saved search for this business object refer to creating a saved search docid\ vwinwjbf5brjccioresmm if there is already a default saved search for the business object for a role, that takes precedence over the value entered in this field for users logged in as that role external object synchronization external defines if this is an external business object, which means that the data comes from an external application for more information about using external business objects, refer to using web services with external data sources docid\ pxnp3x0zsnymycwgcpxn9 note you can only apply this property when you originally create the business object you cannot apply this property to an existing business object you cannot set an existing business object to external; instead, you have to create a new business object therefore you do not refer to this section when viewing or editing a business object; only when creating it external primary key (only shown if you checked external ) the primary key used by the external application you cannot specify this field when you originally create the external business object you first need to add the primary key field to the business object (refer to creating a field docid\ hadincbaizda7r5lyceuu ) and then come back to this page and set this value to the new field that you created when you create the field to be used as the external primary key, ensure that you check unique you can also create an index and use that as the external primary key refer to adding indexes docid\ wjo94k2x6emphr1cmtgo synchronized (only shown if you checked external ) specifies if you can use a cached version of the data if you check this option, the application retains a cache of the external data and uses that if you do not check this option, the application always goes to the external application and uses that data refresh interval (only shown if you checked synchronized ) the time, in minutes, after which the application tries to refresh the data from the external application this value must be less than or equal to the value of the time to live parameter on premise users can change the minimum and maximum values of this parameter by updating the web config file; however, the minimum value cannot be less than one minute time to live (only shown if you checked synchronized ) the time, in minutes, that the data has left before you must refresh the data if the data is older than this value, the application does not let you use it or save any business objects that use this data the application displays a message that the data is stale and you must refresh it usage qualifiers commonly used shows this business object on the business objects workspace under change control when working with a business object derived from the ci and frs cicomponents business objects, check to allow its configuration baseline attributes to be copied special purpose fields primary key the application automatically sets the primary key to recid refer to indexing business objects docid\ wjo94k2x6emphr1cmtgo for information about indexing display a field to show with this business object for example, you can select createdby to show in conjunction with the incident business object state the field to use for driving the lifecycle of the processes in the business object when the object is assigned a certain status, for example, certain business rules might be executed type selector created automatically based on the business object the type selector field is only shown for the group base and group member business objects transaction audit log audit create/update/delete events adds information from this business object to the audit log each time a business object record is created, modified, or deleted select save the application creates the business object, including the following default fields visible on the fields tab createdby createddatetime lastmodby lastmoddatetime newbusinessobjecttype readonly recid to automatically create a workspace for this business object, select auto generate ui the name window appears enter a name for the layout (or use the application generated name), then select ok a new form, list, and layout is created, as indicated by the corresponding tab labels to modify these, refer to using forms docid 5dd6rlsb123v5tlqc9wfn , working with lists docid 5sknnbwacog7kx6hee5ts , and using layouts docid\ fuvwvqr6w3d1sxqeogpyx select save business object tabs the following tabs are generated with this business object details the main page of the business object includes name, description, primary key identifier, and other basic information fields information about the types of fields stored in a business object refer to working with fields docid 0j8v1vxsnconit0dpqmtn relationships when a business object must include information from another business object, create a relationship between the business objects refer to relationship types docid\ szcp qyw98hbg7iwleeu2 each relationship contains a parent business object (the center of the relationship) and a child object that assists a parent object by supplying it with additional data forms a graphical display used to present and capture field information one or many forms compose a record refer to using forms docid 5dd6rlsb123v5tlqc9wfn lists a tabular display for viewing multiple records at once columns represent the fields for each record refer to working with lists docid 5sknnbwacog7kx6hee5ts layouts a collection of forms, tabs, lists, and controls that displays a parent record and its child records the parent record displays as a form with its child records usually displayed as a series of tabs refer to using layouts docid\ fuvwvqr6w3d1sxqeogpyx business rules governs events based on user input forms business rules define triggering events, actions triggered by an event, and characteristics of user input forms pertaining to the business object refer to using business rules docid\ a5ujt2tbpnhh zdyrll2w workflows workflows organize one or more business processes (sets of activities that perform a specific task) and are triggered by a user action, a time based event, or additional business process refer to using workflows docid\ p4kb1hcf81wnxmoqhbcjs search defines how search results from a link field selector are displayed sets up advanced search fields for users to search refer to configuring search settings docid 5kwxiv6vha rq7b fqtra erd an entity relationship diagram refer to using an entity relationship diagram (erd) docid\ veyldxytfk0do cr8opwl saved searches lists the saved searches associated with this business object refer to using a saved search docid\ vwinwjbf5brjccioresmm quick actions opens the quick action center and lists the quick actions associated with this business object refer to using quick actions docid\ qc7s yrfjjgp1ybk v 1s templates lists the quick action templates associated with this business object pick lists lists the pick lists associated with this business object refer to accessing a pick list docid\ m0dqgjwohw5tbwrbrjumj roles lists the roles associated with this business object refer to working with roles docid\ rw3tvl9kqwmniw3mxhalp indexes displays the indexes refer to indexing business objects docid\ wjo94k2x6emphr1cmtgo audit store changes made to the records in this business object the audit history for an individual record is then displayed as a tab refer to accessing the audit history docid\ suej5xmlyduoz68lbfgae permissions creating an extension to existing business objects creating an extension to a single business object you can embed a single business object into a parent business object for example, the group business object called task contains a set of common fields (business properties), such as estimatedeffort actualstartdate emailaddress however, you can create one or more extensions of task , extended business objects that are member business objects the base business object ( task ) has its business properties extended into these business objects without recreating the fields separately for each extended business object the extended business objects can then gather more specific information, such as task assignment contains fields such as plannedcost, assignmentid, and assigneremail task workorder contains fields such as actualcost, estimatedcost, and workorderid an extended business object (such as task workorder ) can be a member of a business object group creating an extension to a group business object from the configuration console, select build > business objects the application displays the business objects workspace from the right panel in the create an object pane, select new object the application displays the business object create new page select extension to group business object the create extension page appears from the list, choose the business object to extend the details page for the business object appears, showing the parent business object link select the link to review the parent business object properties enter information into the fields field description extension to the parent business object name automatically generated by the application suffix name a name for the member business object, relative to the group object display name the default display name (objectname suffixname) automatically generated by the application description describes the business object default form optional the default form for this business object choose from the drop down list you cannot set a default form until you have created at least one form for this business object refer to using forms docid 5dd6rlsb123v5tlqc9wfn default search optional the default saved search for this business object choose from the drop down list you cannot set a default saved search until you have created at least one saved search for this business object refer to creating a saved search docid\ vwinwjbf5brjccioresmm if there is already a default saved search for the business object for a role, that takes precedence over the value entered in this field for users logged in as that role usage qualifiers commonly used shows the business object in the common objects area of the main business objects page under change control when working with a business object derived from the ci and frs cicomponents business objects, select the option to allow its configuration baseline attributes to be copied pure validation object specifies if this is a pure validation object, which indicates that the given business object is used primarily to drive the drop down fields in other business objects special purpose fields primary key the primary key display the display name with this business object for example, you could select incidentnumber to be displayed in conjunction with the incident business object state drives the lifecycle of the processes in the business object when the business object is assigned a certain status, for example, certain business rules might be executed type selector facilitates the extension of the business object you must select a field to permit a business object to be extended transaction audit log audit creates/ update/ deletes adds information from this business object to the audit log each time a business object record is created, modified, or deleted select save creates the business object and generates the fields refer to business object tabs docid\ prrpnuvje8dmzc oaqymn creating a materialized view business object this business object type is used for establishing a universal worklist refer to working with a universal worklist docid\ e3bsa6q7b49crcw6yszdh for information about how to use this feature from the configuration console, select build > business objects the application displays the business objects workspace from the right panel in the create an object pane, select new object the application displays the business object create new page select materialized view business object the new business object page appears enter information into the fields field description business object a unique name for this business object the name is stored in the database display name a unique display name for this business object this name appears to users in the application description a brief description of the purpose of the business object select save creates the business object and the tabs appear this defines the structure into which you copy data automatically generates application fields for this business object, but in reality you will probably not use them from the view fields tab, select add fields from the import fields window appears enter information into the fields field description from child tenant gets data from the child tenant this enables the next field if not checked, you can only get data from the parent tenant tenant the child tenant choose from the drop down list these are defined in the child tenant workspace refer to creating a child tenant docid\ e3bsa6q7b49crcw6yszdh business object the business object whose fields to import and map the fields are listed, but only the physical fields are selected calculated and boolean fields are grayed out to select all valid fields, check select all fields select import the fields are created for the new business object and appear in the field list to add fields from another tenant, select add fields from and repeat the process only creates unique fields; duplicate fields are automatically ignored select save the view fields are created this might take a couple of minutes, depending on how many fields are added viewing parts for a materialized view business object this tab lists any view parts for the materialized view business object you can create multiple view parts from a single tenant from the view part tab, select add new\ the new part page appears enter information into the fields field description view part name a unique name for the view part from child tenant gets data from the child tenant this enables the next field if not checked, you can only get data from the parent tenant tenant the child tenant select from the drop down list these are defined in the child tenant workspace refer to creating a child tenant docid\ e3bsa6q7b49crcw6yszdh business object the related business object enter part of the name and a list of business objects appears in the list the fields are mapped automatically if the part field name matches the tenant field name map the fields if needed select save return to the view parts page your new part appears in the list under the actions column, select build the source data is compiled and ready to use the following actions are now available action description synchronize retrieves any updated data deactivate removes this object from the synchronization process destroy removes all traces of the part from user computers delete removes all field mapping modifying business objects modifying a business object use caution when modifying a business object changing business objects that have been linked to other business objects or that are required in a workflow can cause unexpected results and prevent your application from running correctly we recommend that you only modify business objects that you have created modifying a business object with soft lock soft lock indicates that a metadata component has restricted editing permissions such components are marked with a yellow pencil icon when you hover the mouse pointer over the icon, a tooltip appears with the message edit with restrictions this feature applies only to fields , forms , and lists tabs that are locked and do not have edit permissions in business objects these properties are considered safe for customer customization the future product enhancement releases will not overwrite these modified properties the editable properties appear in bright text, while locked properties are shown in greyed out text you can modify the following properties in the fields , forms , and lists tabs even though it is locked and you and do not have edit permissions fields tab to modify the properties go to configuration console > business object > select any soft locked business object open the fields tab you can modify the following editable properties display name description text length field attributes searched audited full text indexed clearing the audited checkbox deletes all existing audit history to retain this data, back up the audit history before disabling the audit flag forms tab to modify the properties go to configuration console > business object > select any soft locked business object open forms tab you can modify the following editable property label lists tab to modify the properties go to configuration console > business object > select any soft locked business object open lists tab you can modify the following editable property title deleting a business object you cannot delete default business objects; you can only delete business objects that you have created use caution when deleting a business object as you might inadvertently affect a workflow or relationship with another object from the configuration console, select build > business objects the application displays the business objects workspace select view all to refer to a list of objects the objects you can delete appear without a lock in front of the name and with a delete icon enabled for the business object to delete, select the delete icon the delete confirmation window appears select yes the business object no longer appears on the list auditing a business object you can view the history of a specific business object from the audit tab this is in addition to the transaction audit log refer to about the transaction audit log docid\ hnp3zomj8nr9 ts12pjwn you can filter which items appear on the list filter description author the name of the author choose from the drop down list min date the earliest date to search operation the audit operation select from the drop down list all insert update delete max date the latest date to search type the type select from the drop down list select search after setting your filter settings select reset to clear all the filter fields and list all of the audit items using custom tabs and plugins about plugins you can add a custom tab to certain business objects using plugins plugins are ways to extend and add to the functionality that already exists in the business objects plugins are available for the following business objects plugin name use with this business object release schedule release service request parameters service request change schedule change risk level change baseline comparison ci gantt chart multiple adding a custom tab to add a custom tab to a business object from the configuration console, select build > business objects the application displays the business objects workspace select on the release , service request , or change business object this example uses the change business object select the layouts tab select the name of a layout associated with the selected business object in the views in this layout section, select formview the form view editor \[formview] workspace displays select add custom child panel in the display name column, enter a name for the new tab in the object column, select a plugin from the drop down list select save return to the application and refresh the browser verify that the new custom tab displays adding a custom tab using try our new look you can also add a custom tab using try our new look follow these steps to add a custom tab from the configuration console, select build > business objects the application displays the business objects workspace open the release , service request , or change business object this example uses the change business object select the layouts tab open a layout in the views in this layout section, select formview the application displays the form view editor \[formview] page select try our new look! on the left side under toolbox , expand plugins to show the available plugins associated with the selected business object the change business object includes change schedule and risk level select a plugin and drag and drop it to the right pane to make it a subtab you can make the subtab closable by following the steps in making a tab closable docid\ prrpnuvje8dmzc oaqymn select save return to the application and refresh the browser open the business object and open an item to verify that the your selections display in the subtab area making a tab closable you can make child and custom panels closable or non closable if you can close a child or custom panel, the application displays a delete icon to the right of the name when you mouse over the delete icon , it changes to red indicating it is enabled the tab status remains in the same state during navigation refer to the note at the end of this section follow these steps to make a custom tab closable from the configuration console, select build > business objects the application displays the business objects workspace open a business object select the layouts tab open a layout in the views in this layout section, select formview in the display name column under the child panels section locate the tab to make closeable on the right side, check the box in the closable column select save return to the application and refresh the browser select the name of the business object that you selected in step 2 to display the business object workspace open a record the tab you selected in step 6 now includes a delete icon the delete icon only shows on this tab for the current business object if you close this tab for this business object and then open another business object, the application displays the tab for the new business object even though you previously closed the tab for the original business object deleting a custom tab you can delete a custom tab from a business object by following these steps from the configuration console, select build > business objects the application displays the business objects workspace open a business object select the layouts tab open a layout in the views in this layout section, select formview in the display name column, highlight the child panel to delete and select the delete icon select save return to the application and refresh the browser verify that the custom tab that you selected is removed