Modification of the Structure

In Docusnap, you can extend the existing table structures as needed. For this purpose, open Docusnap Management and click the Manage Tables button.

This tab contains all descriptions of the Docusnap database structure. On the upper left pane the details of the below selected table are listed. The corresponding settings for the columns of the selected table can be made in the right pane.

In principle, there are three different types of tables in Docusnap:

General Table Properties

When defining a table, you need to set several properties. The number of properties depends on the table type. The following properties apply to all tables, i.e. they are mandatory:

Properties for Views

Views are tables that are built on the basis of an SQL SELECT statement. Docusnap supports this with a number of variables that will be replaced with actual data during the execution of the SELECT statement.

Basically, the SELECT statement has the following syntax:

SELECT [DISTINCT] SelectionList FROM Source [WHERE WhereClause]
[GROUP BY (GroupByAttribute)+
[HAVING HavingClause]]
[ORDER BY (SortAttribute [ASC|DESC])+];

In principle, all valid variants are possible that comply with the SQL standard.

Docusnap provides the following variables for use in statements. Make sure to always enclose the variable in braces, like this: {Variable}.

Enter the respective SQL statement directly into the SQL statement field where you can enter or edit the statement.

Since an SQL SELECT statement may be used to link multiple tables, Docusnap does not know which table the primary key refers to when you delete this object in the tree view. In the Primary Table field, you can specify the table in which the record should be deleted. If you leave this field blank, it will not be possible to delete meta objects that depend on this table.

SNMP Statements

In addition to SQL statements for the output of tables, Docusnap provides special statements for the output of SNMP tables. When performing an SNMP inventory scan, Docusnap uses MIBs. To program the output, enter the following into the SQL Statement field: First, the text *SNMP:, *then, in parentheses, the MIB and, separated by a comma, its name. To separate the MIBs, enter a semi-colon.

This results in the following syntax:

SNMP:(1.3.6.1.2.1.4.20.1.1,IPAddress;1.3.6.1.2.1.4.20.1.3,SubnetMask;1.3.6.1.2.1.4.20.1.2,InterfaceID)

To ensure the output of values that exist only once for each SNMP device, precede the statement with SNMP-Single.

Use the following syntax:

SNMP-Single: (1.3.6.1.2.1.43.8.2.1.14.1.1,Manufacturer;1.3.6.1.2.1.43.5.1.1.17.1,SerialNumber)

If you need to divide the value of one column by that of another column, e.g. to determine the toner level, separate the MIBs of the two columns using a slash. When the statement is executed, the quotient will be output in this column.

The statement has the following syntax:

SNMP-Single: (1.3.6.1.2.1.43.11.1.1.9.1.1/1.3.6.1.2.1.43.11.1.1.8.1.1,TonerBlack)

IT Asset Statements

It is possible to display IT assets anywhere in the tree, for example, below a contact, which they were assigned to. For that a view with an SQL statement needs to be created that lists all necessary ObjectIDs. The name is matched with the name of the property and the value with the primary key of the parent object. Since the column ObjectValue has the type text the {FilterID} must be specified as text with ‘’. Use the AccountID in the query to filtered the data, so that only IT assets for the respective company are displayed. Only the ObjectID must be included in SQL statement and the ObjectID must be created as a column. Subsequently, this view can be selected for a meta object to display the IT assets. The following SQL statement can be used as the basis for the IT Asset statement.

select tGOValue.ObjectID
from tGODirectory, tGO, tGOValue, tGOProperty
where tGODirectory.DirectoryID = tGO.DirectoryID and
tGO.ObjectID = tGOValue.ObjectID and
tGOValue.PropertyID = tGOProperty.PropertyID
and tGOProperty.PropertyName = 'Name of the Property' and
tGOValue.ObjectValue = '{FilterID}' and
tGODirectory.AccountID = {AccountID}

Data Fields

Data fields represent the various columns of a table. Each field is assigned a data type in Docusnap. The meta description of each field also includes its English or German name.

Display ADS Properties

The values of Active Directory properties are stored in the tables tADSObjectValue (only one value per AD object) and in the table tADSObjectMultiValue (multiple values per AD object possible). Some of these values need to be formatted differently for display. In both the tables there is the column ADSPropertyID, the value of this column is used by Docusnap to display the AD properties in ADSObjectValue column correctly. If a table or a view contains an ADSObject Value column, a ADSPropertyID column is always expected .

When a view is created, which contains more than one column with special AD properties, the formatting can not be defined using the ADSPropertyID column. For this, a reference is created for every respective column. With AD_PROP_ is defined that it is a reference for AD properties. For example, for the property whenCreated (create date of the AD object) {AD_PROP_whenCreated} is entered in the Reference field. The column that contains the value must not be called ADSObjectValue, but will be renamed in the SQL statement with AS.

Export and Import of the Database

If the data from user-defined tables should be taken into account during database import or export, these tables must be included in the import tree.