Invelos Forums: New Plugin: SideCar - Custom Fields Manager (Updated!)

Welcome to the Invelos forums. Please read the forum rules before posting.

Read access to our public forums is open to everyone. To post messages, a free registration is required.

If you have an Invelos account, sign in to post.

Invelos Forums->DVD Profiler: Plugins

Page: 1 2

Previous Next

New Plugin: SideCar - Custom Fields Manager (Updated!)

Author

Message

	mediadogg
	Aim high. Ride the wind.

Registered: March 18, 2007

Reputation: Highest Rating

Posts: 6,463

Posted:

SideCar V1.27 is Available - Supports 3.9.0 Custom Fields - Updated Announcement March 15, 2015

The purpose of SideCar is to provide additional data to HTML sections and to provide user customizable profile fields. It was initially offered in November of 2010 as a Beta concept.

SideCar has been updated in March 2015 to take advantage of new DVDP 3.9.0 database features that allow custom fields to be created and saved with a profile and optionally backed up locally and online. Invelos has also provided a way for plugins to make custom data fields available to HTML sections. See the SideCar User Guide for more detailed information.

The first (Beta) version of SideCar only provided additinal HTML section data, using an obsolete technique. This method has been retained for the initial upgraded version, but will later be removed. HTML sections depending on the older method of accessing, for example, Watched History, will eventually need to be recoded to use the new format for accessing that data in an HTML section.

The initail releas(es) of SideCar provide several customizable fields that can be individually optionally selected within a database. Whether the field is used in a database (fields can be deleted), whether it is displayed, and what caption is used on the Filter Panel and HTML Section Tags ("DP Vars"), are the only things that can be edited.. Future releases might also allow new fields to be created and edited.

The following field types are supported (all except Image can be used in a Filter):

- String
- Integer
- DateTime
- Boolean
- List - multi-line set of text items that can be searched within a filter
- String Dropdown
- Image

Defult Fields
Based on Invelos Forum suggestions and feature requests, SideCar has been created with a number of default fields that reflect those requirements. The captions for any default fields can be changed, filterable values customized, and the field itself can be either deleted from the database or hidden from view. If desired, the set of default fields and initial dropdown values can be restored in the Edit dialogue.

The set of default fields and initial dropdown values are as follows:

- Alternate EAN (String) - no checking is made for EAN format, so this is simply a text field
- Custom Audio Format: {"Auro-3D", "2.1 Mono", "1.0 Mono", "2.0 Dolby", "Dolby Atmos", "DTS:X", "Sensurround"}
- Custom Case Type: {"Bust","Wendecover"}
- Custom Display Mode: {"1080i", "1080p", "4K"}
- Custom Features: (List) - I've seen items like "Play All" requested. You can filter on the items.
- Custom Film Mode: {"Cinemascope", "Panavision", "Todd - AO"}
- Digital Copy Code: (String)
- Digital Copy Type: {"Disney", "Fox", "iTunes", "Lionsgate", "Paramount", "Sony Pictures", "universal", "Warner Bros.", "Ultraviolet"}
- DVD Owner: (String) - in case the collection contains entires for multiple family members
- Number Of Copies: (1) - in case you have more than one copy of a particular DVD
- Custom Video Codec: {"VC1", "AVC"}
- User Bool 1: (false)
- User Bool 2: (false)
- User Bool 3: (false)
- User Bool 4: (false)
- User Bool 5: (false)
- User Date 1:
- User Date 2:
- User Dropdown 1:
- User Dropdown 2:
- User Integer 1: (1)
- User Integer 2: (1)
- User Image 1: - small jpeg image
- User Image 2: - small jpeg image
- User List 1:
- User List 2:
- User String 1:
- User String 2:

In the DVDP Filter Tab, Boolean fields appear as checkboxes, strings and integers can be compared with appropriate operators, such as "Equal", and fields supporting Lists can be compaeed with a text string using "Contains".

In Edit mode, you can hide or delete a field, change the field caption, decide whether to include the field in backups and online, and edit the list of values for Dropdown fields. Only checkmarked fields will display in the Data Entry mode. Fields from other plugins can optionally be displayed for reference only, but they will be Locked and cannot be edited.

