From 01d8a0f7befa47b994207b2fa1e11b413d89b94b Mon Sep 17 00:00:00 2001 From: heathjoy <50637241+heathjoy@users.noreply.github.com> Date: Thu, 5 Mar 2020 08:22:00 -0500 Subject: [PATCH] BXMSDOC-5434-master: Update configuring business central settings and properties doc per changes in RHDM/RHPAM 7.7 (#56) (#2238) * BXMSDOC-5434-master: Added a new chapter Archetype management in the document. * BXMSDOC-5434-master: Incorporated the changes on the basis of SME review. * BXMSDOC-5434-master: Incorporated the changes on the basis on Peer and QE reviews. * BXMSDOC-5434-master: Reverted the red icon changes as per QE review. --- .../assembly_configuring-central/main.adoc | 42 ++++--------------- ...usiness-central-adding-archetype-proc.adoc | 17 ++++++++ ...al-additional-features-archetype-proc.adoc | 21 ++++++++++ ...naging-business-central-archetype-con.adoc | 6 +++ ...central-archetype-space-settings-proc.adoc | 18 ++++++++ ...ntral-creating-archetype-project-proc.adoc | 22 ++++++++++ ...siness-central-listing-archetype-proc.adoc | 14 +++++++ 7 files changed, 106 insertions(+), 34 deletions(-) create mode 100644 doc-content/enterprise-only/admin-and-config/managing-business-central-adding-archetype-proc.adoc create mode 100644 doc-content/enterprise-only/admin-and-config/managing-business-central-additional-features-archetype-proc.adoc create mode 100644 doc-content/enterprise-only/admin-and-config/managing-business-central-archetype-con.adoc create mode 100644 doc-content/enterprise-only/admin-and-config/managing-business-central-archetype-space-settings-proc.adoc create mode 100644 doc-content/enterprise-only/admin-and-config/managing-business-central-creating-archetype-project-proc.adoc create mode 100644 doc-content/enterprise-only/admin-and-config/managing-business-central-listing-archetype-proc.adoc diff --git a/assemblies/assembly_configuring-central/main.adoc b/assemblies/assembly_configuring-central/main.adoc index 701a8b38ec..a6ac88afb6 100644 --- a/assemblies/assembly_configuring-central/main.adoc +++ b/assemblies/assembly_configuring-central/main.adoc @@ -26,6 +26,7 @@ As an administrator, you can customize the following on the admin *Settings* pag * *SSH Keys*: Add or delete SSH keys. * *Service Tasks Administration*: Enable or disable default service tasks and upload custom service tasks. * *Profiles*: Set the workbench profile as *Planner and Rules* or *Full*. +* *Archetype*: View, add, validate, set as default, and delete the archetypes. Used as a template when creating a new project in {CENTRAL}. .Prerequisites * {EAP_LONG} {EAP_VERSION_LONG} is installed. For more information, see https://access.redhat.com/documentation/en-us/red_hat_jboss_enterprise_application_platform/7.2/html-single/installation_guide/[_{EAP_LONG} {EAP_VERSION} Installation Guide_]. @@ -34,51 +35,40 @@ As an administrator, you can customize the following on the admin *Settings* pag // Modules - concepts, procedures, refs, etc. include::{enterprise-dir}/admin-and-config/managing-business-central-user-management-con.adoc[leveloffset=+1] - include::{enterprise-dir}/admin-and-config/business-central-settings-creating-new-users-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-editing-users-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-creating-groups-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-editing-groups-proc.adoc[leveloffset=+2] include::{enterprise-dir}/admin-and-config/business-central-settings-security-con.adoc[leveloffset=+1] - include::{enterprise-dir}/admin-and-config/business-central-settings-changing-permissions-proc.adoc[leveloffset=+2] include::{enterprise-dir}/admin-and-config/managing-business-central-artifacts-con.adoc[leveloffset=+1] - include::{enterprise-dir}/admin-and-config/managing-business-central-view-artifacts-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-download-artifacts-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-upload-artifacts-proc.adoc[leveloffset=+2] include::{enterprise-dir}/admin-and-config/managing-business-central-data-sources-con.adoc[leveloffset=+1] - include::{enterprise-dir}/admin-and-config/managing-business-central-adding-database-driver-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-editing-database-driver-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-deleting-database-driver-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-adding-data-sources-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-editing-data-sources-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-deleting-data-sources-proc.adoc[leveloffset=+2] include::{enterprise-dir}/project-data/data-sets-con.adoc[leveloffset=+1] - include::{enterprise-dir}/project-data/data-sets-add-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/project-data/data-sets-edit-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/project-data/data-sets-refresh-con.adoc[leveloffset=+2] - include::{enterprise-dir}/project-data/data-sets-caching-con.adoc[leveloffset=+2] +include::{enterprise-dir}/admin-and-config/managing-business-central-archetype-con.adoc[leveloffset=+1] +include::{enterprise-dir}/admin-and-config/managing-business-central-listing-archetype-proc.adoc[leveloffset=+2] +include::{enterprise-dir}/admin-and-config/managing-business-central-adding-archetype-proc.adoc[leveloffset=+2] +include::{enterprise-dir}/admin-and-config/managing-business-central-additional-features-archetype-proc.adoc[leveloffset=+2] +include::{enterprise-dir}/admin-and-config/managing-business-central-creating-archetype-project-proc.adoc[leveloffset=+2] +include::{enterprise-dir}/admin-and-config/managing-business-central-archetype-space-settings-proc.adoc[leveloffset=+2] + include::{enterprise-dir}/admin-and-config/managing-business-central-project-preferences-proc.adoc[leveloffset=+1] include::{enterprise-dir}/admin-and-config/managing-business-central-artifact-repository-proc.adoc[leveloffset=+1] @@ -90,15 +80,10 @@ include::{enterprise-dir}/admin-and-config/managing-business-central-process-adm include::{enterprise-dir}/admin-and-config/managing-business-central-process-designer-proc.adoc[leveloffset=+1] include::{enterprise-dir}/admin-and-config/managing-business-central-ssh-keys-con.adoc[leveloffset=+1] - include::{enterprise-dir}/admin-and-config/managing-business-central-ssh-keystore-default-con.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-ssh-keystore-custom-con.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-ssh-keys-create-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-ssh-keys-register-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-ssh-keys-delete-proc.adoc[leveloffset=+2] include::{enterprise-dir}/admin-and-config/manage-service-tasks-proc.adoc[leveloffset=+1] @@ -106,7 +91,6 @@ include::{enterprise-dir}/admin-and-config/manage-service-tasks-proc.adoc[levelo include::{enterprise-dir}/admin-and-config/exporting-importing-dashbuilder-data-proc.adoc[leveloffset=+1] include::{enterprise-dir}/admin-and-config/managing-business-central-ldap-connection-con.adoc[leveloffset=+1] - include::{enterprise-dir}/admin-and-config/managing-business-central-using-usergroupcallback-ref.adoc[leveloffset=+2] include::{enterprise-dir}/admin-and-config/managing-business-central-using-settings-xml-ref.adoc[leveloffset=+1] @@ -116,27 +100,17 @@ include::{enterprise-dir}/admin-and-config/managing-business-central-gav-checks- include::{enterprise-dir}/admin-and-config/configuring-environment-mode-proc.adoc[leveloffset=+1] include::{enterprise-dir}/admin-and-config/managing-business-central-git-hooks-con.adoc[leveloffset=+1] - include::{enterprise-dir}/admin-and-config/managing-business-central-creating-git-hooks-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-importing-remote-git-repositories-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-configuring-git-hooks-existing-remote-git-repositories-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-configuring-git-hooks-system-property-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-integrating-remote-git-repositories-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-git-hook-exit-codes-con.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-customizing-git-hook-notifications-proc.adoc[leveloffset=+2] - include::{enterprise-dir}/admin-and-config/managing-business-central-git-hook-notifications-exit-codes-types-con.adoc[leveloffset=+3] - include::{enterprise-dir}/admin-and-config/managing-business-central-git-hook-notifications-internationalize-con.adoc[leveloffset=+3] include::{enterprise-dir}/admin-and-config/role-based-access-con.adoc[leveloffset=+1] - include::{enterprise-dir}/admin-and-config/define-role-based-access-proc.adoc[leveloffset=+2] include::{enterprise-dir}/admin-and-config/managing-business-central-using-process-instances-logs-proc.adoc[leveloffset=+1] diff --git a/doc-content/enterprise-only/admin-and-config/managing-business-central-adding-archetype-proc.adoc b/doc-content/enterprise-only/admin-and-config/managing-business-central-adding-archetype-proc.adoc new file mode 100644 index 0000000000..3a20f1e33e --- /dev/null +++ b/doc-content/enterprise-only/admin-and-config/managing-business-central-adding-archetype-proc.adoc @@ -0,0 +1,17 @@ +[id='managing-business-central-adding-archetype-proc'] += Adding an archetype + +You can add a new archetype to {CENTRAL}. + +.Prerequisites + +* You have installed an archetype in the Maven repository. + +.Procedure + +. In {CENTRAL}, select the *Admin* icon in the top-right corner of the screen and select *Archetypes*. +. Click *Add Archetype*. +. In the *Add Archetype* panel, enter the GAV attributes in the *Group ID*, *Artifact ID*, and *Version* fields respectively. +. Click *Add*. + +{CENTRAL} validates the newly added archetype and make it available to be used as a template in all the spaces. diff --git a/doc-content/enterprise-only/admin-and-config/managing-business-central-additional-features-archetype-proc.adoc b/doc-content/enterprise-only/admin-and-config/managing-business-central-additional-features-archetype-proc.adoc new file mode 100644 index 0000000000..4237cc8d22 --- /dev/null +++ b/doc-content/enterprise-only/admin-and-config/managing-business-central-additional-features-archetype-proc.adoc @@ -0,0 +1,21 @@ +[id='managing-business-central-additional-features-archetype-proc'] += Managing additional features of an archetype + +You can delete, set a default, and validate the archetypes from the *Archetypes* page in {CENTRAL}. + +.Prerequisites + +* You have created an archetype and listed in the {CENTRAL} *Settings* from the Maven repository. + +.Procedure + +. In {CENTRAL}, select the *Admin* icon in the top-right corner of the screen and select *Archetypes*. +. From the *Actions* column, click the image:project-data/dots.png[] icon on the right side of an archetype. +* Select *Delete* from the drop-down menu to delete an archetype from the list. +* Select *Validate* from the drop-down menu to validate whether the archetype is valid or not. ++ +[NOTE] +==== +When the {CENTRAL} is starting up, all the registered archetypes are automatically validated. +==== +* Select *Set as default* from the drop-down menu to set an archetype as a default for the new spaces. diff --git a/doc-content/enterprise-only/admin-and-config/managing-business-central-archetype-con.adoc b/doc-content/enterprise-only/admin-and-config/managing-business-central-archetype-con.adoc new file mode 100644 index 0000000000..3f93d518e4 --- /dev/null +++ b/doc-content/enterprise-only/admin-and-config/managing-business-central-archetype-con.adoc @@ -0,0 +1,6 @@ +[id='managing-business-central-archetype-con'] += Archetype management + +{CENTRAL} provides an archetype management feature that enables you to list, add, validate, set as default, and delete the archetypes. You can manage archetypes from the *Archetypes* page in {CENTRAL}. Archetypes are projects that are installed in Apache Maven repositories in which a template structure is set or can be created if required. + +For the most up-to-date and detailed information about archetypes, see the https://maven.apache.org/guides/introduction/introduction-to-archetypes.html[Introduction to Archetypes page]. diff --git a/doc-content/enterprise-only/admin-and-config/managing-business-central-archetype-space-settings-proc.adoc b/doc-content/enterprise-only/admin-and-config/managing-business-central-archetype-space-settings-proc.adoc new file mode 100644 index 0000000000..4fe8c1b729 --- /dev/null +++ b/doc-content/enterprise-only/admin-and-config/managing-business-central-archetype-space-settings-proc.adoc @@ -0,0 +1,18 @@ +[id='managing-business-central-archetype-space-settings-proc'] += Managing archetypes using space settings in {CENTRAL} + +When you add the archetypes to {CENTRAL}, they can be used as a templates in all the spaces. You can manage all the archetypes from the *Settings* tab which is available in the space. This tab is visible only to users with the `admin` role. + +.Prerequisites + +* You have installed an archetype in the Maven repository. +* You have created an archetype and listed it in the {CENTRAL} *Settings* from the Maven repository. + +.Procedure + +. In {CENTRAL}, go to *Menu* -> *Design* -> *Projects*. +. Select or create the space into which you want to manage the archetypes. The default space is *MySpace*. +. Click *Settings*. +. To include or exclude the archetypes in the space, select the *Include* check box. +. From the *Actions* column, click the image:project-data/dots.png[] icon on the right side of an archetype and select *Set as default* from the drop-down menu to set an archetype as a default for the space. +. Click *Save*. diff --git a/doc-content/enterprise-only/admin-and-config/managing-business-central-creating-archetype-project-proc.adoc b/doc-content/enterprise-only/admin-and-config/managing-business-central-creating-archetype-project-proc.adoc new file mode 100644 index 0000000000..3717c1059c --- /dev/null +++ b/doc-content/enterprise-only/admin-and-config/managing-business-central-creating-archetype-project-proc.adoc @@ -0,0 +1,22 @@ +[id='managing-business-central-creating-archetype-project-proc'] += Creating a project using archetypes + +You can use archetypes to create a project in {CENTRAL}. When you create a project in {CENTRAL}, it is added to the Git repository that is connected to your {PRODUCT} installation. + +.Prerequisites + +* You have created an archetype and listed it in the {CENTRAL} *Settings* from the Maven repository. +* You have set an archetype as default in your space in the {CENTRAL}. + +.Procedure + +. In {CENTRAL}, go to *Menu* -> *Design* -> *Projects*. +. Select or create the space into which you want to add a new project from an archetype template. +. Click *Add Project*. +. Type the project name and description in the *Name* and *Description* fields respectively. +. Click *Configure Advanced Options*. +. Select the *Based on template* check box. +. Select the archetype from drop-down options if required. The default archetype is selected that is already set in the space. +. Click *Add*. + +The *Assets* view of the project opens based on the selected archetype template. diff --git a/doc-content/enterprise-only/admin-and-config/managing-business-central-listing-archetype-proc.adoc b/doc-content/enterprise-only/admin-and-config/managing-business-central-listing-archetype-proc.adoc new file mode 100644 index 0000000000..814129c960 --- /dev/null +++ b/doc-content/enterprise-only/admin-and-config/managing-business-central-listing-archetype-proc.adoc @@ -0,0 +1,14 @@ +[id='managing-business-central-listing-archetype-proc'] += Listing archetypes + +The *Archetypes* page lists all the archetypes that are added in {CENTRAL}. This list provides the detailed information about *Group ID*, *Artifact ID*, *Version*, *Created Date*, *Status*, and *Actions* of an archetype. + +.Prerequisites + +* You have created an archetype and listed it in the {CENTRAL} *Settings* from the maven repository. + +.Procedure + +. In {CENTRAL}, select the *Admin* icon in the top-right corner of the screen and select *Archetypes*. ++ +In the *Status* column, green icon indicates it is a valid archetype, red icon indicates it is an invalid archetype whereas blue icon indicates the corresponding archetype is the default one for the new spaces.