Manually Defining Feature Dependencies in the SuiteCloud Project Manifest

You can define feature dependencies by updating the manifest file for your SuiteCloud project in SuiteCloud Development Framework (SDF).

To manually define feature dependencies:

  1. Open the manifest.xml file.

  2. After the frameworkversion element, add a dependencies element if one does not already exist.

    Then inside the dependencies element, add a features element if one does not already exist.

  3. Type the following element inside the features element:

                    <feature required=""></feature> 
    
                  

    Your dependencies element should look similar to the following XML:

                        <dependencies>
    
            <features>
    
                <feature required=""></feature>
    
            </features>
    
        </dependencies> 
    
                  
  4. With the cursor placed inside the feature element, enter the feature value. For the list of features, see configurable_features.

  5. Set the required attribute to a string to one of the following values:

    • true – Specifies that the feature is required for the SDF SuiteApp to successfully install (or SDF account customization project to successfully deploy) to the target account. If the target account does not have the feature enabled, the installation (or deployment) will fail with an error.

      The following XML sample is an example of a feature dependency that is required for the SuiteApp to be successfully installed:

                              <dependencies>
      
              <features>
      
                  <feature required="true">EXAMPLEFEATURE</feature>
      
              </features>
      
          </dependencies> 
      
                        
    • false – Specifies that the feature is not required for the SDF SuiteApp to successfully install (or SDF account customization project to successfully deploy) to the target account. SuiteApps (and account customization projects) containing SDF custom objects that support enhanced feature dependency can still successfully deploy without errors when this is value is set. For more information, see Enhanced Feature Dependencies for SDF Custom Objects.

      The following XML sample is an example of a feature dependency that is not required for the SuiteApp to be successfully installed:

                              <dependencies>
      
              <features>
      
                  <feature required="false">EXAMPLEFEATURE</feature>
      
              </features>
      
          </dependencies> 
      
                        
  6. Save the file.

Related Topics

General Notices