In Data Entry mode, you can populate fields with data specific to a DVD. This sample shows a subset of fields selected by removing the checkmark flags for fields to be hidden, while in Edit mode. Thus, during data entry, the screen is not cluttered with fields that are not being actively used. On the sample screen, you see a pop-up dialogue to capture items for a List feild. You can also see a sample image. The image can be selcted or changed by double-clicking on the image "value" cell, and a pop-up file select diaplog is presented. At this time, only jpeg images are supported. SideCar automatically resizes the image to the largest size that will fit into the Invelos restricted field size.A right-click context menu can be used on the image thumbnail that gives options to view the image in various formats, or to preview the image in a viewer.

HTML Section Sample Template

Quote:

<SCRIPT TYPE="text/javascript">

</SCRIPT>
<html>
<head>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; CHARSET=iso-8859-1">
<title><DP NAME="SORTTITLE"></title>
</head>
<body bgcolor="#b5CFF2">
<center>
Sidecar Custom Fields 
DVD Title: <DP NAME="TITLE"> 
<HR color="#e0e0e0">

<table border="0"><tr>
<td align="left">Alternate EAN: <DP NAME="Alternate_EAN"></td>
<td width="0"></td>
<td align="left">Custom Audio Format: <DP NAME="Custom_Audio_Format"></td></tr>
<td align="left">Custom Case Type: <DP NAME="Custom_Case_Type"></td>
<td width="0"></td>
<td align="left">Custom Display Mode: <DP NAME="Custom_Display_Mode"></td></tr>
<td align="left">Custom Features: <DP NAME="Custom_Features"></td>
<td width="0"></td>
<td align="left">Custom Film Mode: <DP NAME="Custom_Film_Mode"></td></tr>
<td align="left">Digital Copy Code: <DP NAME="Digital_Copy_Code"></td>
<td width="0"></td>
<td align="left">Digital Copy Type: <DP NAME="Digital_Copy_Type"></td></tr>
<td align="left">DVD Owner: <DP NAME="DVD_Owner"></td>
<td width="0"></td>
<td align="left">Number Of Copies: <DP NAME="Number_of_Copies"></td></tr>
<td align="left">Custom Video Codec: <DP NAME="Custom_Video_Codec"></td>
<td width="0"></td>
<td align="left">User Bool 1: <DP NAME="User_Bool_1"></td></tr>
<td align="left">User Bool 2: <DP NAME="User_Bool_2"></td>
<td width="0"></td>
<td align="left">User Bool 3: <DP NAME="User_Bool_3"></td></tr>
<td align="left">User Bool 4: <DP NAME="User_Bool_4"></td>
<td width="0"></td>
<td align="left">User Bool 5: <DP NAME="User_Bool_5"></td></tr>
<td align="left">User Date 1: <DP NAME="User_Date_1"></td>
<td width="0"></td>
<td align="left">User Date 2: <DP NAME="User_Date_2"></td></tr>
<td align="left">User Dropdown 1: <DP NAME="User_Dropdown_1"></td>
<td width="0"></td>
<td align="left">User Dropdown 2: <DP NAME="User_Dropdown_2"></td></tr>
<td align="left">User Integer 1: <DP NAME="User_Integer_1"></td>
<td width="0"></td>
<td align="left">User Integer 2: <DP NAME="User_Integer_2"></td></tr>
<td align="left">User List 1: <DP NAME="User_List_1"></td>
<td width="0"></td>
<td align="left">User List 2: <DP NAME="User_List_2"></td></tr>
<td align="left">User String 1: <DP NAME="User_String_1"></td>
<td width="0"></td>
<td align="left">User String 2: <DP NAME="User_String_2"></td></tr>
User Image 1: <DP NAME="User_Image_1" Width="120" Height="120">
User Image 2: <DP NAME="User_Image_2" Width="120" Height="120" >
 
</table>
</body>
</html>

Thanks for your support.
Free Plugins available here.
Advanced plugins available here.
Hey, new product!!! BDPFrog.

Last edited: by mediadogg

	mediadogg
	Aim high. Ride the wind.

Registered: March 18, 2007

Reputation: Highest Rating

Posts: 6,463

Posted:

Original Announcement SideCar Plugin Available - November 7, 2010

This plugin is a Beta concept. It has been designed to have two functions:

(1) Maintain a set of user defined fields associated with a profile that can someday be transferred to the main database when supported. A transfer script will be provided, or could be written by any plugin developer.
(2) Maintain a set of pseudo "DP_VARS" that are available to the HTML sections until the same or similar varaibles become available in the main product.

Function (1) is incomplete and not present in the first Beta release. I am soliciting feedback on the direction of this plugin: pro / con. This idea and the skeleton code has been on the shelf for at least a year. I remember seeing something about custom data, synchronized to profiles, in the Collection Viewer - that's why I stopped short of completing Function (1) - Custom fields. But I could be persuaded to complete the project.

