Setting up a guide
This procedure describes how to create and name the guide, associate it to a form, enter descriptive information about the guide, and how to make an active link guide act as an entry point.
To define basic settings for active link guide or filter guide
- From the All Objects list, open an existing active link guide or filter guide, or create a new one.
- In the Associated Forms panel, click Add.
- In the Form Selector dialog box, select the appropriate form, and then click OK.
To locate a form quickly in the list, use the Filtering Options or the Locate field in the Form Selector dialog box. See To filter the contents in an object list.
The form or forms that you associate with the guide determine which active links or filters you can include in the guide.
You can associate a guide with more than one form. If so, the guide is considered shared, and special considerations apply. See Shared workflow. - If you associated the guide with more than one form, select the correct primary form from the Primary Form list.
The primary form is the reference form for the guide. - (Optional) In the Display panel, enter the Application List Label for the guide.
Make the Application List Label descriptive and indicative of the guide's function. Application List Labels can be as many as 255 bytes.- For an active link guide that acts as an entry point, the Application List Label appears in the Application List on the home page form, and as the name of the entry point in the server object list in the web client.
If you do not supply an Application List Label, the guide name is used as the guide label. - For filter guides and active link guides that are not entry points, the Application List Label appears only in BMC Remedy Developer Studio, for example, in the Guide Selector dialog box when you create a Call Guide action.
- For an active link guide that acts as an entry point, the Application List Label appears in the Application List on the home page form, and as the name of the entry point in the server object list in the web client.
- (Optional) In the Description field, enter a description of the active link guide suitable for users. You can enter a maximum of 2000 bytes.
- For filter guides and active link guides that are not entry points, the contents of the Description field appear only in BMC Remedy Developer Studio, as with the Application List Label field.
- (Optional, active links only) For active link guides that will be an entry point, open the Entry Point panel and enter values to define the entry point:
- In the Application List Display Order field, enter a numerical value. This value determines the location of the guide in the Application List on the home page form.
- In the Start Active Link field, select the starting active link for the guide. This active link can use different actions, but it should at least use the Open Window action.
- Entering values in these two fields in the Entry Point panel has the effect of making an active link guide an entry point. Entering a value in one of these fields makes the other field required.
For more information about using entry points in an application and about the home page, see Creating and managing fields.
- Save the active link guide or filter guide, supplying a name for the guide.
The guide name appears in the following locations:- In the server Object List in BMC Remedy Developer Studio.
- For active links that are entry points with no Application List Label defined, the guide name appears in the Application List on the home page and in the object list.
Guide names must be unique on each BMC Remedy AR System server. There is no enforced convention for specifying guide names, but it is helpful to make the name descriptive and indicative of the guide's function. Guide names can be up to 80 characters, including spaces. Names can include double-byte characters, but avoid using numbers at the beginning of the name.
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*