Technical reference manual

Option 4: use a client specific program feed

You will have to set up what we'll call a closed environment, a closed directory (these steps are required in both options 3 and 4), and adapt the program files you wish to send to specific clients. The fourth section covers some common pitfalls and how to avoid them.

• 1: Create a closed environment
• 2: Create a closed directory
• 3: Configure the closed program feed
• 4: Tips, tricks and pitfalls

If anything on this page needs further clarification, don't hesitate to use the Feedback button at the top. We take your comments seriously and will respond within 24 hours.

How to set up a closed environment

A closed environment is a collection of directory, program and optionally clientDiscount files that, when read by the EDU-DEX server, will only be delivered to specifically targeted clients. In order to hide these files from public view, they are accessed with a GET parameter called key.

The key value will be assigned by EDU-DEX upon registration of a supplier's closed environment. Like the registration of a public environment, the process is an informal one: an email message to info@edudex.nl, stating the location of your directory feed, is sufficient.

From now on, the EDU-DEX servers will visit the registered URL adding the key as a GET parameter. This protocol has several implications:

• Since the key is passed as plain text, it is necessary to use SSL (https) for this communication to avoid sniffing.
• Per learning provider only one closed environment is in use, servicing all targeted clients.
• All links published here will be visited by EDU-DEX appending the key as GET parameter, so they too should use SSL (https).
• It is the publisher's responsibility to make sure that key parameters are checked whenever a closed feed is accessed.

If anything on this page needs further clarification, don't hesitate to use the Feedback button at the top. We take your comments seriously and will respond within 24 hours.

Create a closed directory

Suppose (as in all examples in this section) a learning provider with an orgUnitId of pres wishes to target three clients: first, second and third.

Both options (using a clientDiscount document, and publishing client specific programs) share the fact that only one closed directory is offered. This approach could lead to unexpected results: please refer to step 4 for more information.

The main difference between the two options is that here the directory feed does not refer to clientDiscount documents, but instead adds a clientId to each programResource to be exported.

EDU-DEX will offer to each client a feed containing the orgUnitId's public offering, adding the programs mentioned in this closed directory.

Attention: in order to keep displayed code readable, even on small screens, some lengthy attributes have been replaced with an ellipsis (...); the full code is avaiable using the Download Code button.

	
<?xml version="1.0" encoding="utf-8"?>
<edudexDirectory ... >
	<editor>info@presendata.nl</editor>
	<generator>PresenData XML generator 1.4</generator>
	<version>0.90429</version>
	<orgUnitId>pres</orgUnitId>
	<programResource>
		<clientId>first</clientId>
		<programId>PRD-160F</programId>
		<resourceUrl>https://www.presendata.nl/api/closed/PRD-160F</resourceUrl>
	</programResource>
	<programResource>
		<clientId>second</clientId>
		<programId>PRD-160S</programId>
		<resourceUrl>https://www.presendata.nl/api/closed/PRD-160S</resourceUrl>
	</programResource>
	<programResource>
		<clientId>third</clientId>
		<programId>PRD-320T</programId>
		<resourceUrl>https://www.presendata.nl/api/closed/PRD-320T</resourceUrl>
	</programResource>
	<programResource>
		<clientId>third</clientId>
		<programId>PRD-330T</programId>
		<resourceUrl>https://www.presendata.nl/api/closed/PRD-330T</resourceUrl>
	</programResource>
</edudexDirectory>


	

If anything on this page needs further clarification, don't hesitate to use the Feedback button at the top. We take your comments seriously and will respond within 24 hours.

Adapt the program feeds

Suppose (as in all examples in this section) a learning provider with an orgUnitId of pres wishes to target three clients: first, second and third.

A client-specific program is identified by the presence of a clientId element. Its clientOffer attribute indicates whether the current program is discounted, an in-company offering, or customised according this specific client's specifications.

The following code displays program PRD-160S, let's assume an in-company version of PRD-160, to be delivered to client second.

