Special Keywords

Previous  Next |  Direct link to this topic

Other than the two syntaxes above, SAP formatted searches contains two additional keywords that can be used in B1UP as well.

Formatted Search keywords

Keyword

Description

$[USER]

Gives you the unique id of the user logged in (OUSR.INTERNAL_K).

NB: please note that this is not the username of the user, but the id of him/her. You can use the OUSR table to find what user have what id or use the B1UP specific keyword $[USERNAME]

$[PERIOD]

Gives you the id of the currently used posting period

 

B1UP specific keywords

To extend the formatted search syntax, the B1UP accepts the following keywords

You can see videos about the videos here: User and System Keywords | Folder Keywords | Branch Keywords | Table Keywords | Current Data Keywords | Validation Keywords | Date Keywords |

Keyword

Description

$[USERNAME]

The username of the currently logged in user (OUSR.USER_CODE)

$[DATABASENAME]

The name of the database logged into

$[LOCALIZATION]

The Database country localization

$[COMPANYNAME]

The name of the company

$[SERVERNAME]

The name of the server

$[SERVERDATE]

The date of the server presented in the client format

$[SERVERTIME]

The time of the server presented in the client format

$[SYSTEMID]

The System Id of the company

$[INSTALLATIONID]

The Installation Id of the company

$[CURRENT_PANE]

The forms current pane

$[CURRENT_LANGUAGE]

The current language of the B1 Client in a numeric form
1 = Hebrew, 2 = Spanish (Argentina), 3 = English (United States), 5 = Polish, 6 = English (Singapore), 7 = Spanish (Panama), 8 = English (United Kingdom), 9 = German, 10 = Serbian, 11 = Danish, 12 = Norwegian, 13 = Italian, 14 = Hungarian, 15 = Chinese, 16 = Dutch, 17 = Finnish, 18 = Greek, 19 = Portuguese, 20 = Swedish, 22 = French, 23 = Spanish, 24 = Russian, 25 = Spanish (Latin America), 26 = Czech, 27 = Slovak, 28 = Korean, 29 = Portuguese (Brazil), 30 = Japanese, 31 = Turkish, 35 = Traditional Chinese (Hong Kong)

$[NEWID]

The Id of the currently added object (Example DocEntry of a newly added Invoice).

Video: How to Use the $[NEWID] Keyword

 
Warning: This keyword will only be replaced if the Event is Data Add and Data Update events in ActionSuccess (The keyword will not be replaced in other event-types)

$[ROW]

The row of the event

$[ATTACHMENT_FOLDER]

The path to SAP’s Attachment folder

$[BITMAP_FOLDER]

The path to SAP’s Bitmap (picture) folder

$[WORD_FOLDER]

The path to SAP’s Word folder

$[EXTENSION_FOLDER]

The path to SAP’s Extension folder

$[EXCEL_FOLDER]

The path to SAP’s Excel folder

$[XML_FOLDER]

The path to SAP’s XML folder

$[BRANCH]

The default branch id of the currently logged in user

Warning: the branch name cannot contain the character “:”. NB: if the name of a branch is changed the user will need to restart SAP Business one for the keyword to work.

Warning you cannot use this keyword for anything there runs on the server component

Warning: This keyword does not work on SAP HANA with Fiori Cockpit enabled. It will instead give the value <BRANCH KEYWORD NOT SUPPORTED> back

$[BRANCH_NAME]

The default branch name of the currently logged in user

Warning: the branch name cannot contain the character “:”. NB: if the name of a branch is changed the user will need to restart SAP Business one for the keyword to work.

Warning you cannot use this keyword for anything there runs on the server component

Warning: This keyword does not work on SAP HANA with Fiori Cockpit enabled. It will instead give the value <BRANCH KEYWORD NOT SUPPORTED> back

$[BOY_TABLE]

Give the header table of the screen layout was run from: (Invoice = OINV, Order = ORDR, Delivery = ODLN etc.)

$[BOY_TABLE_IDENTIFIER]

Give the same as $[BOY_TABLE] but without the ‘O’ in front: (Invoice = INV, Order = RDR, Delivery = DLN etc.)

$[BOY_TABLE_EX]

Like the $[BOY_TABLE] Keyword above but in case when used on a Sales or Document in Draft Mode it will return "ODRF" instead of the main table

$[BOY_TABLE_IDENTIFIER_EX]

Like the $[BOY_TABLE_IDENTIFIER] Keyword above but in case when used on a Sales or Document in Draft Mode it will return "DRF" instead of the normal identifier

$[LINE_COUNT(<Item>)]

Gives the number of line in a Matrix or Grid

$[CURRENT_FORMTYPE]

Gives the formtype of the active form

$[CURRENT_ITEM]

Gives the current item Uid

$[CURRENT_COLUMN]

Gives the column id of the current column

$[CURRENT_ROW]

Gives the current row

$[CURRENT_FORMTITLE]

Gives the title of the current form

