In this month’s blog, I want to share how to create a custom Advanced Interface Form to automate more operations in SRM. This is an advanced operation which requires knowledge of AR System workflow development, and like it any customization, appropriate guidelines should be followed to avoid introducing issues. See Customization Policy for more details and ARSystem documentation for references on using the tool. My goal in this write-up is to share the steps so those with the requisite expertise can perform this operation more easily.
- AIF – Introduction and Overview:
The Service Request Management feature Advanced Interface Form (AIF) a user interface to collect user’s request information in the Request Entry console before it is processed by the Service Request Definition (SRD). If the SRD uses an advanced interface form, the advanced interface form is used in the Provide Information stage instead of the usual questions.
Advanced interface forms allow you to have a personalized Provide Information screen in the Request Entry console. You can use the advanced interface form’s functionality to submit requests in place of the default method to submit requests on the Request Entry console. You must have BMC Remedy AR System Administrator permissions and knowledge of BMC Remedy AR System Development to modify and enhance the advanced interface forms. To add existing AIF to SRD, we will need SRM Administration Permission.
Depending on the type of advanced interface form used, you might need to map fields on the advanced interface form to the SRDs required target data (fulfillment application fields).
- Advanced interface forms provide the following functionality:-
- Ability to map more than forty user responses to fulfillment application fields (target data).
- Ability to capture additional fields besides the default set of fields that are captured by using the product as shipped.
- Ability to control data flow in the advanced interface form.
- Ability to create sophisticated data validation.
- OOB AIF Template:
The following three AIF Template Forms are installed with SRM by default. Using these out of the box AIF Templates we can pass data to any backend application. Here is a quick description for what these Template’s role is:
- With Backend Mapping: Using this AIF Form it can store the data in the Regular Form (SRS:AdvancedInterface_WithBackendMapping) as well as map the data to backend application which gets created through the SRs.
- Without Backend Mapping: Using this AIF Form it can only store the data in the Regular Form (SRS:AdvancedInterface_WithoutBackendMapping) but it doesn’t map the data to backend application which gets created through the SRs.
- Password Reset: Using this AIF Form it can’t store any data on the form (SRS:AdvancedInterface_WithoutBackendMapping) as it a Display-Only Form but it can map the data to the backend application which gets created through the SRs.
- We use the following steps to create our own Advanced Interface Forms:
- Step 1 Create your own advanced interface form from the templates that BMC provides.
- Step 2 Register the new form.
- Step 3 (optional) Configure the details fields in the Work Order Template form.
- Step 4 Configure the SRD to use the new form.
- Step 5 (optional) Map your fulfillment application fields, if necessary.
- Step 6 Open the advanced interface form from the Request Entry console.
This feature enables fulfillment process owners and service coordinators to view the user responses on the advanced interface forms.
- Use BMC Remedy Developer Studio to create our own Advanced Interface Forms from templates:
- Step 1. Log into BMC Remedy Developer Studio.
- Step 2. From the AR System Navigator, open one of the sample advanced interface forms. For example, open the SRS:AdvancedInterface_WithBackendMapping form.
- Step 2.1
Tab and only the field labels on the Mapped tab.
Following is a description of the tabs and the fields on those tabs:
-> Your Fields: Data that is entered into these fields is NOT mapped to the backend applications but it’s saved on the Regular Form directly. All Fields from this tab should be visible to Users.
-> Mapped: It contains fields that are pre-defined to map to fulfillment application fields on the Details tab of a work order. The labels on these field can be changed to pose questions to users. This tab and any fields used to pose questions to users should be visible. Any fields not used should be hidden from users
-> Mapped 10-27 and 28-47: It contains additional fields that can be mapped to fulfillment application fields by using the Question Selection and Fulfillment Application Field Mapping dialog during SRD configuration.
- Step 3. Save a copy.
- Choose File > Save Form As.
- If you copy the advanced interface forms with a new name (for example, SRS:MyAdvancedInterface_Questions) and modify the copies, your work will not be overwritten when you upgrade the application.
- Enter a new name for the copy. Avoid using a plus sign sign in the form name to ensure that a URL that contains the form name is not interrupted.
- Step 4. Add your advanced interface form to the form attach list in the BMC workflow.
- Open the packing list you created in BMC Remedy Developer Studio.
- Open all the workflow objects from your packing list (for example, Active Links) and associate your form, except for the four following active links:
- Check the Filters, Active Link Guides, Menus, and Filter Guides, and associate the new advanced interface form to them as well.
- Step 5. Perform the following actions to the preceding active links. You must modify this workflow to set the flag in the “RequiredQuestionsAnswered” field that determines whether the user entered all of the required information to
Submit the service request or the cart.
- Copy and rename the active links.
- Modify the form name to your own interface form.
- Modify the Run If qualification to match the required fields on your form.
- Step 6. Edit the SRS:ADN:SHR_OnSubmit_SubmitInReview active link guide by adding your submit request active links to it.
- - Add your active links under the
SRS:ADN:WithoutMapping_OnSubmit_109_SubmitRequest_CheckReqFields active links.
- Step 7. Edit the SRS:ADN:SHR_OnSubmit_SubmitInCart active link guide by adding
Your cart active links to it.
- - Add your active links under the SRS:ADN:WithMapping_OnSubmit_109_AddToCart_SetFlag and
SRS:ADN:WithoutMapping_OnSubmit_109_AddToCart_SetFlag active links.
- Step 8. Test your copied version of the advanced interface form. It should work just as the original form.
- Step 9. Modify your copy of the advanced interface form. If you used the SRS:AdvancedInterface_WithBackendMapping or SRS:AdvancedInterface_WithoutBackendMapping form as a template, you can
modify the fields in the Your Fields data fields sections.
- Step 10. You must now register the form as described in the next section.
- NOTES & WARNING for CREATING your own AIF:
- You must have BMC Remedy AR System Administrator permissions and knowledge of BMC Remedy AR System development to modify and enhance the advanced interface forms.
- In BMC Remedy Developer Studio, create a packing list of the advanced interface form that you want to modify, and add all the related objects.
- The fields on the Mapped tab can also be mapped in this manner if the target fulfillment application field is not on a work order, that is, an incident or change request.
- Do not modify the other fields on this form—they are the core set of fields that map to the service request, and are needed to create the service request. You can, however, add specific workflow to the advanced interface fields for validation, and so on.
- To avoid migration issues, do not copy and rename the workflow that is attached to the included advanced interface forms.
- Do not use the BMC prefix (SRS:ADN) when you rename the active links.
- Do not delete or modify any other fields on these forms. BMC supports only changes to appearance items, such as the header, background, labels, and so on.
- Register AIF:
You must have SRM Administrator permissions to access the form and to register AIF. The advanced interface forms are installed with localized views for English, Japanese, French, Italian, German, Spanish, and Simplified Chinese.
- Below are the steps to Register AIF:
- Step 1. Open the Application Administration Console.
- Step 2. Click the Custom Configuration tab.
- Step 3. Choose Service Request Management > Advanced > Configure Advanced Interface form data, and click Open. The Configure Advanced Interface Information form appears. The application includes entries for the three advanced interface forms shipped with the application. You must create entries for any copies of the advanced interface forms you create.
- Step 4. Specify a company.
- Step 5. Enter a template name (for example, Advanced Interface Questions).
This name will appear in the Advanced Interface field as a menu choice on the Service Request Definition form.
- Step 6. Enter the form name and location as it appears on the BMC Remedy AR System Server. For example, if you are using the advanced interface form you just created, enter SRS:MyAdvancedInterface_Questions.
- Step 7. Specify the server and specify its status, either Active (enabled) or Inactive (disabled).
- Step 8. Click Save. Service Catalog Managers can now choose this advanced interface template from the Custom Template field when they are creating SRDs.
- Creating SR using out of the box AIF:
In SRD Form, under Advance Interface Option we can see all Active AIFs.
In this example we will be using Work Order Template and “With Backend Mapping” AIF to create a SR. This SRD will generate a Work Order and will have values passed from AIF.
NOTE: Whenever SRDs are created with AIF, the Questions Tab will be hidden, as instead of questions screen we will get the AIF screen.
Below is the WO Template where we have passed values for Summary and Notes Fields.
In the SRD we will add the AIF. Here we haven’t created any variables.
After submitting the SR, Work Order gets created and has below values passed from AIF.
I hope this article provides a better understanding of how AIF’s work and how to take advantage or customize the use of this powerful feature.
Please add comments below on your own experiences with AIF if there are additional tips or practices that are helpful.
You can find additional blogs like this at BMC Remedy Support Blogs