Step 2: Generate script files

Once you have saved customizations in a component as described in Step 1: Save customizations in a component, use that component to produce a set of script files. You can then use these files to apply your customizations to the target Sage CRM system. The process of generating script files from a component is called scripting.

To generate script files from your component:

1. Go to <My Profile> | Administration | Customization | Component Manager | Component Details.
2. Under Existing Components, click to select the component that contains the customizations you want to transfer to another Sage CRM instance. You can view additional information about each component as described in Viewing component details.
3. Select one of the following formats for the output files:
   
   • Sage CRM Script (.es) file. Use this format to transfer your customizations to another instance of Sage CRM. This file stores your customizations as JavaScript. The human-readable comments provided in the file describe what has been customized.
     To use this format, leave the Export as xml check box cleared.
   • Extensible Markup Language (.xml) file. Use this format in scenarios that involve integration with other applications. Note that you cannot use this format to apply your customizations to another instance of Sage CRM.
     To use this format, select the Export as xml check box.

   To preview the customization script you are about to generate, click Preview Script. When you are finished, click Continue.

4. Click Script Component.
5. On the screen that opens, use the following options:
   • File Name. Enter the name for the output script file you want to generate. If you've already scripted the current component, enter a new file name.
   • Description (optional). Enter an informative description for the file. This optional information is saved in the corresponding Sage CRM Component (.ecf) file. For example, a description can remind you of customization changes you made in a particular implementation before you apply them to the target Sage CRM system.
6. Click Script Component to generate the script files.
   The screen that opens shows the names and locations of these files.
   Optionally, you can modify the generated script files as described in Modifying script files.
7. Add the generated script files to a .zip archive.
   Now you need to apply your customizations as described in Step 3: Apply customizations to the target system.
   

On a Sage CRM computer, you can find the generated script files in

%ProgramFiles(x86)%\Sage\<InstallPath>\<InstallName>\inf

The inf folder holds the Sage CRM Component (.ecf) file and the component folder named after the component. The component folder contains the Sage CRM Script (.es) file and any other corresponding files, for example, ASP pages. To transfer your customizations, make sure to add all these files to the .zip archive.

The Component Manager automatically copies files stored in the CustomPages folder of Sage CRM only if these files are included in a tab group with the customfile action. If your customization files include other files such as .asp, .dll, .txt, .js, or .inc, manually copy them into the component's CustomPages folder when the component scripting is finished.

On a Sage CRM server, you can find the CustomPages folder in the following location:

%ProgramFiles(x86)%\Sage\<InstallPath>\<InstallName>\WWWRoot