|
xTuple ERP Reference Guide |
|
|
xTuple ERP Reference Guide |
| 1.1. New Incident | ||
|---|---|---|
 | 1. Incident |  |
Incidents can be used for multiple purposes, including customer service, trouble-ticketing, web-based communication with customers and vendors using the xTuple Web Portal—and more. For sites where xTuple Connect is installed and running, various email notification options are also available. To enter a new incident, go to . The following screen will appear:
When entering a new incident, you are presented with the following options:
Displays the incident number. You may set a beginning incident number at the level.
Enter a few words to briefly describe the incident.
Specify a user-defined category to assign the incident.
If your module is configured to allow for public/private incidents, this option will be shown. When shown, select to indicate you want the incident to be viewable publicly. This option applies primarily to sites where the xTuple Web Portal has been implemented. With the web portal, xTuple incidents may be viewed by customers, vendors, and others on your website. Depending on your website rules, private incidents may be hidden from most website users. To learn more about the CRM configuration which enables this option, please see Section 11.1.1, “Configure CRM”.
Specify the account the incident is associated with.
Specify the user who owns the incident. By default, the user who creates an incident becomes the owner of it.
Specify the user you want to assign the incident to.
Specify a system-defined incident status to assign to the incident from the available options:
This is the default incident status when a new incident is entered.
This status can be used for incidents which require more information before they can be confirmed.
A confirmed incident is ready to be acted on.
When incidents are assigned to a user, they become that user's responsibility.
A resolved incident is ready to be closed. Typically, users work to resolve the incidents assigned to them.
This is the final status and indicates an incident requires no further action. It is completed.
Specify a user-defined severity to assign the incident.
Specify a user-defined priority to assign the incident.
Specify a user-defined resolution to assign the incident.
Manually enter contact information in the fields below—or use the lookup feature to select pre-existing contact information. If the contact you select is linked to a CRM account, the account will be filled in automatically.
If your system is configured to use projects, select a project number to associate with the incident.
This is a scrolling text field with word-wrapping for entering general notes related to the incident. When a note is entered, the content of the note will also automatically be inserted as a comment on the incident. The comment created this way may not be edited; however, if you edit the note, the associated comment will include your edits.
If CRM is configured with a default incident EDI profile or if the category of this incident has an EDI profile, you may encounter an EDI processing interface when saving the incident.
To enter characteristics associated with an incident, select the tab. The following screen will appear:
To create a new characteristic for your current context, select the button from the characteristics list. The following screen will appear:
When creating a new characteristic, you are presented with the following options:
Select a characteristic from the list of characteristics available for your current context. To learn more about how characteristics are linked to specific contexts, please see Section 9.2.2.1, “Characteristic”.
Enter a value to associate with the characteristic.
In some contexts, the Default option will appear. Select if the value entered is the default value for the specified characteristic. Default values will always be listed first where characteristics are used.
To define item and accounting relationships for an incident, select the tab. The following screen will appear:
When defining item and accounting relationships for an incident, you are presented with the following options:
Use the following fields to link an incident to a specific item or lot/serial number:
Enter the item number of the item (if any) you want to associate with the incident.
Inventory unit of measure.
Manually enter a lot/serial number (if any) to associate with the item—or use the lookup feature to select pre-existing lot/serial number information.
Incidents may be linked to a specific receivable item from the right-click menu on the Open Receivables screen. When an incident is linked to a specific receivable item, you are presented with the following options:
Displays the type of document associated with the incident. Document types would include credit memo, debit memo, invoice, and cash deposit.
Displays the identifying number of the document.
When creating a recurring event, you are presented with the following options:
Check this box if you want the event to repeat itself at regular intervals, using the frequency settings you specify below. Recurring events are generated when you run the Recurring Items utility, which is described in more detail here: Section 10.2, “Create Recurring Items”.
Enter a number and select a unit of time to describe how frequently you want the event to occur. You can choose any regular schedule, ranging from once every 1 minute to once every 99 years.
Enter a date and time at which to start the first event. The default value is the time the screen opened. The From option only appears on some screens.
Enter a date and time after which the event should no longer occur.
Enter the maximum number of future copies of this event you want the system to maintain. Whenever the Create Recurring Items screen is run, it will create up to the number you enter here.
If you delete all copies of a recurring event, the event will stop repeating even if the until date has not yet been reached. xTuple recommends setting this to at least 2 to reduce the likelihood of deleting all copies of the event.
Select to make the next job catch up if work was missed.
Select to create one catch-up job if work was missed.
Select to create any missed jobs.
To view the history associated with an incident, select the tab. The following screen will appear:
The History screen displays information related to the incident, including username of incident creator, created date, status, and description.
To view system-generated comments associated with an incident—or to add new comments of your own—select the tab. The following screen will appear:
When adding or reviewing comments, you are presented with the following options:
Select to display all comments in the list in an expanded view which includes the entire text of each comment. To edit a comment, simply select the link next to the comment. That link will not be shown for changelog comments, which can't be edited. If the Verbose Text option is not selected, the comment list will display only header level information for each comment.
Display lists comments related to the record.
The following buttons are available:
Opens screen for creating a new comment.
Highlight a comment and then select this button to reach a read-only view of the Edit screen.
Enables you to edit highlighted comments—as long as the comments are not changelog comments. ChangeLog comments are system-generated and may not be edited. The Edit screen is the same as that for creating a new comment—except that when editing, the fields will contain comment information. Double-clicking on a comment will also bring you to the editing screen.
To enter a new comment, select the button. The following screen will appear:
Select a comment type from the drop-down list to classify the comment. This is a required step. Comment types may be system-defined (i.e., changelog and general) or user-defined, as described in Section 13.2.3, “Comment Types”. Once you have specified a comment type, begin typing your comment in the main text area. The text area features word-wrapping and scroll-bar support for longer comments.
The following buttons are unique to this screen:
Select to show the complete list (i.e., thread) of comments associated with the record. To hide the list, simply select the button again. The comment thread will show the most recent comment first.
To view the subscribers to an incident, select the tab. The following screen will appear:
Incident Subscribers
Subscribers are automatically added to the list of recipients when xTuple Connect sends email for changes to incidents. Subscribers can be either users or contacts, as long as they have an email address. To add a subscriber, click the button. The following screen will appear:
Adding a subscriber
When adding a subscriber, you are presented with the following options:
Select either user or contact.
Type or select the username of an xTuple ERP system user.
Type or select the first and last name of a contact.
To view the documents associated with an incident, select the tab. The following screen will appear:
Incident Documents
When associating documents, you are presented with the following options:
Select to create a new document and associate it with the current record. You may create the following document types:
Select to create a new image association.
Select to create a new fixed asset association.
Select to create a new maintenance order association.
Select to create a new incident and associate it.
Select to create a new project and associate it.
Select to create a new opportunity and associate it.
Select to create a new task and associate it.
Enables you to edit associated documents. The Edit screen is the same as that for creating a new document—except that when editing, the fields will contain document information. Double-clicking on a document will also bring you to the editing screen.
Highlight a document and then select this button to reach a read-only view of the Edit screen.
Select to associate already-existing documents. The following document types may be attached: contact, account, customer, employee, file, image, incident, item, opportunity, project, purchase order, sales order, vendor, web site, work order.
Highlight a document and then select this button to remove the association.
To associate already-existing documents, select the button. The following screen will appear:
When associating already-existing documents, you are presented with the following options:
Indicate how the document is related to the current record. The following relationship options are available: related to, parent of, child of, duplicate of.
Specify the kind of document you want to associate. The following document types may be attached: contact, account, customer, employee, file, image, incident, item, opportunity, project, purchase order, sales order, vendor, web site, work order. When associating files, you will also be given the option to save the file to the database.
There is no file size restriction when saving files to the database. However, excessively large files could cause storage and performance issues.
Leave any notes on the document file as needed.
Use the lookup tool to identify the specific document you want to attach. The data entry options will vary depending on the document type you select.
To view alarms associated with an incident, select the tab. The following screen will appear:
To create a new alarm, select the button. The following screen will appear:
When creating a new alarm you are presented with the following options:
Add the date and time when you want the alarm to alert specific users and contacts.
Select if you would like an event to trigger the alarm. You may select from an unlimited list of users to be notified.
Select if you would like an email notification to be sent as an alarm. You may select from an unlimited list of users to be notified.
Select if you would like a system message to be issued as an alarm. You may select from an unlimited list of users to be notified.
The following buttons are available:
Allows you to choose unlimited number of users created in the system.
Allows you to choose from unlimited number of contacts created in the system.
Creates the alarm and adds it to the list of alarms.
Closes the screen without creating an alarm, returning you to the previous screen.
To view email associated with an incident, select the tab. The following screen will appear:
When viewing associated emails, you are presented with the following options:
Display lists associated emails.
The content of a highlighted email will be displayed here.
Specify the maximum number of associated emails you want to be displayed in the email list. If the list is extremely long, you may experience some slowness when opening the screen.
Select to load all associated emails into the list.
Enter a string of letters or complete words to search for matches in the list of associated emails. The search will scan through subject lines, To addresses, and From addresses.
The following buttons are unique to this screen:
Select to send a new email, using the default email program on your computer.
Highlight an email and then select this button to print a copy of the email.
Highlight an email and then select this button to reply to the email's sender, using the default email program on your computer.
Highlight an email and then select this button to reply to everyone associated with the email, using the default email program on your computer.
Highlight an email and then select this button to forward the email to another person(s), using the default email program on your computer.
Highlight an email and then select this button to attach an email associated with a contact in your contact list.
Highlight an email and then select this button to remove the associated email from the list.
| |  | |
| 1. Incident |  | 1.2. List Incidents |