Help - HetBenkt/DQL-Tester-FX GitHub Wiki

Welcome to the user help page for 'DQL Tester FX'. We assume you are already able to run the tool by itself. Not? please get it started from this page Make sure you have your Documentum Repository up and running and make sure you have your dfc.properties in config folder properly configured as described on page already mentioned.

Below is an overview of all the available use-cases with a small description

The first screen after starting up

After startup (without any parameters) you get the next screen.

This is the start screen where (by default) you start in a disconnected state (See the 'Offline' state in the bottom).

From top to bottom we see these items

  • 'Menu bar' where most actions are disabled. These will be enabled once connected. The 'Help' menu is always available.
  • 'Result panel' where the output of an executed DQL statement will be shown.
  • 'DQL/SQL Statement' where you can add queries that can be executed with the 'ReadQuery' button (when connected!)
  • 'History dropdown' boxes where the last executed queries are saved for reusability (This information is also saved in a file called history.json is the folder from where you executed the tool)
    • In these dropdowns you can delete the saved statements and mark them as 'favorites' to be found in the second drop-down
  • 'Button panel' with the next buttons available
    • 'ReadQuery' will execute the query
    • 'Flush Cache' is not doing anything at the moment!
    • 'Clear Query' clears the SQL/SQL Statement input area
    • 'Connect' brings you to the login procedure
    • 'Exit' stops the program
    • 'Commands' panel gives you feedback on execution times (disabled by default for now)
  • 'Status bar' at the bottom gives the current connection status

The first action (if not connected already) is to 'Connect' to your Documentum Repository and follow the login procedure below.

Login procedure

After clicking the 'Connect' button you get the next screen

Select your repository and provide the login credentials. When done you can click the 'Connect' button. Also, the <Enter> key can be used for faster login.

After the credential fields you have the option the select the 'Secure mode' where you can switch between 'Native' and 'Secure'. This overrules the default from the dfc.properties file.

The 'Save Login Data' is not working yet!

'Cancel' will get you back to the main screen

'ServerMap' will show you information like this

'Connection Broker Map' will show you information like this

At the bottom we show the server name and the version of this tool

Direct Login

There is an option available to direct login to a Documentum Repository during startup of the tool. This is for faster and easy access.

It is described at the bottom of this page in the 'pass 3 parameters' section

After login you see the status bar updated with the current session information on the main screen!

Tools -> Describe Object

Select your dm_type or dm_registered object and click 'Ok' to view the output in the main result panel like this example for a dm_document object:

Note that you can also use the right tree view to select you object to describe.

And there is an option available to switch between 'Type' and 'Table'

Tools -> Get Attributes

Will start with a blank screen, but when you paste in a Documentum r_object_id from an object and click the 'Dump' button you will get the output as the screenshot.

You can 'double click' on an r_object_id in the dump text to get a new 'Get Attributes' screen for that object.

To search in the dump text fill in a search term in the field and use the 'Find', 'Next >', 'Previous <' and 'Case Sensitive' marking to jump to the proper result in the text.

The 2 options 'Use API...' and 'Filter Attributes...' are not functional now

'Exit' will bring you back to the main screen

Tools -> Execute API Script

Will start with a blank screen, but you can paste in data like this or 'Load' it with the button in the top-right of the screen:

dump,c,0912d59180000787
set,c,0912d59180000787,subject
test
save,c,0912d59180000787

'Save' a script is not yet available

Normally a script will stop running when something failed. The option 'Ignore Errors' prevents the script from stopping.

'Clear Scripts' cleans the input text

'Execute' runs the script.

'Exit' will bring you back to the main screen

Note that from the result panel in the main screen there is also an option available to generate an API script from the results!

Tools -> Browse Repository

The panel provides you the option to browse through the repository. Top level is the repository, next is the list of dm_cabinet object, under there the rest of the dm_folder structure with the dm_document objects.

When the object is selected you can view some basic properties in the bottom.

A right-click on the object gives a context menu with the available actions for that object.

  • Open or export content (default temp directory: C:\Users\your_name\AppData\Local\Temp)

  • Checkout/Check-in/Cancel checkout

    • Checked out files are tracked in the checkout.json in the root of the 'DQL Tester FX' tool
  • Get Attributes (gives you a dump of all the properties)

  • Versions (with a context menu for further actions)

  • Renditions (with a context menu for further actions; not all actions are available yet)

  • Find item <F3>

Note the good old <F3> key to find an object in the tree is also made available!

3 options to mark:

  1. 'Show All Versions' is not working yet (reopen the folder to see the change happen!)
  2. 'Show All Cabinets' show all the cabinets (including the home cabinets). This setting is saved in the settings.properties in the 'config' folder of the tool.
  3. 'Read-only Mode' is not working yet

