Managing Data Types from the user interface
You can create, edit, and delete Data Types from the Shared parameters tab of the user interface.
- Create Data Type
- Upload Attributes
- Add Attributes
- Edit Attributes
- Delete Attributes
- Edit Data Type
- Delete Data Type
Create Data Type
- Go to Manage > Shared parameters tab.
- In the Data types section, click Create data type.
-
In the Create data type, enter the Name, Data type, and Description.
Notes:
- The Data Type name must begin with an alphabet and must have a combination of only these characters: [a-zA-Z][a-zA-Z0-9_-]
- Do not use the following reserved names while naming a Data Type:
- Anything that starts with
com.ibm.cloud.cloudconnections
- Anything that starts with
- Click Create. The Edit data type page is displayed wherein you can edit name, Data type, and description or work on the attributes.
Upload Attributes
If the Data type has associated Data objects, then only View attributes option is available.
- In the Data types section, select Edit in the Actions overflow menu.
- Click Upload attributes.
- Click Import from file to import from a JSON file or copy and paste in the editor.
- Click Upload.
Add Attribute
If the Data Type has associated Data Objects, then only View attributes option is available.
- In the Data type section, select Edit in the Actions overflow menu.
- In the Edit data type page, click Upload attributes.
- Click Add attribute.
- Enter the Parameter name.
- Select End-user permission. The available permissions are Read-Only and Read & Write.
- Select a value from the Parameter type drop-down list. The available parameter types are string, password, list, boolean, counter, and map.
-
Enter the parameter values and click Add:
-
Enter the following common fields for all Parameter type:
- Display name - Enter the label of the field.
- Description - Enter a description of the field.
- Required - Select if the field is mandatory. It is available only for Read & Write permission.
-
Enter the following values for string Parameter type:
- Specify options - The Specify options is available for a Read & Write permission of type string. If you select Specify options, then Default label and Value pairs are displayed. To add more pairs of Default label and Value, click Add. Click the cross icon of a label to delete it.
- Validation rule - Enter the Validation rule.
- Default string value - Enter the default value of the string parameter. It is mandatory for Read-Only permission.
- Secured - Select if the field is secured.
-
Enter the following values for map Parameter type:
- Key and Value pair - Enter the key value pair. To add more key value pairs, click Add. Click the cross icon of a key to delete it.
-
Enter the following values for counter:
- Default counter value - Enter the default value for the counter parameter. It is mandatory for Read-only permission.
- Maximum value - Enter the maximum value of the counter parameter. It is available only for Read & Write permission.
- Minimum value - Enter the minimum value of the counter parameter. It is available only for Read & Write permission.
-
Enter the following value for Boolean:
- Default boolean value - Select True or False for the default Boolean parameter value.
-
Enter the following values for list:
- Default list value - Click Add to add default value to the list. Click the cross icon for a default value to delete it.
-
Enter the following values for password:
Note: Password type is applicable only for Read & Write permission.
-
Edit Attributes
You cannot edit the attributes if the data type is associated with data objects.
- In the Edit data type page > Attribute section, select Edit in the Actions overflow menu for the attribute you want to modify.
- Update the values and click Edit to save the changes.
Delete Attributes
You cannot delete the attributes if the data type is associated with data objects.
- In the Edit data type page > Attribute section, select Delete in the Actions overflow menu for the attribute you want to delete.
- Click Delete in the confirmation message box to delete.
Edit Data Type
You can edit description and upload or add attributes, but cannot edit the Name or Type. You cannot edit any of the Data Type values if it is associated with Data Objects.
-
In the Data types section, search for your Data Type.
Note: To search for a Data Type, enter the keywords or name of the Data Type.
- In the Data type section, select Edit in the Actions overflow menu of the Data Type you want to edit.
- In the Edit data type page, click the edit icon to modify the Description.
- In the Attributes section, you can add new attributes, edit, or delete an existing attribute.
- Click Save.
Delete Data Type
You cannot delete a Data Type if it has associated data objects.
-
In the Data types section, search for your Data Type.
Note: To search for a Data Type, enter the keywords or name of the Data Type.
-
In the Data type section, select Delete in the Actions overflow menu of the Data Type you want to delete.
- If there are any associated data objects, a message box lists them. Delete those data objects first and then delete this Data Type.
- If there are no associated data objects, click Delete in the confirmation message box to delete.