HowTo: Customize The GXflow Client

Unofficial Content
This documentation is valid for:

To create a GXflow client tailored to your needs, that is, with a look & feel and behavior that matches the rest of your application, you can use a sample xpz containing a reference implementation based on workflow data types. This allows you to use it as it is and apply your application's design, or change it entirely to adjust its features to your needs. It can also be used as a reference to build a simpler Inbox with fewer options for the end user.

Where it is located

It is called CustomClient.xpz and is distributed with the GeneXus installation within: <GeneXus installation directory>\Packages\GXPM\Extra.

Import

Before importing it, check that a Business Process Diagram has been created in this Knowledge Base. This is necessary to make sure that the model has the workflow data types. Otherwise, the following error will occur during compilation:

error CS0006: The metadata file 'bin\WAPI.dll' cannot be found

In this case, copy the dll called wapi.dll from <GeneXus installation directory>\Packages\GXPM\WFAPI to the model’s bin directory, create an object of Business Process Diagram type, and Build All again.

The xpz file contains the following objects:

CustomClientStructure

WorkflowAPI: Contains the external objects corresponding to the workflow data types.

WorkflowClient

WorkflowDialogs

  • WorkFlowAssign - Web Panel to assign a workitem to a user.

  • WorkFlowComments - Web Panel to enter comments on a process instance or workitem.

  • WorkFlowDocumentVersions - Web Panel that allows you to manage the versions of a document.

  • WorkFlowNewDocument - Web Panel to create a new document.

  • WorkFlowOrganizationalUnitDefinitionDialog - Web Panel to add a new organizational unit definition.

  • WorkFlowOrganizationalUnitDialog - Web Panel to add a new organizational unit.

  • WorkFlowOrganizationalUnitMembers - Web Panel that allows you to manage the users of an organizational unit

  • WorkFlowRenameDocument - Web Panel that allows you to rename documents associated to the current process instance

  • WorkFlowRoleDialog - Web Panel to create a new role.

  • WorkFlowRoleUsers - Web Panel that allows you to manage the users of one role.

  • WorkFlowSelectActivity - Web Panel to select an activity.

  • WorkFlowUploadDocument - Web Panel to upload a file.

  • WorkFlowUserDialog - Web Panel to add/remove/modify users.

  • WorkFlowUserOrganizationalUnits - Web Panel that allows you to manage the organizational units of a user.

  • WorkFlowUserRoles - Web Panel that allows you to manage the roles of a user.

  • WorkFlowWorkWithDocuments - Web Panel that allows you to manage the documents of a workitem

 

WorkflowEntryPoints

  • WorkFlowDocuments - Web Component that allows you to manage your documents.

  • WorkFlowEvents - Web Component that allows you to view the events history.

  • WorkFlowHistory - Web Component that allows you to view a process history.

  • WorkFlowInbox - Web Component that allows you to manage the tasks that the user has to perform.

  • WorkFlowOrganizationalUnitDefinitions - Web Component that allows you to manage organizational units definitions

  • WorkFlowOrganizationalUnits - Web Component that allows you to manage organizational units.

  • WorkFlowProcessDefinitions - Web Component that allows you to manage process definitions

  • WorkFlowProcesses - Web Component that allows you to manage processes.

  • WorkFlowRoles - Web Component that allows you to manage roles.

  • WorkFlowSettings - Web Component that allows you to manage settings.

  • WorkFlowTasks - Web Component that allows you to manage tasks.

  • WorkFlowUsers - Web Component that allows you to manage users.

 

WorkflowHelpers

  • WorkFlowBuildApplicationUrl - Process that build the application url.

  • WorkFlowDocumentDownloader - Process that allows you to download documents.

  • WorkFlowFilters - Web Component that allows you to use filters in grids.

  • WorkFlowPaging - Web Component that allows you to use paging in grids.

 

WorkflowClient: Web Panel that centralizes the client.
 

WorkflowSignIn: Web Panel that allows you to log in to the workflow client.

Execution 

Then, during execution the form below is displayed:

CustomClient

keywords: custom client