Commands Studio


GraphicalInterface_After2016Versions

Note: This graphical user interface is specific to Product name - ev itsm.png versions later than 2016.

Definition

The Commands Studio is used to configure shortcuts to filters, wizards, services and websites.

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.
  • Quick access commands are accessible depending on authorized profiles.

Example

1. Enter the /NewBadge command in the search field.
         Quick access command - Example.png

2. The Recipient field will appear.
         Quick access command - Example parameter.png

3. Select the user called David Planck.
         Quick access command - Example parameter user name.png

==> A "New Badge" service request will automatically appear for 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.

Best Practice big icon.pngBest 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 documentation icon EN.png  NewBadge command ==> Open the creation wizard for the New Badge service.

Screens description

Access: Administration > Studios > Commands Studio

  • 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)
                
             Commands studio.png

Wizard commands

         Wizard command.png

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.
  • Multilingual labels icon.png : 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.

  • Multilingual labels icon.png : Enter the text in different languages.

Wizard Name: Name of the wizard opened when the command is run.


Parameters: List of parameters associated with the wizard. This is automatically displayed.
         Wizard command - Parameters.png

  • Variable: Name of the variable storing the parameter. This is non-modifiable.
  • Meta-object: Product name - ev itsm.png table associated with the parameter.
  • 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.
             Autocompletion entry - Example.png
  • Placeholder/Value (Note: Only if predictive entry is enabled): The text displayed in the search field is automatically cleared once the user starts typing.

    Example documentation icon EN.png   Placeholder example.png

    Best Practice icon.png Use this field to help you enter data, for example, by specifying the authorized characters.

Filter commands

         Filter command.png

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.
  • Multilingual labels icon.png : 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.

  • Multilingual labels icon.png : Enter the text in different languages.

Meta-object: Product name - ev itsm.png table associated with the filter.

Link commands

         Link command.png

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.
  • Multilingual labels icon.png : 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.

  • Multilingual labels icon.png : Enter the text in different languages.

URL: Website URL.


Parameters: List of parameters associated with the URL. Open url.png 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 documentation icon EN.png   Link command - Parameters colors.png

  • 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.

    Example documentation icon EN.png   Placeholder example.png

    Best Practice icon.png Use this field to help you enter data, for example, by specifying the authorized characters.

  • Meta-object (Note: Only if the parameter value is dynamic): Product name - ev itsm.png table associated with the parameter.
    • Only meta-objects configured in the Search Studio will appear.

      Example documentation icon EN.png You select a user from the Employee Directory  ==> AM_EMPLOYEE table. Open url.png See the configuration example for accessing LinkedIn.

Service commands

         Service command.png

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.
  • Multilingual labels icon.png : 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.

  • Multilingual labels icon.png : 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.

Wizard

a. Click Wizard icon.png Wizard in the toolbar.

b. Enter the command name and description. Click Multilingual labels icon.png to enter the name in different languages.

c. Select the wizard to be opened when the command is run.

d. (optional) Specify the associated parameters. Open url.png See the description.

  • Note: You cannot add parameters.
  • Click Save icon.png to save the parameter.
  • Click Delete red icon.png to delete the parameter.

e. Click Save.

Filter

a. Click Filter icon.png Filter in the toolbar.

b. Enter the command name and description. Click Multilingual labels icon.png to enter the name in different languages.

c. In the Meta-object list, select the filter to be opened when the command is run.

Note: To add a filter, open the Search Studio.

d. Click Save.

Link

Service

a. Click Service icon.png Service in the toolbar.

b. Enter the command name and description. Click Multilingual labels icon.png to enter the name in different languages.

c. In the Meta-object list, 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 Trash icon.png.
     

Step 3: Specify the profile authorized to use the quick access command

1. Click Profiles.
         Profile management.png

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.
         Search - Command entry.png
The list of quick access commands will automatically be displayed.
         Search - Commands list.png

2. Select the quick access command you want to run.

3. (optional) Specify the search value based on the type of command.
         Search - Command execution - Value entry.png

  • If predictive entry is enabled for the command, the list of values containing the characters entered will automatically appear.
             Search - Command execution - Autocompletion.png
  • Select the relevant value and click Display popup icon.png.
    • The command will run using the selected value.
      Example documentation icon EN.png  Open the Employee form Search - Command execution - Result.png
    • For Link commands, the website will appear in a new tab of the Web browser.
EndUseQuickCommand_Procedure

Examples

Users will see a predefined keyword in Wikipedia once they have selected the quick access command.

    Example documentation icon EN.png  Display the definition of the keyword, ITSM

Quick access command selected Result

Search for quick access commands using the slash /

Link example - Search with static parameters.png

Notes:

  • Wikipedia will appear in a new tab of the Web browser.
  • The page of the predefined keyword will automatically appear.

Link example - Search with static parameters - Result.png

Step: Configure the link using a parameter.

1. Copy and paste the URL of the Wikipedia page.
          https://en.wikipedia.org/w/index.php?search=ITSM&title=Special%3ASearch

2. In the row of the search parameter which was automatically detected:

  • Enter the predefined keyword, ITSM in the Value field.
  • Do not check the Dynamic box.

Users can enter the keyword to be found in Wikipedia after selecting the quick access command.

    Example documentation icon EN.png  Search for the definition of the keyword, Business process

Quick access command selected Result

Run the quick access command

Link example - Search with dynamic parameters.png

Enter the keyword to be found

Link example - Search with dynamic parameters - Keyword entry.png

Notes:

  • Wikipedia will appear in a new tab of the Web browser.
  • The page of the keyword will automatically appear.

Link example - Search with dynamic parameters - Result.png

Step: Configure the link using a parameter.

1. Copy and paste the URL of the Wikipedia page.
          https://en.wikipedia.org/w/index.php?search=ITSM&title=Special%3ASearch

2. In the row of the search parameter which was automatically detected:

  • Ensure that the Value field points to an 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.

Create a dynamic link to Service ManagerProduct name - ev itsm - big.png

Users can use help to enter data linked to Product name - ev itsm.png.

    Example documentation icon EN.png  Display the list of employees in Product name - ev itsm.png when running a search in LinkedIn

Quick access commands selected Result

Run the quick access command

Link example - Search with dynamic parameters - LinkedIn.png

Help for selecting the employee: Employees in the Product name - ev itsm.png directory will appear

Link example - Search with dynamic parameters - LinkedIn - User selection.png

Notes:

  • LinkedIn will appear in a new tab of the Web browser.
  • The form of the selected employee will open.

Link example - Search with dynamic parameters - LinkedIn - Result.png

Step: Configure the link using a parameter.

1. Copy and paste the URL of the LinkedIn page.
          https://www.linkedin.com/search/results/index/?keywords=Morse

2. In the row of the keywords parameter which was automatically detected:

  • Ensure that the Value field points to an 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.
  • Ensure that the meta-object points to the Employee table in Product name - ev itsm.png.

Use the New Incident command

Step: Define a Wizard command that will run the New Incident wizard.

1. Enter the command name.

2. Specify the shortcut for the quick access command.

3. Select the New Incident wizard.

4. Add the parameter to specify the recipient.

Use the New Service Request command

Step: Define a Service command.

1. Enter the command name.

2. Specify the shortcut for the quick access command.

3. Select the topic of the Service Request Catalog.

4. Add the parameter to specify the recipient.

Tags:
Last modified by Unknown User on 2019/09/10 18:37
Created by Administrator XWiki on 2018/12/14 11:19
Powered by XWiki ©, EasyVista 2019