PROPERTIES( ) function

Returns properties information for the specified ACL project item.

Syntax

PROPERTIES(name, obj_type, info_type)

Parameters

name

Character. The name of the ACL project item you want information about. The name must be enclosed in quotation marks.

If the project item is an ACL table, specify the table layout name, not the data file name. For example: “Invoices”, not “january_invoices.fil”. If you are using the PROPERTIES( ) function to return the name of the active table, enter the name activetable.

obj_type

Character. The type of ACL project item referred to by name. Currently, table is the only type of project item supported. The item type must be enclosed in quotation marks.

info_type

Character. The type of information you want about the ACL project item – the supported information types appear below. The information type must be enclosed in quotation marks.

Output

Character. The maximum length of the output string is 260 characters. If properties information cannot be found, an empty string is returned.

Remarks

Table 1 lists the types of properties information that can be returned by the PROPERTIES( ) function. ACL tables are the only ACL project items that can currently be used with the PROPERTIES( ) function.

“File” information types provide information about the ACL data file (.fil) associated with an ACL table.

“Source” information types provide information about external data sources that can be associated with an ACL table. Only those external data sources that support refreshing an ACL table can be reported on using the PROPERTIES( ) function: Microsoft Excel, Microsoft Access, Delimited text, Adobe Acrobat (PDF), Print Image (Report), SAP private file format/DART, XML, XBRL, and ODBC data sources.

Table 1. Types of properties information

obj_type

info_type

Description

table

filename

Returns the name of the data file associated with the ACL table. For example: january_invoices.fil

filepath

Returns the path of the data file associated with the ACL table. For example: C:\Project Data\Monthly Invoices

filesize

Returns the size, in KB, of the data file associated with the ACL table.

filemodifiedat

Returns the time and date that the data file associated with the ACL table was last modified.

sourcename

Returns the name of the data source associated with the ACL table. For example: january_invoices.xls

Data sources can be external files such as Excel, Access, PDF, XML, or delimited text files, or ODBC data sources.

sourcepath

Returns the path of the data source associated with the ACL table. For example: C:\Project Data\Monthly Invoices_Excel

Not supported for ODBC data sources.

sourcetype

Returns the type of the data source associated with the ACL table. For example: EXCEL, DELIMITED, ODBC

sourcesize

Returns the size, in KB, of the data source associated with the ACL table.

Not supported for ODBC data sources.

sourcemodifiedat

Returns the time and date that the data source associated with the ACL table was last modified.

Not supported for ODBC data sources.

open

Returns the name of the currently active ACL table.

(Multiple ACL tables can be open at the same time, but in the user interface only one table at a time can be active.)

Examples

Example Return value

PROPERTIES("Ap_Trans", "table", "filename")

Ap_Trans.fil

PROPERTIES("Ap_Trans", "table", "filepath")

C:\ACL DATA\Sample Data Files

PROPERTIES("Trans_May", "table", "sourcename")

Trans_May.xls

PROPERTIES("Trans_May", "table", "sourcepath")

C:\ACL DATA\Sample Data Files

PROPERTIES("Trans_May", "table", "sourcetype")

EXCEL

PROPERTIES("activetable", "table", "open")

Trans_May



(C) 2015 ACL Services Ltd. All Rights Reserved.