Previous Topic

Next Topic

Customizing Parallels Business Automation - Standard

You can customize any of Parallels Business Automation - Standard screens in a way that suits your needs.

The following customization types are available:

Important: Please carefully follow both the directories structure and naming conventions offered below to store your customization. Otherwise the customized files will be overwritten after the next Parallels Business Automation - Standard update installation. Do not customize templates inside the original directories because such changes will be also lost after the Parallels Business Automation - Standard update installation.

Warning: We strongly recommend to copy into the custom directories only the files that you really customize. Do not copy the surrounding template files into the custom directories. Considerable number of template files in custom directories can result in the necessity for a lot of extra checks during Parallels Business Automation - Standard upgrade installation, because during upgrade each template in custom directories is checked in respect to compatibility with a new Parallels Business Automation - Standard version.

Customized screen templates should be stored in the single subdirectory created specially:

/var/opt/hspc-root/

Parallels Business Automation - Standard base directory defined by HSPCROOT_ROOT parameter in hspc.conf file.

/var/opt/hspc-root/custom/

Parallels Business Automation - Standard customization base directory.

/var/opt/hspc-root/custom/template/

The subdirectory containing customized templates.

/var/opt/hspc-root/custom/help/

The subdirectory containing customized context help files.

/var/opt/hspc-root/custom/hints/

The subdirectory containing customized onscreen help files.

/var/opt/hspc-root/custom/menu/

The subdirectory containing customized menu items for Control Panel.

/var/opt/hspc-root/custom/screen/

The subdirectory containing screen ID based customization files.

/var/opt/hspc-root/custom/localization/

The subdirectory containing the language pack customization files.

It is also possible to perform the account-specific and language-specific customization, but such customization can be applied to screen templates, context help, and onscreen help only.

The account-specific customization calls for creation of the following subdirectories in /var/opt/hspc-root/custom/template/, /var/opt/hspc-root/custom/help/, and /var/opt/hspc-root/custom/hints/:

default/

The directory to put templates customized for all Providers

1/

The directory to put templates customized for Provider only

RESELLER_ID/

The directory to put templates customized for particular Reseller, where RESELLER_ID represents a Reseller Account ID.

Example1:

To customize screen templates for a particular reseller account (let us assume that this reseller account ID is 123), it is necessary to:

  1. Create a subdirectory 123/ under the /var/opt/hspc-root/custom/template/ directory.
  2. Under the /var/opt/hspc-root/custom/template/123 directory, create subdirectories that exactly follow the path to the original files you want to customize. For example, if you want to customize store frontpage templates, that are originally located in /var/opt/hspc-root/template/HSPC/EM/Plans/, you must create the HSPC/EM/Plans/ subdirectory under the 123/ directory and put the customized files there.

    Thus, following our example, the final path for customized store frontpage templates must be:

    /var/opt/hspc-root/custom/template/123/HSPC/EM/Plans/

    Always create the corresponding subdirectories for customized files to let your customization be applied.

Example2:

To perform the language-specific customization, you should create the subdirectory named by the language two-letter abbreviation, e.g., EN/ for English, FR/ - for French, etc. For example,

/var/opt/hspc-root/custom/hints/FR/

to store the customized onscreen help files in French. And to store the french customization for your Provider account only:

/var/opt/hspc-root/custom/hints/1/FR/

To perform the language dependent customization for a particular Reseller account (for example, with account ID 127), you should create the directory:

/var/opt/hspc-root/custom/hints/127/FR/

For example, In accordance with the rules outlined above, the location of the custom on-screen help file for all French customers of the Reseller with account ID 127 on page with screen ID 01.04.18.02.16 should be the following:

/var/opt/hspc-root/custom/hints/127/FR/01.04.18.02.16.html

The procedure of customization file lookup looks as follows:

/var/opt/hspc-root/custom/hints/127/FR/01.04.18.02.16.html

/var/opt/hspc-root/custom/hints/127/EN/01.04.18.02.16.html

/var/opt/hspc-root/custom/hints/127/01.04.18.02.16.html

/var/opt/hspc-root/custom/hints/fr/01.04.18.02.16.html

/var/opt/hspc-root/custom/hints/en/01.04.18.02.16.html

/var/opt/hspc-root/custom/hints/01.04.18.02.16.html

In This Chapter

Components Repository

PHP Based Store Customization

Screen ID and Aliases Based Customization

Template Based Customization

Adding Custom Items to Control Panel Menu and Dashboard

Creating Custom Placeholders

Customizing Help Bar in Control Panel

Adding New Fields to Accounts Registration Form

Customizing Language Packs

Please send us your feedback on this help page