MfgProgramTemplate

Represents a definition of a program to create a program-based business. A program-based business, also known as a Manufacturing Program, enables manufacturers to drive their business models with forecasting tools and manage the end-to-end sales process efficiently.

Parent Type 

This type extends Metadata and inherits its fields.

File Suffix and Directory Location 

MfgProgramTemplate components have the suffix .mfgProgramTemplate and are stored in the MfgProgramTemplate folder.

Version 

Introduced in API version 54.0.

Special Access Rules 

The program-based business feature setting for Manufacturing Cloud is required to create a program template.

Fields 

description 

  • Type: string
  • Required: No
  • Description: The description of the manufacturing program template.

programTemplateItems 

  • Type: MfgProgramTemplateItem[]
  • Required: No
  • Description: The list of templates associated with the manufacturing program template.

programTemplateName 

  • Type: string

  • Required: Yes

  • Description: Required.

    The unique identifier for the manufacturing program template.

status 

  • Type: MfgProgramTemplateStatus (enumeration of type string)

  • Required: Yes

  • Description: Required.

    The status of the manufacturing program template.

    Values are:

    The default value is Active.

  • Possible values:

    • Active
    • Draft
    • Inactive

MfgProgramTemplateItem Type 

A program template item defines each of the templates associated with a manufacturing program. A template item includes program details, such as a data transformation type and a display order. Transformation type is the method to forecast business visibility to manufacturers.

Fields 

advAccountForecastSet 

  • Type: string
  • Required: No
  • Description: The forecast set associated with the transformation.

contextDefinition 

  • Type: string
  • Required: No
  • Description: The context definition that defines how data is mapped and transformed to the target, such as an opportunity or account.

description 

  • Type: string
  • Required: No
  • Description: The description of the manufacturing program template item.

sourceContextMappingName 

  • Type: string
  • Required: No
  • Description: The context mapping that defines how data is mapped from a list of facts(Input Data) to create structured information.

targetContextMappingName 

  • Type: string
  • Required: No
  • Description: The context mapping that defines how the structured data is saved to the target, such as an opportunity or sales agreement.

templateItemName 

  • Type: string

  • Required: Yes

  • Description: Required.

    The name of the manufacturing program template item.

transformationDisplayOrder 

  • Type: int

  • Required: Yes

  • Description: Required.

    The display order of the transformation in the manufacturing program template.

transformationType 

  • Type: MfgProgramTransformationType (enumeration of type string)

  • Required: Yes

  • Description: Required.

    Specifies the type of transformation.

    Values are:

  • Possible values:

    • BusinessTransformation
    • ForecastSetRelation

Declarative Metadata Sample Definition 

The following is an example of a MfgProgramTemplate component.

1<?xml version="1.0" encoding="UTF-8"?>
2<MfgProgramTemplate xmlns="http://soap.sforce.com/2006/04/metadata" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
3     <description>Program Template</description>
4     <programTemplateItems>
5         <templateItemName>Template Item #1</templateItemName>
6         <transformationDisplayOrder>1</transformationDisplayOrder>
7         <transformationType>BusinessTransformation</transformationType>
8         <description>Program Template Item</description>
9     </programTemplateItems>
10     <programTemplateName>Sample Program Template</programTemplateName>
11     <status>Draft</status>
12</MfgProgramTemplate>

The following is an example package.xml that references the previous definition.

1<?xml version="1.0" encoding="UTF-8"?>
2<Package xmlns="http://soap.sforce.com/2006/04/metadata">
3     <types>
4         <members>*</members>
5         <name>MfgProgramTemplate</name>
6     </types>
7     <version>54.0</version>
8</Package>

Wildcard Support in the Manifest File 

This metadata type supports the wildcard character * (asterisk) in the package.xml manifest file. For information about using the manifest file, see Deploying and Retrieving Metadata with the Zip File.