You are here: Help Topics > Practice > CaseWare Connector > Select a linkage protocol

Select a linkage protocol

You can use the Dynamic Data Exchange (DDE) protocol or the User Defined Functions (UDF) protocol to establish a connection between Word or Excel and the Working Papers database, allowing data to transfer between them seamlessly.

To select the DDE linkage protocol:

  1. On the Add-ins tab, in the Connector group, click Tools | Options.
  2. In the Options dialog, deselect Use Connector User Defined Functions (UDF).
  3. In the Link Path Type drop-down menu, select Active Client.
  4. Click OK.

To select the UDF linkage protocol:

  1. On the Add-ins tab, in the Connector group, click Tools | Options.
  2. In the Options dialog, select Use Connector User Defined Functions (UDF).
  3. In the Link Path Type drop-down menu, select Active Client.
  4. Click OK.

You have selected your linkage protocol.

CaseWare recommends that your documents contain either DDE or UDF linkages exclusively. We also recommend using UDF rather than DDE, as UDF offers enhanced functionality and stability over DDE.

Note: If a document contains both UDF and DDE linkages, values will not be retrieved from the same source file, and will be inconsistent. You can change link paths to ensure that links connect to the same source file, or convert DDE links to UDF to help resolve any discrepancies.

To see a comparison between DDE and UDF linkage protocols, refer to the following table:

Category DDE links UDF links
Active Working Papers sessions Only one session of Working Papers can be active while working with Connector. Multiple sessions of Working Papers can be active while working with Connector.
Link evaluation The link is only evaluated if Working Papers is running. The link is evaluated even if Working Papers is not running, as long as Connector can establish a connection to the Working Papers database.
Vulnerability Attempts a connection with every running application. May cause Word or Excel to stop responding. Attempts a connection with Working Papers only.
Referencing Cannot use Excel references in formulas. Can use Excel references in formulas.
Linking to a Working Papers file You must specify the Client GUID or Client Path in each link to retrieve the values. If the Working Papers file path does not exist, Excel may stop responding. You must specify the Working Papers file by Client Path, Client GUID, or reference to the cell where the Path or GUID is defined. If the Working Papers file path does not exist, Connector returns an error.
Editing In Excel, you must link formulas manually to a new cell. In Excel, you can copy formulas to a new cell and the reference will automatically update the cell address accordingly.

To see the difference between DDE and UDF linkage syntax, refer to the following table:

Category Syntax
DDE links

The DDE link protocol is defined by:

  • The Microsoft Word document icon as displayed in the Document Manager DDE CWIN32 Data CWEval
  • The Microsoft Excel worksheet icon as displayed in the Document Manager CWIN32|Data!'CWEval

The data you are linking is defined by:

  • The Microsoft Word document icon as displayed in the Document Manager act(\"BR\",\"S71\")
  • The Microsoft Excel worksheet icon as displayed in the Document Manager act("BR","S71")

The bolded syntax is the Working Papers link path. You can select the Link Path Type in Tools | Options.

Active client

  • The Microsoft Word document icon as displayed in the Document Manager {DDE CWIN32 Data CWEval|active|act(\"BR\",\"S71\")| \* MERGEFORMAT}
  • The Microsoft Excel worksheet icon as displayed in the Document Manager CWIN32|Data!'CWEval|active|act("BR","S71")|'

Client GUID

  • The Microsoft Word document icon as displayed in the Document Manager {DDE CWIN32 Data CWEval|LusYIL040AsMWhV+n5MpeB|act(\"BR\",\"S71\")| \* MERGEFORMAT}
  • The Microsoft Excel worksheet icon as displayed in the Document Manager CWIN32|Data!'CWEval|LusYIL040AsMWhV+n5MpeB|act("BR","S71")|'

Client path

  • The Microsoft Word document icon as displayed in the Document Manager {DDE CWIN32 Data CWEval|c:\\PROGRA~2\\caseware\\2021\\data\\samp01\\samp01.ac|act(\"BR\",\"S71\")| \* MERGEFORMAT}
  • The Microsoft Excel worksheet icon as displayed in the Document Manager CWIN32|Data!'CWEval|c:\PROGRA~2\caseware\2021\data\samp01\samp01.ac|act("BR","S71")|'
UDF links

The UDF link protocol is defined by:

  • The Microsoft Word document icon as displayed in the Document Manager DOCVARIABLE cw_udf...xxx
  • The Microsoft Excel worksheet icon as displayed in the Document Manager cw_

The data you are linking is defined by:

  • The Microsoft Word document icon as displayed in the Document Manager act("BR","S71")

The bolded syntax is the Working Papers link path. You can select the Link Path Type in Tools | Options.

Active client

  • The Microsoft Word document icon as displayed in the Document Manager {DOCVARIABLE cw_udf4e7f8265-7417-4145-b423-202487cd03e9 \&f act("BR","S71") \&fe \* MERGEFORMAT}
  • The Microsoft Excel worksheet icon as displayed in the Document Manager cw_act("BR","S71")

Client GUID

  • The Microsoft Word document icon as displayed in the Document Manager {DOCVARIABLE cw_udfbfd3f267-23b5-4099-a714-c9f73a695008 \&f act("BR","S71") \&fe \&c LusYIL040AsMWhV+n5MpeB \&ce \* MERGEFORMAT}

Client path

  • The Microsoft Word document icon as displayed in the Document Manager {DOCVARIABLE cw_udf634480a4-55f5-4e8c-bfbe-069cd244d370 \&f act("BR","S71") \&fe \&c c:\PROGRA~2\caseware\2021\data\samp01\samp01.ac \&ce \* MERGEFORMAT}

Visit us: www.caseware.com | Follow us: LinkedIn Facebook Twitter YouTube

© 2021 CaseWare International Inc. | Privacy | Terms of Use | Trademarks