Preferences
To manage the preferences in the ARCAD-API Studio, click the Preferences icon in the navigator.
Create, edit and delete categories for the web services. Categories group the Web Service Descriptors into sets. Descriptors can be added to categories when they are created.
Click the Create button to create new categories. Each category must have a short code and a name. New categories are automatically available when creating new descriptors and also in existing descriptors' editors.
Select an existing category and click the Edit button to modify its code or name. Modifications are automatically and immediately taken into account.
Select an existing category and click the Delete button to remove it.
If any descriptors are actively saved in a category, the category is "in use" and cannot be deleted. You must first move the descriptors from the category, or delete them, then you can delete the category.
Categories are used when creating and editing web service descriptors. Refer to Web service descriptors.
Sometimes, the values captured on the screen don't match exactly what the web service consumer expects. Use mapping tables to map a given value to another one before returning it. Create a mapping table defining the way a field value should be returned. You assign the mapping table to a field or a column to ensure that the value returned is translated.
To create a mapping table, click the Create button.
In the Mapping Tables dialog, define the mapping table's properties.
- Name
- The name of the mapping table.
- Description
- A brief description of the mapping table.
- Default value
- The mapped value used if no mapping entry has been found (if the Keep value if no entry found option is not selected).
- Keep value if no entry found
- Check this box to keep the captured value unchanged if no mapping entry has been found.
- Input Data Type
- The data type of the captured value.
- Output Data Type
- The data type of the mapped value.
Click OK to save.
To modify its parameters' values, select an existing mapping table and click the Edit button. Modifications are automatically and immediately taken into account.
To manage the mapping values, click the Values button. In the dialog, click the Add button to add the Original Value and its corresponding Translated Value. Click OK to save.
Select a value and click Edit to modify it or Delete to remove it from the mapping table.
To delete a mapping table, select an existing mapping table and click the Delete button.
Refer to Web service descriptors.
Rights grant users the possibility to view, create and modify various ARCAD-API entities. If the proper access rights are not granted to a profile, access to the corresponding entity (ex: engines) or action (ex: editing engines) is restricted.
Rights are granted to users via profiles. A profile is packed with rights that determine which items a user should be able to access throughout ARCAD-API and if they can edit them or not. Profiles are assigned to individual users.
There is no limit on how many profiles can be created. If all of your users should have access to all entities in the ARCAD-API Studio, there may be no need to create new profiles. Assigning the All Right profile to all users will enable everyone to have access to everything.
Open the Profiles menu to access and define the list of existing profiles.
Follow the subsequent steps to define a user profile.
To create a new profile click the Create button. Fill in the required code and name in the dialog.
Defined profiles are available in the Preferences menu and in the Profiles tab of the User editor.
Select a profile and click the Edit button to change the defined code and/or description.
To delete a profile select it and click the Delete button.
Click OK to save.
To grant rights to a profile, select it from the list and click the Rights button. If the profile already has rights assigned to it, they are listed in Right Definition dialog. Click the Add... button to display the list of Available Rights which contains all of the rights not yet assigned to the profile.
The rights are categorized by ARCAD-API entity or by action. Select the individual right(s) intended for the chosen profile (Ctrl+click
to select multiple rights) then click OK to add them to the list of that profile's rights.
Remove rights granted to a profile by selecting them from the list and clicking the Remove button.
Click OK to save.
For more information about the different rights available in the ARCAD-API Studio, refer to User rights.
After a profile is created, it is available to be assigned to individual users. It is recommended to define the rights for each profile before assigning them to users in order to best organize the authorization hierarchy. If the profiles are well-defined in advance, it will be easier to know which user(s) to assign based on their intended tasks.
For more information about creating users or assigning profiles to users, refer to Users.
Rights grant users the possibility to create, view and modify entities. Profiles are defined and granted rights by the administrator.
If you do not have the rights to access a certain ARCAD-API entity, when you try to, an error message displays informing you that you are not allowed to use that feature.
If you have the rights to access the Users view, you can see which profile(s) your user is assigned in the User editor.
If you cannot access the User editor, you can still view the list of your user's current rights in the Preferences menu. Click Current User Information to view all of the rights granted to your current user.