T4S4  18.1 C7177 A20283
Teamcenter Gateway for SAP S/4HANA API Reference
CFM ITK functions

All ITK functions of group CFM supported by T4x. More...

Functions

 CFM_create_intent IntentName IntentDescriptions
 This function calls the ITK pipe server function CFM_create_intent to create a new intent. More...
 
 CFM_effectivity_ask_date_ranges HexEffectivityTag
 This function calls the ITK pipe server function CFM_effectivity_ask_date_ranges to return the effectivity date for the given effectivity. More...
 
 CFM_effectivity_create EffectivityId
 This function calls the ITK pipe server function CFM_effectivity_create to create a new effectivity for the given Id. More...
 
 CFM_effectivity_find EffectivityId
 This function calls the ITK pipe server function CFM_effectivity_find to find the effectivity for the given Id. More...
 
 CFM_effectivity_set_date_ranges HexEffectivityTag NumberOfRanges args
 This function calls the ITK pipe server function CFM_effectivity_set_date_ranges to set the effectivity dates for the given effectivity. More...
 
 CFM_find RuleName
 This function calls the ITK pipe server function CFM_find to finds the revision rule tag of the rule name. More...
 
 CFM_item_ask_configured HexRuleTag HexItemTag
 This function calls the ITK pipe server function CFM_item_ask_configured to finds the revision of the given item that is configured when the given revision rule is used to configure the given item. More...
 
 CFM_rule_add_entry_by_name HexRevisionRuleTag RuleType
 This function calls the ITK pipe server function CFM_rule_add_entry_by_name to add rule entry to the revision rule. More...
 
 CFM_rule_add_intent HexRuleTag HexIntentTag
 This function calls the ITK pipe server function CFM_rule_add_intent to add an intent to the given rule. More...
 
 CFM_rule_copy RevisionRuleTag NewRevisionRuleName
 This function calls the ITK pipe server function CFM_rule_copy to create a new revision rule based on a given revision rule tag. More...
 
 CFM_rule_create RevisionRuleName RevisionRuleDesc
 This function calls the ITK pipe server function CFM_rule_create to create a new revision rule. More...
 
 CFM_rule_list_intents HexRuleTag
 This function calls the ITK pipe server function CFM_rule_list_intents to get all intents of the given rule. More...
 
 CFM_rule_remove_intent HexRuleTag HexIntentTag
 This function calls the ITK pipe server function CFM_rule_remove_intent to remove an intent from the given rule. More...
 
 CFM_rule_set_date HexRevisionRuleTag DateString
 This function calls the ITK pipe server function CFM_rule_set_date to sets the date entry into the Revision Rule. If a date entry already exists with the revision rule it will be updated. More...
 

Detailed Description

All ITK functions of group CFM supported by T4x.

This group specifies all ITK functions of group CFM for which wrappers have been defined in T4x

Function Documentation

◆ CFM_create_intent()

ITK::CFM_create_intent   IntentName IntentDescriptions  

This function calls the ITK pipe server function CFM_create_intent to create a new intent.

Parameters
IntentName
IntentDescriptions
Returns
List of ITK Status and HexIntentTag or list of ITK status and error message

◆ CFM_effectivity_ask_date_ranges()

ITK::CFM_effectivity_ask_date_ranges   HexEffectivityTag  

This function calls the ITK pipe server function CFM_effectivity_ask_date_ranges to return the effectivity date for the given effectivity.

Parameters
HexEffectivityTag
Returns
List of ITK_ok (=0) and found effectivity date ranges or list of ITK status and error message format 0 {{{from date} {to date}}} e.g. 0 {{{2010.01.01 00:00:00} {2011.01.01 00:00:00}} ...}

◆ CFM_effectivity_create()

ITK::CFM_effectivity_create   EffectivityId  

This function calls the ITK pipe server function CFM_effectivity_create to create a new effectivity for the given Id.

Parameters
EffectivityId
Returns
List of ITK_ok (=0) and effectivity tag or list of ITK status and error message

◆ CFM_effectivity_find()

ITK::CFM_effectivity_find   EffectivityId  

This function calls the ITK pipe server function CFM_effectivity_find to find the effectivity for the given Id.