$[IS_COLUMN_VISIBLE(<item>|<column>)]

Gives a Y/N depending om whether a column is visible or not.

$[IS_COLUMN_EDITABLE(<item>|<column>)]

Gives a Y/N depending om whether a column is editable or not.

Disclaimer: In rare cases we have seen that SAP SDK gives the wrong value back (Example for the Qty field on sales order on partially delivered lines). We can only report back what the SDK tells us.

$[IS_ROW_SELECTED(<Item>|<Row)]

 

Gives a Y/N depending om whether a row is selected or not,

NB: a row does not need to be  specified if working on line level or in a lineloop

 

$[NEWLINE]
$[TAB]

Keywords for making line-breaks and Tabs in the body of Universal Function - File Exports

$[IS_SHIFT_PRESSED]

Keyword that determine if user is holding down the SHIFT modifier key on their keyboard.. If so it return value Y else N

$[IS_CTRL_PRESSED]

Keyword that determine if user is holding down the CTRL modifier key on their keyboard.. If so it return value Y else N

$[IS_ALT_PRESSED]

Keyword that determine if user is holding down the ALT modifier key on their keyboard.. If so it return value Y else N

$[B1SRESULT.STRING] $[B1SRESULT.NUMBER]

The Result Keywords of B1 Search Customization that can be used in Universal Functions

$[B1DASHBOARDVALUE.STRING] $[B1DASHBOARDVALUE.NUMBER]

The Result Keywords of Dashboard Navigation that can be used in Universal Functions

$[LLRESULT.STRING] $[LLRESULT.NUMBER]

$[LLRESULT.COLNAME.STRING] $[LLRESULT.COLNAME.NUMBER] $[LLRESULT.COLNAME.DATE]

The Result Keywords of Line Loops that can be used in other Universal Functions

$[B1VALRESULT.COLNAME.STRING] $[B1VALRESULT.COLNAME.NUMBER] $[B1VALRESULT.COLNAME.DATE]

The Result Keywords of B1 Validations that can be used in Universal Functions

$[CRYSTAL_KEY]

The Result Keyword From Crystal Report Golden Arrows

 

B1UP Date keywords

To make it easier to add date to fields or use them in reports, the B1UP accepts the following Date Keywords.

Keyword

$[Today]

$[SameDayLastYear]

$[SameDayLastQuarter]

$[SameDayLastMonth]

$[SameDayLastWeek]

$[SameDayNextYear]

$[SameDayNextQuarter]

$[SameDayNextMonth]

$[SameDayNextWeek]

$[Yesterday]

$[Tomorrow]

$[StartOfYear]

$[StartOfFiscalYear]

$[EndOfYear]

$[EndOfFiscalYear]

$[StartOfLastYear]

$[StartOfLastFiscalYear]

$[EndOfLastYear]

$[EndOfLastFiscalYear]

$[StartOfNextYear]

$[EndOfNextYear]

$[StartOfMonth]

$[EndOfMonth]

$[StartOfLastMonth]

$[EndOfLastMonth]

$[StartOfNextMonth]

$[EndOfNextMonth]

$[StartOfWeek]

$[EndOfWeek]

$[StartOfLastWeek]

$[EndOfLastWeek]

$[StartOfNextWeek]

$[EndOfNextWeek]

$[NextMonday]

$[NextTuesday]

$[NextWednesday]

$[NextThursday]

$[NextFriday]

$[NextSaturday]

$[NextSunday]

$[LastMonday]

$[LastTuesday]

$[LastWednesday]

$[LastThursday]

$[LastFriday]

$[LastSaturday]

$[LastSunday]

$[StartOfQuarter]

$[EndOfQuarter]

$[StartOfNextQuarter]

$[EndOfNextQuarter]

$[StartOfLastQuarter]

$[EndOfLastQuarter]

$[In42Days] //Where 42 can any number between 1 and 99

$[In42Months] //Where 42 can any number between 1 and 99

$[In42Years] //Where 42 can any number between 1 and 99

$[42DaysAgo] //Where 42 can any number between 1 and 99

$[42MonthsAgo] //Where 42 can any number between 1 and 99

$[42YearsAgo] //Where 42 can any number between 1 and 99

Tip: For all listed keywords 4 variants exists:

The Keyword itself where we try and give it back to you in the most likely needed format: Example: $[EndOfYear] used in SQL give back 20191231 while used to setting a GUI element give back 2019-12-31

The keyword with an _HUMAN suffix that will give the date back in the format your Windows machine is running: Example: $[EndOfYear_HUMAN] = 31-12-2019 if you windows format is day-month-year

The keyword with an _SQL suffix that will give the date back in primary format a SQL Server / HANA accept: Example: $[EndOfYear_SQL] = 20191231 (aka yyyyMMdd)

The keyword with an _UIAPI suffix that will give the date back in primary format SAP GUI accept: Example: $[EndOfYear_UIAPI] = 2019-12-31 (aka yyyy-MM-dd)