UIORGS-453: Enhancement settings help text (#670)

* UIORGS-453-enhancement-settings-help-text * UIORGS-453-enhancement-settings-help-text refinement * UIORGS-453-enhancement-settings-help-text remove unused --------- Co-authored-by: elsenhans <[email protected]>
folio-org · Jan 16, 2025 · e0fc73f · e0fc73f
1 parent 1e8b5ea
commit e0fc73f
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 1 deletion.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -8,6 +8,7 @@
 * Add claiming to organization integration details. Refs UIORGS-442.
 * Add "Duplicate" integration action to organization integration view. Refs UIORGS-441.
 * *BREAKING* Add number generator for vendor code including settings page. Refs UIORGS-336, UIORGS-337.
+* Enhancement help text on Settings > Organizations > Number generator options. Refs UIORGS-453.
 
 ## [5.2.0](https://github.com/folio-org/ui-organizations/tree/v5.2.0) (2024-10-31)
 [Full Changelog](https://github.com/folio-org/ui-organizations/compare/v5.1.1...v5.2.0)

diff --git a/src/Settings/NumberGeneratorSettings/NumberGeneratorSettingsForm.js b/src/Settings/NumberGeneratorSettings/NumberGeneratorSettingsForm.js
@@ -1,4 +1,5 @@
 import PropTypes from 'prop-types';
+import { Link } from 'react-router-dom';
 import { Field } from 'react-final-form';
 import { FormattedMessage } from 'react-intl';
 
@@ -16,6 +17,8 @@ import stripesFinalForm from '@folio/stripes/final-form';
 
 import css from './NumberGeneratorSettingsForm.css';
 import {
+  SERVICE_INTERACTION_API,
+  SERVICE_INTERACTION_NUMBER_GENERATOR_SEQUENCES_API,
   VENDOR_CODE_GENERATOR_OPTIONS,
   VENDOR_CODE_GENERATOR_SETTINGS_KEY,
 } from '../../common/constants/numberGenerator';
@@ -50,7 +53,27 @@ const NumberGeneratorSettingsForm = ({ handleSubmit, pristine, submitting }) =>
         <Col xs={12}>
           <div className={css.marginBottomGutter}>
             <MessageBanner>
-              <FormattedMessage id="ui-organizations.settings.numberGeneratorOptions.info" />
+              <p><FormattedMessage id="ui-organizations.settings.numberGeneratorOptions.info" /></p>
+              <p>
+                <FormattedMessage
+                  id="ui-organizations.settings.numberGeneratorOptions.infoAdditional"
+                  values={{
+                    serviceInteractionLink: (
+                      <Link to={SERVICE_INTERACTION_API}>
+                        <FormattedMessage id="stripes-core.settings" />{' > '}
+                        <FormattedMessage id="ui-service-interaction.meta.title" />
+                      </Link>
+                    ),
+                    numberGeneratorSequencesLink: (
+                      <Link to={SERVICE_INTERACTION_NUMBER_GENERATOR_SEQUENCES_API}>
+                        <FormattedMessage id="stripes-core.settings" />{' > '}
+                        <FormattedMessage id="ui-service-interaction.meta.title" />{' > '}
+                        <FormattedMessage id="ui-service-interaction.settings.numberGeneratorSequences" />
+                      </Link>
+                    ),
+                  }}
+                />
+              </p>
             </MessageBanner>
           </div>
         </Col>

diff --git a/src/Settings/NumberGeneratorSettings/NumberGeneratorSettingsForm.test.js b/src/Settings/NumberGeneratorSettings/NumberGeneratorSettingsForm.test.js
@@ -32,6 +32,7 @@ describe('NumberGeneratorSettingsForm', () => {
 
     expect(screen.getByText('ui-organizations.settings.numberGeneratorOptions')).toBeInTheDocument();
     expect(screen.getByText('ui-organizations.settings.numberGeneratorOptions.info')).toBeInTheDocument();
+    expect(screen.getByText('ui-organizations.settings.numberGeneratorOptions.infoAdditional')).toBeInTheDocument();
     expect(
       screen.getByLabelText('ui-organizations.settings.numberGeneratorOptions.useTextFieldForVendor'),
     ).toBeInTheDocument();

diff --git a/src/common/constants/numberGenerator.js b/src/common/constants/numberGenerator.js
@@ -1,6 +1,9 @@
 export const NUMBER_GENERATOR_INTERFACE_NAME = 'servint';
 export const NUMBER_GENERATOR_INTERFACE_VERSION = '4.0';
 
+export const SERVICE_INTERACTION_API = '/settings/service-interaction';
+export const SERVICE_INTERACTION_NUMBER_GENERATOR_SEQUENCES_API = '/settings/service-interaction/numberGeneratorSequences/';
+
 export const VENDOR_CODE_GENERATOR_OPTIONS = {
   BOTH: 'useBoth',
   TEXTFIELD: 'useTextField',

diff --git a/translations/ui-organizations/en.json b/translations/ui-organizations/en.json
@@ -514,6 +514,7 @@
   "settings.typeStatus.Inactive": "Inactive",
   "settings.numberGeneratorOptions": "Number generator options",
   "settings.numberGeneratorOptions.info": "Fields which are usually filled using a numeric sequence can use the number generator. When the generator is switched on the field can either be fixed to prevent manual update, or made fully editable. When switched off, the field must be filled manually.",
+  "settings.numberGeneratorOptions.infoAdditional": "Additional number generator settings are available under {serviceInteractionLink}.  At {numberGeneratorSequencesLink} sequences can be defined by selecting the appropriate generator via the drop-down menu.",
   "settings.numberGeneratorOptions.useGeneratorForVendor": "Number generator on, fixed: the vendor code can be filled using the generator only.",
   "settings.numberGeneratorOptions.useTextFieldForVendor": "Number generator off: the vendor code can be filled manually only.",
   "settings.numberGeneratorOptions.useBothForVendor": "Number generator on, editable: the vendor code can be filled using the generator and be edited, or filled manually.",