Procedures and Metadata on the Application Tree

Reference:

The Applications page groups all application files, including procedures, synonyms, HTML files, data flows, user functions, and other files on a single application tree. By default, files in an application are listed in order of file type. The file type is indicated by a unique icon for each type that displays to the left of the file name in the tree. However, you can sort or filter the list to generate custom views of each application.

Right-clicking an item brings up a context menu. The items you see on the context menu depend on your role and the type of file. Some items are only available to administrators or other users with administrator privileges. Some of the items on the context menu provide shortcuts to items on the Workspace or My Console menu.

Reference: Application Tree Icons

The following table lists the icons displayed for each type of file on the application tree.

Icon

Type of File

Closed application directory

Closed application directory

Open application directory

Opened application directory

Metadata

Synonym icon

Synonym (.mas)

Synonym icon

Cluster synonym (.mas)

Synonym icon

Business View synonym (.mas)

Procedures

Stored Procedure (.fex)

Data Migrator Flow (.fex)

Data Migrator Flow with Change Data Capture (CDC) (.fex)

DBMS SQL Flow (.fex)

Direct Load Flow (.fex)

Direct Load Flow with Change Data Capture (CDC) (.fex)

User function icon

User Function (.fex)

Scheduled only procedure icon

Scheduled Only (.fex)

Documents

HTML icon

HTML file (.htm, .html, .shtml, .htt, .mht, .mhtml, .cfm, .tpl, .hta, .htb)

Excel file icon

Microsoft Excel® Document (.xls, .xlsx, .xlsb, .xht, .xltx, .xlsm, .xltm)

Adobe Acrobat Document (.pdf, .ai)

XML icon

XML Document (.xml, .wsd, .xsd, .wsdl, .mxml, .gcl, .xul, .dtd, .xsl, .xslt, .axl)

JSON file icon

JavaScript Object Notation (.json)

Microsoft PowerPoint® Document (.ppt, .pptx, .pptm)

Microsoft Word document icon

Microsoft Word® Document (.doc, .docx, .docm, .dot, .dotx, .dotm)

Other

SQL Script icon

SQL Script (.sql)

Data File (.foc, .ftm, .dat, .txt, .csv, .tab, .bdat, .data, .tmp)

Graphics File (.jpg, .jpeg, .jpe, .svg, .jfif, .tif, .tiff, .ico, .gif, .bmp, .png)

Note: The text inside the icon identifies the type of image file.

StyleSheet file icon

Style File (.sty, .focstyle, .css)

.zip file icon

Archive File (.zip, .rar, .tar, .jar, .war)

.js file icon

Script File (.js, .jcs, .omi, .cbl, .hti, .jji, .vbs, .sh, .ctl, .bat, .t3i, .jcl, .ps)

Log/Trace File (.log, .trc, .hto, .t3o, .sta, .msg)

Configuration File (.cfg, .ini, .prf, .err, .nls)

Language file icon

Language File (.lng)

Other file type icon

Other Document (.prn, .dif, .fmu, .wp, .ifp, .lzx, .syl, .dmc, .tdl, .bst, .adr, .eps, .swf, .as, .trf, .idx)

MAINTAIN File (.mpt, .mnt, .fcm, .wfm, .wri, .wxi)

Reference: Context Menu Options for Application Directories

The following options are available on the Applications page ribbon:

New. Enables you to create new application files. The available context menu options are:

  • Cluster Business View. Opens the Synonym Editor.
  • Flow. Opens a flow page.
  • Advanced/Custom Copy. Starts the custom copy process.
  • Procedure. Opens the New Procedure text editor.
  • Text File. Opens a text box in which you can create a new file as text.
  • Upload Raw Data. Enables you to upload image or data files to an application directory. No synonym is created for data files.
  • Application Directory. Enables you to create a new application directory folder.
  • Tutorials. Opens the Create Tutorial Framework page where you can create samples tables and metadata.

Get Data. Opens the Get Data page for uploading files or configuring adapters and connections.

Filter. Enables you to customize the items that display on the application tree. If there are nested application directories and you want to see the selected files from all of them in a single list, click the ellipsis button (...) on the files pane. The available context menu options are:

  • Procedures. The options are All Procedures or Scheduled Only.
  • Synonyms. The options are All Synonyms, Cluster Only, or Business View Only.
  • Advanced. Opens the Filter Applications Tree page, where you can specify file properties, select among all of the types of files available, and select file statistics such as size or date modified. For more information, see How to Filter Items on the Application Tree.
  • Impact Analysis. Reports on your use of synonyms, columns, and procedures. The choices are Synonyms by Procedure, Procedures by Synonym, Columns by Procedure, and Procedures by Column. In addition, you can select a Summary or Detailed flow report.
  • Recent. Opens the list of files the user opened recently (history.txt in the myhome application for the user).
  • Favorites. Opens the list of files the user added as favorites.

