Restrict Codes in a Codelist - Revision history

Vmurrell at 15:05, 17 April 2024

2024-04-17T15:05:30Z

Vmurrell at 16:10, 5 September 2022

2022-09-05T16:10:24Z

Vmurrell: /* Generating a Restriction from an existing Codelist */

2021-05-03T09:57:26Z

‎Generating a Restriction from an existing Codelist

Vmurrell: /* Overview */

2021-05-03T09:56:32Z

‎Overview

Vmurrell: /* Manifistation */

2021-03-08T16:50:35Z

‎Manifistation

Vmurrell: /* Generating a Restriction from an existing Codelist */

2021-03-08T16:49:59Z

‎Generating a Restriction from an existing Codelist

Vmurrell: /* Generating a Restriction from an existing Codelist */

2021-03-08T16:48:57Z

‎Generating a Restriction from an existing Codelist

Vmurrell: /* Overview */

2021-03-08T16:48:14Z

‎Overview

Vmurrell: /* Overview */

2021-03-08T16:47:38Z

‎Overview

Vmurrell: /* Restrict Codes in a Codelist */

2021-03-08T16:45:05Z

‎Restrict Codes in a Codelist

← Older revision		Revision as of 15:05, 17 April 2024
Line 1:		Line 1:
		+	__NOTOC__
	[[Category:How_To]]		[[Category:How_To]]
	[[Category:How_To V11]]		[[Category:How_To V11]]

← Older revision		Revision as of 16:10, 5 September 2022
Line 1:		Line 1:
	[[Category:How_To]]		[[Category:How_To]]
		+	[[Category:How_To V11]]
	== Overview ==		== Overview ==

@@ Line 29: / Line 29: @@
 If the Codelist already has codes, the Registry can generate a Regular Expression from the existing codes. This feature can be found on Step 1 of the Codelist Wizard. Next to the "Restrict Codes" input area, there is a "plus" button shown below:
-[[File:CodelistWizard-RestrictCodesInput.PNG|500px]]<br>
+[[File:CodelistWizard-RestrictCodesInput.PNG|Restricting Codes|500px]]<br>
 Clicking this button will make the Registry analyse the codes in the Codelist to determine what the Regular Expression should be. The result will be displayed in both human-readable form and in Regular Expression form in a modal as shown below:
@@ Line 38: / Line 38: @@
-[[File:RC2.PNG|500px]]<br>
+[[File:RC2.PNG|Generate Regular Expression|500px]]<br>
 =Manifistation=
 If a user attempts to add a code which does not fit into the restriction, at the end of the Codelist Wizard the Registry will perform a check. If an invalid code is detected, it will not be possible to save the codelist without removing (or editing) the offending code.

← Older revision		Revision as of 09:56, 3 May 2021
Line 7:		Line 7:


−	[[File:RC1.PNG\|500px]]<br>	+	[[File:RC1.PNG\|Codelist - Step 1\|500px]]<br>

	When you define your codes within the Codelist you should specify IDs that conform to this restriction. When creating or editing codes, the Registry User Interface will not warn you if the restriction is not adhered to. Only when you click "Finish" and submit the Codelist to the Registry are all the codes checked to ensure that they meet the standard defined in the Regular Expression.		When you define your codes within the Codelist you should specify IDs that conform to this restriction. When creating or editing codes, the Registry User Interface will not warn you if the restriction is not adhered to. Only when you click "Finish" and submit the Codelist to the Registry are all the codes checked to ensure that they meet the standard defined in the Regular Expression.

← Older revision		Revision as of 16:50, 8 March 2021
Line 41:		Line 41:

	=Manifistation=		=Manifistation=
−	If a user attempts to add a code which does not fit into the restriction, at the end of the Codelist Wizard the Registry will ~~preform~~ a check. If an invalid code is detected, it will not be possible to save the codelist without removing (or editing) the offending code.	+	If a user attempts to add a code which does not fit into the restriction, at the end of the Codelist Wizard the Registry will perform a check. If an invalid code is detected, it will not be possible to save the codelist without removing (or editing) the offending code.

← Older revision		Revision as of 16:49, 8 March 2021
Line 35:		Line 35:
	Clicking the "Apply Regular Expression" button will dismiss the modal and fill in the "Restrict Codes" field on Step 1 of the Codelist Wizard with the Regular Expression.		Clicking the "Apply Regular Expression" button will dismiss the modal and fill in the "Restrict Codes" field on Step 1 of the Codelist Wizard with the Regular Expression.

