Service Agreement Workbench
User stories
A user story is a short, simple statement that describes a specific action or goal that a user wants to achieve using a product or service. This is a brief description of how Service Agreement Workbench supports a user working as a service agreement administrator.
Agreement administrator
Goals:- Ensure that agreement data is up to date and accurate.
- Create, maintain, update, and invoice agreements.
- Ensure that performed services are in accordance with agreement specifications.
- Analyze potential risks involved with specific contract terms.
- Communicate findings to key stakeholders.
- Produce accurate reports for agreement customers.
- Spends most of the time on the computer in the office.
- Occasionally works from home on a laptop.
- Mostly uses Infor M3 BE.
- In the morning, checks the homepage and emails for alerts about needed agreement updates.
- Monitors and maintains alerted agreements.
- Informs involved parties about updates.
- Monitors and performs agreement invoicing.
- Sometimes gets a text from the agreement manager about a last-minute rate change and pushes out the requested change remotely from home.
- Data accuracy due to manual updates.
- Too many last-minute updates.
- Hard to get the full picture of agreement performance due data in many different places.
- Work is often reactive instead of proactive.
M3 Business Engine configuration
- Add service agreements in (COS410) and related tables.
- These 'Information Browser Category. Open' (CMS010) records are
used by the API LISTMI transactions and must be in place:
- M3SERVAGR_01
- M3SERVAGR_02
- M3SERVAGR_03
- M3SERVAGR_04
- M3SERVAGR_05
- M3SERVAGR_06
- M3SERVAGR_07
- Enable functional search for maintenance agreements ((COS410), table ACUAGH), maintenance customer orders ('Maintenance Customer Orders. Open' (COS100), table ACUORH), and work orders ('Work Order. Open' (MOS100), table MMOHED).
- The IDM links in the components are based on the specific IDM configuration. The IDM links require checking or re-configuring in each new environment that the Service Agreement Workbench application is installed in.
- You must configure printer file COS436PF to be able to tag the correct agreement
printout to the agreement selected in the application. Go to 'XML Structure.
Open' (CMS006/G) and add these attribute IDs: set 'Agreement' to MDS_id1,
'Start date' to MDS_id2, and 'Printer file' to MDS_id3. COS436PF belongs to 'Document type' MDS_GenericDocument in this setup. Check the setup in IDM -> Control Center -> Administration -> Document Type -> Document. This is the document type where MDS_GenericDocument and behind the tab 'Attributes' id1-id3 are found.Note:COS436PF is a report and not a document. This means that you can print COS436PF for several agreement numbers at a time, and therefore one printout is tagged to several agreement numbers.
For more details regarding specific configuration per component, see the section Components.
Application authorization
To access and run the Experience Designer application, you must be authorized to the M3 Business Engine functions and API transactions used by the application. These are the functions and transactions that are used by the Service Agreement Workbench application.
This table shows the functions and transactions used by Service Agreement Workbench.
| Function or API | Transaction | Information category | View |
|---|---|---|---|
| AEMAPIMI | GetEquip | ||
| AEMAPIMI | LstFault | ||
| AEMAPIMI | LstLoc | ||
| AEMAPIMI | LstMeterReading | ||
| AEMAPIMI | LstSwitch | ||
| COS100MI | LstMCOLines | ||
| COS100MI | SearchHead | ||
| COS350MI | LstInvHead | ||
| COS350MI | LstInvLine | ||
| COS403MI | LstAgrSite | ||
| COS410MI | AddAgreement | ||
| COS410MI | GetAgreement | ||
| COS410MI | LstAgrCharges | ||
| COS410MI | LstAgreement | ||
| COS410MI | LstAgrLines | ||
| COS410MI | Search | ||
| COS410MI | UpdAgreement | ||
| COS413MI | LstAgrModel | ||
| COS421MI | Lst | ||
| COS427MI | Lst | ||
| COS433MI | LstAgrSiteEq | ||
| CRS610MI | GetBasicData | ||
| EQINFOMI | SelServiceHist | ||
| EQINFOMI | SelWorkRequest | ||
| LISTMI | M3SERVAGR_03 | STD01-01 | |
| LISTMI | M3SERVAGR_01 | STD01-01 | |
| LISTMI | M3SERVAGR_04 | STD20-01 | |
| LISTMI | M3SERVAGR_05 | STD17-00 | |
| LISTMI | M3SERVAGR_06 | STD01-01 | |
| LISTMI | M3SERVAGR_07 | STD01-01 | |
| LISTMI | M3SERVAGR_02 | STD80-01 | |
| MOS100MI | SearchWo |
Limitations
- This application only works for maintenance service agreements added in (COS410).
- If an M3 BE function has an API to add, change, or delete, you can add those functions in related components. In this application you can do this only for some components and use it as examples when or if you want to further develop the functions of the application. The same applies to bookmarks and M3 Automation.
- When using a bookmark link or an M3 Automation link, you must press 'Previous/F12' to go back to the Experience Designer Application.
Components
This table shows specific configuration per component:
| Component | Component details |
|---|---|
| Index List |
Purpose: Search for and list service agreements. M3 BE data used: 'Maint Agrmnt. Open' (COS410). Comment: The agreements that are shown are related to the user's logged on company number ({userContext.CONO}) and sorted by agreement number. Filter by facility to get the same number of agreements as in (COS410). Component ID: IndexList_Agreement Data services used: Search_ServiceAgreements Functional search: ACUAGH |
| Application Header |
Purpose: Application header. Comment: Includes button to create a new service agreement using COS410MI/AddAgreement. Component ID: Header_ServiceAgreementDetails |
| Button/Create Service Agreement |
Purpose: Create a new service agreement. M3 BE data used: 'Maint Agrmnt. Open' (COS410). Comment: SimpleDialog_CreateNewServiceAgreement Component ID: Header_ServiceAgreementDetails Data services used: Add_ServiceAgreementHeader |
| Application Header Details |
Purpose: Show general details about service agreement. M3 BE data used: 'Maint Agrmnt. Open' (COS410). Comment: A placeholder for customer logo is kept to the left of the customer number. Configuration: Add valid IDM link to the customer number logo in the 'Image' header in the component. Component ID: Header_ServiceAgreement Data services used: Get_ServiceAgreement |
| Overview/Basic Information |
Purpose: Show and change important agreement information. M3 BE data used: 'Maint Agrmnt. Open' (COS410/H). Comment: Buttons to change and refresh data. Component ID: Form_ServiceAgreementBasicInformation Data services used: Get_ServiceAgreement and Update_ServiceAgreement |
| Overview/Agreement ToDos |
Purpose: Get an overview of agreement activities including the date when they must be performed. M3 BE data used: 'Maintenance Agreement. Monitor' (COS432). Comment: Open (COS432) and add activities to the agreement number to view it in the application. Add the 'Reason code name' (AMTX15) field in 'Data Grid Configuration' -> Columns -> Add to see the reason code name in the data grid. Component ID: DataGrid_ServiceAgreementToDo Data services used: List_AgreementToDos |
| Overview/Agreement Document |
Purpose: View the printed agreement report COS436PF. M3 BE data used: COS436PF stored in IDM. Comment: Note that COS436PF is a report and not a document. You can print this printout for several agreement numbers at the same time (done through a selection table in 'Maintenance Agreement. Print' (COS435)), and therefore one COS436PF printout is tagged against several agreement numbers. Configuration: You must configure COS436PF to be able to tag the correct agreement printout to the agreement selected in the application. Go to (CMS006/G) and add these attribute IDs; set 'Agreement' to MDS_id1, 'Start date' to MDS_id2, and 'Printer file' to MDS_id3. COS436PF belongs to 'Document type' MDS_GenericDocument. Check the set up in IDM -> Control Center -> Administration -> Document Type -> Document. This is the document type where MDS_GenericDocument and behind the tab 'Attributes' id1-id3 are found. Component ID: Media_AgreementDocument |
| Overview/Connected Equipment |
Purpose: View equipment that is covered by the agreement. M3 BE data used: 'Maint Agrmt. Connect Model Individual' (COS413/B). Comment: Note that you can connect equipment in 'Maint Agrmt. Connect Objects' (COS412) as well. If you do this, the data service has to be changed and use another API to show that information. Component ID: DataGrid_ConnectedEquipment Data services used: List_ConnectedModels |
| Overview/Connected Equipment/Periodic Service Schedule/WO Proposals |
Purpose: View WO proposals related to a specific equipment included in the agreement. M3 BE data used: 'Work Request. Open' (MOS170). Comment: Select equipment in the component 'Connected Equipment' to activate. Currently shows all service proposals connected to the selected equipment, not just related to the selected service agreement. Component ID: DataGrid_WOProposals Data services used: Select_WO_Request |
| Overview/Connected Equipment/Service History/Performed Service |
Purpose: View service history related to a specific equipment covered in the agreement. M3 BE data used: 'Equipment. Open Service History' (MOS180). Comment: Select equipment in the component 'Connected Equipment' to activate. Component ID: DataGrid_ListServiceHistory Data services used: List_ServiceHistory |
| Overview/Connected Equipment/IoT Equipment/IoT Equipment Set Up |
Purpose: View if the equipment is communicating through IoT. M3 BE data used: Data stored in table AEMEQI. No H5 UI, only possible to add or view data through API AEMAPIMI. Comment: Select equipment in the component 'Connected Equipment' to activate. Component ID: DataGrid_IoTEquipment Data services used: Get_IoTEquipment |
|
Overview/Connected Equipment/IoT Messages/ Incoming Messages |
Purpose: View IoT-messages sent to M3BE by the equipment. M3 BE data used: Data in table AEMERR. No H5 UI, only possible to add or view data through API AEMAPIMI. Comment: Select equipment in the component 'Connected Equipment' to activate. Component ID: DataGrid_IoTMessages Data services used: List_IoTIncomingMessage |
|
Overview/Connected Equipment/IoT Meter Readings/ Incoming Readings |
Purpose: View IoT meter readings sent to M3BE by the equipment. M3 BE data used: Data in table AEMMES. No H5 UI, only possible to add or view data through API AEMAPIMI. Comment: Select equipment in the component 'Connected Equipment' to activate. Component ID: DataGrid_IoTMeterReadings Data services used: List_IoTMeterReadings |
| Overview/Connected Equipment/IoT Locations/Equipment Location | Purpose: View IoT location sent to M3BE by the equipment. M3 BE data used: Data in table AEMMES. No H5 UI, only possible to add or view data through API AEMAPIMI.Comment: Select equipment in the component 'Connected Equipment' to activate. Component ID: DataGrid_IoTLocation Data services used: List_IOTLocation |
| Overview/Connected Equipment/IoT Switch/Switch on/off | Purpose: View if a specific IoT switch is on or off. M3 BE data used: Data in table AEMMES. No H5 UI, only possible to add or view data through API AEMAPIMI.Comment: Select equipment in the component 'Connected Equipment' to activate. Component ID: DataGrid_IoTSwitch Data services used: List_IoTSwitch |
| Terms/Pricing Conditions/Service Pricing |
Purpose: View service pricing conditions. M3 BE data used: 'Maint Agrmnt. Open Lines' (COS411). Comment: Button 'Agreement Lines' opens (COS411). Component ID: DataGrid_ServicePricing Data services used: List_AgreementLines |
| Terms/Pricing Conditions/Material Pricing |
Purpose: View and update material pricing conditions. M3 BE data used: 'Maint Agrmnt. Open' (COS410/G). Comment: You can change and save data. Component ID: Form_MaterialPricing Data services used: Get_AgreementData and Update_ServiceAgreement |
| Terms/Pricing Conditions/Invoice Split |
Purpose: View related invoice split lines. M3 BE data used: 'Maint Agrmnt. Connect Payers' (COS427). Comment: Select a line in the component 'Service Pricing' to activate. Component ID: DataGrid_InvoiceSplit Data services used: List_InvoiceSplit |
| Terms/Charges/Agreement Header Charges |
Purpose: View agreement header charges. M3 BE data used: 'Maintenance Agreement. Connect Charge' (COS416). Comment: Button 'Agreement Charges' opens (COS416). Component ID: DataGrid_AgreementHeaderCharges Data services used: List_AgreementHeaderCharges |
| Terms/Included & Excluded |
Purpose: View agreement content. M3 BE data used: 'Agreement Contents' (COS421). Component ID: DataGrid_AgreementIncluded&Excluded Data services used: List_AgreementContent |
| Agreement Invoicing/Basic Data & Price Information/Agreement Site |
Purpose: View agreement site information. M3 BE data used: 'Agreement Site. Open' (COS403). Component ID: DataGrid_AgreementSite Data services used: List_AgreementSite |
| Agreement Invoicing/Basic Data & Price Information/Agreement Invoice Lines |
Purpose: View equipment and prices included in agreement periodic invoicing. M3 BE data used: 'Maintenance Agreement Equipment. Open' (COS433). Comment: Select a line in the component 'Agreement Site' to activate. Component ID: DataGrid_AgreementInvoiceLines Data services used: List_AgreementInvoiceLines |
| Agreement Invoicing/Basic Data & Price Information/Agreement Index |
Purpose: View index related updates that are valid for the periodic agreement invoice lines. M3 BE data used: 'Maint Agreement Equipment Index. Open' (COS434). Comment: Select a line in the component 'Agreement Site' to activate. Component ID: DataGrid_AgreementIndex Data services used: List_MaintenanceAgreementEqIndex |
| Agreement Invoicing/Manage Agreement Invoice/Agreement Invoice Rounds |
Purpose: View agreement invoice rounds ready to be created, reviewed, reset, invoiced, or approved. M3 BE data used: 'Invoicing Round. Browse' (COS615). Comment: M3 Automation button 'Agr Invoice Generate MCO' takes you to 'Agreement Invoicing. Create MCOs' (COS610/E) to create a new agreement MCO for invoicing. This is the same as highlighting the line in (COS615) and selecting related option 11-'Agreement invoicing create MCO'. M3 Automation button 'Invoice Round Reset' takes you to 'Invoicing Round. Reset' (COS620/E) to reset the agreement MCO for invoicing. This is the same as highlighting the line in (COS615) and selecting related option 14-'Invoicing round reset'. M3 Automation button 'Approve for invoicing' is the same as highlighting the line in (COS615) and selecting related option 24-'Approve for invoicing'. If 'Periodic invoice order type' on (COS410/F) has next manual function 6, it requires approval before you can invoice the agreement MCO. M3 Automation button 'Create Service Agreement Invoice' takes you to 'Maint Invoice. Print' (COS180/E) to invoice the agreement MCO. This is the same as highlighting the line in (COS615) and selecting related option 15-'Maintenance invoice print'. Button to refresh the grid if data has been updated. Component ID: DataGrid_AgreementInvoiceRounds Data services used: List_AgreementInvoiceRound |
| Agreement Invoicing/Manage Agreement Invoice/Agreement Invoice Round Lines |
Purpose: View agreement MCO lines to be invoiced. M3 BE data used: 'Maintenance CO. Open Toolbox' (COS280) and 'Maintenance CO Line. Open Toolbox' (COS281). Comment: Sequential API call is used in the data service to first retrieve MCO header and then view related MCO lines. Component ID: DataGrid_AgreementInvoiceRoundLines Data services used: List_AgreementInvoiceRoundLines |
| Agreement Invoicing/View, Credit & Print Invoice Copy/View Invoice Headers |
Purpose: View invoice headers. M3 BE data used: 'Agreement Profitability Summary. Display' (COS439). Comment: Currently showing invoice headers based on agreement profitability functionality (COS439) since the agreement number (AAGN) is missing in invoice headers. Button 'Credit Agreement Invoice' opens 'Maint Invoice. Print Credit' (COS370/E). This is the same as highlighting the invoice line in 'Maint Invoice. Display' (COS350) and selecting related option 13-'Credit invoice'. Button 'Print Invoice Copy' opens 'Maintenance Invoice. Print Copy' (COS680/E). This is the same as highlighting the invoice line in (COS350) and selecting related option 14-'Print invoice copy'. Component ID: DataGrid_ViewInvoiceHeaders Data services used: List_AgreementProfitability |
| Agreement Invoicing/View, Credit & Print Invoice Copy/Invoice Preview |
Purpose: View service agreement invoices. M3 BE data used: COS184PF stored in IDM. Component ID: Media_InvoicePreview |
| Agreement Invoicing/View, Credit & Print Invoice Copy/Related Invoice Lines |
Purpose: View invoice lines. M3 BE data used: 'Maint Invoice. Display Lines' (COS351). Comment: API COS350MI/LstInvLine has to have something in the 'IVNO' field. Currently hardcoded to '1234', the actual invoice number sent in the 'EXIN' field. Component ID: DataGrid_RelatedInvoiceLines Data services used: List_InvoiceLineNo2 |
| Profitability/Agreement Profitability |
Purpose: List agreement profitability. M3 BE data used: 'Agreement Profitability Summary. Display' (COS439). Comment: Sum showed by period. Component ID: DataGrid_AgreementProfitability Data services used: List_AgreementProfitability |
| Profitability/Agreement Profitability: Revenue |
Purpose: Chart showing agreement revenue. M3 BE data used: 'Agreement Profitability Summary. Display' (COS439). Comment: Currently the chart component only shows one value, therefore revenue and cost are shown in separate charts. Component ID: Chart_AgreementProfitabilityRevenue Data services used: List_AgreementProfitability |
| Profitability/ Agreement Profitability: Cost |
Purpose: Chart showing cost related to selected agreement. M3 BE data used: 'Agreement Profitability Summary. Display' (COS439). Comment: Currently the chart component only shows one value, therefore revenue and cost are shown in separate charts. Component ID: Chart_AgreemntProfitabilityCost Data services used: List_AgreementProfitability |
| Profitability/Invoice Headers |
Purpose: Show related invoice headers. M3 BE data used: 'Maint Invoice. Display' (COS350). Comment: Select a line in the component 'Agreement Profitability' to activate. Component ID: DataGrid_InvoiceHeaders Data services used: List_InvoiceHeaders |
| Profitability/Invoice Lines |
Purpose: View related invoice lines. M3 BE data used: 'Maint Invoice. Display Lines' (COS351). Comment: Select a line in the component 'Invoice Headers' to activate. Component ID: DataGrid_ListInvoiceLines Data services used: List_InvoiceLine |
| Profitability/Invoice Lines |
Purpose: View service agreement invoices. M3 BE data used: COS184PF stored in IDM. Comment: Select a line in the component 'Agreement Profitability' to activate. Component ID: Media_InvoicePreview |
| Orders/Open MCOs/List Open MCO Headers |
Purpose: View open MCOs related to the service agreement. M3 BE data used: 'Maintenance Customer Orders. Open' (COS100). Comment: Lists open MCO headers. Queries lowest status (AOSL) between 00 to 69. Component ID: DataGrid_ListOpenMCOHeaders Data services used: List_OpenMCOHeaders Functional search: ACUORH |
| Orders/Open MCOs/List Open MCO Lines |
Purpose: View open MCO lines related to the agreement. M3 BE data used: 'Maintenance Customer Orders. Open Line' (COS101). Comment: Select an MCO header in the component 'List Open MCO Headers' to activate. Component ID: DataGrid_ListOpenMCOLines Data services used: List_OpenMCOLines |
| Orders/Open MCOs/List Related Open Work Orders |
Purpose: View WOs related to the MCO header. M3 BE data used: 'Work Order. Open' (MOS100). Component ID: DataGrid_ListOpenWOs Data services used: List_WOOpenHeadersPerMCONo Functional search: MMOHED |
| Orders/Open MCOs/Service Report |
Purpose: View service reports connected to the service agreement MCOs. M3 BE data used: MOS059PF stored in IDM. Comment: Note that the link is connected to the document type 'M3_WorkOrderDocument'. Component ID: Media_ServiceReport |
| Orders/Closed MCOs/List Closed MCO Headers |
Purpose: View closed MCOs related to the service agreement. M3 BE data used: 'Maintenance Customer Orders. Open' (COS100). Comment: Lists closed MCO headers. Queries lowest status (AOSL) equal to 70. Component ID: DataGrid_ListClosedMCOHeaders Data services used: List_ClosedMCOHeaders Functional search: ACUORH |
| Orders/Closed MCOs/List MCO Lines |
Purpose: View closed MCO lines related to the agreement. M3 BE data used: 'Maintenance Customer Orders. Open Line' (COS101). Comment: Select an MCO header in the component 'List Closed MCO Headers' to activate. Component ID: DataGrid_ListClosedMCOLines Data services used: List_ClosedMCOLines |
| Orders/Open MCOs/List Related Closed Work Orders |
Purpose: View WOs related to the MCO header. M3 BE data used: 'Work Order. Open' (MOS100). Component ID: DataGrid_ListClosedWOs Data services used: List_WOOpenHeadersPerMCONo Functional search: MMOHED |
| Orders/Closed MCOs/Service Report |
Purpose: View service reports connected to the service agreement MCOs. M3 BE data used: MOS059PF stored in IDM. Comment: Note that the link is connected to the document type 'M3_WorkOrderDocument'. Component ID: Media_ServiceReportClosed |
| Related Documents/Legal Documents |
Purpose: Legal documents etc. connected to the service agreement number in IDM. M3 BE data used: - Comment: An IDM placeholder and requires configuring for each implementation project. Component ID: Media_LegalDocuments |
| Related Documents/Email Conversations |
Purpose: Email conversations etc. connected to the service agreement number in IDM. M3 BE data used: - Comment: An IDM placeholder and requires configuring for each implementation project. Component ID: Media_EmailConversations |
| Related Documents/Other Agreement Documents |
Purpose: Placeholder for other agreement documents connected to the service agreement number in IDM. M3 BE data used: - Comment: An IDM placeholder and requires configuring for each implementation project. Component ID: Media_OtherAgreementDoucuments |
| Change Log/Agreement Field Changes |
Purpose: Possibility to follow field changes on agreement header (ACUAGH) and agreement line (ACUAGL) level. M3 BE data used: 'Event Log. Display' (CMS300). Configuration: Add the agreement related tables to follow in 'Event Subscription. Open' (CMS045) and select related option 12-'Event log files' to get to 'Event Log Fields. Open' (CMS048) to add the fields to track changes. Component ID: DataGrid_AgreementFldChanges Data services used: List_ChgLog |