Communities
A collaborative platform to connect and grow with like-minded Informaticans across the globe
Product Communities
Connect and collaborate with Informatica experts and champions
Discussions
Have a question? Start a Discussion and get immediate answers you are looking for
User Groups
Customer-organized groups that meet online and in-person. Join today to network, share ideas, and get tips on how to get the most out of Informatica
Get Started
Community Guidelines
Knowledge Center
Troubleshooting documents, product guides, how to videos, best practices, and more
Knowledge Base
One-stop self-service portal for solutions, FAQs, Whitepapers, How Tos, Videos, and more
Support TV
Video channel for step-by-step instructions to use our products, best practices, troubleshooting tips, and much more
Documentation
Information library of the latest product documents
Velocity (Best Practices)
Best practices and use cases from the Implementation team
Learn
Rich resources to help you leverage full capabilities of our products
Trainings
Role-based training programs for the best ROI
Certifications
Get certified on Informatica products. Free, Foundation, or Professional
Product Learning Paths
Free and unlimited modules based on your expertise level and journey
Resources
Library of content to help you leverage the best of Informatica products
Tech Tuesdays Webinars
Most popular webinars on product architecture, best practices, and more
Product Availability Matrix
Product Availability Matrix statements of Informatica products
SupportFlash
Monthly support newsletter
Support Documents
Informatica Support Guide and Statements, Quick Start Guides, and Cloud Product Description Schedule
Product Lifecycle
End of Life statements of Informatica products
Ideas
Events
Change Request Tracking
Marketplace
English
  • Edge Data Streaming 2.5.0
  • All Products

Table of Contents

Search

  1. Preface
  2. Introduction to Edge Data Streaming Custom Entity Types
  3. Managing Custom Entity Types
  4. Custom Entities from Maven Archetypes
  5. REST APIs
  6. HTTP Request and Response Parameters
  7. Sample JSON Requests and Responses
  8. Glossary

Developer Guide

Developer Guide

Back Next

Format of the Edge Data Streaming Plug-in XML Document

Format of the Edge Data Streaming Plug-in XML Document