Any feedback, opinions or suggestion are welcome - including "throw da bum out!".

In order to use the SideCar HTML Section variables, simple Javascripting is required. The following sample script is provided as part of the plugin:

<HTML>
<HEAD>
<SCRIPT TYPE="text/javascript">

var AuxDP = new ActiveXObject("SideCar.DVDData");
var watched_history = eval( AuxDP.watchedhistory);
var boxset_contents = eval (AuxDP.boxsetcontents);
document.write("" + AuxDP.parentprofile+ "");
document.write("" + AuxDP.retailertype+ "");
document.write("" + AuxDP.retailerwebsite+ "");
document.write("" + AuxDP.boxsetcontents+ ""); // <-- shows what is passed to eval
document.write("" + AuxDP.watchedhistory+ ""); // <-- shows what is passed to eval
document.write("" + watched_history+ ""); // <-- the actual array
document.write("" + boxset_contents+ "");
</SCRIPT>
</HEAD>
<BODY>
</BODY>
</HTML>

What this coding does is to make the following profile data available to an HTML section:

- Parent profile ID
- Retailer type (Local / Online)
- Retailer Web Site
- Box Set Contents array
- Watched History array

Based on the sample code, the way to get the first entry in the watched array would be: watched_history[0]

Is is very easy to add just about anything else from the profile, provided that the information is availabele to plugins.

Each line of the watched history consists of a string using "|" as a delimter, representing a watched event, e.g. "date|firstname|lastname|notes".

This string can be parsed using the string "split" operator to yield an array of the individual components.

Thanks for your support.
Free Plugins available here.
Advanced plugins available here.
Hey, new product!!! BDPFrog.

Last edited: by mediadogg

	TraunStaa

Registered: June 2, 2009

Reputation: Highest Rating

Posts: 306

Posted:

I get two identical errors ('illegal parameter' - one while loading the Profiler, the second when loading is finished).

Last edited: by TraunStaa

	mediadogg
	Aim high. Ride the wind.

Registered: March 18, 2007

Reputation: Highest Rating

Posts: 6,463

Posted:

Quoting TraunStaa:

Quote:
I get two identical errors ('illegal parameter' - one while loading the Profiler, the second when loading is finished).

Oh nooo ... guess I'm glad I called it Beta. Let's see if somebody else gets it. I'll try to think of some way to debug ...

By the way, does the plugin function at all, after loading is complete?

Edit: Oh I see where I left some test code in that is looking for some images. I'll take that code out and re-publish. Unfortuantely, the error will probably occur each time you select a new profile.

Edit: Ok, I made the fix and put up V0.3. Fingers crossed ...

Thanks for your support.
Free Plugins available here.
Advanced plugins available here.
Hey, new product!!! BDPFrog.

Last edited: by mediadogg

	TraunStaa

Registered: June 2, 2009

Reputation: Highest Rating

Posts: 306

Posted:

0.3 loading without any errors and showing up under "View Plugins". So how do I get from there?

	mediadogg
	Aim high. Ride the wind.

Registered: March 18, 2007

Reputation: Highest Rating

Posts: 6,463

Posted:

Quoting TraunStaa:

Quote:
0.3 loading without any errors and showing up under "View Plugins". So how do I get from there?

(1) Copy the sample code posted above.
(2) Create a new HTML section and paste the code and save it under whatever name
(3) Preview to verify
(4) Save

Now you can View and dock the HTML window and watch the results change as you click on profiles
Of course, making use of those varaibles in your own Javascript is totally up to you.

I really appreciate you helping me find that initial bug.

(In case you are looking for the custom field option, as I stated above, that code is not yet finished. I was waiting to get confirmation that such a function was still needed, given that we already have Cinematic Collection Viewer).

Thanks for your support.
Free Plugins available here.
Advanced plugins available here.
Hey, new product!!! BDPFrog.

Last edited: by mediadogg

	TraunStaa

Registered: June 2, 2009

Reputation: Highest Rating

Posts: 306

Posted:

Was just doing that and made a new section besidst my Trivia HTML. The SideCar window reads

Online

undefined

undefined

	TraunStaa

Registered: June 2, 2009

Reputation: Highest Rating

Posts: 306

Posted:

On the root entry of Alien Anthology it reads for example

Online

new Array("I01097679DDE16AFE.5","I12607E2B26073C06.5","I2752E617592BFE50.5","I2D617DB2D5474DAB.5","I392E623CC57263C6.5","I3AA89B582966B087.5","I6FC42E5D5E7D1B44.5","IE83814C12716493B.5")

