Utility to compile HighPoint application branding.
yarn add -D @highpoint/compile-branding
Copy .env-sample to your application's root directory and name it .env.
Populate the values. You can reference the table below for examples of what
values should be used. This file should not be included in your source
control, so add it to your .gitignore (or similar) file.
| Variable | Example |
|---|---|
| PS_HOSTNAME | cs92-devo.mhighpoint.com |
| PS_ENVIRONMENT | csdev92 |
| PS_NODE | SA |
| PS_USERNAME | PS |
| PS_PASSWORD | mysupersecretpassword |
| HTTP_USERNAME | PS |
| HTTP_PASSWORD | mysupersecretpassword |
Produces a compiled version of the branding in a local directory.
const { compileBranding } = require('@highpoint/compile-branding');
const { resolve } = require('path');
compileBranding({
app: 'app',
inFile: resolve(`./src/main.scss`),
outDir: resolve('./dist'),
weblib: 'WEBLIB_H_BRNDNG'
}).catch(({ message }) => console.error(message));The abbreviation of the application whose branding is being compiled.
Examples: app, dp, mc, sb
The absolute path to the SCSS file that acts as the template for compiling branding.
Example: path.resolve('./scss/main.scss')
The absolute path to the directory that the compiled CSS files should be outputted to.
Example: path.resolve('./dist')
The PeopleSoft web library that will be called. It needs to have the following functions:
- IScript_GetVars
- IScript_CompileTemplate
Example: WEBLIB_H_BRNDNG
Triggers branding compilation remotely. This is primarily used by continuous integration services (e.g. Jenkins) to tell PeopleSoft that it should compile the branding.
const { triggerCompile } = require('@highpoint/compile-branding');
triggerCompile({ weblib: 'WEBLIB_H_BRNDNG' }).catch(({ message }) => {
console.error(message);
process.exit(1);
});The PeopleSoft web library that will be called. It needs to have the following function:
- IScript_Compile