The EDS plug-in XML document consists of a set of XML elements that describe a custom entity type. The file is
vdsplugin.xml
.
The following XML document shows a EDS plug-in XML document with fields that you use: 
<tns:vdsPlugin>
	<tns:id>AllSrc</tns:id>
	<tns:displayName>All Source Types</tns:displayName>
	<tns:version>3.0</tns:version>
	<tns:type>SOURCE</tns:type>
	<tns:configuration>
		<tns:fields>
			<tns:field>
        		<tns:textControl>          
					<tns:name>txt</tns:name>
				 	<tns:displayName>Text Field</tns:displayName>
				 	<tns:description>Enter value for text field</tns:description>
				  	<tns:mandatory>true</tns:mandatory>
          			<tns:stringTextField>
          				<tns:pattern>^[A-Z]*$</tns:pattern>
          				<tns:maxLength>30</tns:maxLength>
          				<tns:secure>false</tns:secure>
            			<tns:default>ABCD</tns:default>
            			<tns:placeholder>A-Z</tns:placeholder>
          			</tns:stringTextField>
        		</tns:textControl>
        	</tns:field>
			<tns:field>
        		<tns:textControl>          
					<tns:name>pwd</tns:name>
				 	<tns:displayName>Password</tns:displayName>
				 	<tns:description>Enter value for password</tns:description>
				  	<tns:mandatory>true</tns:mandatory>
          			<tns:stringTextField>
          				<tns:maxLength>10</tns:maxLength>
          				<tns:secure>true</tns:secure>
          			</tns:stringTextField>
        		</tns:textControl>
        	</tns:field>
			<tns:field>
        		<tns:textControl>          
					<tns:name>int</tns:name>
				 	<tns:displayName>Int Field</tns:displayName>
				 	<tns:description>Enter value for int field</tns:description>
				  	<tns:mandatory>true</tns:mandatory>
          			<tns:integerTextField>
          				<tns:minValue>10</tns:minValue>
          				<tns:maxValue>90</tns:maxValue>
            			<tns:default>30</tns:default>
          			</tns:integerTextField>
        		</tns:textControl>
        	</tns:field>
			<tns:field>
        		<tns:textControl>          
					<tns:name>dou</tns:name>
				 	<tns:displayName>Double Field</tns:displayName>
				 	<tns:description>Enter value for double field</tns:description>
				  	<tns:mandatory>false</tns:mandatory>
          			<tns:doubleTextField>
          				<tns:minValue>11.11</tns:minValue>
          				<tns:maxValue>99.99</tns:maxValue>
            			<tns:default>33.33</tns:default>
          			</tns:doubleTextField>
        		</tns:textControl>
        	</tns:field>
			<tns:field>
        		<tns:radioGroupControl>          
					<tns:name>radio</tns:name>
				  	<tns:displayName>Mother Tongue</tns:displayName>
				  	<tns:description>Enter value for mother tongue</tns:description>
				  	<tns:items>
          				<tns:item>
	            			<tns:displayName>English</tns:displayName>
	           				<tns:id>1</tns:id>
          				</tns:item>
          				<tns:item>
          					<tns:displayName>Hindi</tns:displayName>
          					<tns:id>2</tns:id>
	            			<tns:textFields>
	            				<tns:textControl>
		              				<tns:name>txtScript</tns:name>
						      		<tns:displayName>Script</tns:displayName>
						      		<tns:mandatory/>
		              				<tns:stringTextField>
		                				<tns:secure/>
		              				</tns:stringTextField>
	              				</tns:textControl>
	            				<tns:textControl>
		              				<tns:name>txtUnicode</tns:name>
						      		<tns:displayName>Unicode</tns:displayName>
						      		<tns:mandatory/>
		              				<tns:stringTextField>
		                				<tns:secure/>
		              				</tns:stringTextField>
	              				</tns:textControl>
	            			</tns:textFields>
	            			<tns:subListBoxField>
	            				<tns:listControl>
		              				<tns:name>variant</tns:name>
						      		<tns:displayName>Variant</tns:displayName>
						      		<tns:items>
						      			<tns:item>
						      				<tns:displayName>Bihar</tns:displayName>
            								<tns:id>1</tns:id>
				          				</tns:item>
						      			<tns:item>
						      				<tns:displayName>Rajasthan</tns:displayName>
            								<tns:id>2</tns:id>
				          				</tns:item> 
				            			<tns:item>
				            				<tns:displayName>U.P.</tns:displayName>
				            				<tns:id>3</tns:id>
				            			</tns:item>
				            		</tns:items>
				            		<tns:default>2</tns:default>
	              				</tns:listControl>
	            			</tns:subListBoxField>
          				</tns:item>
          			</tns:items>
          			<tns:default>1</tns:default>
          		</tns:radioGroupControl>          		
			</tns:field>
			<tns:field>
				<tns:listControl>          
					<tns:name>list</tns:name>
				  	<tns:displayName>Qualifications</tns:displayName>
				  	<tns:description>Enter value for qualifications</tns:description>
          			<tns:items>
          				<tns:item>
            				<tns:displayName>Degree</tns:displayName>
            				<tns:id>1</tns:id>
          				</tns:item>          				
          				<tns:item>
            				<tns:displayName>Masters</tns:displayName>
            				<tns:id>2</tns:id>
            				<tns:textFields>
            					<tns:textControl>
	            					<tns:name>txtField1</tns:name>
	            					<tns:displayName>College</tns:displayName>
	            					<tns:mandatory>false</tns:mandatory>
	            					<tns:stringTextField>
		                				<tns:secure/>
		              				</tns:stringTextField>
            					</tns:textControl>
            				</tns:textFields>
	            			<tns:subListBoxField>
	            				<tns:listControl>
		              				<tns:name>division</tns:name>
						      		<tns:displayName>Division</tns:displayName>
						      		<tns:items>
						      			<tns:item>
						      				<tns:displayName>A1</tns:displayName>
            								<tns:id>1</tns:id>
				          				</tns:item>
						      			<tns:item>
						      				<tns:displayName>A2</tns:displayName>
            								<tns:id>2</tns:id>
				          				</tns:item> 
				            			<tns:item>
				            				<tns:displayName>A3</tns:displayName>
				            				<tns:id>3</tns:id>
				            			</tns:item>
				            		</tns:items>
				            		<tns:default>3</tns:default>
	              				</tns:listControl>
	            			</tns:subListBoxField>
            			</tns:item>
            			<tns:item>
            				<tns:displayName>Ph.D</tns:displayName>
            				<tns:id>3</tns:id>
            			</tns:item>
            		</tns:items>
          			<tns:default>3</tns:default>
          		</tns:listControl>
			</tns:field>
			<tns:field>
        		<tns:checkBoxControl>          
					<tns:name>chkBox</tns:name>
				  	<tns:displayName>Married</tns:displayName>
				  	<tns:description>Marital Status</tns:description>
          			<tns:default/>
          			<tns:checkedFields>
          				<tns:textControl>
            				<tns:name>txtFieldM1</tns:name>
				    		<tns:displayName>Spouse</tns:displayName>				    		
				    		<tns:mandatory/>
				    		<tns:stringTextField>
				    			<tns:secure/>
				    		</tns:stringTextField>
				   		</tns:textControl>            
          			</tns:checkedFields>          
          			<tns:uncheckedFields>          			
          				<tns:textControl>
            				<tns:name>txtFieldM2</tns:name>
				    		<tns:displayName>Mother</tns:displayName>				    		
				    		<tns:mandatory/>
				    		<tns:stringTextField>
				    			<tns:secure/>
				    		</tns:stringTextField>
				   		</tns:textControl>
          			</tns:uncheckedFields>
        		</tns:checkBoxControl>
			</tns:field>
			<tns:field>
        		<tns:textAreaControl>          
					<tns:name>txtArea</tns:name>
				  	<tns:displayName>Comments</tns:displayName>
				  	<tns:description>Your comments</tns:description>
				  	<tns:mandatory>true</tns:mandatory>
				  	<tns:maxLength>30</tns:maxLength>
				  	<tns:default></tns:default>
				  	<tns:placeholder>Place Src holder</tns:placeholder>
				</tns:textAreaControl>
			</tns:field>
		</tns:fields>
	</tns:configuration>
	<tns:pluginStatistics>	    
					<tns:statistic>	        
									<tns:id>1</tns:id>
	        <tns:displayName>Statistic1</tns:displayName>
	        <tns:type>CUMULATIVE</tns:type>
	    </tns:statistic>
	    <tns:statistic>
	        <tns:id>2</tns:id>
	        <tns:displayName>Statistic2</tns:displayName>
	        <tns:type>CUMULATIVE</tns:type>
	    </tns:statistic>
	</tns:pluginStatistics>
	<tns:runTime>
		<tns:pluginJar>AllSource.jar</tns:pluginJar>
		<tns:pluginClass>com.informatica.vds.plugin.custom.AllTypeSource</tns:pluginClass>
	</tns:runTime>
  <tns:helpKey></tns:helpKey>