Manage. Enables you to manage your applications. The following context menu options are available:

  • Settings. Opens the Application Settings pane.
  • External Repository. Has the following options.

    SQL Repository. Provides options to create and manage SQL repositories, allowing you to store the contents of an application folder in an SQL database.

    WebFOCUS Client Repository. Provides options to link to or list and delete a WebFOCUS Client Repository.

  • Application Path. Opens the Application Path Configuration page under the My Console menu while leaving the Application Directories tree open in the left pane.
  • Schedule/Email. Has the options Scheduler Agents, Scheduled Events, Log and Statistics, and Force Scheduler Scan. Enable you to view various scheduler pages and logs and statistics while leaving the Application tree open in the left pane.
  • Create My Home. Creates the home application directory of the user.
  • Shared Resources. Opens a pane that enables the user to share personal files and folders under his myhome directory and shows the shared resources the user has configured.
  • Preferences. Opens the Application Preferences page, where you can customize the tree display. The available options are:
    • Show edahome, edaconf, edaprfu, scaroot, edatemp, edalog and foccache of all users. Shows internal directories on the application directories tree for users with Server Administrator privileges.
    • Show Descriptions on Applications Tree. Shows the file description on the files pane.
    • Show Also Applications not in APPATH. Adds an Inactive Directories tree listing all of the applications not in the path to the Application Tree. When the Inactive Directories tree is displayed, the context menu option changes to Hide Applications not in Path.

      Note that this option is only available for the server administrator and users with server administrator privileges. Users with these privileges can manage (add, delete, copy, move, or modify files) directories that are not in the Application Path.

    • Swap File/Dir Description and Name. Shows the description, if any, where the file name displays in the default layout.
    • Show Files from Nested Applications. Shows files from nested applications in the list of files. The default display shows nested application directory names, and you can double-click them to show the files within them.
    • Show Application Profile. Shows the current application profile.
    • Show Files on Application Tree. Enables you to open the list of files directly in the Application Tree instead of in a separate pane.

Reset. Resets the application page to its default settings and enables the user to show or hide the different panes.

Reference: Context Menu Options for an Application Directory

Like the top level of the Application Directories tree, application directory folders include New, Schedule and E-mail, and Impact Analysis options, as described in Context Menu Options for Application Directories.

Application directory folders also include the following right-click options:

  • Refresh. Refreshes the list of files in the application.
  • New. In the application directory enables you to create a new cluster Business View, synonym, custom copy, data flow, procedure, text file, upload raw data, application directory, or tutorials.
  • Quick Copy. Enables you to copy data when you have configured SQL adapters.
  • Schedule and E-Mail. Opens the Scheduler Agents or Scheduled Events page for the application or forces a Scheduler scan.
  • Log and Statistics. Opens the Log and Statistics page where you can view a range of log and statistics reports.
  • Impact Analysis. Lets you run impact analysis and flow reports for the application.
  • Copy. Copies the application directory.
  • Delete. Deletes the application directory and is only available for application directories that you created.
  • Cut. Cuts the application directory and is only available for application directories you created.
  • Paste. Pastes the application directory.
  • Rename. Opens a dialog box for renaming the application directory.
  • Privileges. Opens the Manage Privileges pane for this application directory. This option is only available to Server Administrators.
  • Properties. Opens the Properties pane that shows the location of the application directory, number of files in the directory, the date the directory was last modified, and the description. You can also edit the description using the text box provided.

Reference: Context Menu Options for All Files in an Application Directory

All files include the standard right-click options of Cut, Copy, Paste, Rename, and Delete. .

You can multi-select files before clicking an option on the right-click menu. To select a group of contiguous files, click the first file, hold down the Shift key and click the last file. To select discontiguous files, hold down the Ctrl key while clicking the files you want to select.

Files also include the following right-click options:

  • Open. Opens the file in the editor associated with that type of file (not available for Quick Query, HTML, and Synonym).
  • Properties. Opens the Properties pane that shows the location of the file, the date it was last modified, the Job Type, the description, and the privileges associated with the file.
  • Download. When this option is selected, the file is transferred to the Downloads folder of the user. On Windows, this folder is, by default, the following directory:
    C:\users\username\Downloads

    If you right-click a synonym, the shortcut menu gives you a choice of Master File or Access File.

  • Copy. Copies the application file. Multi-select is supported. You can hold the Ctrl key to add files.
  • Delete. Deletes the application file and is only available for application directories that you created.
  • Cut. Cuts the application file and is only available for application directories you created.
  • Rename. Opens a dialog box for renaming the application file.
  • Add to Favorites. Adds the file to your list of favorites. You can view the list of favorites by clicking Filter on the ribbon and selecting Favorites.
  • Privileges. Opens the Manage Privileges pane for this application file. This option is only available to Server Administrators.
  • Properties. Opens the Properties pane that shows the location of the application file, the date the file was last modified, the description, and the privileges for the connected user. You can also edit the description using the text box provided.

