Configuration

Previous  Next |  Direct link to this topic

Setting up the buttons is done through the configuration window located under Administration > Add-ons > B1 Usability Package > Module configuration > Function Buttons.

image110

Each field will be described in the following sections.

 

Field

Description

Code

Each configuration will need a unique code in order to function. When you switch to add-mode, the system will automatically suggest a code (FB-001, FB-002, and so on).

Form type (Mandatory)

 

The form type for the window you want to configure Function Buttons for. The form type is found by opening the form you need form type for. Activate the system information (View > System information), and the information is displayed in the bottom left corner of the client when you hold the mouse over an item.

image112

image114

 

Warning: Some windows do not support Function Buttons. While this is not an exhaustive list, these are some of the known forms that do not support it: [Main Menu, Calendar Window, Messages and Alerts Window, SAP Search Window, Pop-up Windows (message box and prompts), Choose Company Window, B1 Search Windows, SQL Report Chart Window, Macro Variables Popup Window, PLD Windows]

Description

This is a simple description of the form type. The information is not used elsewhere in the add-on. On the most common form types, this description appears automatically.

Form Width & Height

These fields are only relevant for Add-on and UDO forms. They ensure function buttons to be shown properly on those kind of windows but for normal system forms it is recommended to leave them blank.

SPECIAL NOTE: IF YOU USE FUNCTION BUTTONS AND ITEM PLACEMENT TOOL ON THE SAME FORM TYPE, PLEASE CLEAR THE WIDTH AND HEIGHT OF THE ITEM PLACEMENT TOOL CONFIGURATION TO ALLOW THE SIZING FOR THE BUTTONS.

Video: Get help here if you experience having problems with the form width and height

Button Width

This is an optional field that allows you to specify the button width. If nothing is specified the button will use its default 100 pixel width.

Users

Here you have the option via the edit text and the radio buttons to make your configurations user-specific (making it possible to have one user who has one unique configuration, while another user has a different configuration)

image115

The above screenshot result in that only the two users with user codes “user1” and “user2” will see this configuration, while the screenshot below makes the configuration active to all other users except

image116

NB: IT IS YOUR RESPONSIBILITY THAT A USER DOES NOT OVERLAP OR IS INCLUDED IN TWO OR MORE CONFIGURATIONS. IF THAT IS THE CASE, THE SYSTEM WILL WORK WITH THE FIRST CONFIGURATION IT FINDS AND IGNORE THE ADDITIONAL CONFIGURATIONS

Category

Here you define if you wish to categorize your configuration. Categorization is optional and you can read more about it in the manual section describing Configuration categorization.

Active

Here you have the option to temporarily deactivate a configuration instead of removing it entirely.

The Buttons

 

You can specify as many buttons as you like (Press add on the right-hand side to get a new button configuration).

Column

Description

Active

The active checkbox determines whether the button will be visible on the screen it is added to.

Caption

You freely decide the caption of the button.

TIP: IT IS POSSIBLE TO MAKE KEYBOARD SHORTCUTS WITH THE FUNCTION BUTTONS. THIS IS DONE BY PLACING A ‘&’ IN THE CAPTION OF THE BUTTON. THE NEXT CHARACTER AFTER THE ‘&’ WILL ACT AS THE SHORTCUT USING ALT + CHARACTER. (NB. THIS TIP WILL NOT WORK ON BUTTONS TIED TO A FORMATTED SEARCH, SINCE THE ALT-KEY IS SUCH ARE USED TO OPEN THE FORMATTED SEARCH CONFIGURATION)

image117

Will look like this:

image118

Functions

 

For each button you can bind one of the 30+ functions available. These are:

Function

Description

Formatted Search

Activate a formatted search like it would normally be done using SHIFT + F2. The first time you will need to define the formatted search. If you later need to edit the formatted search, hold down the ALT key while pressing the button. The result can be transferred to a specific field or column and identifiers can also be used. See sections below for more information about these options.

User defined menu

Enables you to activate any menu item in the SAP Business One, including other add-ons menu items, for example the XL reporter’s menu items. The menu items can be found using the “View > System Information” and hovering over each item using the top menu. The MenuUid should be entered in the Arguments field for the button

User Query

