|
xTuple ERP Reference Guide |
|
|
xTuple ERP Reference Guide |
| 11.5.1. Custom Command | ||
|---|---|---|
 | 11.5. Custom Commands |  |
Custom commands enable you to insert ad hoc functionality into the xTuple ERP menu system. Examples of ad hoc features are custom report definitions, custom .ui screens, and more. All custom commands are launched from a special menu option, which gets created at the bottom of the menu tree for modules you are adding custom commands to. To create a new custom command, select the button. The following screen will appear:
When creating a new custom command, you are presented with the following options:
Select the name of the module where you want the menu option to appear. You may create custom commands for any of the modules within the system. By default, a menu option named will be added to the bottom of a module's menu tree when a custom command is created for that module.
You must restart the application to see any new menu options. Some changes, like newly-added arguments, are effective immediately for existing custom commands.
Enter a name to identify the custom command as it will appear on the menu tree for the specified module. Each menu label should be used to describe a separate custom command. There is no limit to the number of custom commands which may be added to a module.
Enter a name to describe the privilege associated with the custom command. By associating a privilege with a custom command, you gain the ability to grant or withhold access to the menu option on a user-by-user basis. Users who have been granted the privilege will have access to the custom command; all others will not. Keep in mind, this is an optional setting. If the privilege name is left empty, then all users will have access to the Custom Command.
Enter a programmatic-style name for the custom command, so the system will be able to locate and process the information easily. This is an optional setting but it is recommended. Having an action name also makes it possible to create a hot key for the custom command. Because of the hot key feature, you should consider using an action name which conforms to the already-existing naming convention for hot key actions. For more information see Section 5.1, “Hot Key”.
The information entered in this field will vary depending on the use case—that is, whether you are launching a custom screen, custom report, other executable program, etc. If the custom command will launch an executable program (e.g., RPTRender), then you should enter the path to the location where the executable program is located. When users select the associated menu option, the executable program will be launched.
Enter text to describe the custom command.
If you want the system to pass parameters or other arguments to the specified executable when it is launched, select the tab. The following screen will appear:
The arguments display lists all arguments defined for the specified executable. When trying to open a web page or file (i.e., the executable is set to !openurl), create a new argument and enter the URL to open (see Qt's documentation for details). If there are multiple arguments, each will be opened.
To create a new argument for the system to pass to the specified executable program, select the button. The following screen will appear:
When creating a new argument, you are presented with the following options:
Specify the order in which the argument should be passed to the specified executable program.
You can change the position of an argument as it appears on the list by editing the argument and changing its order number. If there are multiple arguments with the same number, then their order is undefined.
Enter the argument you want the system to pass to the specified executable program.
If the custom command is designed to launch a custom report, specify the location for the standalone report renderer (RPTrender) in the Executable field. The following examples illustrate how (on Windows) you can map to either local or network drives:
Local Drive: C:\Program Files\xTuple\RPTrender.exe
Network URL: \\drive_name\dir_name\xTuple\RPTrender.exe
You may encounter cross-platform conflicts when placing executables on network drives. To reduce these conflicts, it may be necessary to create separate custom menus to support executables designed for different operating systems.
Macintosh users should enter an executable path which points all the way to the executable file located within a package's contents directory. For example, to launch the report renderer, enter the following path:
../rptrender.app/Contents/MacOS/rptrender
Under Mac, the RPTrender application will not open if the path does not continue past the rptrender.app file.
The next table shows the range of possible arguments you can pass to the report renderer (RPTRender) if you are running custom reports:
Table 9.3. Arguments Used for Custom Reports
Syntax | Description |
|---|---|
-databaseURL | Used to specify the location of the database server. This is followed by the server address, database name, and port number. If running a custom report, the program will automatically connect to the database specified when the report renderer (RPTrender) is launched Example:
|
-username | Enter the username RPTrender should use to connect to the specified database. Example:
|
-passwd | Enter the password for the specified user. Example:
|
-param | Enter any parameters you want the system to pass to the report renderer. These pre-defined parameters will be used when RPTrender runs the specified report definition. Example:
|
This argument tells RPTrender to print the specified report definition using the indicated parameters—if any. Example:
| |
-close | Use this argument to close the RPTrender program when its work is done. Example:
|
-noAuth | This argument tell RPTrender that not all login fields, if any, are required and it will attempt to login to the specified database without presenting the Login screen. Example:
|
-loadfromdb= | This argument specifies the name a report definition to load from the database that is being connected to. Example:
|
-printerName= | This argument specified the printer to print to by it's name. Names vary from system to system and you must determine the correct name for this option. Example:
|
This argument specifies that you want the output to be in .pdf format. Example:
| |
-outpdf= | This argument specifies the name you want .pdf output to be sent to. Example:
|
If the custom command is designed to launch a custom screen, then the following text should be entered in the Executable field:
!customuiform
It should be noted, however, that launching custom screens in this matter is a deprecated approach. This same functionality can be addressed more elegantly using xTuple's scripting tool set.
The following table shows the range of possible arguments if the executable is a custom screen (i.e., ui form):
Table 9.4. Arguments Used for Custom Screens
Syntax | Description |
|---|---|
uiform= | This is a required argument. Use the argument followed by the name of the ui form (i.e., the screen) which the custom command will be executing. The screen name is the name entered on the main Custom Screen window. Example:
|
uiformtype= | Use this argument to specify which type of screen it is. There are two possible values: Example:
This is an optional argument. The default value is |
| |  | |
| 11.5. Custom Commands |  | 11.6. Packages |