ManPageW Client
Enjoy it, and help to fill it! But please, always respecting copyright.
Please write your contributions under the Contributions Section
Contents
Window: Client
Description : Maintain Clients/Tenants
Help : The Client is the highest level of an independent business entity. Each Client will have one or more Organizations reporting to it. Each Client defines the accounting parameters (Accounting Schema, Tree definition, Non Monetary UOM's). To create new Clients, run the Initial Client Setup with the System Administrator Role. Do not create a new client in this window, but use "Initial Client Setup" to set up the required security and access rules. If you create a new client here, you will not be able to view it and also the required client infrastructure would not have been set up.
Tab: Client
Description : Client/Tenant Definition
Help : The Client Definition Tab defines a unique client. Do not create a new client in this window, but use "Initial Client Setup" (System Administrator Role) to set up the required security and access rules. If you create a new client here, you will not be able to view it and also the required client infrastructure would not have been set up.
Table Name : AD_Client
Fields
| Name | Description | Help | Technical Data |
|---|---|---|---|
| Search Key | Search key for the record in the format required - must be unique | A search key allows you a fast method of finding a particular record.
If you leave the search key empty, the system automatically creates a numeric number. The document sequence used for this fallback number is defined in the "Maintain Sequence" window with the name "DocumentNo_<TableName>", where TableName is the actual name of the table (e.g. C_Order). |
Value
NVARCHAR2(40) String |
| Name | Alphanumeric identifier of the entity | The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. | Name
NVARCHAR2(60) String |
| Description | Optional short description of the record | A description is limited to 255 characters. | Description
NVARCHAR2(255) String |
| Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
| Use Beta Functions | Enable the use of Beta Functionality | The exact scope of Beta Functionality is listed in the release note. It is usually not recommended to enable Beta functionality in production environments. | IsUseBetaFunctions
CHAR(1) YesNo |
| Language | Language for this entity | The Language identifies the language to use for display and formatting | AD_Language
VARCHAR2 Table |
| Multi Lingual Documents | Documents are Multi Lingual | If selected, you enable multi lingual documents and need to maintain translations for entities used in documents (examples: Products, Payment Terms, ...). Please note, that the base language is always English. |
IsMultiLingualDocument
CHAR(1) YesNo |
| Auto Archive | Enable and level of automatic Archive of documents | Adempiere allows to automatically create archives of Documents (e.g. Invoices) or Reports. You view the archived material with the Archive Viewer | AutoArchive
CHAR(1) List |
| Material Policy | Material Movement Policy | The Material Movement Policy determines how the stock is flowing (FiFo or LiFo) if a specific Product Instance was not selected. The policy can not contradict the costing method (e.g. FiFo movement policy and LiFo costing method). | MMPolicy
CHAR(1) List |
| Mail Host | Hostname of Mail Server for SMTP and IMAP | The host name of the Mail Server for this client with SMTP services to send mail, and IMAP to process incoming mail. | SMTPHost
NVARCHAR2(60) String |
| SMTP Authentication | Your mail server requires Authentication | Some email servers require authentication before sending emails. If yes, users are required to define their email user name and password. If authentication is required and no user name and password is required, delivery will fail. | IsSmtpAuthorization
CHAR(1) YesNo |
| Request EMail | EMail address to send automated mails from or receive mails for automated processing (fully qualified) | EMails for requests, alerts and escalation are sent from this email address as well as delivery information if the sales rep does not have an email account. The address must be filly qualified (e.g. joe.smith@company.com) and should be a valid address. | RequestEMail
NVARCHAR2(60) String |
| Request Folder | EMail folder to process incoming emails; if empty INBOX is used | Email folder used to read emails to process as requests, If left empty the default mailbox (INBOX) will be used. Requires IMAP services. | RequestFolder
NVARCHAR2(20) String |
| Request User | User Name (ID) of the email owner | EMail user name for requests, alerts and escalation are sent from this email address as well as delivery information if the sales rep does not have an email account. Required, if your mail server requires authentification as well as for processing incoming mails. | RequestUser
NVARCHAR2(60) String |
| Request User Password | Password of the user name (ID) for mail processing | RequestUserPW
NVARCHAR2(20) String | |
| Server EMail | Send EMail from Server | When selected, mail is sent from the server rather then the client. This decreases availability. You would select this when you do not want to enable email relay for the client addresses in your mail server. | IsServerEMail
CHAR(1) YesNo |
| Test EMail | Test EMail Connection | Test EMail Connection based on info defined. An EMail is sent from the request user to the request user. Also, the web store mail settings are tested. | EMailTest
CHAR(1) Button |
| Model Validation Classes | List of data model validation classes separated by ; | List of classes implementing the interface org.compiere.model.ModelValidator, separaed by semicolon.
The class is called for the client and alows to validate documents in the prepare stage and monitor model changes. |
ModelValidationClasses
NVARCHAR2(255) String |
| Post Immediately | Post the accounting immediately for testing | If selected, the accouning consequences are immediately generated when completing a doecument. Otherwise the document is posted by a batch process. You should select this only if you are testing, | IsPostImmediate
CHAR(1) YesNo |
| Cost Immediately | Update Costs immediately for testing | If selected, costs are updated immediately when a Cost Detail record is created (by matching or shipping). Otherwise the costs are updated by batch or when the costs are needed for posting. You should select this only if you are testing, | IsCostImmediate
CHAR(1) YesNo |
| Store Attachments On File System | StoreAttachmentsOnFileSystem
CHAR(1) YesNo | ||
| Windows Attachment Path | WindowsAttachmentPath
NVARCHAR2(255) String | ||
| Unix Attachment Path | UnixAttachmentPath
NVARCHAR2(255) String | ||
| Store Archive On File System | StoreArchiveOnFileSystem
CHAR(1) YesNo | ||
| Windows Archive Path | WindowsArchivePath
NVARCHAR2(255) String | ||
| Unix Archive Path | UnixArchivePath
NVARCHAR2(255) String | ||
| IsUseASP | IsUseASP
CHAR(1) YesNo |
Tab: Client Info
Description : Client Info
Help : The Client Info Tab defines the details for each client. The accounting rules and high level defaults are defined here. The Calendar is used to determine if a period is open or closed.
Table Name : AD_ClientInfo
Fields
| Name | Description | Help | Technical Data |
|---|---|---|---|
| Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
| Discount calculated from Line Amounts | Payment Discount calculation does not include Taxes and Charges | If the payment discount is calculated from line amounts only, the tax and charge amounts are not included. This is e.g. business practice in the US. If not selected the total invoice amount is used to calculate the payment discount. | IsDiscountLineAmt
CHAR(1) YesNo |
| Calendar | Accounting Calendar Name | The Calendar uniquely identifies an accounting calendar. Multiple calendars can be used. For example you may need a standard calendar that runs from Jan 1 to Dec 31 and a fiscal calendar that runs from July 1 to June 30. | C_Calendar_ID
NUMBER(10) TableDir |
| Primary Accounting Schema | Primary rules for accounting | An Accounting Schema defines the rules used accounting such as costing method, currency and calendar. | C_AcctSchema1_ID
NUMBER(10) Table |
| UOM for Volume | Standard Unit of Measure for Volume | The Standard UOM for Volume indicates the UOM to use for products referenced by volume in a document. | C_UOM_Volume_ID
NUMBER(10) Table |
| UOM for Weight | Standard Unit of Measure for Weight | The Standard UOM for Weight indicates the UOM to use for products referenced by weight in a document. | C_UOM_Weight_ID
NUMBER(10) Table |
| UOM for Length | Standard Unit of Measure for Length | The Standard UOM for Length indicates the UOM to use for products referenced by length in a document. | C_UOM_Length_ID
NUMBER(10) Table |
| UOM for Time | Standard Unit of Measure for Time | The Standard UOM for Time indicates the UOM to use for products referenced by time in a document. | C_UOM_Time_ID
NUMBER(10) Table |
| Template B.Partner | Business Partner used for creating new Business Partners on the fly | When creating a new Business Partner from the Business Partner Search Field (right-click: Create), the selected business partner is used as a template, e.g. to define price list, payment terms, etc. | C_BPartnerCashTrx_ID
NUMBER(10) Search |
| Product for Freight | M_ProductFreight_ID
NUMBER(10) Search | ||
| Days to keep Log | Number of days to keep the log entries | Older Log entries may be deleted | KeepLogDays
NUMBER(10) Integer |
| Organization Tree | Tree to determine organizational hierarchy | Trees are used for (finanial) reporting and security access (via role) | AD_Tree_Org_ID
NUMBER(10) Table |
| Menu Tree | Tree of the menu | Menu access tree | AD_Tree_Menu_ID
NUMBER(10) Table |
| BPartner Tree | Tree to determine business partner hierarchy | Trees are used for (finanial) reporting | AD_Tree_BPartner_ID
NUMBER(10) Table |
| Product Tree | Tree to determine product hierarchy | Trees are used for (finanial) reporting | AD_Tree_Product_ID
NUMBER(10) Table |
| Project Tree | Tree to determine project hierarchy | Trees are used for (finanial) reporting | AD_Tree_Project_ID
NUMBER(10) Table |
| Sales Region Tree | Tree to determine sales regional hierarchy | Trees are used for (finanial) reporting | AD_Tree_SalesRegion_ID
NUMBER(10) Table |
| Campaign Tree | Tree to determine marketing campaign hierarchy | Trees are used for (finanial) reporting | AD_Tree_Campaign_ID
NUMBER(10) Table |
| Activity Tree | Tree to determine activity hierarchy | Trees are used for (finanial) reporting | AD_Tree_Activity_ID
NUMBER(10) Table |
Description : Force (not) sharing of client/org entities
Help : Business Partner can be either defined on Client level (shared) or on Org level (not shared). You can define here of Products are always shared (i.e. always created under Organization "*") or if they are not shared (i.e. you cannot enter them with Organization "*").
The creation of "Client and Org" shared records is the default and is ignored.
Table Name : AD_ClientShare
Fields
| Name | Description | Help | Technical Data |
|---|---|---|---|
| Client | Client/Tenant for this installation. | A Client is a company or a legal entity. You cannot share data between Clients. Tenant is a synonym for Client. | AD_Client_ID
NUMBER(10) TableDir |
| Organization | Organizational entity within client | An organization is a unit of your client or legal entity - examples are store, department. You can share data between organizations. | AD_Org_ID
NUMBER(10) TableDir |
| Name | Alphanumeric identifier of the entity | The name of an entity (record) is used as an default search option in addition to the search key. The name is up to 60 characters in length. | Name
NVARCHAR2(60) String |
| Description | Optional short description of the record | A description is limited to 255 characters. | Description
NVARCHAR2(255) String |
| Active | The record is active in the system | There are two methods of making records unavailable in the system: One is to delete the record, the other is to de-activate the record. A de-activated record is not available for selection, but available for reports.
There are two reasons for de-activating and not deleting records: (1) The system requires the record for audit purposes. (2) The record is referenced by other records. E.g., you cannot delete a Business Partner, if there are invoices for this partner record existing. You de-activate the Business Partner and prevent that this record is used for future entries. |
IsActive
CHAR(1) YesNo |
| Table | Database Table information | The Database Table provides the information of the table definition | AD_Table_ID
NUMBER(10) TableDir |
| Share Type | Type of sharing | Defines if a table is shared within a client or not. | ShareType
CHAR(1) List |
