Form Development
caution
While you can deploy the Workspaces 19.11 application in a TJM 20.05 instance, we don't recommend this mixed-release deployment. For more information, see Can I deploy the Workspaces 19.11 portal in a TJM 20.05, 20.11 or 21.05 environment?.
Foreword
Workspaces is a production-ready solution and component library for creating awesome application review processes that enhance the customer support experience, and provide valuable workgroup management capabilities. The new Workspaces introduces templates and components that follow the Temenos Design System, designed to improve the user and development experiences. Workspaces applications are built with React and the Temenos Journey Platform.
Your feedback is welcome and much appreciated. With your help, we can progress towards more elegant and better-designed components that will provide you with a better Workspaces experience.
Prerequisites
Workspaces is based on ES2015+, React, Redux, and Material UI. Familiarity with these technologies is recommended but not required.
As a Workspaces developer, you need the following installed on your computer:
Install the command-line tool
To install the command-line tool (CLI), run the following command in a terminal:
yarn add -g @transact-open-ux/[email protected]
Then, you can install the template with the following command.
transact create --clone --template https://gitlab+deploy-token-6:[email protected]/workspaces/workspaces-template.git PROJECT_DIR
Replace PROJECT_DIR with the name of the new folder where your workspaces project will be stored. If PROJECT_DIR doesn't exist, it is created by this command.
note
If your project uses a client services CI/CD pipeline for the build and deploy process, Workspaces 20.05 supports an automated build and deployment process. For details, refer to the README that comes packaged with your setup.
Scaffolding
A scaffold is provided which includes common configs for development, testing and springboard, and demonstrates the component library. The project layout is as follows.
├── public # Public files
├── src
│ ├── configs # Space configurations
│ ├── ├── default # Config for default
│ ├── ├── development # Config for development
│ ├── ├── testing # Config for testing
│ ├── ├── springboard # Config for springboard
│ ├── ├── custom # Custom config
│ ├── fixtures # Mock data/fixtures
│ ├── ├── default # Fixtures for default
│ ├── ├── development # Fixtures for development
│ ├── ├── testing # Fixtures for testing
│ ├── ├── springboard # Fixtures for springboard
│ ├── ├── custom # Custom fixtures
│ ├── locales # i18n Messages
│ ├── index.jsx # App entry
│ ├── react-app-env.d.ts # TypeScript reference for react-scripts
├── README.md # Getting Started
└── .transact-auth # Auth credentials
└── transact-config.json # Transact configuration
└── transact-schema.json # Transact Schema
└── package.json # Dependencies
└── yarn.lock # lock file for dependencies
Development
To start the project using the mock data provided in the repo, run the following command.
$ yarn run start
Your form should start in the console and you should be able to see it on http://localhost:5000
note
Once you are ready with your Form, you will need to configure JM to use our Form as the default Workspaces Client. For more information, see Form Deployment and Security.