Xcalar Design provides you with extensions to augment its features. You can browse the Extensions Marketplace to see what extensions are available. If you are a Xcalar Design administrator, you can select an extension to install.
Understanding the Extensions Marketplace
Xcalar Design comes with a set of pre-installed extensions. These extensions are also listed in the Extensions Marketplace. If an extension has already been installed, the INSTALLED button is displayed in the Extensions Marketplace. If an INSTALL button is shown instead, the extension has not been installed. If you are an administrator, you can click INSTALL to install the extension.
Before installing an extension, read the description under its name, which helps you understand whether it meets your needs.
To quickly find an extension, type a partial or complete extension name in the search bar. To help you locate an extension, Xcalar Design lists the extensions by categories such as Database, Finance, and so on.
The following screenshot shows an example of the Extensions Marketplace.
Displaying a list of installed extensions
You can display a list of installed extensions that the Xcalar Design administrator has installed from the Extensions Marketplace or uploaded after receiving it from Xcalar.
To display the Installed Extensions panel, when the Extension Marketplace is displayed, click the Extension icon under the Monitor icon.
Uploading an extension obtained from Xcalar (Xcalar administrators only)
If you log in as administrator, you can upload a custom extension that you have received from Xcalar. Follow these steps to upload an extension from your computer:
Click the icon in the Installed Extensions panel to start the upload procedure, as shown in the following partial screenshot:
The Upload Custom Extension window is displayed.
- In the Upload Custom Extension window, click BROWSE.
- Navigate to the extension file on your computer, which must be in the .tar.gz format. The path to the file is copied to the Upload Custom Extension window.
- Click Upload to copy the extension from your computer to
Managing installed extensions
You can enable or disable an extension. Users can use an extension only when it is enabled.
You can also remove an extension after you disable it. The following partial screenshot illustrates how to manage extensions in the Installed Extensions panel.
Running an extension
Pre-installed extensions are described in this topic. To learn more about using an extension, click the VIEW MORE button in the Extensions Marketplace to display a link to the extension's website, which provides detailed information about running the extension.
You can start an extension from the column drop-down menu or from the My Extensions panel. Some extensions cannot be directly invokable; instead, they provide you with buttons in the Xcalar Design user interface.
Follow these steps to start an extension from the column drop-down menu:
- Right click the header of a column on which you want to execute the extension.
- In the column drop-down menu, select Extensions… (last option on the menu) to display the My Extensions panel. The panel shows the extensions installed.
- Click the extension name.
Follow these steps to start an extension from the My Extensions panel:
Click to display the My Extensions panel. The following screenshot shows the location of the icon.
- Click the extension name to display the input fields. Enter the appropriate information in the fields. If an input field calls for a table name, simply click the header for the desired table in the worksheet.
- By default, the name of the column from which you start the function is displayed as an argument. If you want to use another column as an argument, you can change the argument to the name of another column.
- When typing a column name, always start with the dollar sign ($).
- When typing a column name, always include the prefix if one exists. (A derived column does not have a column name prefix.)
- If the panel calls for the resultant column name, type the name without preceding it with the dollar sign ($).
- To avoid mistakes when typing a column name as an operand, place the insertion point in the argument field, move your cursor to the active table and click anywhere in the desired column. The column's name is automatically entered in the operand field.
- If an operand accepts a column name, it also accepts the aggregate name that you created when you calculated the aggregate value for a column.
- When typing a decimal number for an operand, do not start with the decimal point. For example, type 0.5 instead of .5.
- If necessary, click in the panel to bring the specified table into focus. You can then scroll the table to make the desired column visible.
- When typing a string, do not enclose the string with double quote marks (").
When typing a string as input, escape the following characters with a backslash (\) if you want the characters to be interpreted literally:
- backslash (\)
- double quote mark (")
- dollar sign ($) if it is the first character
- caret (^) if it is the first character
- You can undo any typing with the undo key or key combination that you normally use in your browser.
- Click APPLY.