+1-757-461-3022 x124

Library

Primary tabs

What API keys and fields are required to use FedEx with xTupleCommerce?

If you want to include FedEx in the list of shipping options for your xTupleCommerce customers, you'll need to acquire API keys from FedEx, for both your production and development environments. Once you have the information and have added the keys to the ERP, the keys will need to be added to the xTupleCommerce website.

Here is an outline of the fields you need for both the production and development keys: 

Production Keys

  • Account Username
  • Account Password
  • Authentication Key
  • Meter Number
  • Account Number
  • Production API Password
  • Production URL

Development Keys

  • Account Username
  • Account Password
  • Test Key
  • Test Key Password
  • Test Account Number
  • Test Meter Number
  • Test URL
Was this Helpful?
up
52 users have voted.

Where do I mark commissions as paid?

Commissions can be marked as paid from any of the sales history reports. To do this, open a sales history record for editing—and then select the paid option. The commission will now be shown as paid in sales commission reports.

Was this Helpful?
up
52 users have voted.

Are there examples of customer groups?

One option would be to define customer groups by geographic region. For example, you might organize customers by country (e.g., U.S., Mexico, Canada) or by state (e.g., VA, NY, CA). Another possibility would be to create groups that organize customers by sales volume (e.g., small, medium, large). Customer groups are user-definable. You can set them up however you wish.

Was this Helpful?
up
51 users have voted.

Can I manage my item images in the xTupleCommerce website?

Your xTupleCommerce site has the capability of hosting images, PDFs, documents and other media. Once your site is live you can associate these files with Items and Item Groups in the ERP. For instance, you can associate product images with Items in the ERP. Or you can associate Marketing PDFs with Items in the ERP. These images and PDFs will be displayed with the products on the xTupleCommerce site.

If your site is still in the development or testing phases (aka, you are still going to a stage.domain.xtuple.net URL to view your site), we encourage you to use a service such as Cloudinary to host your images and determine URLs.

However, if your xTupleCommerce website has gone live, you can begin using the site to host files and create the URLs needed for the document in the ERP. 

Uploading the files to your xTupleCommerce site :

  1. Go to your xTupleCommerce website and login as a manager or editor. 
  2. Navigate Admin > Content > Files.
  3. Click ADD FILE
  4. Select and upload the image. Typically files must be less than 8MB. 
  5. Click NEXT
  6. Leave the radio button selected for public local files and click NEXT.
  7. Update and fill in the fields for name and file name. The name will show up in the URL path of the image. 
  8. Click SAVE. 
  9. Highlight the path of the image-most recently added files are on the top of the list-and copy.

Associate files with Items or Item Groups in the ERP

  1. Login to your ERP.
  2. Open an Item or Item Group
  3. Go to the documents tab
  4. Click Attach
  5. Choose Web Site from the drop down
  6. Give the file a name in the Name field
  7. Paste the URL into the URL Field
  8. The URL should include your website domain followed by the path that you copied.  
    Example: https://www.yourwebsite.com/files/public/content/media/image.jpg
  9. Click Save 
  10. Save and close the Item and Item Group

Check your work

Navigate to the Item or Item Group where the file should appear on the website

The file should appear. If the file does not appear, you may need to flush the cache on the website.

Was this Helpful?
up
51 users have voted.

Do I need more than one cost category?

You can certainly run your business using only one cost category. That's all you need to set up item sites and track inventory movements in the general ledger. If you want more detailed inventory accounting, though, you should consider implementing multiple cost categories. For example, you might have a cost category for finished goods and a different one for raw materials. In this way you can track particular item types or groups by different accounts—thus leading to more detailed financial reporting.

Was this Helpful?
up
51 users have voted.

Do I need to enter a base currency?

If you are using only xTuple CRM, then currency is optional. However, once you begin to use xTuple accounting, you must have a base currency defined. The base currency is your currency of record. It is used by the general ledger to record accounting transactions.

