|
xTuple ERP Reference Guide |
|
|
xTuple ERP Reference Guide |
Comment Types are required whenever you enter a new Comment. They are used to distinguish between different categories of Comments. There are two system-defined Comment Types ("Changelog" and "General") and an unlimited number of possible user-defined Comment Types. User-defined Comment Types may be edited or deleted. System-defined Comment Types cannot be deleted, but the "General" Comment Type can be edited. You can also define the sort order for Comment Types to influence which Comment Types appear first at the top where there are used.
Another "hidden" feature of Comments is the ability to mark them as being either public or private. This feature can be useful if you are running xTuple Web Portal products where comments may be viewed in a public context. In the metric table of the xTuple Database, there is a metric called CommentPublicPrivate which can be manually turned on to enable the public/private Comment feature. If public/private Comments are enabled, an additional metric called CommentPublicDefault defines whether new Comments are public or private by default. For more information on how to set this up, please contact your xTuple system administrator.
To access the master list of Comment Types, select the "Comment Types" option. The following screen will appear:
The "Comment Types" screen displays information on all existing Comment Types, including Comment Type name and Comment Type description.
To create a new Comment Type, select the NEW button. The following screen will appear:
When creating a new Comment Type, you are presented with the following options:
Enter a unique Comment Type name.
Enter a brief description of the Comment Type.
Specify the sort order for the Comment Type. The order number defines where the Comment Type will appear in lists where it is used. For example, Comment Types assigned order "1" will appear at the top of Comment Type selections and those defined as order "5" will appear farther down the list.
Select if you want to allow users to edit the content of Comments entered using the Comment Type. If not selected, users will not be able to edit Comments created under the Comment Type—in other words, Comments will be read-only.
Specify the module(s) where you want the Comment Type to be available for use. For example, if you only want Comments using this Comment Type to appear in the Manufacture module, then select the "Manufacture" option from the drop-down list. You can then further limit visibility to the Comment Type by selecting one or more sources available for each module. Users will only be able to use a Comment Type if the Comment Type has been explicitly assigned to a module and source.
For each of the available modules, there are corresponding places (i.e., sources) where Comments may be entered. In the Sales module, for example, you can add Comments to Customers, Sales Orders, Quotes, etc. The available sources list indicates all the places in a module where Comments can be used.
The granted sources list indicates all the places in a module where the Comment Type has been made available for use. If a source does not appear in the granted list, then the Comment Type won't be available for use in that source.
The following buttons are unique to this screen:
Highlight a specific source in the available sources column, then select this button to transfer the source to the granted sources column. Double-clicking on an available source will also transfer it to the granted sources column.
Select this button to automatically transfer all available sources to the granted sources column.
Highlight a specific source in the granted sources column, then select this button to remove the source from the granted sources column. Double-clicking on a granted v will also remove it from the granted sources column.
Select this button to automatically remove all granted sources from the granted sources column.