Enables you to activate a user query in the database. (Use this for the user queries instead of the User defined menu because the menu Uid of a user query is not static)

Since there is no place in the client where you can find the true id of a user query you will need to use the following SQL sentence to find the key (Called Internal Key (Fieldname: IntrnalKey)).

MSSQL:
SELECT T0.IntrnalKey, T0.QName, T1.CatName FROM OUQR T0 JOIN OQCN T1 ON T0.QCategory = T1.CategoryId WHERE T0.QCcategory != -2 ORDER BY T1.CatName, T0.QName

HANA:
SELECT T0."IntrnalKey", T0."QName", T1."CatName" FROM "OUQR" T0 JOIN "OQCN" T1 ON T0."QCategory" = T1."CategoryId" WHERE T0."QCategory" != -2 ORDER BY T1."CatName", T0."QName"

Once you have the key, provide it in the arguments field for the button, and it should work.

Opportunity

Opens the Opportunities. In special windows, like the Business Partner Master data window, it will draw the BP-code to the new opportunity so you do not need to type it yourself.

Blanket Agreement

Opens the Sales/Purchase Blanket Agreement. In special windows, like the Business Partner Master data window it will draw the BP-code to the new Agreement so you don’t need to type it yourself. If unable to determine a type, the add-on will ask you which type you want to open.

Quotation

Opens the Sales/Purchase Quotation. In special windows, like the Business Partner Master data window it will draw the BP-code to the new Quotation so you don’t need to type it yourself. If unable to determine a type, the add-on will ask you which type you want to open.

Order

Opens the Sales/Purchase Order window. In special windows, like the Business Partner Master data window, it will check the type of the current BP and open the respected window type (Sales Order for Customers and Purchase Order for Suppliers). This will draw the BP-code to the new Sales/Purchase Order so you do not need to type it yourself. If unable to determine a type, the add-on will ask you which type you want to open.

Delivery/Goods Receipt PO

Opens the Delivery/Goods Receipt window. In special windows, like the Business Partner Master data window, it will check the type of the current BP and open the respected window type and draw the BP-code to the new window. If unable to determine a type, the add-on will ask you which type you want to open.

Return/Goods Return

Opens the Return/Goods Return window. In special windows, like the Business Partner Master data window, it will check the type of the current BP and open the respected window type and draw the BP-code to the new window. If unable to determine a type, the add-on will ask you which type you want to open.

Down Payment

Opens the Sales/Purchase Down Payment window. In special windows, like the Business Partner Master data window, it will check the type of the current BP and open the respected window type and draw the BP-code to the new window. If unable to determine a type, the add-on will ask you which type you want to open.

Invoice

Opens the AP/AR Invoice window. In special windows, like the Business Partner Master data window, it will check the type of the current BP and open the respected window type and draw the BP-code to the new window. If unable to determine a type, the add-on will ask you which type you want to open.

Credit Note

Opens the AP/AR Credit Note window. In special windows, like the Business Partner Master data window, it will check the type of the current BP and open the respected window type and draw the BP-code to the new window. If unable to determine a type, the add-on will ask you which type you want to open.

Activity

Opens the Activity. In special windows, like the Business Partner Master data window, it will check the type of the current BP and transfer it.

Incoming Payment

Opens the incoming payment window. In special windows, like the Business Partner Master data window it, will draw the BP-code to window so you don’t need to type it yourself (also determines type).

Outgoing Payment

Opens the outgoing payment window. In special windows, like the Business Partner Master data window, it will draw the BP-code to window so you don’t need to type it yourself (also determines type).

Posting Periods

Open the General Setting and set the focus on the Posting Periods tab-page.

Reconciliation

Open the Banking Reconciliation window.

Goods Receipt

Opens the Goods Receipt window. On special windows, like the Item Master Data, the active Item code will be draw onto the new window and be placed as a line so you do not need to type it yourself.

Goods Issue

Opens the Goods Issue window. On special windows like the Item Master Data the active Item code will be draw onto the new window and be placed as a line so you don’t need to type it yourself.

Inventory Transfer

Opens the Inventory Transfer window. On special windows like the Item Master Data the active Item code will be draw onto the new window and be placed as a line so you don’t need to type it yourself.

Last Price Report

Opens the Last Price Report window. On special windows, like the Item Master Data, the active Item code will be draw onto the new window for easy use.

