T4S4  18.2 C7549 A21431
Teamcenter Gateway for SAP S/4HANA API Reference
DATASET ITK functions

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

Functions

 DATASET_exportNamedRefsOfDataset HexItemId HexItemRevId HexRelationTypeName HexDatasetTypeName HexNamedRefName HexDatasetCreationDate HexDatasetTag
 This function calls the ITK pipe server function DATASET_list_namedreferences to exports all named file references based on the given parameters. More...
 
 DATASET_exportNamedRefsOfDataset_WithoutDateCheck HexItemId HexItemRevId HexRelationTypeName HexDatasetTypeName HexNamedRefName HexDatasetTag
 This function calls the ITK pipe server function DATASET_list_namedreferences to exports all named file references based on the given parameters. More...
 
 DATASET_importNamedReference DatasetTag NamedRefName OriginalFileName FileName
 This function calls a set of ITK pipe server function to set / exchange the named reference for the given dataset. More...
 
 DATASET_importNamedRefOfDataset ItemId ItemRevId RelationTypeName DatasetTypeName HexDatasetTag NamedRefName OriginalFileName FileName DatasetName
 This function calls the ITK pipe server function DATASET_list_namedreferences to return a list of defined named references for a given Dataset type name. More...
 
 DATASET_list_namedreferences DatasetTypeName
 This function calls the ITK pipe server function DATASET_list_namedreferences to return a list of defined named references for a given Dataset type name. More...
 

Detailed Description

All ITK functions of group DATASET supported by T4x.

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

Function Documentation

◆ DATASET_exportNamedRefsOfDataset()

ITK::DATASET_exportNamedRefsOfDataset   HexItemId HexItemRevId HexRelationTypeName HexDatasetTypeName HexNamedRefName HexDatasetCreationDate HexDatasetTag  

This function calls the ITK pipe server function DATASET_list_namedreferences to exports all named file references based on the given parameters.

In addition to DATASET_exportNamedRefsOfDataset_WithoutDateCheck this function checks that the creation date of the dataset, found by the navigation parameters, is identical to the given date. If the HexDatasetCreationDate parameter is present, the check is not executed.

Parameters
HexItemIdItemID
HexItemRevIdRevisionID
HexRelationTypeNameType name of the relation from the revision to the dataset
HexDatasetTypeNametype name of the dataset (e.g. "Text" or "MSExcel")
HexNamedRefNamereference name in the dataset
HexDatasetCreationDatecreation date of the dataset, required format string: "%Y.%m.%d %H:%M:%S"
HexDatasetTagtag of the dataset
Returns
List of 0 and exported file names or List of ITK status and error message

◆ DATASET_exportNamedRefsOfDataset_WithoutDateCheck()

ITK::DATASET_exportNamedRefsOfDataset_WithoutDateCheck   HexItemId HexItemRevId HexRelationTypeName HexDatasetTypeName HexNamedRefName HexDatasetTag  

This function calls the ITK pipe server function DATASET_list_namedreferences to exports all named file references based on the given parameters.

You can either navigate to the dataset using the parameters HexItemId, HexItemRevId, HexRelationTypeName, HexDatasetTypeName and leave HexDatasetTag empty ("") or just pass a valid dataset tag in HexDatasetTag.

Parameters
HexItemIdItemID
HexItemRevIdRevisionID
HexRelationTypeNameType name of the relation from the revision to the dataset
HexDatasetTypeNametype name of the dataset (e.g. "Text" or "MSExcel")
HexNamedRefNamereference name in the dataset
HexDatasetTagtag of the dataset
Returns
List of 0 and exported file names or List of ITK status and error message

◆ DATASET_importNamedReference()

ITK::DATASET_importNamedReference   DatasetTag NamedRefName OriginalFileName FileName  

This function calls a set of ITK pipe server function to set / exchange the named reference for the given dataset.

Parameters
DatasetTagtag of the dataset
NamedRefNamereference name in the dataset
OriginalFileNamethe original file name to store for the named reference
FileNamethe file of the file to read from
Returns
ITK_ok (=0) or list of ITK status and error message

Referenced by T4X::CUSTOM::MAPPING::TOOLBOX::importNamedReference().

◆ DATASET_importNamedRefOfDataset()

ITK::DATASET_importNamedRefOfDataset   ItemId ItemRevId RelationTypeName DatasetTypeName HexDatasetTag NamedRefName OriginalFileName FileName DatasetName  

This function calls the ITK pipe server function DATASET_list_namedreferences to return a list of defined named references for a given Dataset type name.

You can either navigate to the dataset using the parameters ItemId, ItemRevId, RelationTypeName, DatasetTypeName and leave HexDatasetTag empty ("") or just pass a valid dataset tag in HexDatasetTag. The dataset gets created if not present.

Parameters
ItemIdItemID
ItemRevIdRevisionID
RelationTypeNameType name of the relation from the revision to the dataset
DatasetTypeNametype name of the dataset (e.g. "Text" or "MSExcel")
HexDatasetTagtag of the dataset
NamedRefNamereference name in the dataset
OriginalFileNamethe original file name to store for the named reference
FileNamethe file of the file to read from
DatasetName(may be empty, in this case a canonical name is created)
Returns
List of ITK_ok (=0) and found names references or list of ITK status and error message

◆ DATASET_list_namedreferences()

ITK::DATASET_list_namedreferences   DatasetTypeName  

This function calls the ITK pipe server function DATASET_list_namedreferences to return a list of defined named references for a given Dataset type name.

Parameters
DatasetTypeName
Returns
List of ITK_ok (=0) and found names references or list of ITK status and error message