The Dayplan Hourline View XML Export functionality is intended to create a set of files in XML format containing the Booking and Resource information for a range of date from the User’s Hourline Views.
Requirements
- User must have access to Server Setup access
- Saved Views must be available in the Hourline
- Enable the feature and choose XML Repository in Server Setup > General
Setting definition
“Update Time”, “Show Days Before” and “Show Days After”
Define those settings in the Toolbox > Settings > Server Setup > Web Share Settings.
“Update Time” defines how often or on what time of the day the export will happen.
“Show Days Before” and “Show Days After” defines the days before and after that will be included in the export results.
Select views to export
By clicking the "Hourline Views To Day-plan XML Exports Setup" select the User's Hourline views that should be included in the export.
“Static Time Frames“ defines the date range in which the export is viewable, any dates outside those ranges will not be exported. (Optional)
By clicking “OK” the selected Time Frame will be set. When clicking Cancel the system will prompt for Time Frame removal.
Export XML
An Export can be done automatically by setting “Update Time” or manually by clicking “Update Now” (files will be stored in [Server Folder]\files\xml_exports\[view name]\)
Results: Export XML files by clicking “Update Now” [Server Folder]\files\xml_exports\[view name]\
XML Structure
ViewGroups
ViewGroup: A logical grouping for objects as how they are presented in Hourline View
viewGroupID: Id of the View Group
name: Name of the View Group
ViewGroupMemberIDS
objectID: Id of object that has been included in the View Group
Objects
Object: Details of an object
type: Object
displayName: Object name
objectType: Object Type: user1, user1, user3, machine, resource, room, other,
objectID: Unique Id for the object
ObjectClasses
ObjectClass
objectClassID: Unique id for the object class
name: Name of the object class
ObjectClassMemberIDS
objectID: ID of the object, refers to an Object defined in the Objects branch
DayPlans
DayPlan
day: Date for the plan
DayPlanNodes
DayPlanNode
nodeType: could be project, booking, binder, mediaorder…
nodeID: unique Id for the node
nodeName: node name
position: position of the node in DayPlan
DayPlanNode: Child node (only if parent nodeType is binder)
[There can be up to two DayPlanNode, also with the same tag structure]
Event
day: date of the event
type: event type: project, mediaorder, task, personnel, maintenance
eventID: Node Id
mainHeader: Event name
subHeader: Event subname
isPreliminary: 0/1
isAlldayEvent: 0/1
note
timeIn: Event starting time (23.25, 23.50, 23.75, 0.00)
timeOut: Event ending time
timeInAsString: Event starting time (23.15, 23.30, 23.45, 0.00)
timeOutAsString: Event ending time
bookingLineID: Id that links events from DayPlanNodes
isReadonly: 0/1
involvedHeader: name of other objects involved in that event
bookingName: Booking title
bookingPosition: Class Bookings Order in system
objectPosition: Position of object within event
objectClassID: Id of the object class assigned to the booking
objectClassName: Name of the Object Class
objectActivityName: Object Activity Name
objectName: Object Name
objectType: user1, user1, user3, machine, resource, room, other…
objectID: Unique Id for the object
projectID: Id of the project the event lays on
projectName: Name of the project the event lays on
projectBinderID: Id of binder
projectBinderName: Binder name
projectBinderNameIncludingParentName: Parent’s binder name
projectBinderPosition: ordering key
projectBinderParentBinderID: Id of the parent’s binder
projectBinderParentBinderName: Name of the parent’s binder
projectBinderParentBinderPosition: Position of the parent’s binder
projectBinderFrameworkID: Id of the framework booking
projectBinderFrameworkName: Name of the framework booking
projectBinderFrameworkPosition: Position of the framework booking
CustomField: Booking custom fields
type: entry, text, selector, date, checkbox, files, thumbnail, images
label: custom field name
value: value set for the custom field; Only received if user set a value for this field
optionValue: only selectors; all possible values
canLinkToContact: only entry/texts types; if field is a finder. Value format: 0 or 1
mediaorderID: Id of the media order the event belongs to
mediaorderName: Name of the media order the event belongs to
projectContainerName: Name of container the project is assigned to
position: Event’s position
Please note: The string separator is • (mainHeader, subHeader…).
Resulting XML to Screen Sample attached.