Generating URLs that open the Request Entry console in context
Use the BMC Service Request Management Context URL Builder utility to generate URLs to open the Request Entry console in context. You can use these URLs to enable users to access a specific view in the console without logging on to the Request Entry console. For example, you can provide direct access to a request or to request categories.
You can also open the Request Entry console in context by using a Action Request System Open Window action, which specifies the context in On Dialog Open Action.
Context fields
When creating launch-in-context URLs, context fields are added to the Request Entry console to specify which view to launch, the context to display, and the behavior of the console after it is launched. The following table lists the context fields, and provides a description of the values used to set the context.
To see Service Review on the Request Entry console, hover the mouse pointer over the service title.
Field name | Database ID | Values | Description |
|---|---|---|---|
Context_View | 303900000 | 1 - Browse Categories view 2 - Browse Subcategories view 3 - Services view 4- Provide Information view 5 - Cart view 6 - Submitted Requests view | This field value is required for all views. The Context_View field is used to designate which view to launch. |
Context_Category1_ | 303906900 | Category 1 (Navigational Category) instanceId. This value might need to be URL encoded. | This field value is required when the value of Context_View is 2 or 3. It is used to specify the category to display subcategories, and to specify the category under which a search for services is constrained. |
Context_Search | 303901700 | A URL encoded string used to limit the search for services. | (Optional) This field value is used when the value of Context_View is 3. This string is used to check the Service Request Definition search cache field. The search cache field contains a string representation of a combination of an SRD's title, navigational categories, and keywords. |
Context_SRD | 303900900 | The Service Request Definition instance ID. This value might need to be URL encoded. | This field value is required when the value of Context_View is 4 or 5. It is used to specify the SRD to be used in the context of the view. If the Context_SRD_Number field value is set instead, the Context_SRD_InstanceId value is set by the workflow that looks up the value based on the Context_SRD_Number value. |
Context_SRD | 301628200 | Service Request Definition ID | (Optional) This field value is used when the value of Context_View is 4 or 5. It is used to specify the SRD to be used in the context of the view. It can be used in place of the Context_SRD_InstanceId field value. It is used by the workflow to look up the Context_SRD_InstanceId field value. |
Context_Request | 303901600 | 10 – All open requests (default) | This field value is required when the value of Context_View is set to 7. It is used to specify the filter value for the Submitted Requests. |
Context_Restrict_ | 303902000 | 0 – No (default) | This field is required, but is set to 0 by default. Its value determines whether the navigation links outside the work area (Popular Services, Submitted Requests, Broadcasts, and so on) are disabled when the console is launched. If the value is set to 1, the links are disabled and the users must drill down the through the work area to submit a request. |
Context_Restrict | 303906700 | 0 – No (default) | This field is required, but is set to 0 by default. Its value determines whether the On Behalf Of link is disabled when the console is launched. If the value is set to 1, the link is disabled, and users cannot act on behalf of another user. |
Context_PI_ | 303902100 | 0 – No (default) | This field is required when the value of Context_View field is set to 4 or 5. It is set to 0 by default. Its value determines whether the console closes immediately after the user submits a request. |
Context_ | 303931400 | This field is used when Entitlement Management is set to On, to verify whether the user is entitled to request the SRD specified in the context. The value is set by the workflow on the Service Request console. | |
Context_ | 302792000 | 1000 – Online | This field is used when the value of Context_View is set to 4 or 5. It verifies that the SRD specified in the context is online for users to request. The value is set by workflow on the Service Request console. |
Context_VerifyFailed | 303932500 | 0 – No (default) | This field is used when the value of Context_View is set to 4 or 5. It verifies that the SRD specified in the context is online and the user is entitled to request it when Entitlement Management is set to On. The value is set by workflow on the Service Request console. |
To generate URLs by using the Context URL Builder utility
Log on toService Request Management as the SRM Administrator and navigate to Custom Configuration > Service Request Management > Request Entry Management > Launch-In-Context URL Generator.
Alternatively, in a browser, open the SRS:SRCLaunchURLBuilder form using SRM Administrator permission. Use the following URL example to open the SRS:SRCLaunchURLBuilder form:http://<webServer>:<portNumber>/arsys/forms/<serverName>/SRS%3ASRCLaunchURLBuilderBased on the server you logged in to, the values in the Mid Tier Path and Server fields are automatically filled in. You can modify these fields as needed (for example, with a different mid tier or server).
Enter the following information to define the launch URL:
Field name
Description
Restrict Acting On Behalf Of
Determines if the On Behalf Of link is disabled when the console is launched. The default value is No — the link is not disabled, and the user can act on behalf of another user.
Restrict Navigation
Determines if the navigation links (Preferences, Approval Central, Give Feedback, Complete Survey, Home) and Favorite, Popular, Browse, and Search buttons are disabled when the console is launched. The default value is No — the link is not disabled, allowing users to navigate away from the specified context.
Close Console After Request Is Submitted
Determines if the console closes immediately, and the user is logged out after submitting a request. The default value is No.
From the View list, select a Request Entry console view, and then perform the following steps, depending on the view that you selected:
View
Perform these steps to generate a URL
Service Categories
Click Generate URL.
Service Subcategories
- Select a subcategory.
- Click Generate URL.
Services
- Enter a search string.
- Click Launch URL Encoder.
Not all characters are valid in URLs (for example, the # character or certain GUIDs). This utility helps you create valid URLs. - In the ARURLEncoder form, enter the original string.
- Click Convert.
- Copy the encoded string and paste it into the URL Encoded String field in the Context URL Builder utility.
- Click Generate URL.
Provide Information
- Search for an SRD to use in context (for example, by company or title).
- Select an SRD from the table list of search results.
- Click Generate URL.
Service Review
- Search for an SRD to use in context (for example, by company or title).
- Select an SRD from the table list of search results.
- Click Generate URL.
Cart
Click Generate URL.
Submitted Requests
- From the Show field, select the status to display (for example, All Open Requests or Draft Requests).
- Click Generate URL.
A URL appears in the URL field.
- (Optional) To ensure that your URLs are properly encoded, perform the following steps:
Open the URL Encoder form.
http://<webServer>:<port>/arsys/shared/ar_url_encoder.jsp- Enter the original string to encode.
- Click Convert.
- Copy the encoded string.
Creating the URLs manually
If you do not use the Context URL Builder to generate the URLs, you can manually create URLs for opening the Request Entry console in context.
The URLs must be formatted as follows:
http://<webServer>:<port>/arsys/forms/<ARServer>/SRS:ServiceRequestConsole/?mode=submit&F<fieldID=paramValue>&F<fieldID2=paramValue2>&F<fieldID3=paramValue3>The variables in the URL are defined as follows:
- <
webServer> — Fully qualified name of the Mid Tier system, specified in the format serverName.company.com - <
port> — Optional port number, which is needed if the web server is not on the default port (port 80) - <
ARServer> — Name of the Action Request System server that contains the application - <
fieldID> — Database ID of the field for which you must supply a value when the Request Entry console opens - <
paramValue> — Value to be populated in the field when the Request Entry console opens
Examples of launch-in-context URLs
The following table lists examples of launch-in-context URLs:
Context | Sample URL |
|---|---|
Service categories | http://<webServer>:<port>/arsys/forms/<ARServer>/SRS:ServiceRequestConsole/ |
Service subcategories | http://<webServer>:<port>/arsys/forms/<ARServer>/SRS:ServiceRequestConsole/ |
Services | http://<webServer>:<port>/arsys/forms/<ARServer>/SRS:ServiceRequestConsole/ |
Provide information | http://<webServer>:<port>/arsys/forms/<ARServer>/SRS:ServiceRequestConsole/ |
Service review | http://<webServer>:<port>/arsys/forms/<ARServer>/SRS:ServiceRequestConsole/ |
Cart | http://<webServer>:<port>/arsys/forms/<ARServer>/SRS:ServiceRequestConsole/ |
Submitted requests | http://<webServer>:<port>/arsys/forms/<ARServer>/SRS:ServiceRequestConsole/ |
Comments
Log in or register to comment.