This topic is related to Transact Maestro. |
Form BuilderTemplate Designer | v5.1 & Higher
This feature is related to v5.1 and higher.
All forms are based on numerous resources, including templates, shared styles, images, and shared components. These resources fall under different categories and are created and managed by different roles:
Style resources - corporate branding and template shared components, owned by the Template Designer.
Business shared components - business components shared across forms (e.g. address, contact details, etc.), owned by the Form Builder with responsibility for standardization.
Form resources - form specific components, owned by the Form Builder.
The objective of this best practice is to recommend an efficient way to package these resources to ensure re-use and provide a clear separation of responsibility between Template Designers and Form Builders. For instance, this will enable forms to re-use the corporate styling without unnecessarily inheriting form specific components.
It's recommended that you setup your projects and libraries before you begin development using the structure below; see Project Configuration and Create a New Template for detailed information.
There are three types of projects:
Form Project (a) - These projects contain the forms under development but do not contain any styles or templates. Any shared components in these projects are form specific only, and not intended to be shared across projects. Over time, it is typical for there to be multiple form projects grouped by business line, form type, or geography.
Shared Components Project (b) - There should only be one shared components project per organization, which only contains shared business components to be shared across projects. This should not include template components such as header, footer, etc. Note that shared business components that are first created from a form will be added to the form project component folder by default. It is therefore necessary to move these to the shared component project by exporting and importing. Do not forget to delete from the form project.
Style Project (c) - There should only be one style project per organization, which contains the templates, images, all shared styles, and components needed by the template (e.g. header, footer, navigator). This includes shared styles needed for shared business components.
There are two types of organization libraries:
Shared Components Library (d) - This organization library contains all published shared business components. Only resources from the shared components project are published to this library.
Style Library (e) - This organization library contains all published style resources. Only resources from the style project are published to this library.
The Shared Components Project and Style Project should have no project libraries. Their resources are always published to the organization libraries (Shared Components Library, Style Library). The Form Projects may have project libraries for any form specific shared components created.
Recommended naming convention for projects and libraries
Here are some recommended naming conventions for project and library names:
Name the style project "Style", unless the corporate style has a specific name.
Name the shared component project "Shared Components" to highlight that this should only contain shared components.
Prefix the style and shared component projects with the organization name or acronym so that exports are easily identified with the organization.
Form projects and libraries should be named based on the grouping; for example, Home Loan, Customer Onboarding, US Wealth Management, etc. The libraries for these projects should have the same name, ending with the suffix "Library".