Was this Helpful?
up
51 users have voted.

Our xTupleCommerce website is down. What do we do?

If you are hosting your website on your own web server, we suggest you try rebooting your server. If your website is being hosted on the xTuple cloud, please report an incident and we will reboot it for you.

Was this Helpful?
up
51 users have voted.

When do I use tax classes?

Tax classes are needed for managing complex tax scenarios—for example, tiered, nested, or cumulative taxes. With tax classes, you can manipulate the sequence in which tax codes are applied. By applying multiple tax codes in the correct order, you can build support for even the most complicated tax requirements.

Was this Helpful?
up
51 users have voted.

Why do some privileges appear greyed-out?

If a user privilege is greyed-out, this means the privilege belongs to a user account role. Bold-colored checkboxes indicate a privilege is assigned individually to the user. It's possible for users to have a combination of privileges—both individual privileges and privileges inherited from user account roles.

Hint: If you manually select a greyed-out privilege and make it bold, that privilege will remain with the user even if the underlying user account role is removed from their user account.

Was this Helpful?
up
51 users have voted.

Can I use abbreviations for state names?

Yes, you may abbreviate state names. However, before manually adding a state (or province) you should check whether the state already exists in the database. (Hint: If you enter the country first, the corresponding states, if available, will appear.) For example, the default list of states for the United States uses the standard two-letter abbreviations. New York appears as NY and Virginia appears as VA in the list of U.S. states.

Was this Helpful?
up
50 users have voted.

How do I drill down into inventory history?

The advanced search panel gives you the most control when trying to locate specific records or groups of records in inventory history. Click on the advanced search button in the main menu to open the advanced search panel. Using advanced search, you can specify multiple different parameters—making it possible to drill down and reach the specific records you are looking for.

Was this Helpful?
up
50 users have voted.

What is a characteristic role?

Characteristic roles define where characteristics can be used. For example, if you want a characteristic to be associated with contact records, you would select the contact role. Item characteristics would require the item role. And so on. Individual characteristics may be associated with multiple roles. The same characteristic might apply to contacts and addresses and opportunities. If you are having trouble finding a characteristic to associate, it's likely the characteristic role isn't defined properly.

Was this Helpful?
up
50 users have voted.

What's the difference between a context and a source?

When using Qt Linguist for translation work, you will see references to "contexts" and "sources."

  • context is a business object, like the contact screen or the bill of materials screen.

  • source is a specific string of text within a context. For example the “Bill of Materials” context contains 56 sources, including “Print”, “Save”, “Revision Date”, etc.

Was this Helpful?
up
50 users have voted.

Do returns update inventory?

Yes, returns will automatically return stock to inventory, assuming the return line item has the update inventory flag selected. If that flag is not selected, your inventory will not be updated.

Was this Helpful?
up
49 users have voted.

How does xTupleCommerce secure credit card transactions?

Both the xTupleCommerce system and the ERP both integrate with a secure credit card payment gateway. The following graphic provides a high-level illustration of how the process works:

 

 

  1. xTupleCommerce sends the submitted credit card information and requested amount to the Credit Card (CC) Gateway to check for a pre-authorization (preauth).
  2. The CC Gateway confirms that the requested amount is available on the credit card and provides a token for the preauth.
  3. xTupleCommerce sends the preauth token to the ERP along with the sales order.
  4. The ERP sends the token to the CC Gateway asking to confirm the preauth for the exact amount of the sales order.
  5. The CC Gateway confirms that the preauth is still valid
  6. The ERP sends confirmation of the order to the CC Gateway and requests that they charge the credit card with the exact amount.


When storing a credit card on file, xTupleCommerce uses the CC Gateway tokens that represent the credit card information and customer data. In addition, the "Blowfish Security" algorithm for encrypting sensitive information is used in the PostgreSQL database, on the ERP side. This ensures that the customer information is never passed or stored as plain text, but rather as an encrypted string of letters and numbers that serve as a key to unlock that information. Without a direct connection to the CC Gateway system through the API integration, the keys are worthless, thus preventing attackers from obtaining the sensitive information.