undefined

I01097679DDE16AFE.5,I12607E2B26073C06.5,I2752E617592BFE50.5,I2D617DB2D5474DAB.5,I392E623CC57263C6.5,I3AA89B582966B087.5,I6FC42E5D5E7D1B44.5,IE83814C12716493B.5

Last edited: by TraunStaa

	mediadogg
	Aim high. Ride the wind.

Registered: March 18, 2007

Reputation: Highest Rating

Posts: 6,463

Posted:

Looks all good. I assume you know what to do now, otherwise you wouldn't be using it ...

Not sure what you are up to, but the results are as expected. The "undefined" values are due to thiose arrays being empty in the profile. The data will vary from profile to profile - of course that's the point.

Thanks for your support.
Free Plugins available here.
Advanced plugins available here.
Hey, new product!!! BDPFrog.

Last edited: by mediadogg

	TraunStaa

Registered: June 2, 2009

Reputation: Highest Rating

Posts: 306

Posted:

mediadogg,

I took the SampleSection.html code first, now I copied the HTML from your first posting. Now the window stays clear. As I first had the retailer like "www.amazon.com" in the second row, now there is nothing shown.

	mediadogg
	Aim high. Ride the wind.

Registered: March 18, 2007

Reputation: Highest Rating

Posts: 6,463

Posted:

Quoting TraunStaa:

Quote:
mediadogg,

I took the SampleSection.html code first, now I copied the HTML from your first posting. Now the window stays clear. As I first had the retailer like "www.amazon.com" in the second row, now there is nothing shown.

I still don't know what you are trying to do. My sample code is basically useless, except as an example. It is just to verify installation. I'm not sure what you are expecting to happen.

The code I posted above has some last minute comments I put in that are causing it not to run. I'll fix that later. But when I do, you will get exactly the same results as before.

Thanks for your support.
Free Plugins available here.
Advanced plugins available here.
Hey, new product!!! BDPFrog.

Last edited: by mediadogg

	TraunStaa

Registered: June 2, 2009

Reputation: Highest Rating

Posts: 306

Posted:

Installation verified as OK and plugin is working. Just playing around with the settings

so nothing to worry about

	mediadogg
	Aim high. Ride the wind.

Registered: March 18, 2007

Reputation: Highest Rating

Posts: 6,463

Posted:

Quoting TraunStaa:

Quote:
Installation verified as OK and plugin is working. Just playing around with the settings so nothing to worry about

Ok, great. I added the missing comment separators to the posted code.

When you get an interesting HTML section, maybe you can share it here or in the Layouts Forum. And if you find any other data needed that is not already in the HEADER_VARS, let me know.

Thanks again for your responsive help in verifying operation.

Thanks for your support.
Free Plugins available here.
Advanced plugins available here.
Hey, new product!!! BDPFrog.

Last edited: by mediadogg

	TraunStaa

Registered: June 2, 2009

Reputation: Highest Rating

Posts: 306

Posted:

OK, will do.

	mediadogg
	Aim high. Ride the wind.

Registered: March 18, 2007

Reputation: Highest Rating

Posts: 6,463

Posted:

Anybody using this plugin, please note that Box Set Contents array is now available in DVDP 3.8.0 Build 1509.

I hope that more will be picked up in 3.8.1.

Thanks for your support.
Free Plugins available here.
Advanced plugins available here.
Hey, new product!!! BDPFrog.

Last edited: by mediadogg

	mediadogg
	Aim high. Ride the wind.

Registered: March 18, 2007

Reputation: Highest Rating

Posts: 6,463

Posted:

SideCar V1.27 is Available - Supports 3.9.0 Custom Fields

The purpose of SideCar is to provide additional data to HTML sections and to provide user customizable profile fields. It was initially offered in November of 2010 as a Beta concept.

SideCar has been updated in March 2015 to take advantage of new DVDP 3.9.0 database features that allow custom fields to be created and saved with a profile and optionally backed up locally and online. Invelos has also provided a way for plugins to make custom data fields available to HTML sections. See the SideCar User Guide for more detailed information.

This post has been truncated and the remainder of it moved to replace the original Beta announcement at the beginning of this thread.

Thanks for your support.
Free Plugins available here.
Advanced plugins available here.
Hey, new product!!! BDPFrog.

Last edited: by mediadogg

Invelos Forums->DVD Profiler: Plugins

Page: 1 2

Previous Next