Tool descriptors

All the following use the tool type of EXTPOINT which is similar to PLUGIN and also uses the ISA_Plug_In element to specify the ID.

Tool Descriptor MF_GetWorkspaceProjects
Input Parameter #1 -> [natures criteria]
Output Parameter #1 -> MF_WKSP_ResultList
Tool Descriptor MF_GetWorkspaceContents
Input Parameter #1 -> [the workspace container]
Output Parameter #1 -> MF_WKSP_ResultList
Tool Descriptor MF_LocalEdit
Tool Descriptor MF_LocalPaint
Tool Descriptor MF_LocalDataEdit
Tool Descriptor MF_Properties
Tool Descriptor MF_EclipseCommandHandler
Input Parameter #1 -> [the handler ID]
Input Parameter #2 -> [the command ID]
Tool Descriptor MF_SelectProjectFolder
Input Parameter #1 -> PARAM_PromptText
Input Parameter #2 -> PARAM_Natures
Output Parameter #1 -> MF_WKSP_ResultList
Tool Descriptor MF_SelectFolder
Input Parameter #1 -> PARAM_PromptText
Input Parameter #2 -> PARAM_Project
Output Parameter #1 -> MF_WKSP_ResultList
Tool Descriptor MF_RefreshResource
Tool Descriptor MF_DeleteResource
Tool Descriptor MF_MoveResource
Input Parameter #1 -> MFProp_WorkspacePath
Input Parameter #2 -> MFProp_ProjectFolder
Tool Descriptor MF_CopyResource
Input Parameter #1 -> MFProp_WorkspacePath
Input Parameter #2 -> PARAM_TargetFilename
Tool Descriptor MF_RenameResource
Input Parameter #1 -> MFProp_WorkspacePath
Input Parameter #2 -> PARAM_TargetFilename
Tool Descriptor MF_ClearFileCache
Tool Descriptor MF_ParseWithRefresh
Tool Descriptor MF_ClearFileCache
Tool Descriptor MF_ParseWithRefresh
Tool Descriptor MF_ResolveResourceToPath
Input Parameter #1 -> PARAM_SourcePath
Input Parameter #2 -> PARAM_TargetPath
Tool Descriptor MF_ResolvePathToResource
Input Parameter #1 -> PARAM_SourcePath
Input Parameter #2 -> PARAM_TargetPath
Tool Descriptor MF_IsAutoBuilding
Output Parameter #1 -> [True or False]
Tool descriptor/relationships Attribute Meaning
MF_GetWorkspaceProjects Target_ID = MF_WKSP_ResultList Use this tool to return all the projects in the Eclipse workspace which match the selection criteria based on the nature of the project (such as project type).

It takes a list of project natures to include or exclude from the project list returned as an input parameter. To exclude a nature which would otherwise be included, precede it with "!".

The example below returns all mainframe projects (local and UNIX remote): 
com.microfocus.eclipse.project.cobolNature,com.microfocus.eclipse.edt.core.edtNature
To exclude UNIX remote projects, add: 
,!com.microfocus.eclipse.project.remoteCobolNature
MF_GetWorkspaceContents Target_ID = MF_WKSP_ResultList

Use this tool to return all the sub-items of a workspace container, as returned by an earlier invocation of MF_GetWorkspaceContents or MF_GetWorkspaceProjects.

An action associated with the MF_GetWorkspaceContents tool would be expected to be configured as the Get Children action on the workspace project element type (MF_ELE_PROJECT). This action must be configured to have an element list of MF_ELIST_WorkspaceListStructure.

MF_LocalEdit - The same as the standard Edit Opener integrated tool.
MF_LocalPaint - Opens the BMS screen painter on the selected workspace resource.
MF_LocalDataEdit - Opens the DataTools data file editor on the selected workspace resource.
MF_Properties - Opens the Eclipse Properties dialog box for the selected workspace resource.
MF_EclipseCommandHandler - Invokes an Eclipse command handler by ID. A generic tool that works with most command handlers.

The input parameters are the selected workspace resource, and the ID of the handler and command to be invoked.

See the table below for a list of these IDs.

MF_SelectProjectFolder - Displays a dialog box to allow the user to select a sub-folder within a workspace project.

Use the element representing the workspace project for which the dialog box should allow sub-folder selection and the prompt text to show in the dialog box as the input parameters.

The output parameter is the workspace element representing the selected sub-folder

MF_SelectFolder - Displays a dialog box to allow the user to select a project or sub-folder within the workspace. You can filter the available projects by nature ID.

It takes a list of project natures to include or exclude from the project list returned as an input parameter. To exclude a nature which would otherwise be included, precede it with "!".

Use the prompt text to show in the dialog box as the other input parameter.

The output parameter is the workspace element representing the selected sub-folder

MF_RefreshResource - Refreshes the selected resource. The same as the Eclipse file system refresh tool
MF_DeleteResource - Deletes the selected resource.
MF_MoveResource - Moves a resource from one folder to another.

As input parameters, it takes the full workspace path to the resource to move and the location to which resource should be moved

MF_CopyResource - Makes a copy of the resource in the same folder with a different name.

As input parameters, it takes the full workspace path to the resource to move and the filename, without a path, of the new resource.

MF_RenameResource - Renames a resource within a folder.

As input parameters, it takes the full workspace path to the resource to rename and the new filename, without a path.

MF_ClearFileCache - Clears the entire copybook cache.
MF_ParseWithRefresh - Used as global editor action, and causes a fresh background parse to be done after getting new copies of copybooks from the mainframe and refreshing the cached copies.
MF_ResolveResourceToPath - Returns the local file system path for an Eclipse resource.

It takes the workspace path to the resource as its input parameter, and outputs the file system path.

MF_ResolvePathToResource - Returns the Eclipse resource location for a local file system path.

It takes the file system path to the resource as its input parameter, and outputs the workspace path.

MF_IsAutoBuilding - Returns True or False depending on whether the workspace has "Build Automatically" enabled or not.

MF_EclipseCommandHandler handler and command IDs

Name Handler ID Command ID
Determine Directives com.microfocus.eclipse.project com.microfocus.eclipse.project.determineDirectives
Selected file compile com.microfocus.eclipse.edt.ui com.microfocus.eclipse.edt.ui.compileFile
Submit to Enterprise Server com.microfocus.eclipse.edt.ui com.microfocus.eclipse.edt.ui.submitJcl
IMS Zeroload com.microfocus.eclipse.edt.ui com.microfocus.eclipse.edt.ui.imsdbu.zeroload
IMS Load com.microfocus.eclipse.edt.ui com.microfocus.eclipse.edt.ui.imsdbu.load
IMS Unload com.microfocus.eclipse.edt.ui com.microfocus.eclipse.edt.ui.imsdbu.unload
IMS Add com.microfocus.eclipse.edt.ui com.microfocus.eclipse.edt.ui.imsdbu.add
Parent topic: Enterprise Developer for IBM zEnterprise workflow modelling extensions