Connector for dg archive - Use in Applications

To use data from dg archive in applications, first create a dg archive connection in the "Integration" module. A data group can then be configured accordingly, as described below.

Data Groups

To save stamp data and documents to dg archive via Intrexx, you need a standard Intrexx data group. Third-party data groups are not currently supported by the connector. The data fields in the data group can then be linked to dg archive stamp fields. For files, a file data field is added to the data group, which receives a special FileHandler class for dg archive.

In the application structure, select the data group that you want to link to dg archive, and use the main menu option "New / Data Field" to create at least the following data fields:

• Department ID

  "Integer" Data Type (Creates an integer data field)

• Document ID

  "Integer" Data Type (Creates an integer data field)

• Title/Name

  "Short Text" Data Type (Creates a string data field)

File Data Fields

Next, create another data field with the "File" data type. Click "More...".

Select the "Intrexx Handler" option and the "dg archive Handler" here. Then click "OK" and finish creating the file data field by clicking "OK" as well.

Open the Properties dialog box for the new file data field by double-clicking the field in the application structure. You can display the data fields in the application structure using the main menu option "Edit / Show Data Fields" if the data group is selected there. The "General" tab displays the field title and the previously selected handler class. In addition, specific information is required:

Configuration

Select the " dg archive" connection here.

Department

Based on the selected configuration, the system lists all available departments for which the specified user has access. Select the department for the documents here.

Department ID

There must be a unique value to link records in Intrexx to documents in dg archive. This requires an Intrexx data field (data type "Integer") in which the department ID from dg archive can be stored.

Document ID

There must be a unique value to link records in Intrexx to documents in dg archive. This requires an Intrexx data field (data type "Integer") in which the document IDs from dg archive can be stored.

Document Name

Select a data field here in which the document name will be stored.

Document Type

A document type must be defined for the documents. This can either be selected statically or determined dynamically via an Intrexx data field (data type "Integer") that contains the type ID.

Document Note

If the document type "From Intrexx Data Field" is selected, you can choose a data field from the application here in which comments on the document will be stored.

Create as a folder

Controls whether files from Intrexx are saved in dg archive as a single document or in a document folder.

Versionable

Enables document versioning in dg archive.

Comment

Here, you can select a data field in which to enter comments for versions.

Stamp Fields

Mapping Intrexx Fields

Then switch to the " Field Mapping" tab. Here, Intrexx data fields or values are mapped to the dg archive stamp fields.

The left side of the dialog lists the dg archive stamps from the previously selected dg archive server; the right side displays the fields of the Intrexx data group, if applicable. the fields of a parent data group and user-specific values. For a clearer overview, the dg archive fields can be filtered by stamp. You can use the " " arrow buttons to map dg archive fields to Intrexx data fields. When a record is saved in Intrexx, the value of the Intrexx data field is automatically saved in the linked dg archive field. Please note that the data type in dg archive must be compatible with that of the Intrexx data field.

Assignment of User-Specific Values

In addition to data fields, user-specific values can also be assigned to dg archive fields. To do this, click " " and select" Add Value."

Select a static value, system value, GUID, or null value here. This is helpful, for example, when you want to use the same value for a required stamp field every time. In the same way, date values calculated in this manner or system values—such as the current Intrexx user—can be created. Another example would be generating a GUID at runtime as a unique record ID for Intrexx and dg archive. You can find help for this dialog box here. By default, calculated values are not stored in Intrexx data fields, but only in dg archive fields. For certain purposes, it is necessary to store a static value in an Intrexx data field as well. Therefore, after assigning a value to a dg archive field, you will automatically be asked whether the value should also be saved in an Intrexx data field.

Here, you can enable the " Save value in data field " setting. Click "OK."

The "Save value in data field" setting can be edited in the field mapping by clicking " " and selecting " Save value in data field."

Assignment of Selection Lists

Like Intrexx, dg archive also allows you to define drop-down lists for data fields. Fields with drop-down lists have the data type "sngsel" or "mltsel" (for lists with multiple selections) in dg archive. In dg archive, drop-down lists can be assigned values from Intrexx data fields or static values. It should be noted that the value in Intrexx can be used to determine the corresponding entry in the selection list in dg archive. If an Intrexx string data field is assigned to the list box, the value stored in it must correspond to a display value in the "dg archive" drop-down list. Please note that this is case-sensitive.

View and Input Pages

The standard data field controls on view and input pages are available for viewing and editing stamp fields. To enable Intrexx to identify the document linked to a given data record in dg archive, you must configure the fields for Department ID and Document ID on every view and input page to reference dg archive. The department ID can be found in the file field's properties on the "Expert" tab in Settings (value of the attribute archive.department.id).