Was this Helpful?
up
49 users have voted.

How do I become a translator for xTuple?

If you are interested in getting involved with xTuple user interface translation, please review the following articles: Starting a new translation project and Getting and Using xTuple Translation Files. Translators will also find useful the Translation Glossary, which provides explanations of unfamiliar words/terms found in the user interface.

Was this Helpful?
up
49 users have voted.

How do shipment numbers get generated?

Shipment numbers are generated as soon as you issue stock to shipping for an order. The shipment number is pulled from the shipping configuration panel. During configuration, you define the initial shipment number—and then every shipment automatically increments the base shipping number by one. For example, if your starting shipment number is 60001, the second will be 60002, the third 60003, etc.

Was this Helpful?
up
49 users have voted.

In the tax system, how is the calculation basis used?

The calculation basis is used to determine how taxes should be applied. Choose the base price option to have taxes calculated off the base price of sold items. For those requiring more complex tax scenarios (i.e., nested taxes or "tax on tax"), the calculation basis can be linked to any other tax code which uses the same tax class. When another tax code is chosen as the calculation basis, taxes will be calculated against the derived amount from the referenced tax code.

Was this Helpful?
up
49 users have voted.

My xTupleCommerce account is temporarily blocked due to 5 failed attempts to login. How can I get into my xTupleCommerce website?

Unfortunately, you will have to wait until the system clears your IP Address for access. We do not have access to manually do this. The system may take an hour, 4 hours, or even 8 hours to clear your IP Address as there is no standard amount of time for it to cycle through. This is one of the main reasons we encourage our users to change their password to something easy for them to remember.

Was this Helpful?
up
49 users have voted.

What are item sources?

Item sources identify the relationship between items and the vendors who supply them. Having item sources pre-defined helps accelerate purchase order entry. Purchase order accuracy also improves when item sources are used.

Was this Helpful?
up
49 users have voted.

What does "Error on socket 0" mean?

That error typically indicates there is either an incorrect mail server configuration or a network problem of some kind. Check the mail server options in the xTuple Connect menu. Also check your mail server and network routing to make sure all is in order.

Was this Helpful?
up
49 users have voted.

Are freight classes required?

Freight classes are only required if you are using pricing schedules to automatically calculate freight charges during sales order entry. Pricing schedules include freight classes as one factor in their pricing matrix. Using this matrix, it's possible to define pricing schedules by freight class.

Was this Helpful?
up
48 users have voted.

Are opportunity stages required?

Yes, an opportunity stage is required when creating an opportunity. That means you must have opportunity stages defined before you can successfully save an opportunity.

Was this Helpful?
up
48 users have voted.

Can I add PDFs to an item and have them show up on my xTupleCommerce website?

Yes, you can add documents, such as PDFs, to individual items in the same way that you would add images linked to items. Like item images, the PDFs need to be stored on a separate web server, with a unique URL for each PDF. However, the ERP should contain cross references to these PDFs, via their URL.

To enter URLs for PDFs in the ERP, go to the item master for the item in question and follow these steps:

  1. Select the documents tab
  2. Choose the ATTACH button
  3. Next to the "related to" option, choose the "website" option from the list
  4. Enter the URL for the PDF
  5. Specify a name to identify it

The PDF will show up on the product page as a link for the user to view and download.

Was this Helpful?
up
48 users have voted.

Do all accounts need parents?

No, the parent account feature is optional. You would only use it for accounts that are sub-accounts. For example, you might have customers TTOYS-SE and TTOYS-NE that are regional branches of Tremendous Toys. In this case, you would link Tremendous Toys as the parent for both TTOYS-SE and TTOYS-NE.

Was this Helpful?
up
48 users have voted.