Parameters
EffectivityId
Returns
List of ITK_ok (=0) and found effectivity tag or list of ITK status and error message

◆ CFM_effectivity_set_date_ranges()

ITK::CFM_effectivity_set_date_ranges   HexEffectivityTag NumberOfRanges args  

This function calls the ITK pipe server function CFM_effectivity_set_date_ranges to set the effectivity dates for the given effectivity.

Parameters
HexEffectivityTag
NumberOfRanges
argsoptional flat pairs of {FromDate} {ToDate} ... (format of dates: "year.month.day hour:minutes:second" or "year-month-day hour:minutes:second")
Returns
List of ITK_ok (=0) or list of ITK status and error message

◆ CFM_find()

ITK::CFM_find   RuleName  

This function calls the ITK pipe server function CFM_find to finds the revision rule tag of the rule name.

Parameters
RuleName
Returns
List of ITK_ok (=0) and Revision Rule tag or list of ITK status and error message

◆ CFM_item_ask_configured()

ITK::CFM_item_ask_configured   HexRuleTag HexItemTag  

This function calls the ITK pipe server function CFM_item_ask_configured to finds the revision of the given item that is configured when the given revision rule is used to configure the given item.

Parameters
HexRuleTag
HexItemTag
Returns
List of ITK_ok (=0) and ItemRevision tag or list of ITK status and error message

◆ CFM_rule_add_entry_by_name()

ITK::CFM_rule_add_entry_by_name   HexRevisionRuleTag RuleType  

This function calls the ITK pipe server function CFM_rule_add_entry_by_name to add rule entry to the revision rule.

Parameters
HexRevisionRuleTag
RuleTypesupported are the following values: CFM_entry_working Working entry No user or group specified CFM_entry_status Status entry ANY status and type CFM_entry_latest Latest entry Type CFM_latest_creation_date CFM_entry_override Override entry No override folder specified CFM_entry_date Date entry "Today" CFM_entry_unit_no Unit Number entry Unit number 0 CFM_entry_end_item End Item entry No end item CFM_entry_precise Precise entry N/A
Returns
List of ITK_ok (=0) and Rule Entry tag or list of ITK status and error message

◆ CFM_rule_add_intent()

ITK::CFM_rule_add_intent   HexRuleTag HexIntentTag  

This function calls the ITK pipe server function CFM_rule_add_intent to add an intent to the given rule.

Parameters
HexRuleTag
HexIntentTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ CFM_rule_copy()

ITK::CFM_rule_copy   RevisionRuleTag NewRevisionRuleName  

This function calls the ITK pipe server function CFM_rule_copy to create a new revision rule based on a given revision rule tag.

Parameters
RevisionRuleTag
NewRevisionRuleName
Returns
List of ITK_ok (=0) and Revision Rule tag or list of ITK status and error message

◆ CFM_rule_create()

ITK::CFM_rule_create   RevisionRuleName RevisionRuleDesc  

This function calls the ITK pipe server function CFM_rule_create to create a new revision rule.

Parameters
RevisionRuleName
RevisionRuleDesc
Returns
List of ITK_ok (=0) and Revision Rule tag or list of ITK status and error message

◆ CFM_rule_list_intents()

ITK::CFM_rule_list_intents   HexRuleTag  

This function calls the ITK pipe server function CFM_rule_list_intents to get all intents of the given rule.

Parameters
HexRuleTag
Returns
List of ITK Status and list of HexIntentTags or list of ITK status and error message

◆ CFM_rule_remove_intent()

ITK::CFM_rule_remove_intent   HexRuleTag HexIntentTag  

This function calls the ITK pipe server function CFM_rule_remove_intent to remove an intent from the given rule.

Parameters
HexRuleTag
HexIntentTag
Returns
ITK_ok (=0) or list of ITK status and error message

◆ CFM_rule_set_date()

ITK::CFM_rule_set_date   HexRevisionRuleTag DateString  

This function calls the ITK pipe server function CFM_rule_set_date to sets the date entry into the Revision Rule. If a date entry already exists with the revision rule it will be updated.

Parameters
HexRevisionRuleTag
DateStringin the format "2013.03.11 00:00:00"
Returns
List of ITK_ok (=0) or list of ITK status and error message