</tns:vdsPlugin>
The XML document consists of the following XML elements:
vdsPlugin
Encloses all the XML elements that describe the custom entity type.
id
The EDS plug-in ID. The value must be unique across the plug-ins that you use in the EDS deployment. The value must not contain spaces and can have a maximum length of 32 characters.
displayName
A name for the entity. EDS displays the entity type with the specified name in the
Entity Types
 pane of the Administrator tool.
_vds_entity_name
 is a reserved word and must not be used as the name of any field.
For example, if you use the preceding XML document, EDS displays the entity type with the name
MyCustomSource
.
version
A string used to version the entity type.
For example, if you use the preceding XML document, EDS creates an entity type with the version number
1.0
.
type
The type of entity that you want EDS to create. The type can be
SOURCE
,
TARGET
, or
TRANSFORMATION
.
For example, if you use the preceding XML document, EDS creates a source service.
configuration
Describes the properties of the fields in the dialog box that a user uses to configure the entity in the Administrator tool. The
configuration
 element encloses the following element:
fields
Describes the fields in the dialog box. The
fields
 element encloses the following element:
field
Encloses the XML elements that describe the field. You can create multiple
field
 elements within the
fields
 element, each with its own set of properties.
The
field
 element encloses the following element:
textControl
Encloses the XML elements that describe the field type and properties.
The
textControl
 element encloses the following elements:
name
Specifies an internal name for the field. Use the internal name to reference the entity in your implementation of a EDS interface.
_VDS_ENTITY_NAME
 is a reserved word and must not be used as the name of any field.
displayName
Specifies the name with which the field must appear when a user adds the entity to a data flow.
For example, if the field accepts a directory path for the source file, use the name
directory
.
description
An internal description for the field.
mandatory
Makes the field required or optional. The setting
true
 indicates that the field is required. The setting
false
 indicates that the field is optional.
