Standard Data Groups in the Intrexx DRACOON Connector
The following two data sets are included by default with the Intrexx DRACOON Connector.
|
Data Group |
Data Group Adapter |
|
|---|---|---|
| 1 | DracoonDataSpace | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonDataSpaceDataGroupAdapter |
| 2 | DracoonUsers | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonApiDataGroupAdapter |
You can add the following data groups using the corresponding data group adapters:
|
Data Group |
Data Group Adapter |
|
|---|---|---|
| 3 | Dracoon User Groups | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonApiDataGroupAdapter |
| 4 | DracoonGroupMembers | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonGroupMembersDataGroupAdapter |
| 5 | UserRoles | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonRolesWithGroupsDataGroupAdapter |
| 6 | GroupRoles | |
| 7 | Share | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonShareDataGroupAdapter |
| 8 | ShareUploads | |
| 9 | PublicShareDownload | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonPublicShareDataGroupAdapter |
| 10 | PublicShareUpload |
Additional Data Groups
You have the option to create additional data groups beyond those described here. The generic Java class `de.uplanet.lucy.server.odata.consumer.dracoon.DracoonApiDataGroupAdapter ` is available for this purpose.
For detailed information on this topic, see the section " Create Your Own Data Groups"
Description
Below is a description of all data groups. Here you will find information on the following topics:
-
Data Group Adapter
This field specifies the data group adapter on which the respective data group is based.
-
Pagination
This specifies whether pagination—that is, a multi-page display of content that allows users to "scroll" through the pages—is available.
-
Sorting
This section lists the fields by which you can sort.
Background: In the DRACOON API, you can sort only by selected fields at a time. Sorting across all accessible fields is not guaranteed.
ixSorting_Fields
Intrexx-specific fields were implemented for the " Intrexx DRACOON Connector " to enable sorting. Each of these begins with "ixSorting." These fields correspond to fields in the DRACOON API that have been specially formatted for processing in Intrexx.
-
Filtering
This section lists the fields you can use to filter.
Background: In the DRACOON API, you can only filter by selected fields at a time. Filtering across all accessible fields is not guaranteed.
ixFilter_Fields
Intrexx-specific fields were implemented for the " Intrexx DRACOON Connector " to enable filtering. Each of these begins with "ixFilter". These fields correspond to fields in the DRACOON API that have been specially formatted for processing in Intrexx.
-
dracoon.api.endpoint.uri, dracoon.api.endpoint.suffixUri
If applicable, you will find information about the API endpoint URI and—if necessary—an associated suffix.
DRACOON API
You can find all information about the fields that can be queried via the DRACOON API, as well as additional information, at the following link: DRACOON API
Access to Files and Folders
The "DracoonDataSpace" data group can be used to access files. This data group displays the contents of a DRACOON data room or a folder within a data room and allows you to upload and download files. To do this, the standard file field control in Intrexx applications is used, which is linked to the "File" field in the data group. In the Expert Settings, you can specify the ID of a DRACOON data space or folder to be loaded initially under the "dracoon.dataspace.id" attribute. Without this setting, the contents of the top data pane are displayed.
| Data Group | DracoonDataSpace |
| Data Group Adapter | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonDataSpaceDataGroupAdapter |
| Pagination | Yes |
|
Field Name |
Sorting |
Filter |
|---|---|---|
| branchVersion | — | Greater than or equal to, Less than or equal to |
| classification | X | — |
| cntDeletedVersions | X | — |
| createdAt | X | — |
| fileType | X | — |
| ixFilter_encrypted | — | Right away |
| ixSorting_createdBy | X | — |
| ixSorting_updatedBy | X | — |
| name | X | Contains, Equal |
| referenceId | — | Right away |
| size | X | — |
| timestampCreation | X | Greater than or equal to, Less than or equal to |
| timestampModification | X | Greater than or equal to, Less than or equal to |
| type | — | Right away |
| updatedAt | X | — |
Access to Users and Groups
The data groups "DracoonUsers" and "DracoonUserGroups" can be used to access users and groups. These data groups display the users and groups in DRACOON and allow you to create, edit, and delete users and groups. The "DracoonGroupMembers" data group allows you to view the members of a group and add new members.
| Data Group | DracoonUsers |
| Data Group Adapter | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonApiDataGroupAdapter |
| dracoon.api.endpoint.uri | /api/v4/users |
| Pagination | Yes |
|
Field Name |
Sorting |
Filter |
|---|---|---|
| createdAt | X | Greater than or equal to, Less than or equal to |
| X | Immediately, Includes | |
| expireAt | X | — |
| firstName | X | Contains |
| isEncryptionEnabled | — | Right away |
| isLocked | X | Right away |
| ixFilter_effectiveRoles | — | Right away |
| ixFilter_hasRole | — | Same, Not the same |
| lastLoginSuccessAt | X | — |
| lastName | X | Contains |
| Phone | — | Right away |
| userName | X | Immediately, Includes |
| Data Group | Dracoon User Groups |
| Data Group Adapter | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonApiDataGroupAdapter |
| dracoon.api.endpoint.uri | /api/v4/groups |
| Pagination | Yes |
|
Field Name |
Sorting |
Filter |
|---|---|---|
| createdAt | X | Greater than or equal to, Less than or equal to |
| X | Immediately, Includes | |
| expireAt | X | — |
| firstName | X | Contains |
| isEncryptionEnabled | — | Right away |
| isLocked | X | Right away |
| ixFilter_effectiveRoles | — | Right away |
| ixFilter_hasRole | — | Same, Not the same |
| lastLoginSuccessAt | X | — |
| lastName | X | Contains |
| Phone | — | Right away |
| userName | X | Immediately, Includes |
| Data Group | DracoonGroupMembers |
| Data Group Adapter | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonGroupMembersDataGroupAdapter |
| Pagination | Yes |
|
Field Name |
Sorting (DracoonGroupMembers |
Filter |
|---|---|---|
| cntUsers | X | — |
| createdAt | X | — |
| expireAt | X | — |
| ixFilter_hasRole | — | Right away |
| name | X | Contains |
Access to User Roles
To access user roles, you can use the "DracoonRoles" data group, which contains the child data groups "UserRoles" and "GroupRoles." This data set shows the roles created in Dracoon, as well as the users and groups assigned to those roles. In addition, this endpoint allows you to assign users and groups to roles.
| Data Group | UserRoles |
| Data Group Adapter | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonRolesWithGroupsDataGroupAdapter |
| dracoon.api.endpoint.uri | /api/v4/roles |
| dracoon.api.endpoint.suffixUri | users |
| Pagination | No |
| Sorting | No |
| Filtering | No |
| Data Group | GroupRoles |
| Data Group Adapter | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonRolesWithGroupsDataGroupAdapter |
| dracoon.api.endpoint.uri | /api/v4/roles |
| dracoon.api.endpoint.suffixUri | groups1 |
| Pagination | No |
| Sorting | No |
| Filtering | No |
Creating Share Links
The "Share" and "ShareUpload" data groups can be used to create share links. Using these data sets, it is possible to create access keys for files and data rooms, which grant individuals without access rights to DRACOON upload or download permissions, provided they have the access key and—if assigned—the required password.
| Data Group | Share |
| Data Group Adapter | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonShareDataGroupAdapter |
| Pagination | Yes |
|
Field Name |
Sorting |
Filter |
|---|---|---|
| accessKey | — | Contains |
| classification | X | — |
| createdAt | X | Greater than or equal to, Less than or equal to |
| expireAt | X | — |
| ixFilter_createdBy | — | Contains, Equal |
| ixFilter_createdById | — | Right away |
| ixFilter_updatedBy | — | Contains, Equal |
| ixFilter_updatedById | — | Right away |
| ixSorting_createdBy | X | — |
| ixSorting_notifyCreator | X | — |
| name | X | Contains |
| nodeId | — | Right away |
| Data Group | ShareUpload |
| Data Group Adapter | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonShareDataGroupAdapter |
| Pagination | Yes |
|
Field Name |
Sorting |
Filter |
|---|---|---|
| accessKey | — | Right away |
| createdAt | X | Greater than or equal to, Less than or equal to |
| expireAt | X | — |
| ixFilter_createdBy | — | Contains, Equal |
| ixFilter_createdById | — | Right away |
| ixFilter_updatedBy | — | Contains, Equal |
| ixFilter_updatedById | — | Contains |
| ixFilter_userId | — | Right away |
| ixSorting_createdBy | X | — |
| ixSorting_notifyCreator | X | — |
| name | X | Contains |
| targetId | — | Right away |
Creating Share Links for Uploading and Downloading
To create share links for uploading and downloading, you can use the "PublicShareDownload" and "PublicShareUpload" data groups. Using these data sets, along with the required access keys and passwords, you can download and upload files and data rooms.
| Data Group | PublicShareDownload |
| Data Group Adapter | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonPublicShareDataGroupAdapter |
| dracoon.api.endpoint.uri | /api/v4/public/shares/downloads |
| Pagination | No |
| Sorting | No |
| Filtering | No |
| Data Group | PublicShareUpload |
| Data Group Adapter | de.uplanet.lucy.server.odata.consumer.dracoon.DracoonPublicShareDataGroupAdapter |
| dracoon.api.endpoint.uri | /api/v4/public/shares/uploads |
| Pagination | No |
| Sorting | No |
| Filtering | No |
For these data groups, please note that in the expert settings for the "file" field, the key "dracoon.service.isShare" must be added and set to "true."
