Setting up folders

The procedure to set up folders for customization is provided in this topic.

  1. Create an extensions folder in the <EXTN_WORKSPACE> which is henceforth referred as <EXTN_FOLDER>.
  2. Create ngstore folder inside <EXTN_FOLDER>. For example, <EXTN_FOLDER>/ngstore. You will be editing files within this folder. The package structure within this folder should reflect the folder structure, <WSCDEVWAR_FOLDER>/ngstore of the application.
    The <EXTN_FOLDER>/ngstore should contain the following folders:
    • jsps : contains overridden or new jsp files
    • shared : contains overridden or new shared features like directives, services, and so on
    • store : contains overridden or new application views like screens, wizards, and so on
    • vendor : contains new third-party libraries used in the application
  3. If you want to work with an exploded war, explode the war to a folder <WSCDEVWAR_FOLDER>. You must have an extn folder within <WSCDEVWAR_FOLDER>. For example, <WSCDEVWAR_FOLDER>/extn.
    • Create soft links inside <WSCDEVWAR_FOLDER>/extn/ngstore folder pointing to the appropriate folders inside <EXTN_FOLDER>/ngstore folder by using the following commands:
      • Windows command to create a soft link:
        cd <WSCDEVWAR_FOLDER>/extn/ngstore
        mklink /D jsps <EXTN_FOLDER>/ngstore/jsps
        mklink /D shared <EXTN_FOLDER>/ngstore/shared
        mklink /D store <EXTN_FOLDER>/ngstore/store
        mklink /D vendor <EXTN_FOLDER>/ngstore/vendor
      • Unix or Linux command to create a soft link:
        ln -s <WSCDEVWAR_FOLDER>/extn/ngstore/jsps <EXTN_FOLDER>/ngstore/jsps
        ln -s <WSCDEVWAR_FOLDER>/extn/ngstore/shared <EXTN_FOLDER>/ngstore/shared
        ln -s <WSCDEVWAR_FOLDER>/extn/ngstore/store <EXTN_FOLDER>/ngstore/store
        ln -s <WSCDEVWAR_FOLDER>/extn/ngstore/vendor <EXTN_FOLDER>/ngstore/vendor
      Note: If the war is built with extensions, then these folders would already be present in the <WSCDEVWAR_FOLDER>/extn/ngstore folder. You may delete these folders and create soft links instead.
  4. If you are working with a local runtime or a central runtime, ensure that you have <RUNTIME>/extensions/wsc/webpages folder.
    • Create soft links inside <RUNTIME>/extensions/wsc/webpages/ngstore folder pointing to the appropriate folders inside <EXTN_FOLDER>/ngstore folder by using the following commands:
      • Windows command to create a soft link:
        cd <RUNTIME>/extensions/wsc/webpages/ngstore
        mklink /D jsps <EXTN_FOLDER>/ngstore/jsps
        mklink /D shared <EXTN_FOLDER>/ngstore/shared
        mklink /D store <EXTN_FOLDER>/ngstore/store
        mklink /D vendor <EXTN_FOLDER>/ngstore/vendor
      • Unix or Linux command to create a soft link:
        ln -s <RUNTIME>/extensions/wsc/webpages/ngstore/jsps <EXTN_FOLDER>/ngstore/jsps
        ln -s <RUNTIME>/extensions/wsc/webpages/ngstore/shared <EXTN_FOLDER>/ngstore/shared
        ln -s <RUNTIME>/extensions/wsc/webpages/ngstore/store <EXTN_FOLDER>/ngstore/store
        ln -s <RUNTIME>/extensions/wsc/webpages/ngstore/vendor <EXTN_FOLDER>/ngstore/vendor
Note: Soft links help you update the runtime and exploded war files with the changes you make in your local workspace. Therefore, files edited in the <EXTN_FOLDER> will be automatically available within the <WSCDEVWAR_FOLDER>, without having to manually copy the modified files.