stringTextField
Specifies that the field is a string. The
stringTextField
 element encloses the following elements:
  • pattern
    . Specifies the pattern that text field can hold.
  • maxLength
    . Specifies the maximum length of the text field.
  • secure
    . Specifies that the field is secure.
    If you have installed EDS in secure mode, the field is securely communicated using encryption over UM or HTTPS, and then encrypted and stored in the database. If you have installed EDS in a normal mode, the value in the field appears masked in the Administrator tool, and is not encrypted.
  • default
    . Specifies the default value of the field
  • placeholder
    . Specifies the placeholder text that must appear when a user adds the entity to a data flow.
integerTextField
Specifies that the field is an integer. The
integerTextField
 element encloses the following elements:
  • minValue
    . Specifies the minimum value that the field can hold.
  • maxValue
    . Specifies the maximum value that the field can hold.
  • default
    . Specifies the default value of the field.
doubleTextField
Specifies that the field is a double text field. The
doubleTextField
 element encloses the following elements:
  • minValue
    . Specifies the minimum value that the field can hold.
  • maxValue
    . Specifies the maximum value that the field can hold.
  • default
    . Specifies the default value of the field.
radioGroupControl
Specifies that the field is an option button.
The
radioGroupControl
 element encloses the following elements:
name
Specifies the name of the option button.
displayName
Specifies the name with which the option button must appear when you add the entity to the data flow.
description
Specifies the description of the option button.
items
Specifies the options that are part of the option button. This element encloses the
item
 element. If you require to specify the conditional fields you can specify them within the
item
 element. Each
item
 element encloses the
textControl
 and the
listControl
 elements. You can add multiple
item
 elements.
default
Specifies the option that should be selected the default.
listControl
Specifies that the field is a drop-down list field.
The
listControl
 element encloses the following elements:
name
Specifies the name of the drop-down list field.
displayName
Specifies the name with which the drop-down list field must appear when you add the entity to the data flow.
description
Specifies the description of the drop-down list field.
items
Specifies the options that are part of the option button. This element encloses the
item
 element. If you require to specify the conditional fields you can specify them within the
item
 element. Each
item
 element encloses the
textControl
 and the
listControl
 elements. You can add multiple
item
 elements.
default
Specifies the option that should be selected the default.
checkBoxControl
Specifies that the field is a checkbox field.
The
checkBoxControl
 element encloses the following elements:
name
Specifies the name of the checkbox field.
displayName
Specifies the name with which the checkbox field must appear when you add the entity to the data flow.
description
Specifies the description of the checkbox field.
default
Specifies the field that is select by default.
checkedFields
Specifies the list of fields that are selected. If you require to specify the conditional fields you can specify them within the
checkedFields
 element. This element encloses the
textControl
 element.
uncheckedFields
Specifies the list of fields that are not selected. This element encloses the
textControl
 and the
listControl
 elements.
textAreaControl
Specifies that the field is a text area field.
The
textAreaControl
 element encloses the following elements:
name
Specifies the name of the text area.
displayName
Specifies the name with which the text area must appear when you add the entity to the data flow.
description
Specifies the description of the text area.
mandatory
The setting
true
 indicates that the field is required. The setting
false
 indicates that the field is optional.
maxLength
Specifies the maximum length of the text area.
default
Specifies the default value of the text area.
placeholder
Specifics the placeholder text that must appear when you add the text area to the data flow.
pluginStatistics
Encloses information about the statistics that you want to create. The
pluginStatistics
 element encloses the following element:
statistic
Encloses information that describe the statistics that you create. The
statistic
 encloses the following elements:
id
The statistic ID. The value must be unique across the plug-ins that you use in the EDS deployment. The value must not contain spaces and can have a maximum length of 32 characters.
displayName
Specifies the name with which the statistic must appear when a user adds it to the entity.
type
The type of statistic that you want EDS to create. The type can be CUMULATIVE.
runTime
Encloses information that EDS needs to run the entity at run time. The
runTime
 element encloses the following elements:
pluginJar
The name of the JAR file that contains the implementation of a EDS interface.
For example, if you use the preceding XML document, EDS creates the entity by using the plug-in
mySourcePlugin.jar
pluginClass
The fully qualified name of the class that implements a EDS interface. For example, if you name the class that implements a EDS interface
myClass
, and you add the class to the package
com.myOrg.myPackage
, enter
com.myOrg.myPackage.myClass
.
0 COMMENTS
We’d like to hear from you!