To display existing dg archive documents in the Intrexx application, you must create the corresponding records with the correct department ID and document ID. This can also be done in the hidden section so that the fields are not visible to users. If a document's stamp data is modified directly in dg archive, it cannot be automatically synchronized with Intrexx immediately. Therefore, Intrexx automatically updates the fields of a dg archive stamp as soon as the record is opened on a view or input page. To save the updated data in Intrexx as well, the user must then click "Save."

Authentication

As the final step in configuring the file data field, you can use the Authentication tab to specify which portal user should be identified for authentication when accessing the dg archive server.

By default, the currently logged-in portal user is used here. If no dg archive session exists for this user and "Username and Password" was selected as the authentication method in the connection configuration, the user will be prompted in the portal to log in to dg archive. There are use cases in which access to dg archive should always be performed using the same dg archive user, regardless of which portal user is currently logged in. This is the case, for example, when there isn't a dg archive user for every Intrexx user, or when documents from Intrexx are always supposed to be saved in dg archive under the same user. In this case, you can select a static user here. This refers to an Intrexx user who has been assigned a dg archive user account in the dg archive configuration. You can also create a static user directly through the dialog box. As soon as such a user is entered in the file data field, all access to the dg archive will be routed through the data group associated with that dg archive user account. This means that interactive login to dg archive via the portal is no longer necessary. This also makes it possible to implement simple single-sign-on scenarios without having to rely on Kerberos authentication.

dg archive Data Group Handler

As soon as a file data field for `dg archive` is added to an Intrexx data group and configured, the data handler class in the data group's expert attributes is automatically set to

            de.uplanet.lucy.server.dghyparchive.connector.rtdata.RtDataGroupTableHypArchive
        

changed. This can also be done at a later time. The dg archive-specific data group handler class is optional, but it provides additional functionality when Intrexx and dg archive are used together. This ensures that the timestamp values from dg archive are automatically synchronized as soon as an archive record is loaded onto an Intrexx view or input page. This ensures that Intrexx portal users always see the most up-to-date stamp data from dg archive. In some cases, it may happen that stamp data has been changed in dg archive, but the previous values are still stored in Intrexx.

Country Settings

Date, number, and currency fields are formatted by dg archive using the format specified by the user in the country settings. dg archive requires the full language/culture code (e.g., de-DE or en-US instead of de or en). The formats for the required languages can be defined in the portal properties. Alternatively, a default language can be specified for dg archive in the configuration of the file data field. In that case, the same language code is used for all calls to `dg archive`. Please note that in Intrexx, the format expected by dg archive must be set for date/number and currency input fields.

Support for SAP Documents

To support SAP ArchiveLink documents (available starting with Intrexx 8 / Online Update 07), the following additional settings must be configured in the application:

1. A data field with the data type "Short Text " is required for the SAP Archive ID.

2. In the properties of the file data field, the following settings must be added on the "Expert / Settings" tab:

   • hyparchive.sap.archive = true (Type: Boolean)

   • hyparchive.sap.archive.id.field.guid = [GUID of the SAP ArchiveLink ID data field] (Type: GUID)

Expert Settings

The following settings are available on the "Expert" tab in the file data field's properties for further configuration of the connector:

• hyparchive.sap.archive

  Flag indicating whether documents are archived using SAP ArchiveLink.

• hyparchive.sap.archive.id.field.guid

  GUID of the data field for the SAP ArchivLink ID.

• hyparchive.cfg.guid

  The GUID of the dgarchive configuration.

• hyparchive.container.doc.class

  Class for folder documents (DC_FILE by default).

• hyparchive.container.document

  Flag indicating whether the document is a single document or a container document (Yes/No).