Special Prices

Opens the BP Special Prices window. On special windows, like the documents and BP Master data, the BP code will be draw onto the new window for easy use.

Discount Groups

Opens the Discount Groups window. On special windows, like the documents and BP Master data, the BP code will be drawn onto the new window for easy use.

Aging

Opens the Aging. On special windows, like the documents and BP Master data, the BP code will be draw onto the new window for easy use.

Data launcher

Launch the Data Launcher which is a special function type with extended functionality.

External launcher

Launch an external program from the button which can be dependent on data from the window

Syntax: PROGRAM|ARGUMENTS (Example: winword.exe|”C:\test.doc” launch Microsoft Word and open the document in C:\test.doc)

As an advanced feature, you are also able to get dynamic data from the active form. The syntax for referring to the parent form is $[$<item>.<column>.<type>]

Example: if you would like to have the BP-code as part of your data, you should write $[$5.0.0] since the item code text field on the Business Partner Master data have unique id 5, while if you would like the current address street name you should write $[$178.2.0] since the matrix Uid is 178 and the column is 2.

Commonly used configurations:

Configuration

Arguments

Start a Microsoft Word Document

- Program: winword.exe

- Parameters: $data (e.g. $data = “\\server\docs\test.doc”)

Start a Microsoft Excel document

- Program: excel.exe

- Parameters: $data (e.g. $data = “\\server\docs\test.xsl”)

Start Remote Desktop

- Program: mstsc.exe

- Parameters: /v $data (e.g. $data = 192.168.1.1)

Start a PDF-document

- Program: AcroRd32.exe

- Parameters: $data (e.g. $data = “\\server\docs\test.pdf”)

Start Internet explorer on a specific website

- Program: iexplore.exe

- Parameters: $data (e.g. $data = http://www.boyum-it.com)

Universal Function

Enables you to activate a Universal Function from a function button. Which button to activate is chosen in the universal function field for the button (Press TAB to choose)

Multi Button

Enable you to create a button that instead of one function contains a drop-down of different functions.

image119

(Read more about the Multi-buttons in the Multi-button section of the manual)

Do Nothing(B1 Validation System)

Create a button that does not do anything. This is included in order to allow the B1 Validation System to work with the function buttons

Universal Function

If you set the Function Type to Universal Function then this field need to specify which UF to run (Else you can leave it blank)

Multi Button

If you set the Function Type to Multi Button then this field need to specify which MB to run (Else you can leave it blank).

Find/Add/OK Checkboxes

 

These checkboxes control in which modes the button should be enabled.

Example:

If you put a button on the Business Partner Window, but the function of the button only makes sense if a Business Partner is selected, then you should remove the check in the Find and Add checkboxes. This will result in the button only being enabled in OK-mode (Where a Business Partner is selected).

Arguments

 

        If choosing the function ‘User-defined Menu’ you must enter which menu to open when the button is pressed.

o   Video: Click here to watch more information on how to find menu-uids.

        If choosing a user query, enter the id of the query.

        If choosing external launcher enter programs and arguments.

FMS: Target (Only used with formatted searches)

Buttons bound to a formatted search will perform the search on an invisible field, but if the formatted search result should be saved to a field, this can be entered here. The items ID can be found using the debug information while pointing at the specific item.

FMS: Target Column (Only used with formatted searches)

If the target of the formatted search is not an item but a column, the Item ID for the matrix and the ID of the column should be entered here. The ID of the column can be seen using the debug information when pointing at the column.

 

FMS: Target Identifier (Only used with formatted searches)

Advanced Formatted searches can be set to validate the value of a target before its function. Using this field, you will be able to enter such validation values.

 

Category

If you wish to categorize a specific button to category you can do so (If not, it will assume it is the header category). Read more about categorization in the Category section of this manual.

Item Uid

The Item-Uid of the button you insert. By default you should leave it to auto-assign a UID but for backward compatibility we still leave allow you to override it for advanced scenarios

Import

This allows you to import configurations (Either one at the time or as a batch). See more info in under “Configuring the Add-on > Shared functionality > Import

Export

This allows you to export configurations to XML (Either one at the time or as a batch). See more info in under “Configuring the Add-on > Shared functionality > Export