This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
app:app_how_to_cust [2019/08/01 00:13] dtucker [How To Export/Import Item Properties and Events] |
app:app_how_to_cust [2019/08/02 00:07] (current) dtucker [How To Publish APP Customizer Changes to All Users] |
||
|---|---|---|---|
| Line 8: | Line 8: | ||
| {{: | {{: | ||
| - | ===== How To Convert APP Form Customized Data to XML ===== | + | ===== How To Convert APP Form Customized Data to XML During APP Upgrade |
| Information for forms that have been customized using APP will be saved into the database as XML. These XML files are used at the time that the form is loaded in SAP® Business One. | Information for forms that have been customized using APP will be saved into the database as XML. These XML files are used at the time that the form is loaded in SAP® Business One. | ||
| Line 40: | Line 40: | ||
| * The user should fill in the Menu UID for each form and then click the <color # | * The user should fill in the Menu UID for each form and then click the <color # | ||
| * When the process is complete the user will receive a message on the SAP® B1 satus bar that the process was successful. | * When the process is complete the user will receive a message on the SAP® B1 satus bar that the process was successful. | ||
| + | |||
| + | {{: | ||
| + | |||
| + | ===== How To Publish APP Customizer Changes to All Users ===== | ||
| + | |||
| + | The APP Customizer **Publish Forms** screen lists all SAP® Business One forms or other APP registered forms that have been modified through APP Customizer (Item Placement, Tab Order, and Mandatory Fields). | ||
| + | |||
| + | Click the SAP menu option titled <color # | ||
| + | |||
| + | {{: | ||
| + | |||
| + | * Click the <color # | ||
| + | * Click the <color # | ||
| + | * Close the APP Customizer **Publish Forms** screen. | ||
| + | |||
| + | <WRAP center round info 90%> | ||
| + | Once APP Customizer form modifications have been published for all users, the changes will be reflected once any open instances of the form(s) published have been closed and reopened. | ||
| + | </ | ||
| + | |||
| {{: | {{: | ||
| Line 431: | Line 450: | ||
| Process Rules functionality allows the user to add field validations and procedure executions to enhance any SAP® Business One forms or UI-based add-on application screens without the use of programming knowledge. | Process Rules functionality allows the user to add field validations and procedure executions to enhance any SAP® Business One forms or UI-based add-on application screens without the use of programming knowledge. | ||
| - | + | {{: | |
| Line 2958: | Line 2976: | ||
| The tab order cannot be used to set the tab order of columns in an SAP UI grid or matrix object. This is an SAP® Business One UI limitation. | The tab order cannot be used to set the tab order of columns in an SAP UI grid or matrix object. This is an SAP® Business One UI limitation. | ||
| </ | </ | ||
| - | + | ||
| + | {{: | ||
| ===== How To Set Tab Order Sequence ===== | ===== How To Set Tab Order Sequence ===== | ||
| Line 3149: | Line 3168: | ||
| Mandatory Fields functionality allows the user to establish, edit, and remove custom designated mandatory fields for forms that will operate in addition to the normal required fields on a form. | Mandatory Fields functionality allows the user to establish, edit, and remove custom designated mandatory fields for forms that will operate in addition to the normal required fields on a form. | ||
| + | {{: | ||
| ===== How To Set Mandatory Fields ===== | ===== How To Set Mandatory Fields ===== | ||
| Line 3515: | Line 3534: | ||
| * {{: | * {{: | ||
| - | ===== How To Export/Import Objects and Properties ===== | + | {{:app/image44.jpeg? |
| + | ====== Exporting/ | ||
| APP Customizer includes the ability to export and import a number of objects, including... | APP Customizer includes the ability to export and import a number of objects, including... | ||
| - | Item Properties and Events | + | * Item Properties and Events |
| + | * Charts | ||
| + | * Dashboards | ||
| - | | + | <WRAP center round important 90%> |
| + | After importing **any** objects into APP, the application **must** be stopped and restarted for the imported modifications to take effect. | ||
| + | </ | ||
| - | | + | {{: |
| - | + | ====== How To Export Item Properties and Events ====== | |
| - | + | ||
| - | **[[# | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | **Warning –** After importing **any** objects into APP, the application **must** be stopped and restarted for the imported modifications to take effect. | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | + | ||
| - | ====== How To Export/ | + | |
| - | + | ||
| - | APP Customizer includes the ability to export and import Item Properties and Events | + | |
| <WRAP center round info 90%> | <WRAP center round info 90%> | ||
| This example is for the **Item Master Data** screen. | This example is for the **Item Master Data** screen. | ||
| </ | </ | ||
| - | |||
| - | ===== How To Export Item Properties and Events ===== | ||
| * Click the SAP menu option titled <color # | * Click the SAP menu option titled <color # | ||
| Line 3583: | Line 3591: | ||
| {{: | {{: | ||
| - | ===== How To Import Item Properties and Events ===== | + | ====== How To Import Item Properties and Events |
| - | Click the SAP menu option titled | + | <WRAP center round info 90%> |
| + | This example is for the **Item Master Data** screen. | ||
| + | </ | ||
| - | {{:app/image159.jpeg? | + | * Click the SAP menu option titled <color # |
| - | **Note** - For this example, I am reusing the same SAP database. The **Unit Price** field and label customizations have been removed following the export of the data to the XML file. | + | <WRAP center round info 90%> |
| + | For this example, I am reusing the same SAP database. The <color #00a2e8>**Unit Price**</ | ||
| + | </ | ||
| {{: | {{: | ||
| - | Click the SAP menu option titled | + | * Click the <color #22b14c>**Import XML**</ |
| - | + | | |
| - | {{:app/image67.jpeg?11x11}} | + | |
| - | + | ||
| - | A window will open to allow you to specify the directory and file name for the XML file to be imported. | + | |
| - | + | ||
| - | {{: | + | |
| {{: | {{: | ||
| - | Double click the file name or select the file and click the **Open** button. | + | * Double click the file name or select the file and click the <color #22b14c>**Open**</ |
| {{: | {{: | ||
| - | Stop and restart the APP application. | + | * Stop and restart the APP application. |
| - | {{: | + | <WRAP center round important 90%> |
| + | After importing **any** objects into APP, the application **must** be stopped and restarted for the imported modifications to take effect. | ||
| + | </ | ||
| - | **Warning –** After importing **any** objects into APP, the application **must** be stopped and restarted for the imported modifications to take effect. | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | Click the SAP menu option titled **Item Master Data** under the **Inventory** menu to load the Inventory | + | |
| {{: | {{: | ||
| - | The Item Master screen now reflects the customizations | + | * |
| - | {{:app/image34.jpeg?804}} | + | {{:app/image44.jpeg?786}} |
| - | ===== How To Export/ | + | ====== How To Export Charts |
| - | + | | |
| - | + | | |
| - | APP Customizer includes the ability to export and import Charts | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | **Exporting** | + | |
| - | + | ||
| - | Click the SAP menu option titled | + | |
| - | + | ||
| - | Click on the object with the associated Chart that you want to export. | + | |
| {{: | {{: | ||
| - | Click the **Manage Charts** button | + | * Click the <color #22b14c>**Manage Charts**</ |
| {{: | {{: | ||
| - | Click the **Export** button. | + | * Click the <color #22b14c>**Export**</ |
| - | + | | |
| - | A window will open to allow you to specify the directory and file name under which the exported XML file will be saved. | + | |
| {{: | {{: | ||
| + | * Enter a file name. | ||
| + | * Click the <color # | ||
| + | * Navigating and opening the exported XML file shows the data that has been exported and can be imported into either the same SAP database or any other SAP database utilizing APP Customizer. | ||
| - | + | <WRAP center round info 90%> | |
| - | Enter a file name. | + | The Query for the Chart is also included in the exported XML file information. |
| - | + | </ | |
| - | Click the **Save** button. | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | **Note** - The Query for the Chart is also included in the exported XML file information. | + | |
| {{: | {{: | ||
| - | **Importing** | + | ====== How To Import |
| - | + | ||
| - | Click the SAP menu option titled **Item Master Data** under the **Inventory** menu to load the Inventory Master Data screen. | + | |
| - | + | ||
| - | Click the SAP menu option titled **Import | + | |
| - | + | ||
| - | A window will open to allow you to specify the directory and file name for | + | |
| - | the XML file to be imported. | + | * Click the SAP menu option titled <color # |
| + | * A window will open to allow you to specify the directory and file name for the XML file to be imported. | ||
| {{: | {{: | ||
| - | | + | * |
| + | * The XML file will be imported into APP Customizer | ||
| {{: | {{: | ||
| - | Stop and restart the APP application. | + | * Stop and restart the APP application. |
| - | {{: | + | <WRAP center round important 90%> |
| + | After importing **any** objects into APP, the application **must** be stopped and restarted for the imported modifications to take effect. | ||
| + | </ | ||
| - | **Warning –** After importing **any** objects into APP, the application **must** be stopped and restarted for the imported modifications to take effect. | + | ====== How To Export Dashboards ====== |
| - | ===== How To Export/ | + | |
| - | + | | |
| - | + | ||
| - | + | ||
| - | APP Customizer includes the ability to export and import Dashboards | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | **Exporting** | + | |
| - | + | ||
| - | Click the SAP menu option titled **Dashboard Setup** under the **Administration** | + | |
| - | + | ||
| - | Load the Dashboard that you want to export. | + | |
| {{: | {{: | ||
| - | Click the **Export** button. | + | * Click the <color #22b14c>**Export**</ |
| - | + | | |
| - | A window will open to allow you to specify the directory and file name under which the exported XML file will be saved. | + | |
| {{: | {{: | ||
| - | Enter a file name. | + | * Enter a file name. |
| + | * Click the <color # | ||
| + | * Navigating and opening the exported XML file shows the data that has been exported and can be imported into either the same SAP database or any other SAP database utilizing APP Customizer. | ||
| - | Click the **Save** button. | + | <WRAP center round info 90%> |
| - | + | The Query for the Dashboard panes are also included in the exported XML file information. | |
| - | | + | </ |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | **Note** - The Query for the Dashboard panes are also included in the exported XML file information. | + | |
| {{: | {{: | ||
| - | **Importing** | + | ====== How To Import Dashboards ====== |
| - | Click the SAP menu option titled | + | |
| - | + | | |
| - | Click the SAP menu option titled **Import XML** under the **Administration** | + | |
| - | + | ||
| - | A window will open to allow you to specify the directory and file name for the XML file to be imported. | + | |
| {{: | {{: | ||
| - | Double click the file name or select the file and click the **Open** button. | + | * Double click the file name or select the file and click the <color #22b14c>**Open**</ |
| {{: | {{: | ||
| - | Stop and restart the APP application. | + | * Stop and restart the APP application. |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | **Warning –** After importing **any** objects into APP, the application **must** be stopped and restarted for the imported modifications to take effect. | + | |
| - | + | ||
| - | + | ||
| - | ===== A Guide to Dynamic Syntax ===== | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | Dynamic syntax is based upon the SAP® Business One formatted search capabilities and is a way for the user to dynamically substitute information from the system into SQL queries that can be launched from the current form within Business One. Dynamic syntax can be broken down into two types... | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | **Item Syntax** | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | Item syntax is the most commonly used form of dynamic syntax. It allows the user the ability to execute SQL queries that automatically substitute information values from an active SAP Business One® form. | + | |
| - | + | ||
| - | **General Item Syntax Form** | + | |
| - | + | ||
| - | **$[$< | + | |
| - | + | ||
| - | **Item Syntax Components** | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | **Examples** | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | **String Data Type** | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | The String data type form of Item Syntax can be used to substitute the value from any string (text) data field on an SAP Business One® form. | + | |
| - | + | ||
| - | In this example, we will represent the Business Partner Card Code in dynamic syntax for a SQL query. | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | The **Item UID** for the BP Code field is " | + | |
| - | + | ||
| - | The **Column UID** for the BP Code field is " | + | |
| - | + | ||
| - | The **Data Type** for the BP Code is either " | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | Setting up the dynamic syntax in a SQL query will look like this... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | Execution of the Query while the Business Partner Master Data screen is active and populated with a specific Business Partner will result in the following dynamic syntax substitution from the BP Code field... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | **Integer Data Type** | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | The Integer data type form of Item Syntax can be used to substitute the value from any integer(whole #) data field on an SAP Business One® form. | + | |
| - | + | ||
| - | In this example, we will represent the Sales Order Document Number in dynamic syntax for a SQL query. | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | The **Item UID** for the Document # field is " | + | |
| - | + | ||
| - | The **Column UID** for the Document # field is " | + | |
| - | + | ||
| - | The **Data Type** for the Document # is " | + | |
| - | + | ||
| - | Setting up the dynamic syntax in a SQL query will look like this... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | **Decimal Data Type** | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | The Decimal data type form of Item Syntax can be used to substitute the value or currency code from any decimal (numeric with decimal places) data field on an SAP Business One® form. | + | |
| - | + | ||
| - | **Numeric Value** | + | |
| - | + | ||
| - | In this example, we will represent the Business Partner Credit Limit in dynamic syntax for a SQL query. | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | The **Item UID** for the Credit Limit field is " | + | |
| - | + | ||
| - | The **Column UID** for the Credit Limit field is " | + | |
| - | + | ||
| - | The **Data Type** for the Credit Limit is " | + | |
| - | + | ||
| - | Setting up the dynamic syntax in a SQL query will look like this... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | Execution of the Query while the Business Partner Master Data screen is active and populated with a specific Business Partner will result in the following dynamic syntax substitution from the Credit Limit field... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | **Currency Code Value** | + | |
| - | + | ||
| - | In this example, we will represent the Sales Order Document Total currency code in dynamic syntax for a SQL query. | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | The **Item UID** for the Document Total field is " | + | |
| - | + | ||
| - | The **Column UID** for the Document Total field is " | + | |
| - | + | ||
| - | The **Data Type** for the Document Total currency code is " | + | |
| - | + | ||
| - | Setting up the dynamic syntax in a SQL query will look like this... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | Execution of the Query while the Sales Order screen is active and populated with a specific document will result in the following dynamic syntax substitution from the Document Total field... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | **Date Data Type** | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | The Date data type form of Item Syntax can be used to substitute the value from any date data field on an SAP Business One® form. | + | |
| - | + | ||
| - | In this example, we will represent the Sales Order Document Date in dynamic syntax for a SQL query. | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | The **Item UID** for the Document Date field is " | + | |
| - | + | ||
| - | The **Column UID** for the Document Date field is " | + | |
| - | + | ||
| - | The **Data Type** for the Document Date is " | + | |
| - | + | ||
| - | Setting up the dynamic syntax in a SQL query will look like this... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | **Line Level Data** | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | Obtaining information from the line level details of SAP Business One® objects follows the same general dynamic syntax format as the previous examples, however additionally we need to specify a value for the **Column** **UID** of the column the data is being obtained from on the form. | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | **String Data Type Column Example** | + | |
| - | + | ||
| - | In this example, we will represent the Item Code from a Sales Order line in dynamic syntax for a SQL query. | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | The **Item UID** for the Item Code field is " | + | |
| - | + | ||
| - | The **Column UID** for the Item Code field is " | + | |
| - | + | ||
| - | The **Data Type** for the Item Code is either " | + | |
| - | + | ||
| - | Setting up the dynamic syntax in a SQL query will look like this... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | Execution of the Query while the Sales Order screen is active and populated with a specific document will result in the following dynamic syntax substitution from the Item Code field... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | **Decimal Data Type Column Numeric Example** | + | |
| - | + | ||
| - | In this example, we will represent the Quantity from a Sales Order line in dynamic syntax for a SQL query. | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | The **Item UID** for the Quantity field is " | + | |
| - | + | ||
| - | The **Column UID** for the Quantity field is " | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | Setting up the dynamic syntax in a SQL query will look like this... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | Execution of the Query while the Sales Order screen is active and populated with a specific document will result in the following dynamic syntax substitution from the Quantity field... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | **Integer Data Type Column Example** | + | |
| - | + | ||
| - | In this example, we will represent the Warehouse Code from a Sales Order line in dynamic syntax for a SQL query. | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | The **Item UID** for the Warehouse Code field is " | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | system information from the status bar. | + | |
| - | + | ||
| - | The **Column UID** for the Warehouse Code field is " | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | The **Data Type** for the Warehouse Code is " | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | Setting up the dynamic syntax in a SQL query will look like this... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | Execution of the Query while the Sales Order screen is active and populated with a specific document will result in the following dynamic syntax substitution from the Warehouse Code field... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | **User Table Syntax** | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | Table syntax is the form of dynamic syntax that can be used to obtain information from SAP Business One® user-defined fields and from forms. It allows the user the ability to execute SQL queries that automatically substitute information values from an active SAP Business One® form. | + | |
| - | + | ||
| - | **General User Table Syntax Form** | + | |
| - | + | ||
| - | **$[< | + | |
| - | + | ||
| - | **User Table Syntax Components** | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | **Examples** | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | In this example, we will represent the Customer Label user-defined field value from the Business Partner screen in dynamic syntax for a SQL query. | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | The **Table Name** for the Customer Label field is " | + | |
| - | + | ||
| - | The **Field ID** for the Customer Label field is " | + | |
| - | + | ||
| - | The **Data Type** for the Customer Label is " | + | |
| - | + | ||
| - | Setting up the dynamic syntax in a SQL query will look like this... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | Execution of the Query while the Business Partner screen is active and populated with a specific partner will result in the following dynamic syntax substitution from the Customer Label field... | + | |
| - | + | ||
| - | {{: | + | |
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| - | + | ||
| + | <WRAP center round important 90%> | ||
| + | After importing **any** objects into APP, the application **must** be stopped and restarted for the imported modifications to take effect. | ||
| + | </ | ||