• hyparchive.default.language

  The default language to use for dg archive web service requests (e.g., de-DE; by default, the Intrexx user's standard country format).

• hyparchive.department.id

  ID of the dg archive department.

• hyparchive.department.name

  Name of the dg archive department.

• hyparchive.deptid.field.guid

  GUID field for Department ID.

• hyparchive.docid.field.guid

  GUID field for document ID.

• hyparchive.docName.field.guid

  GUID field for document name.

• hyparchive.docType.id

  dg archive document type ID.

• hyparchive.file.doc.class

  Class for single-file documents (DC_DOSFILE by default).

• hyparchive.filename.as.docname

  Flag indicating whether the filename should be used as the document name.

• hyparchive.impersonation.guid

  Intrexx user GUID for logging in as a static user.

• hyparchive.onlyUpdatePropertiesWithFileField

  Update the stamp fields when saving even if there are no file fields on the input page or if they are added to the update in processes (Type: boolean, default: false).

• hyparchive.showindatarange

  Flag indicating whether files should be displayed in view tables.

• hyparchive.stamp.field.mapping

  Stamp Field Assignments.

• hyparchive.version.comment.field.guid

  GUID field for comments in versioning.

• hyparchive.versionable

  Flag indicating whether documents can be versioned.

DG Archive in Portal Applications

Authentication

The first time a user accesses a portal application that contains a data group with dg archive file data fields, the user is prompted to log in to dg archive. This is required only once per session and per dg archive server. If Integrated Windows Authentication is enabled, the user will be automatically logged in upon their first access. Registration is not required if a static user for dg archive authentication has been specified in the file data field of the data group. After successful authentication, you can access dg archive data through the Intrexx application. Portal users have access to the same functions with dg archive data groups as they do with regular Intrexx data groups. There are only a few special considerations to keep in mind regarding file operations.

File Operations in View Tables

dg archive file data fields can be placed in view tables to open files directly from the tables. By default, however, for performance reasons, files from the dg archive are not displayed in file data fields when they are shown in a view table. To do this, enable the option "Also display files from the dg archive in view tables" in the file data field configuration. If you want to be able to download documents directly from tables, you must enable this feature in the options for the file data field in the view table.

File Operations on View Pages

dg archive files are displayed on view pages using the " File Selection View " application element.

Here, too, it is possible to download the files.

File Operations on Input Pages

Using the file selection feature on input pages, you can upload and edit files and documents via Intrexx and save them to dg archive. All the functions of standard Intrexx file data fields are available.

In addition to enabling downloads, you can also configure upload settings. By default, new files are added to the existing files in dg archive document folders. However, it is also possible to replace files.

You can also set the maximum number of files that can be stored per file data field. You can also specify the maximum file size. In addition, there are advanced features for uploading files that affect how the control behaves in the portal. In the browser, files can be dragged and dropped onto the file control and thus automatically uploaded to the Intrexx server. When the input page is saved, the uploaded files are transferred to the dg archive server along with the information in the stamp fields. The new document IDs are stored in Intrexx.

Existing files can be deleted from the dg archive in the browser by clicking "Delete" at .

File Operations in Drop-Down Lists

To make it as easy as possible for portal users to maintain the dg archive stamp fields, it makes sense to create selection lists in Intrexx that are identical to the selection lists in dg archive. The values of dg archive selection lists can be determined using the archive FormEdit tool. In Intrexx, you can create a drop-down list on an input page whose entries reflect those of a dg archive value list. To do this, the values can be taken from other applications, references, or defined by the user.

Stamp Data Update

Since documents and files are stored and maintained exclusively in dg archive, they are always up to date when accessed via Intrexx. The situation is somewhat different when it comes to a document's stamp data. These are stored both in data fields of the Intrexx data group and in dg archive. This has the advantage that you can search for stamp fields and access records directly in Intrexx without having to access the dg archive server every time. The drawback of this approach is that, over time, a document's metadata in dg archive may change, while Intrexx still stores the old values.

Another approach to ensuring that stamp data between Intrexx and dg archive is always kept in sync is to use processes.

Search the dg archive documents

Search Options

Documents and files in dg archive data fields are stored only on the dg archive server. As a result, the Intrexx search engine is unable to index the contents of the files to make them available for search queries in Intrexx. Only stamp data stored in Intrexx data groups can be searched for using the Intrexx search function. The dg archive Web service interface allows you to search for documents in dg archive using the dg archive full-text search. The results must then be formatted appropriately for Intrexx so that, when a match is clicked, the document opens in the dg archive web client, or the corresponding record is opened in Intrexx via a filter with a link to the dg archive document.

Intrexx Search

Index Stamp Fields Using the Intrexx Search

In order for the Intrexx search to find a document's stamp fields, these fields must be indexed by the Intrexx search. To do this, you must make a change in the "moduleConfig.xml" configuration file.

You can find the "moduleConfig.xml" file at the following location: <Portal Directory>/internal/search/moduleConfig.xml

In the "moduleConfig.xml" file, look for the following entry:

            <fileHandler class="de.uplanet.lucy.server.dghyparchive.connector.HypArchiveFileHandler" adapter="de.uplanet.lucy.server.dghyparchive.connector.HypArchiveBusinessAdapterQueryEngine" adapterNeedsSolrIndex="false"/>
        

Change "false" to "true."

Original

            <fileHandler class="de.uplanet.lucy.server.dghyparchive.connector.HypArchiveFileHandler" adapter="de.uplanet.lucy.server.dghyparchive.connector.HypArchiveBusinessAdapterQueryEngine" adapterNeedsSolrIndex="false"/>
        

After the change

            <fileHandler class="de.uplanet.lucy.server.dghyparchive.connector.HypArchiveFileHandler" adapter="de.uplanet.lucy.server.dghyparchive.connector.HypArchiveBusinessAdapterQueryEngine" adapterNeedsSolrIndex="true"/>
        

Now restart the Intrexx services.

Configure Search in the Application

To search for stamp fields in a document stored in Intrexx, you can configure the search in an application as usual. To do this, create a search configuration and select the stamp fields in the dg archive data group that you want the search engine to index. Afterward, dg archive records can be searched for stamp data using the search function in Intrexx. Another approach is to search using filters in Intrexx applications. This involves defining filters on view tables that filter records based on the values in the stamp fields of the Intrexx data group.

Full-text search

If you want to search for keywords in the documents in addition to the stamp data, the dg archive full-text search is a good option. This allows you to search directly within Intrexx for dg archive documents managed in Intrexx and view the results. You can also search the portal for documents in the dg archive that were not entered via Intrexx. In the latter case, portal users also need access to the dg archive WebClient or DocPresenter to open the documents they find there. The following section describes the implementation of both approaches.

Full-text search of documents managed in Intrexx

In the following example, the goal is to search for dg archive documents for which there is a corresponding data record in a dg archive data group. To do this, create a view table based on the "dg archive" data group for the search results. In addition, an input field for the search term is required. Then open the Properties dialog box for the view table and go to the Dependencies tab . Click " " "Add Dependency" there to define a new dependency. First, a triggering event is required. To do this, click "Add Event" at , select the input field as the control, and select, for example, "onchange" as the event. Next, a filter is needed. To do this, click "Edit filters in expert mode" at . Copy the following XML fragment into the editor within the <filter></filter> element:

            <exp op="" type="in">	
	<arg content="1414DAF1C286E4E92CC553C65615FE60D1500B15" type="fieldguid"/>	
	<arg adapterGuid="8B74A66AB861FC2265829FB96D6985F07C5EBBBB" content="de.uplanet.lucy.server.dghyparchive.connector.rendering.HypArchiveFullTextSearchFilterHandler" searchControlName="textcontrol7D64D21B" singleton="false" type="handlerClass"/>
</exp>

        

Then customize the filter arguments to suit your application:

• content

  In the first <arg> element, enter the data group field GUID that corresponds to the document ID in dg archive. The remaining information refers to the attributes of the second <arg> element.

• adapterGuid

  The GUID of the dg archive file data field.

• searchControlName

  Enter the name of the input validation rule for the search term here.

• Domains (optional)

  Here, a comma-separated list is used to tell the filter which departments to search for documents in.

Now confirm all dialog boxes by clicking "OK" and publish the application. The search function will then be available on the portal.

Full-text search of documents not managed by Intrexx

Using the dg archive web service interface, you can also search for documents in Groovy action handlers and Velocity templates and display the results in Intrexx. To do this, you must program the search queries and the display of the results yourself, since these are always specific to the requirements.

Stamp Search

In addition to the full-text search, it is also possible to search for documents using stamp/system fields. To do this, follow the same steps as for a full-text search. Only one other filter handler is used to search for stamp values:

            <exp op="" type="in">	
	<arg content="1414DAF1C286E4E92CC553C65615FE60D1500B15" type="fieldguid"/>	
	<arg adapterGuid="8B74A66AB861FC2265829FB96D6985F07C5EBBBB" content="de.uplanet.lucy.server.dghyparchive.connector.rendering.HypArchiveQueryFilterHandler" singleton="false" stampControls="textcontrol3A8C3723" stampFields="IXTITLE" stampName="IX" systemStampControls="textcontrol38DDAF24" systemStampFields="TIMESTAMP" type="handlerClass"/>
</exp>

        

Customize the filter arguments to suit your application:

• content

  In the first <arg> element, enter the data group field GUID that corresponds to the document ID in dg archive. The remaining information refers to the attributes of the second <arg> element.

• adapterGuid

  The GUID of the dg archive file data field.

• stampName

  Enter the name of the stamp you want to use for the search here.

• stampControls

  Enter the names of the input controls for the search term here, separated by commas.

• stampFields

  Enter the stamp field names here, separated by commas. The order must match that in stampControls.

• systemStampControls

  Enter the names of the input controls for the system stamp fields here, separated by commas.

• systemStampFields

  Enter the system stamp field names here, separated by commas. The order must match that in systemStampControls.

• Domains (optional)

  Here, a comma-separated list is used to tell the filter which departments to search for documents in.

More Information

General Information

Create and Edit Connections in the "Integration" Module

Use in Processes

Troubleshooting