Using Pre-Vinson Services with Vinson Release or Later

Services included with SuiteCommerce Advanced (SCA) prior to the Vinson release contain all the logic necessary to function with the Vinson release and later.

The Vinson release of SCA ports existing, unmodified services of previous releases. Therefore, any unmodified services using pre-Vinson architecture will function with Vinson without requiring any changes to the code. However, if you made any customizations to pre-Vinson services, you can still use your existing customizations with the Vinson release of SCA. This requires that you edit the appropriate ns.package.json file to use the existing service (.ss file).

With the Vinson release of SCA, each module's ns.package.json file contains the autogenerated-services object. This object includes a list of .ss files to automatically generate when you deploy your site plus their associated Service Controllers. The following example shows the ns.package.json file for the Account module:

1{
2"gulp": {
3   "javascript": [
4      "JavaScript/*.js"
5   ]
6,   "ssp-libraries": [
7      "SuiteScript/*.js"
8   ]
9,   "autogenerated-services":
10   {
11      "Account.ForgotPassword.Service.ss" : "Account.ForgotPassword.ServiceController",
12      "Account.Login.Service.ss" : "Account.Login.ServiceController",
13      "Account.Register.Service.ss" : "Account.Register.ServiceController",
14      "Account.RegisterAsGuest.Service.ss" : "Account.RegisterAsGuest.ServiceController",
15      "Account.ResetPassword.Service.ss" : "Account.ResetPassword.ServiceController"
16   }
17}
18}

If you have customized any services using pre-Vinson architecture, you can add code to the services array of the appropriate ns.package.json file, forcing the SCA developer tools to use existing .ss files of the same name instead of automatically generating new ones.

To use pre-Vinson services with Vinson release or later:

1. Open the ns.package.json file located in the module containing the service file you want to use.

2. Add the following code to the file:

   jsonCopy

   ,   "services": [
            "SuiteScript/*.ss"
         ]

   Note:

   If a custom service (.ss file) exists in the module that bears the same name as one listed in the autogenerated-services object, this code prevents the SCA developer tools from automatically generating that .ss file. The dev tools will display a warning, informing you that the service will not be automatically generated because of the custom service with the same name. This warning is displayed as information only and does not require any action.

3. Save the ns.package.json file.

4. Use the SCA developer tools to deploy your services to your site.

Related Topics

• Create a Service to Handle HTTP Requests
• Create a Service to Handle HTTP Requests (Pre-Vinson)

General Notices