Document pipeline step in DocumentIntelligenceDataModel(DocumentPipelineStep)
Latest version of the JSON entity definition is available on GitHub.
Traits
Traits for this entity are listed below.
is.CDM.entityVersion
Parameter | Value | Data type | Explanation |
---|---|---|---|
versionNumber | "1.1" | string | semantic version number of the entity |
is.identifiedBy
names a specifc identity attribute to use with an entity
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | DocumentPipelineStep/(resolvedAttributes)/documentpipelinestepId | attribute |
means.entityState
the attribute represents the current state of the entity.
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | DocumentPipelineStep/(resolvedAttributes)/statecode | attribute |
is.CDM.attributeGroup
identifies standard groups of attributes in CDM entities.
Parameter | Value | Data type | Explanation | ||
---|---|---|---|---|---|
groupList |
| entity |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msfsi_documentpipelinestep" | string |
has.entitySchemaAbstractionLevel
A level of abstraction assigned to an Entity schema. Logical schema descriptions use complex dataTypes, inheritance, and entities as attributes. Resolved descriptions contain none of those things, only final trait and attribute sets are shown. A composition schema manipulates, guides or re-states parts of logical schemas to produce one resolved schema.
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "resolved" | string | Possible values: logical, composition, resolved |
Attributes
documentpipelinestepId
Unique identifier for entity instances
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value |
---|---|
displayName | Document pipeline step |
description | Unique identifier for entity instances |
isPrimaryKey | true |
dataFormat | guid |
sourceName | msfsi_documentpipelinestepid |
Traits
List of traits for the documentpipelinestepId attribute are listed below.
is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
is.dataFormat.guid
means.identity.entityId
is.identifiedBy
names a specifc identity attribute to use with an entity
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | DocumentPipelineStep/(resolvedAttributes)/documentpipelinestepId | attribute |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "systemrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msfsi_documentpipelinestepid" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "1" | integer |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
createdOn
Date and time when the record was created.
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value |
---|---|
displayName | Created On |
description | Date and time when the record was created. |
dataFormat | dateTime |
isNullable | true |
sourceName | createdon |
Traits
List of traits for the createdOn attribute are listed below.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "createdon" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "2" | integer |
is.dataFormat.time
is.dataFormat.date
modifiedOn
Date and time when the record was modified.
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value |
---|---|
displayName | Modified On |
description | Date and time when the record was modified. |
dataFormat | dateTime |
isNullable | true |
sourceName | modifiedon |
Traits
List of traits for the modifiedOn attribute are listed below.
is.dataFormat.date
means.measurement.date
is.dataFormat.time
means.measurement.time
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "modifiedon" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "4" | integer |
is.dataFormat.time
is.dataFormat.date
statecode
Status of the document pipeline step
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value | |||||||||
---|---|---|---|---|---|---|---|---|---|---|
displayName | Status | |||||||||
description | Status of the document pipeline step | |||||||||
dataFormat | int32 | |||||||||
sourceName | statecode | |||||||||
valueConstrainedToList | true | |||||||||
defaultValue |
|
Traits
List of traits for the statecode attribute are listed below.
is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.
is.dataFormat.numeric
does.haveDefault
An attribute has a default value
Parameter | Value | Data type | Explanation | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|
default |
| any |
is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities
means.entityState
the attribute represents the current state of the entity.
Parameter | Value | Data type | Explanation |
---|---|---|---|
attribute | DocumentPipelineStep/(resolvedAttributes)/statecode | attribute |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "systemrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "statecode" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "25" | integer |
is.dataFormat.integer
statuscode
Reason for the status of the document pipeline step
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
displayName | Status Reason | ||||||||||||
description | Reason for the status of the document pipeline step | ||||||||||||
dataFormat | int32 | ||||||||||||
isNullable | true | ||||||||||||
sourceName | statuscode | ||||||||||||
valueConstrainedToList | true | ||||||||||||
defaultValue |
|
Traits
List of traits for the statuscode attribute are listed below.
is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.
is.dataFormat.numeric
does.haveDefault
An attribute has a default value
Parameter | Value | Data type | Explanation | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
default |
| any |
is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities
is.correlatedWith
the attribute value is correlated with the sourceAttribute
Parameter | Value | Data type | Explanation |
---|---|---|---|
sourceAttribute | "statecode" | attributeName |
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "statuscode" | string |
is.nullable
The attribute value may be set to NULL.
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "27" | integer |
is.dataFormat.integer
importSequenceNumber
Sequence number of the import that created this record.
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value |
---|---|
displayName | Import Sequence Number |
description | Sequence number of the import that created this record. |
dataFormat | int32 |
maximumValue | 2147483647 |
minimumValue | -2147483648 |
isNullable | true |
sourceName | importsequencenumber |
Traits
List of traits for the importSequenceNumber attribute are listed below.
is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.
is.dataFormat.numeric
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
maximum length or value constraints
Parameter | Value | Data type | Explanation |
---|---|---|---|
minimumValue | "-2147483648" | decimal | |
maximumValue | "2147483647" | decimal |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "importsequencenumber" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "30" | integer |
is.dataFormat.integer
overriddenCreatedOn
Date and time that the record was migrated.
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value |
---|---|
displayName | Record Created On |
description | Date and time that the record was migrated. |
dataFormat | date |
isNullable | true |
sourceName | overriddencreatedon |
Traits
List of traits for the overriddenCreatedOn attribute are listed below.
is.dataFormat.date
means.measurement.date
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "overriddencreatedon" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "31" | integer |
is.dataFormat.date
timeZoneRuleVersionNumber
For internal use only.
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value |
---|---|
displayName | Time Zone Rule Version Number |
description | For internal use only. |
dataFormat | int32 |
maximumValue | 2147483647 |
minimumValue | -1 |
isNullable | true |
sourceName | timezoneruleversionnumber |
Traits
List of traits for the timeZoneRuleVersionNumber attribute are listed below.
is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.
is.dataFormat.numeric
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
maximum length or value constraints
Parameter | Value | Data type | Explanation |
---|---|---|---|
minimumValue | "-1" | decimal | |
maximumValue | "2147483647" | decimal |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "timezoneruleversionnumber" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "32" | integer |
is.dataFormat.integer
UTCConversionTimeZoneCode
Time zone code that was in use when the record was created.
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value |
---|---|
displayName | UTC Conversion Time Zone Code |
description | Time zone code that was in use when the record was created. |
dataFormat | int32 |
maximumValue | 2147483647 |
minimumValue | -1 |
isNullable | true |
sourceName | utcconversiontimezonecode |
Traits
List of traits for the UTCConversionTimeZoneCode attribute are listed below.
is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.
is.dataFormat.numeric
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
maximum length or value constraints
Parameter | Value | Data type | Explanation |
---|---|---|---|
minimumValue | "-1" | decimal | |
maximumValue | "2147483647" | decimal |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "utcconversiontimezonecode" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "33" | integer |
is.dataFormat.integer
name
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value |
---|---|
displayName | Name |
dataFormat | string |
maximumLength | 100 |
isNullable | true |
sourceName | msfsi_name |
Traits
List of traits for the name attribute are listed below.
is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "applicationrequired" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
maximum length or value constraints
Parameter | Value | Data type | Explanation |
---|---|---|---|
maximumLength | "100" | integer |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msfsi_name" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "34" | integer |
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
documentpipeline
Lookup to the pipeline workflow that the pipeline step is related to.
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value |
---|---|
displayName | Document pipeline |
description | Lookup to the pipeline workflow that the pipeline step is related to. |
dataFormat | guid |
Traits
List of traits for the documentpipeline attribute are listed below.
is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
is.dataFormat.guid
means.identity.entityId
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter | Value | Data type | Explanation |
---|---|---|---|
style | "single" | string |
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Parameter | Value | Data type | Explanation | |||||
---|---|---|---|---|---|---|---|---|
entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
output
The formatted output of the pipeline step.
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value |
---|---|
displayName | Output |
description | The formatted output of the pipeline step. |
dataFormat | string |
maximumLength | 1000000 |
isNullable | true |
sourceName | msfsi_output |
Traits
List of traits for the output attribute are listed below.
is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
maximum length or value constraints
Parameter | Value | Data type | Explanation |
---|---|---|---|
maximumLength | "1000000" | integer |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msfsi_output" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "36" | integer |
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
pipelinestepdefinition
Lookup to pipeline step definition table which provides the metadata of the pipeline step.
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value |
---|---|
displayName | Pipeline step definition |
description | Lookup to pipeline step definition table which provides the metadata of the pipeline step. |
dataFormat | guid |
Traits
List of traits for the pipelinestepdefinition attribute are listed below.
is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
is.dataFormat.guid
means.identity.entityId
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.CDS.lookup
The attribute represents a style of lookup in CDS for Applications
Parameter | Value | Data type | Explanation |
---|---|---|---|
style | "single" | string |
is.linkedEntity.identifier
Marks the attribute(s) that hold foreign key references to a linked (used as an attribute) entity. This attribute is added to the resolved entity to enumerate the referenced entities.
Parameter | Value | Data type | Explanation | |||||
---|---|---|---|---|---|---|---|---|
entityReferences |
| entity | a reference to the constant entity holding the list of entity references |
is.dataFormat.guid
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
pipelinestepdocumentstate
The status of the document determined by the current pipeline step
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
displayName | Pipeline step document state | ||||||||||||
description | The status of the document determined by the current pipeline step | ||||||||||||
dataFormat | int32 | ||||||||||||
isNullable | true | ||||||||||||
sourceName | msfsi_pipelinestepdocumentstate | ||||||||||||
valueConstrainedToList | true | ||||||||||||
defaultValue |
|
Traits
List of traits for the pipelinestepdocumentstate attribute are listed below.
is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.
is.dataFormat.numeric
does.haveDefault
An attribute has a default value
Parameter | Value | Data type | Explanation | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
default |
| any |
is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msfsi_pipelinestepdocumentstate" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "38" | integer |
is.dataFormat.integer
pipelinestepstate
The run status of the pipeline step, whether it is running, failed or succeeded.
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
displayName | Pipeline step state | ||||||||||||
description | The run status of the pipeline step, whether it is running, failed or succeeded. | ||||||||||||
dataFormat | int32 | ||||||||||||
isNullable | true | ||||||||||||
sourceName | msfsi_pipelinestepstate | ||||||||||||
valueConstrainedToList | true | ||||||||||||
defaultValue |
|
Traits
List of traits for the pipelinestepstate attribute are listed below.
is.dataFormat.integer
is.dataFormat.signed
indicates the capability to represent values less than zero.
is.dataFormat.numeric
does.haveDefault
An attribute has a default value
Parameter | Value | Data type | Explanation | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
default |
| any |
is.constrainedList
the values of an attribute are taken from or looked up from a fixed list of possibilities
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msfsi_pipelinestepstate" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "40" | integer |
is.dataFormat.integer
rawoutput
The actual output of the pipeline step logic (AI Model, Third Party, API, etc..)
First included in: DocumentIntelligenceDataModel/DocumentPipelineStep (this entity)
Properties
Name | Value |
---|---|
displayName | Raw output |
description | The actual output of the pipeline step logic (AI Model, Third Party, API, etc..) |
dataFormat | string |
maximumLength | 1000000 |
isNullable | true |
sourceName | msfsi_rawoutput |
Traits
List of traits for the rawoutput attribute are listed below.
is.dataFormat.character
is.dataFormat.big
indicates an atomic but multi-unit version of a fundamental type such as a multi byte encoded character, a double precision float, a long integer.
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object
is.requiredAtLevel
The requirement level for setting values into this attribute in CDS for Applications or for including this attribute in entities created in CDS for Analytics
Parameter | Value | Data type | Explanation |
---|---|---|---|
level | "none" | string | values can be: 'systemrequired', 'required', 'recommended', 'none' |
is.localized.describedAs
Holds the list of language specific descriptive text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.localized.displayedAs
Holds the list of language specific display text for an object.
Parameter | Value | Data type | Explanation | ||||
---|---|---|---|---|---|---|---|
localizedDisplayText |
| entity | a reference to the constant entity holding the list of localized text |
is.constrained
maximum length or value constraints
Parameter | Value | Data type | Explanation |
---|---|---|---|
maximumLength | "1000000" | integer |
is.nullable
The attribute value may be set to NULL.
is.CDS.sourceNamed
the unique name that identifies this object in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
name | "msfsi_rawoutput" | string |
is.CDS.ordered
the column number for an attribute with an entity in CDS for Applications.
Parameter | Value | Data type | Explanation |
---|---|---|---|
ordinal | "42" | integer |
is.dataFormat.character
is.dataFormat.array
indicates a contiguous sequence of fundamental units that shoud be taken as a whole and considered one value. Array of Character is a String, Array of Byte is a Binary Object