Attention: in order to keep displayed code readable, even on small screens, some lengthy attributes have been replaced with an ellipsis (...); the full code is avaiable using the Download Code button.

	
<?xml version="1.0" encoding="utf-8"?>
<program ... >
	<clientId @clientOffer="incompany program">theclient</clientId>
	<editor>info@presendata.nl</editor>
	<expires xsi:nil="true" />
	<format>1.5</format>
	<generator>PresenData XML generator 1.4</generator>
	<inPublication>true</inPublication>
	<lastEdited>2018-12-21T21:37:25</lastEdited>
	<programAdmission>
		<applicationOpen>true</applicationOpen>
		<applicationType>individual</applicationType>
		<paymentDue>up-front</paymentDue>
		<startDateDetermination>direct start</startDateDetermination>
	</programAdmission>
	<programClassification>
		<degree>certificate</degree>
		<orgUnitId>pres</orgUnitId>
		<programDuration unit="day">5</programDuration>
		<programForm>full-time</programForm>
		<programId>PRD-160S</programId>
		<programLevel>mbo+</programLevel>
		<programLocation>Varsseveld</programLocation>
		<programType>training</programType>
		<startingYear>2019</startingYear>
	</programClassification>
	<programContacts>
		<contactData>
			<contactName>Training and Software Development</contactName>
			<email>training@presendata.nl</email>
			<role>Software Development and Training</role>
		</contactData>
	</programContacts>
	<programCurriculum>
		<instructionMode>seminar</instructionMode>
	</programCurriculum>
	<programDescriptions>
		<programName xml:lang="nl">Web Development using the Zend Expressive Framework</programName>
		<programSummaryText xml:lang="nl">A no-nonsense introduction to Zend Expressive</programSummaryText>
		<programDescriptionText xml:lang="nl">Covers installation, requirements, structure and specialisation. In this version special attention will be given to problems experienced by the client.</programDescriptionText>
	</programDescriptions>
	<programSchedule>
		<genericProgramRun>
			<contactHoursPartOfDay>day</contactHoursPartOfDay>
			<cost>
				<amount>50</amount>
				<amountVAT>3</amountVAT>
				<amountIsFinal>true</amountIsFinal>
				<costType>study material</costType>
				<currency>eur</currency>
				<isRequiredCost>true</isRequiredCost>
				<VATExemptAmount>50</VATExemptAmount>
				<VATExemptAmountVAT>3</VATExemptAmountVAT>
			</cost>
			<cost>
				<amount>956.25</amount>
				<amountVAT>200.81</amountVAT>
				<amountIsFinal>true</amountIsFinal>
				<costType>tuition fee</costType>
				<currency>eur</currency>
				<isRequiredCost>true</isRequiredCost>
				<VATExemptAmount>1051.88</VATExemptAmount>
				<VATExemptAmountVAT>0</VATExemptAmountVAT>
			</cost>
			<courseDay>
				<id>PRD-160MO</id>
				<dayOfTheWeek>Monday</dayOfTheWeek>
				<startTime>09:30:00</startTime>
				<endTime>16:30:00</endTime>
			</courseDay>
			<courseDay>
				<id>PRD-160TU</id>
				<dayOfTheWeek>Tuesday</dayOfTheWeek>
				<startTime>09:30:00</startTime>
				<endTime>16:30:00</endTime>
			</courseDay>
			<courseDay>
				<id>PRD-160WE</id>
				<dayOfTheWeek>Wednesday</dayOfTheWeek>
				<startTime>09:30:00</startTime>
				<endTime>16:30:00</endTime>
			</courseDay>
			<numberOfContactSessions>4</numberOfContactSessions>
		</genericProgramRun>
	</programSchedule>
</program>	

Programs containing a clientId will never appear in a public feed. Therefore, they are completely independent and allow the learning provider to tailor them to meet the specific needs of a client in many respects, not only regarding price discounts (as in option 3).

If anything on this page needs further clarification, don't hesitate to use the Feedback button at the top. We take your comments seriously and will respond within 24 hours.

Tips, tricks and pitfalls

The most common pitfall, when conveying client specific information, occurs when the two possible options are combined in the one and only directory feed. Nothing opposes combining them, but please take into account that every programResource following the clientDiscountResources will override discounts defined earlier!

By and by, more tips will be added to this section - keep visiting this page!

If anything on this page needs further clarification, don't hesitate to use the Feedback button at the top. We take your comments seriously and will respond within 24 hours.