You are here: Help Topics > Practice > Caseware Connector > UDF functions

UDF functions

UDF functions are only applicable in Excel. The following table outlines all UDF functions in Connector.

Note: Ensure that you use the appropriate national separator for your area. In North America, arguments are delimited using commas in the function.

Function	Arguments	Example
cw_act()	balance_type account_number client_file	cw_act("BR","101") Returns the report balance for account 101.
cw_actdesc()	account_number client_file	cw_actdesc("101") Returns the account description for account 101.
cw_actdesc_ext()	account_number client_file	cw_actdesc_ext("101") Returns the extended account description for account 101.
cw_class()	balance_type class_id client_file	cw_class("BR","TR") Returns the report balance for trade receivables in current assets.
cw_client_path()	-	cw_client_path() Returns the full path of the active file - currently open Working Papers client file.
cw_clp()	clp_code client_file	cw_clp("CLP2") Returns the operating name of the client.
cw_cvdata()	group form id client_file	cw_cvdata("AREA","DISTRICT","ALPHACELL") Returns information located in the CaseView Database. More information on use of the CV Database can be found in the CaseView help.
cw_entdesc()	entity_id client_file	Returns the short description for the entity entered in the Entity Properties dialog of the consolidated file.
cw_entdesc_ext()	entity_id client_file	Returns the extended description for the entity entered in the Entity Properties dialog of the consolidated file. If an extended description is not available, then the short description is returned.
cw_eval()	expression client_file	Example 1 cw_eval(5*2) Returns the value 10 (five multiplied by two). Example 2 cw_eval("R1P\|map('BR','111')") Returns the report balance for map number 111.
cw_field()	database_identifier column_heading row_identifier client_file	cw_field("AM","EJE_BAL","101") Returns the Eliminating Entries balance ("EJE_BAL") for account 101 from the Trial Balance database ("AM").
cw_grp()	group_number balance_type group_id client_file	cw_grp("1","BR","AA") Returns the balance for a given group number/ID combination based on the specified balance type. The example would retrieve the report balance for group 1's grouping AA.
cw_grpdesc()	group_number group_id client_file	cw_grpdesc("1","AA") Returns the group description for a specified group number/ID.
cw_grpdesc_ext()	group_number group_id client_file	cw_grpdesc_ext("1","AA") Returns the extended group description for a specified group number/ID.
cw_lsdesc()	document_number description_type client_file	cw_lsdesc("FS","2") Returns the description of the given document in the Document Manager.
cw_map()	balance_type map_number client_file	cw_map("BR","2115") Returns a balance for a given map number based on the specified balance type.
cw_mapdesc()	map_number client_file	cw_mapdesc("2115") Returns a Map Description for a specified map number.
cw_mapdesc_ext()	map_number client_file	cw_mapdesc_ext("2115") Returns extended map description for a specified map number.
cw_sdate_field()	database_identifier column_heading row_identifier client_file	cw_sdate("SH","AD1","FS") Returns a date value from a specific field in a database. The universal "s" arguments in this case refer to the database identifier, the column heading in the database, and the row identifier for that particular database. The example would search the Document Manager (SH) database to retrieve the roll 1 sign off date (AD1) for the Financial Statements document (FS).
cw_tax()	balance_type tax_export_code client_file	cw_tax("BR","7125") Returns a balance for a given tax code based on the specified balance type.
cw_taxdesc()	tax_export_code client_file	cw_taxdesc("7125") Returns tax code description for a specified tax code.
cw_taxdesc_ext()	tax_export_code client_file	cw_taxdesc_ext("7125") Returns extended tax code description for a specified tax export code.
cw_ud()	user_defined client_file	cw_ud("UD1") Returns the value associated with a User Defined Data code. Values are entered under Tools \| User Defined Data in CaseView.

Function

Arguments

Example

cw_act()

balance_type

account_number

client_file

cw_act("BR","101")

Returns the report balance for account 101.

cw_actdesc()

account_number

client_file

cw_actdesc("101")

Returns the account description for account 101.

cw_actdesc_ext()

account_number

client_file

cw_actdesc_ext("101")

Returns the extended account description for account 101.

cw_class()

balance_type

class_id

client_file

cw_class("BR","TR")

Returns the report balance for trade receivables in current assets.

cw_client_path()

Returns the full path of the active file - currently open Working Papers client file.

cw_clp()

clp_code

client_file

cw_clp("CLP2")

Returns the operating name of the client.

cw_cvdata()

group

form

client_file

cw_cvdata("AREA","DISTRICT","ALPHACELL")

Returns information located in the CaseView Database. More information on use of the CV Database can be found in the CaseView help.

cw_entdesc()

entity_id

client_file

Returns the short description for the entity entered in the Entity Properties dialog of the consolidated file.

cw_entdesc_ext()

entity_id

client_file

Returns the extended description for the entity entered in the Entity Properties dialog of the consolidated file. If an extended description is not available, then the short description is returned.

cw_eval()

expression

client_file

Example 1

cw_eval(5*2)

Returns the value 10 (five multiplied by two).

Example 2

cw_eval("R1P|map('BR','111')")

Returns the report balance for map number 111.

cw_field()

database_identifier

column_heading

row_identifier

client_file

cw_field("AM","EJE_BAL","101")

Returns the Eliminating Entries balance ("EJE_BAL") for account 101 from the Trial Balance database ("AM").

cw_grp()

group_number

balance_type

group_id

client_file

cw_grp("1","BR","AA")

Returns the balance for a given group number/ID combination based on the specified balance type. The example would retrieve the report balance for group 1's grouping AA.

cw_grpdesc()

group_number

group_id

client_file

cw_grpdesc("1","AA")

Returns the group description for a specified group number/ID.

cw_grpdesc_ext()

group_number

group_id

client_file

cw_grpdesc_ext("1","AA")

Returns the extended group description for a specified group number/ID.

cw_lsdesc()

document_number

description_type

client_file

cw_lsdesc("FS","2")

Returns the description of the given document in the Document Manager.

cw_map()

balance_type

map_number

client_file

cw_map("BR","2115")

Returns a balance for a given map number based on the specified balance type.

cw_mapdesc()

map_number

client_file

cw_mapdesc("2115")

Returns a Map Description for a specified map number.

cw_mapdesc_ext()

map_number

client_file

cw_mapdesc_ext("2115")

Returns extended map description for a specified map number.

cw_sdate_field()

database_identifier

column_heading

row_identifier

client_file

cw_sdate("SH","AD1","FS")

Returns a date value from a specific field in a database. The universal "s" arguments in this case refer to the database identifier, the column heading in the database, and the row identifier for that particular database. The example would search the Document Manager (SH) database to retrieve the roll 1 sign off date (AD1) for the Financial Statements document (FS).

cw_tax()

balance_type

tax_export_code

client_file

cw_tax("BR","7125")

Returns a balance for a given tax code based on the specified balance type.

cw_taxdesc()

tax_export_code

client_file

cw_taxdesc("7125")

Returns tax code description for a specified tax code.

cw_taxdesc_ext()

tax_export_code

client_file

cw_taxdesc_ext("7125")

Returns extended tax code description for a specified tax export code.

cw_ud()

user_defined

client_file

cw_ud("UD1")

Returns the value associated with a User Defined Data code. Values are entered under Tools | User Defined Data in CaseView.

UDF functions

Cookie Notice