Tools -> Export results

When you have a result available in the result panel of the main screen you can choose this option and export the result to a .csv file. This is comma-separated data that can be represented in your own favorite tool like for example Excel.

Context menu on 'result' panel

A right click on the result list gives you the next context menu

These are the actions that can be applied:

  • Content related

    • 'Open Content' downloads the content in the temp directory and opens the file directly
    • 'Export Content' saves the content on your local machine in the temp directory C:\Users\your_name\AppData\Local\Temp
  • Object related

    • 'Get Attributes' gives a dump of all the properties for the object ID

    • 'Destroy Object' deletes the object for that object ID from the repository with a confirmation message

    • 'Versions and renditions' show the same information when you select the actions from 'Browse Repository' module

    • 'Describe Object' only available on 'dm_type' and 'dm_relation' result items and shows the same information as the 'Describe Object' module

    • 'Checkout/Check-in/Cancel checkout' executes the same action when you select the actions from 'Browse Repository' module

  • Result related

    • 'Export results' calls the module 'Export results' and exports the result to a CSV file

    • 'Generate API script' is described in a separate use-case in the next section

    • 'Properties' is showing the column information for the selected cell

    • 'Clipboard actions' can be used to copy a cell value, row value or all the data in the result

Generate API script

This is an action from the result list context menu. When selected you get this screen

You need to fill an API Template based on variables from the result that are shown in the bottom list.

So, an input like this

dump,c,{r_object_id}
set,c,object_name
{title}
save,c,{r_object_id}

Will result in an output like this which can be directly executed as 'normal' API script

dump,c,0912d59180000787
set,c,object_name
my test title
save,c,0912d59180000787

By default, it generates the script based on the current selected object ID. The mark 'Per result item' will generate the script for all the items in the result. So, with 2 items in the result the output (with the same example) will look like this

dump,c,0912d59180000786
set,c,object_name
my second title
save,c,0912d59180000786
dump,c,0912d59180000787
set,c,object_name
my test title
save,c,0912d59180000787

Administration -> Manage Users

This module lets you edit the 'dm_user' objects in more detail.

When you select a user, the fields are filled in for you to change.

This list can be filtered by the top-left textbox and the total number of users in the list is shown in the left-bottom number.

Available buttons:

  • 'Exit' brings you back to the main screen
  • 'Update' is only available once a field is updated for the current selected user
  • 'Export User' generates an API script based on the current selected user data
  • 'New User', 'Delete User', 'Copy User' and 'Refresh' are not functional yet

Administration -> Manage Jobs

This module lets you edit the 'dm_job' objects in more detail.

When you select a job, the fields are filled in for you to change.

This list can be filtered by the top-left dropdown and the total number of jobs in the list is shown in the left number.

Available buttons:

  • 'Exit' brings you back to the main screen
  • 'Update' is only available once a field is updated for the current selected job
  • 'Refresh' will refresh the list when new jobs are available
  • 'New Job', 'Export Job', 'Delete Job' and 'Copy Job' are not functional yet

Note the nice feature to 'Watch a job' for running. Mark the 'Run After Update', 'Update' the job and then mark the 'Watch Job' option!

Administration -> Manage Workflows

This module lets you view 'dm_workflow' instances in more detail.

By default, all the 'dm_workflow' instances are shown with the process variable (if applicable), packages, attachments and errors in the several tabs. Select a row in the workflow result table to get more data.

You can filter for the 'Today workflows', 'All workflows' or the 'Paused workflows'.

There is a mark 'Monitor' that puts the screen into a 'Watch mode' so the list will be refreshed based on the current filter settings.

With the 2 filter boxes you can filter out the flows by 'supervisor_name', 'object_name' or 'r_object_id'.

Info -> Show Current Sessions...

This action will show an overview in the result panel for the current sessions available

Info -> Get Last SQL

This action will show you the last executed SQL statement on the database

Special -> Enable SQL Trace

It will enable SQL trace that will be traced in the repository log

[DM_SERVER_I_TRACING_ENABLED_GLOBAL]info: "Tracing type: 'sqltrace'"

Special -> Disable SQL Trace

It will enable SQL trace that will be traced in the repository log

[DM_SERVER_I_TRACING_DISABLED_GLOBAL]info: "Tracing type: 'sqltrace'"

Help -> DQL Tester FX Help

Will bring you to this page

Help -> Shortcut Keys

Will bring you to the shortcut keys page

Help -> About DQL Tester FX

This panel will show the current version of the tool and some links to useful information like 'What is new', 'Send feedback' and 'License information'

⚠️ **GitHub.com Fallback** ⚠️