−	The generated Regular Expression will only analyse the existing code IDs for minimum and maximum length, and whether alphabetic, numeric or special characters are used in the code IDs. It will not attempt to enforce if all codes have a special prefix or that special characters appear at certain positions in the code ID. For example, the codes: MT_A1, MT_FOO, MT_EXAMPLE quite clearly show that the codes all ~~begine~~ with "MT_". This analysis tool would only state that the minimum length of a code is 5 characters, the maximum length of a code ID is 10 characters and the alphabetic, ~~numerics~~ and the underscore character are permissible. If you wish to specify that the restriction is the characters "MT_" followed by a specific number of characters, then the appropriate Regular Expression must be defined by yourself.	+	The generated Regular Expression will only analyse the existing code IDs for minimum and maximum length, and whether alphabetic, numeric, or special characters are used in the code IDs. It will not attempt to enforce if all codes have a special prefix or that special characters appear at certain positions in the code ID. For example, the codes: MT_A1, MT_FOO, MT_EXAMPLE quite clearly show that the codes all begin with "MT_". This analysis tool would only state that the minimum length of a code is 5 characters, the maximum length of a code ID is 10 characters and the alphabetic, numeric, and the underscore character are permissible. If you wish to specify that the restriction is the characters "MT_" followed by a specific number of characters, then the appropriate Regular Expression must be defined by yourself.

@@ Line 27: / Line 27: @@
 == Generating a Restriction from an existing Codelist ==
-If the Codelist already has codes, the Registry has the ability to generate a Regular Expression from the existing codes. This feature can be found on Step 1 of the Codelist Wizard. Next to the "Restrict Codes" input area, there is a "plus" button shown below:
+If the Codelist already has codes, the Registry can generate a Regular Expression from the existing codes. This feature can be found on Step 1 of the Codelist Wizard. Next to the "Restrict Codes" input area, there is a "plus" button shown below:
 [[File:CodelistWizard-RestrictCodesInput.PNG|500px]]<br>

← Older revision		Revision as of 16:48, 8 March 2021
Line 4:		Line 4:
	It is possible to create a Codelist which specifies a restriction on the code IDs that can be created within that Codelist. This is useful if you wish to ensure that the codes in your Codelist conform to a specific format.		It is possible to create a Codelist which specifies a restriction on the code IDs that can be created within that Codelist. This is useful if you wish to ensure that the codes in your Codelist conform to a specific format.

−	To achieve this, on step 1 of the Codelist Wizard, there is an input area titled: '''Restrict Codes'''. This area accepts a [https://en.wikipedia.org/wiki/Regular_expression Regular Expression] which you can use to specify the restriction. For example to restrict the codes to only be 3 upper-case alphabetic characters, you could use the Regular Expression: '''[A-Z]{3}'''.	+	To achieve this, on step 1 of the Codelist Wizard, there is an input area titled: '''Restrict Codes'''. This area accepts a [https://en.wikipedia.org/wiki/Regular_expression Regular Expression] which you can use to specify the restriction. For example, to restrict the codes to only be 3 upper-case alphabetic characters, you could use the Regular Expression: '''[A-Z]{3}'''.

← Older revision		Revision as of 16:47, 8 March 2021
Line 4:		Line 4:
	It is possible to create a Codelist which specifies a restriction on the code IDs that can be created within that Codelist. This is useful if you wish to ensure that the codes in your Codelist conform to a specific format.		It is possible to create a Codelist which specifies a restriction on the code IDs that can be created within that Codelist. This is useful if you wish to ensure that the codes in your Codelist conform to a specific format.

−	To achieve this, on step 1 of the Codelist Wizard, there is an input area titled: "Restrict Codes". This area accepts a Regular Expression which you can use to specify the restriction. For example to restrict the codes to only be 3 upper-case alphabetic characters, you could use the Regular Expression: '''[A-Z]{3}'''.	+	To achieve this, on step 1 of the Codelist Wizard, there is an input area titled: '''Restrict Codes'''. This area accepts a [https://en.wikipedia.org/wiki/Regular_expression Regular Expression] which you can use to specify the restriction. For example to restrict the codes to only be 3 upper-case alphabetic characters, you could use the Regular Expression: '''[A-Z]{3}'''.

← Older revision		Revision as of 16:45, 8 March 2021
Line 1:		Line 1:
	[[Category:How_To]]		[[Category:How_To]]
−	~~=Restrict Codes in a Codelist=~~
−
	== Overview ==		== Overview ==