Configuring the resource’s data structure configuring-the-resource-s-data-structure

Use the Create element button to create a field.

Specify a label, an ID, a field type, and define the maximum length authorized for this field.

The ID field is mandatory and must be unique for each field added.

To modify one of the fields, check the Edit Properties button.

In the Field definition screen, you can define a category that will be used for the audience and targeting, or even add a description.

Check the Specify a list of authorized values option if you need to define values that will be offered to the user (enumeration values).

Then, click Create element and specify a Label and Value. Add as many values as needed.

Once you have added your fields, check the Add audit fields box to include fields detailing the creation date, the user that created the resource, the date, and the author of the last modification.

Check the Add access authorization management fields box to include the fields stating who has access rights to that particular resource.

These fields appear in the data and metadata that can be displayed once the database update has been carried out. For more on this, refer to the Updating the database structure section.

Check the Add automatic ID field to automatically generate an ID. Please note that existing entities will remain empty. For more on this, refer to the Generating a unique ID for profiles and custom resources.

To modify the way in which the name of the resource elements will appear in the lists and creation steps, check the Customize the title of the resource elements box. Select a field from those you created for this resource.

Specify it in the Automatic primary key section the size for the storage if you would like to have a technical key automatically and incrementally generated.

Use the Create element button to create a key.

The Label and ID fields are completed by default but you can edit them.

To define the elements making up this key, click Create element and select the fields that you created for this resource.

Created keys are displayed in the Custom keys section.

Use the Create element button to create an index.

The Label and ID fields are completed by default, but you can edit them.

To define the elements making up this index, select the fields from those that you created for this resource.

Click Confirm.

Use the Create element button to create a link to a target resource.

Click Select a target resource.

Resources are shown in alphabetical order and can be filtered by name. Their technical name is displayed in brackets.

Select an element from the list and click Confirm.

Select the Link type according to cardinality. Depending on the cardinality type selected, the behavior if the records are deleted or duplicated may vary.

The various link types are as follows:

• 1 cardinality simple link: one occurrence of the source table can have at most one corresponding occurrence of the target table.
• N cardinality collection link: one occurrence of the source table can have several corresponding occurrences of the target table, but one occurrence of the target table can have at most one corresponding occurrence of the source table.
• 0 or 1 cardinality simple link: one occurrence of the source table can have at most one corresponding occurrence of the target table or none. Note that this kind of Link type can cause performance issue.

In the New link screen, the Label and ID fields are completed by default, but you can edit them.

The Category for the audience and targeting list allows you to assign this link to a category making it more visible in the query editor tool.

If needed, the Reverse link definition section allows you to display the label and ID of the resource in the targeted resource.

Define the behavior of the records referenced by the link in the Behavior if deleted/duplicated section.

By default, the target record will be deleted once it is no longer referenced by the link.

In the Join definition section, the default Use the primary keys to make the join option is selected but you can choose between two options:

• Use the primary key to make the join: This join definition allows you to use the profiles primary key to reconcile with the purchases’ primary key.
• Define specific join conditions: This join definition allows you to manually select the fields that will join both resources. Please note that if data are not correctly configured, the Purchase record will not be visible.

Create your new Purchase resource.

To link it with the Profiles custom resource, unfold the Links section in the Data structure tab and click Create element.

Select the target resource, here Profiles (profile).

In this example, keep the default 1 cardinality simple link Link type selected.

Choose a join definition, here keep the default Use the primary key to make the join.

If needed, you can define a detail screen to be able to edit Purchase and link it to a profile.

Unfold the Detail screen configuration section and check the Define a detail screen to configure the screen that corresponds to each element of the resource. If you do not check this box, the detail view of elements of this resource will not be accessible.

Click Create element.

Select your linked resource and click Add.

Your new resource will then be available in the advanced menu by selecting Client data > Purchase.

Once your configuration is done, click Confirm.

You can now publish your new resource.

Click the Edit properties button to add a description.

If needed, modify the label and ID of the resource.

If you need to restrict the access to this resource to certain organizational units, specify them here. Only users from authorized units will be able to work with this resource in the application.

Save the modifications.

Create an extension to the profiles resource or create a new resource.

In the data structure definition, check the Add automatic ID field option, under the Fields section.

Save and publish the modification made to the resource. If you want this mechanism to apply for elements created via the API, check the option to extend the API.