Application extensions are managed from the Extensions page of the Admin Console (accessed from the menu bar by selecting Resources > Extensions). By default, the grid is empty. As extensions are created, they are listed in the grid. The Used By column indicates whether an extension is activated in any of the Jacada Interact clients. For example:

The following sections explain how to add, modify and delete extensions, and how to activate extensions in applications.

Adding Extensions

Creating an application extension involves specifying a name for the extension, and writing the extension's code. 

Note: For sample code examples and more details about writing application extensions, refer to Creating Application Extensions.

To create a new extension:

  1. At the upper right corner of the Extensions page, click Add.
    The New Extension page opens. In the code editor, there are placeholders for the initExtensions function and the registerExtension method.

  2. In the Name field, enter a relevant name for your extension.
  3. If desired, in the Description field, enter notes or comments about the extension.
  4. In the first line of the code editor, replace sample with the name of your extension. Then, modify the sample code provided and replace it with your own code.
    • Delete the sample code that is provided for the technique that you are not using (e.g., if you are not registering the loaded event, delete that portion of the code).
    • For sample code examples and more details about writing application extensions, refer to Creating Application Extensions.
    • If you need to style new elements that you adding, you can use the Jacada CSS tab under the theme associated with the application.
  5. At the upper right corner of the page, click Save.
    A confirmation message is displayed, and the new extension is listed in a new row in the grid on the Extensions page. In addition, the new extension is listed in the Available Extensions frame of the Client Settings tab of your Agent, Mobile Web, and Web Self Service applications. For example: 

Note: The new extension cannot affect an application's behavior until you activate it in the application's settings.

Activating Extensions in Applications

By default, all defined application extensions are available for use in Agent, Mobile Web, and Web Self Service applications. However, for an extension to actually affect the behavior of an application, the extension needs to be activated for use in that application. This is done by applying the extension to the application, from the application's Client Settings tab. 

To apply an extension to an application:

  1. From the Extensions page, at the left side of the grid, select the checkbox(es) of the extension(s) that you want to apply to an application. To select all extensions, select the checkbox in the column header.
    The Apply To list is enabled.

  2. From the Apply To list, select the client to which you want to apply the extension(s).
    The Client Settings tab of the relevant application opens in Edit mode. In the Extensions section at the bottom of the page, the extension that you just applied to the application is listed in the Selected Extensions frame. If other extensions were previously applied to the application, the newly applied extension appears last in the list. For example:

  3. Edit the Selected Extensions list as required:
    • To remove an extension from the Selected Extensions list, select it and then click the left arrow icon. The extension moves to the Available Extensions list, and will not longer be applied to the application. 
    • To add an available extension to the Selected Extensions list, select it and then click the right arrow icon. The extension moves to the Selected Extensions list, and will be applied to the application. 
    • To edit the order of the Selected Extensions list, select an extension and use the up/down arrow icons to move it to the desired position in the list. The order of the extensions in the list can be important when the same extension point function is used by more than one extension. In this case, the functions are executed in the order of the extensions in the Selected Extensions list.
  4. At the upper right corner of the page, click Save.
    A confirmation message is displayed, and the Applications page opens.

Updating Extensions

You can update the name, description or content of an application extension at any time. 

To update an extension:

  1. From the Extensions page, in the Name column, click the name of the extension that you want to apply to modify.
    An editable Details page for the extension opens. For example: 

  2. Update the name, description and/or content of the extension, as required.
  3. At the upper right corner of the page, click Save.
    A confirmation message is displayed, and the Extensions page opens.

Deleting Extensions

The Delete button enables you to remove extensions that are no longer relevant.

Note: Extensions that are applied to one or more applications cannot be deleted.

To delete an extension:

  1. From the Extensions page, at the left side of the grid, select the checkbox(es) of the extension(s) that you want to delete. To select all extensions, select the checkbox in the column header.
    The Delete button is enabled.  
  2. At the upper right corner of the page, click Delete.
    A warning popup opens.

  3. From the popup, click Yes.
    A confirmation message is displayed, and the extension is deleted from the system.

Revision:

Comments