Reference: Context Menu Options for Stored Procedures

Stored procedures include the right-click options Open, Delete, Cut, Rename, and Properties, as described in Context Menu Options for Application Directories.

Stored procedures also include the following right-click options:

  • Open Advanced. Attempts to open the procedure in the Flow Editor.
  • Run. Runs the file if it is an executable file.
  • Run Advanced. Opens a menu containing the following options:
    • Submit with E-mail. Enables you to manage email notification when the procedure starts and/or completes
    • Run Changing Defaults. Lets you enter values for variables and then runs the file if it is an executable file.
    • Run As. Prompts for credentials prior to running the procedure if the connections_autoprompt profile setting is y and the Auto Prompt Connection Credentials setting is y for the connection being used.
    • Run Stress. Opens a pane that enables you to set the number of threads, the interval, and the time to keep alive the procedure when it runs. You can also choose to generate statistics and comparisons for this run.
    • Run Stress Deferred. Opens a pane that enables you to set the number of threads, the interval, and the time to keep alive the procedure when it runs deferred. You can also choose to generate statistics and comparisons for this run.
    • Debug. Enable you to run the procedure in debug mode. You can step through the code, viewing the result for each line. For more information, see Debugging a Stored Procedure.
  • Schedule and E-Mail. Enables you to manage email notification when the procedure starts and/or completes, and to change default values of amper variables. It also enables you to open the list of Scheduler Agents and Scheduled Events.
  • Logs. Provides the following options:
    • Last Log. Displays the log from the last time the procedure was run.
    • Last Output. Displays the output from the last time the procedure was run.
    • Log and Statistics. Opens the Logs and Statistics page where you can view a range of log and statistics reports.
  • Analysis Reports. Provides the following options:
    • Impact Analysis. Reports where this procedure is found and its properties.
    • Dependencies Analysis. Displays the Dependencies Analysis page. It enables you to see the synonym(s) and other procedures that are used by the procedure.
    • Data Lineage. Reports on the fields in the procedure and their properties.

Reference: Context Menu Options for TIBCO Data Migrator and Direct Load Flows

Data Migrator and Direct Load Flows include the Schedule and E-mail and Impact Analysis options, as described in Context Menu Options for Application Directories. They include the Run, Run Advanced, Logs, and Dependencies Analysis options, as described in Context Menu Options for Stored Procedures.

Data Migrator and Direct Load Flows also include the following options:

  • Open Flow. Opens the flow in the Data Flow Editor.
  • Submit. Submits the flow for processing.
  • Flow Report. Displays details about the flow, including source and target information, load options, SQL select statements, transformations, execution properties, and record logging.

Reference: Context Menu Options for Quick Queries

Quick Queries include the Schedule and E-mail and Impact Analysis options, as described in Context Menu Options for Application Directories. They also include the Run, Run Advanced, Submit with Options, and Logs options, as described Context Menu Options for Stored Procedures.

Reference: Context Menu Options for User Functions

In addition to the standard file options (Cut, Copy, Paste, Delete, and Properties), User Functions include the Test right-click option, which tests the function.

Reference: Context Menu Options for HTML Files

In addition to the standard file options (Cut, Copy, Paste, Delete, and Properties), HTML files include the Run and Logs options, as described in Context Menu Options for Synonyms.

HTML files also include the following options:

  • Edit. Enables you to edit the HTML code.
  • View. Enables you to view how the file displays in a browser.

Reference: Context Menu Options for Custom Pages

Custom Pages include the standard file options (Open, Cut, Copy, Paste, Delete, Privileges, and Properties). Custom Pages also include an Edit option.

Reference: Context Menu Options for Synonyms

Synonyms include the Analysis Reports option, as described in Context Menu Options for an Application Directory. They also include the Download, Copy, Delete, Rename, and Properties options, as described Context Menu Options for Stored Procedures.

Synonyms also include the following options:

  • Open. Opens the synonym in Data Assist.
  • Sample Data. Runs a sample report against a synonym.
  • Data Profiling. Runs a report against a synonym listing its segments, fields, and field information, with a drill-down report to field values.
  • Analysis Reports. You can select Impact Analysis, which reports where this synonym is found and its properties, or Dependencies Analysis, which displays the Dependencies Analysis page. It enables you to see the applications and synonyms that contain or have references to this synonym.
  • Metadata Management. Provides options to create a cluster synonym, to refresh (update) synonyms (only available for base synonyms, not cluster synonyms), to edit the Master File in the text editor, to open the Access File in the text editor, and to prepare translation files for the metadata in the synonym.
  • Data Management. Enables you to recreate a DBMS table, drop a table, insert sample data, delete all data, and show/modify data.
  • Quick Copy. Opens the Quick Copy page where you can specify the target parameters for the new synonym and table.
  • Custom Copy. Opens Data Assist for editing and enhancing the synonym.
  • Flow. Opens a demo flow page.