{ "componentChunkName": "component---src-templates-plugin-docs-tsx", "path": "/plugins/scm-custom-properties-plugin/docs/1.4.x/en/overview/", "result": {"data":{"plugin":{"name":"scm-custom-properties-plugin","displayName":"Custom Properties","description":"Plugin to add user-defined properties to a repository as a key-value structure","author":"Cloudogu GmbH","documentation":[{"version":"1.5.x","languages":["de","en"]},{"version":"1.4.x","languages":["de","en"]},{"version":"1.3.x","languages":["en","de"]},{"version":"1.2.x","languages":["de","en"]},{"version":"1.1.x","languages":["de","en"]},{"version":"1.0.x","languages":["de","en"]}]},"navigation":{"nodes":[{"section":"Features","entries":[{"frontmatter":{"title":"Overview","subtitle":null,"partiallyActive":null},"fields":{"slug":"/plugins/scm-custom-properties-plugin/docs/1.4.x/en/overview/"}}]}]},"versions":{"group":[{"fieldValue":"1.0.x"},{"fieldValue":"1.1.x"},{"fieldValue":"1.2.x"},{"fieldValue":"1.3.x"},{"fieldValue":"1.4.x"},{"fieldValue":"1.5.x"}]},"languages":{"group":[{"fieldValue":"de"},{"fieldValue":"en"}]},"markdownRemark":{"html":"

With this plugin it is possible to create a collection of user-defined properties for each repository.\nThese properties are defined as key-value pairs.\nTo see an overview of the existing properties in tabular form,\nyou can click on the 'Custom Properties' entry in the repository navigation.

\n

\n \n

Creation of Custom Properties

\n

\n \n

\n \n \n

\n

When entering a key, it is also possible to select from predefined keys.\nTo do this, these keys must be defined in the global or respective namespace configuration (see documentation on configuring the plugin).\nTo display the available suggestions, focus on the text input for the key.\nThen press the down arrow key to display all suggestions in a combo box.\nThe list of suggested keys can be filtered by entering characters in the text input field.\nThe filter checks whether the current user input is present in the keys as a substring.\nThe filter is case-insensitive.

\n

When creating the property, make sure that the key

\n
    \n
  1. is not longer than 255 characters,
    2. \n
  2. consists only of letters, numbers, periods, spaces, underscores, slashes, colons, dashes, and the @ character,
    3. \n
  3. is unique within a repository(each key can be assigned only once).
    4. \n
\n

Multiple values for the same key must be entered as a single property separated by commas.\nThere are no restrictions on the value, unless a predefined key is being used with predefined values.\nIf this is the case, then the user can select one of the allowed values within a dropdown element.

\n

\n \n \n

\n

Editing and Deletion of Custom Properties

\n

For each custom property in the overview, there is a separate button for editing and deleting properties.\nA property is edited in a similar way as it is created.

\n

To edit, delete, and create properties, it is necessary to have the permission to modify the repository metadata.\nIf the user does not have this permission, the corresponding buttons will not be displayed.

\n

Default Custom Properties

\n

\n \n \n

\n

If mandatory custom properties have been defined but not created in a repository,\na banner will be displayed below the title in the respective repository.\nThis banner informs the user that mandatory custom properties are missing and need to be created.\nIt also contains a link to the overview page with the custom properties of the respective repository.

","description":"With this plugin it is possible to create a collection of user-defined properties for each repository.\nThese properties are defined as key-value pairs.\nTo see…","tableOfContents":"","frontmatter":{"title":"Overview","subtitle":null,"description":null,"keywords":null,"displayToc":null,"image":null}}},"pageContext":{"name":"scm-custom-properties-plugin","slug":"/plugins/scm-custom-properties-plugin/docs/1.4.x/en/overview/","version":"1.4.x","latestVersion":"1.5.x","latestPageVersion":"1.5.x","language":"en","canonicalPath":"/plugins/scm-custom-properties-plugin/docs/latest/en/overview/","latestRootPath":"/plugins/scm-custom-properties-plugin/docs/1.5.x/en/"}}, "staticQueryHashes": ["1973669194","2742214048","2956773653","2957019495","698804963"]}