Commands Studio
Definition
EndDefinition
You can run the quick access commands in the search field.
- You call the quick access commands by entering the slash / followed by the code of the shortcut.
- You may be required to specify other parameters.
- To define the configuration of shortcuts, quick access commands are using meta-objects which are associated with a table and the fields of a parent query.
- They are accessible depending on authorized profiles.
Example
Create a New Badge service request for David Planck.
- Enter the /NewBadge command in the search field.
- The Recipient search field will appear.
- Select the user called David Planck.
Notes
- Quick access commands are used to search multiple fields in a single table. Unlike quick access commands, the standard search function is run in a single field (the most relevant) in several tables.
- You can configure the tables and fields in which the quick access commands will run in the Search Studio.
Caution
- Users can only use shortcuts in the menus they are authorized by their profile to access.
example
- Users authorized by their profile to access the Employees menu
- They can run the /moveEmployee command to run the Move wizard in the Employee form.
- They can use the /moveEmployee mic command to display a list of all employees whose name starts with mic.
- Users not authorized by their profile to access the Employees menu
- The /moveEmployee command will not return any result.
- The search results will not return any employee when they run a search using mic.
- Users authorized by their profile to access the Employees menu
Best Practice
- You should create quick access commands for adding the most commonly occurring incidents and the most commonly used services. These quick access commands call creation wizards that offer an alternative to creating a ticket.
example NewBadge command ==> Open the creation wizard for the New Badge service.
Access
Administration > Studios > Commands Studio
Screens description
- To create a quick access command: Click one of the four categories in the wizard title bar. (1)
- To modify a quick access command: Click the sequence number in the first column of the grid. (2)
Wizard commands
CommandName
Command Name: Shortcut used to call the command in the search field.
- The code must be unique.
- Only alphanumeric characters are authorized. There must be no punctuation marks or spaces.
: Enter the text in different languages.
- Note: You must not specify the slash / in the code.
CommandDescription
Description: Function of the command displayed in the search field.
: Enter the text in different languages.
Wizard Name: Name of the wizard opened when the command is run. See the list of Service Manager wizards.
Parameters: List of parameters associated with the wizard. This is automatically displayed.
- Variable: Name of the variable storing the parameter. This is non-modifiable.
- Meta-object: Service Manager table associated with the parameter.
- Only meta-objects configured in the Search Studio will appear.
- Auto-completion: Used to indicate whether predictive entry is enabled when the command is entered in the search field (box is checked) or not (box is not checked). If it is enabled, the values corresponding to the characters entered by the user will appear. If it is disabled, no values will appear.
- Placeholder/Value (Note: Only if predictive entry is enabled): The text displayed in the search field is automatically cleared once the user starts typing.
Filter commands
CommandName
Command Name: Shortcut used to call the command in the search field.
- The code must be unique.
- Only alphanumeric characters are authorized. There must be no punctuation marks or spaces.
: Enter the text in different languages.
- Note: You must not specify the slash / in the code.
CommandDescription
Description: Function of the command displayed in the search field.
: Enter the text in different languages.
Meta-object: Service Manager table associated with the filter.
- Only meta-objects configured in the Search Studio will appear.
Link commands
CommandName
Command Name: Shortcut used to call the command in the search field.
- The code must be unique.
- Only alphanumeric characters are authorized. There must be no punctuation marks or spaces.
: Enter the text in different languages.
- Note: You must not specify the slash / in the code.
CommandDescription
Description: Function of the command displayed in the search field.
: Enter the text in different languages.
URL: Website URL.
Parameters: List of parameters associated with the URL. See configuration examples.
- If the specified URL contains parameters:
- They are automatically detected by the question mark ? and separated using the ampersand &.
- They will appear in different colors in a table at the bottom of the screen.
example
- Key: Name of the parameter.
- Value: Value of the parameter.
- Dynamic: Used to indicate whether the parameter value is dynamic (box is checked) or static (box is not checked). If it is dynamic, users must specify the value in the search field. If it is static, users cannot modify the value.
- Placeholder (Note: Only if the parameter value is dynamic): The text displayed in the search field is automatically cleared once the user starts typing.
- Meta-object (Note: Only if the parameter value is dynamic): Service Manager table associated with the parameter.
- Only meta-objects configured in the Search Studio will appear.
exampleYou select a user from the Employee Directory ==> AM_EMPLOYEE table. See the configuration example for accessing LinkedIn.
Service commands
CommandName
Command Name: Shortcut used to call the command in the search field.
- The code must be unique.
- Only alphanumeric characters are authorized. There must be no punctuation marks or spaces.
: Enter the text in different languages.
- Note: You must not specify the slash / in the code.
CommandDescription
Description: Function of the command displayed in the search field.
: Enter the text in different languages.
Service Name: Entry in the Service Request Catalog.
Procedures
How to create a quick access command
Step 1: Open the Commands Studio.
1. Select Administration > Studios > Commands Studio in the menu.
Step 2: Create the quick access command.
1. Select the type of command you want.
2. Specify the required information based on the type of command. Click below to see instructions.
Click to see the procedure for a wizard
a. Click Wizard in the toolbar.
b. Enter the quick access shortcut and description. Click to enter the name in different languages.
c. Select the wizard to be opened when the command is run. See the list of Service Manager wizards.
d. (optional) Specify the associated parameters. See the description.
- Note: You cannot add parameters.
- Click
to save the parameter.
- Click
to delete the parameter.
e. Click Save.
Click to see the procedure for a filter
a. Click Filter in the toolbar.
b. Enter the quick access shortcut and description. Click to enter the name in different languages.
c. Select the meta-object associated with the filter, e.g. Employee, CI or Equipment. Note: Only meta-objects configured in the Search Studio will appear.
d. Click Save.
Click to see the procedure for a link
a. Click Link in the toolbar.
b. Enter the quick access shortcut and description. Click to enter the name in different languages.
c. Select the URL to be accessed when the command is run.
d. (optional) Specify the associated parameters. See the description.
- Note: Users are only required to specify the unspecified parameters in the URL.
- To add a parameter, complete the last row of the table and click
.
- Click
to delete the parameter.
e. Click Save.
Click to see the procedure for a service
a. Click Service in the toolbar.
b. Enter the quick access shortcut and description. Click to enter the name in different languages.
c. Select the service to be opened when the command is run.
d. Click Save.
Modify a quick access command
- Click the relevant row.
- Make the required modifications.
- Click Save.
Delete a quick access command
- Move the cursor over the relevant row.
- Click
.
Step 3: Specify the profile authorized to use the quick access command
1. Click Profiles.
2. Specify the authorized profiles.
For all profiles created AFTER the quick access command was created/modified (1)
- Select can access to this command option to authorize the access to the profiles.
- Select cannot access to this command option to not authorize the access to the profiles.
For all profiles created BEFORE the quick access command was created/modified (2)
- Drag and drop the authorized profiles in the right list.
- Drag and drop the unauthorized profiles in the left list.
3. Click OK.
Step 4: Save the quick access command.
1. Click Save.
The command will be added at the bottom of the list.
How to use a quick access command
UseQuickCommand_Procedure
1. Enter the slash / in the search field.
The list of quick access commands will automatically be displayed.
2. Select the quick access command you want to run.
3. (optional) Specify the search value based on the type of command.
- If predictive entry is enabled for the command, the list of values containing the characters entered will automatically appear.
- Select the relevant value and click
.
- The command will run using the selected value.
example Open the Employee form
- For Link commands, the website will appear in a new tab of the Web browser.
- The command will run using the selected value.
EndUseQuickCommand_Procedure
Examples
Opening a Wikipedia predefined page: Static link
A quick access command is created to directly open the Wikipedia site on the ITSM page.
1. Create a Link command.
2. Enter the quick access shortcut.
example /Wikipedia_ITSM
3. Copy and paste the URL of the Wikipedia search page.
https://en.wikipedia.org/w/index.php?search=ITSM&title=Special%3ASearch
The parameters associated with the URL will be automatically detected and displayed.
4. Check the search parameter information.
- Value : Predefined keyword, ITSM.
5. Specify the authorized profiles.
Running the new command
- When the quick access command is selected, the Wikipedia site will automatically open in a new tab of the Web browser. The ITSM page will appear.
Opening the Wikipedia site: Dynamic link
A quick access command is created to directly open the Wikipedia site on a keyword page you enter dynamically.
1. Create a Link command.
2. Enter the quick access shortcut.
example /Wikipedia
3. Copy and paste the URL of the Wikipedia search page.
https://en.wikipedia.org/w/index.php?search=ITSM
The parameters associated with the URL will be automatically detected and displayed.
4. Modify the search parameter information.
- Enter the internal variable, @search@ that identifies the keyword to be found in Wikipedia.
- Check the Dynamic box.
- In the Placeholder field, enter the text you want to display in the search field.
5. Specify the authorized profiles.
Running the new command
- When the quick access command is selected, the search field to enter the keyword to search in Wikipedia will automatically be displayed.
- The Wikipedia site will automatically open in a new tab of the Web browser once you enter the keyword. The keyword page will appear.
Displaying LinkedIn information of a Service Manager employee: Dynamic link
A quick access command is created to search information of a Service Manager employee in the LinkedIn site.
1. Create a Link command.
2. Enter the quick access shortcut.
example /LinkedIn
3. Copy and paste the URL of the LinkedIn search page.
https://www.linkedin.com/search/results/index/?keywords=Morse
The parameters associated with the URL will be automatically detected and displayed.
4. Modify the search parameter information.
- Enter the internal variable, @keywords@ that identifies the employee to be found in LinkedIn.
- Check the Dynamic box.
- In the Placeholder field, enter the text you want to display in the search field.
- Select the Employee meta-object
5. Specify the authorized profiles.
Running the new command
- When the quick access command is selected, the list of employees in the Service Manager directory will automatically be displayed.
- The LinkedIn site will automatically open in a new tab of the Web browser once you select the employee. The form of the selected employee will open.
New incident on a CI: Wizard
1. Create a Wizard command.
2. Enter the quick access shortcut.
example /NewIncident_CI
3. Select the New Incident wizard.
The list of parameters associated with the wizard will be displayed.
4. Select the meta-object CI. Note: The meta-object must be configured in the Search Studio.
5. Specify the authorized profiles.
Running the new command
- When the quick access command is selected, the search field to enter the CI impacted by the incident will automatically be displayed.
- The input screen for the new incident will be displayed once you enter the CI.
New request for a badge: Service
1. Create a Service command.
2. Enter the quick access shortcut.
example /NewBadge
3. Select the New badge topic in the Service Request Catalog, via the Service Name list.
4. Specify the authorized profiles.
Running the new command
- When the quick access command is selected, the search field will automatically be displayed to enter the recipient for the new request.
- The input screen for the new request will be displayed once you enter the recipent.