This repository has been archived by the owner on Aug 8, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 7
/
shotgun_help.html
1524 lines (1461 loc) · 49.4 KB
/
shotgun_help.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
<meta name="generator" content="AsciiDoc 8.5.3" />
<title>RV/Shotgun Integration (v1.30)</title>
<style type="text/css">
/* Debug borders */
p, li, dt, dd, div, pre, h1, h2, h3, h4, h5, h6 {
/*
border: 1px solid red;
*/
}
body {
margin: 1em 5% 1em 5%;
}
a {
color: blue;
text-decoration: underline;
}
a:visited {
color: fuchsia;
}
em {
font-style: italic;
color: navy;
}
strong {
font-weight: bold;
color: #083194;
}
tt {
color: navy;
}
h1, h2, h3, h4, h5, h6 {
color: #527bbd;
font-family: sans-serif;
margin-top: 1.2em;
margin-bottom: 0.5em;
line-height: 1.3;
}
h1, h2, h3 {
border-bottom: 2px solid silver;
}
h2 {
padding-top: 0.5em;
}
h3 {
float: left;
}
h3 + * {
clear: left;
}
div.sectionbody {
font-family: serif;
margin-left: 0;
}
hr {
border: 1px solid silver;
}
p {
margin-top: 0.5em;
margin-bottom: 0.5em;
}
ul, ol, li > p {
margin-top: 0;
}
pre {
padding: 0;
margin: 0;
}
span#author {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
font-size: 1.1em;
}
span#email {
}
span#revnumber, span#revdate, span#revremark {
font-family: sans-serif;
}
div#footer {
font-family: sans-serif;
font-size: small;
border-top: 2px solid silver;
padding-top: 0.5em;
margin-top: 4.0em;
}
div#footer-text {
float: left;
padding-bottom: 0.5em;
}
div#footer-badges {
float: right;
padding-bottom: 0.5em;
}
div#preamble {
margin-top: 1.5em;
margin-bottom: 1.5em;
}
div.tableblock, div.imageblock, div.exampleblock, div.verseblock,
div.quoteblock, div.literalblock, div.listingblock, div.sidebarblock,
div.admonitionblock {
margin-top: 1.0em;
margin-bottom: 1.5em;
}
div.admonitionblock {
margin-top: 2.0em;
margin-bottom: 2.0em;
margin-right: 10%;
color: #606060;
}
div.content { /* Block element content. */
padding: 0;
}
/* Block element titles. */
div.title, caption.title {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
text-align: left;
margin-top: 1.0em;
margin-bottom: 0.5em;
}
div.title + * {
margin-top: 0;
}
td div.title:first-child {
margin-top: 0.0em;
}
div.content div.title:first-child {
margin-top: 0.0em;
}
div.content + div.title {
margin-top: 0.0em;
}
div.sidebarblock > div.content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.listingblock > div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock, div.verseblock {
padding-left: 1.0em;
margin-left: 1.0em;
margin-right: 10%;
border-left: 5px solid #dddddd;
color: #777777;
}
div.quoteblock > div.attribution {
padding-top: 0.5em;
text-align: right;
}
div.verseblock > pre.content {
font-family: inherit;
}
div.verseblock > div.attribution {
padding-top: 0.75em;
text-align: left;
}
/* DEPRECATED: Pre version 8.2.7 verse style literal block. */
div.verseblock + div.attribution {
text-align: left;
}
div.admonitionblock .icon {
vertical-align: top;
font-size: 1.1em;
font-weight: bold;
text-decoration: underline;
color: #527bbd;
padding-right: 0.5em;
}
div.admonitionblock td.content {
padding-left: 0.5em;
border-left: 3px solid #dddddd;
}
div.exampleblock > div.content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
div.imageblock div.content { padding-left: 0; }
span.image img { border-style: none; }
a.image:visited { color: white; }
dl {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
dt {
margin-top: 0.5em;
margin-bottom: 0;
font-style: normal;
color: navy;
}
dd > *:first-child {
margin-top: 0.1em;
}
ul, ol {
list-style-position: outside;
}
ol.arabic {
list-style-type: decimal;
}
ol.loweralpha {
list-style-type: lower-alpha;
}
ol.upperalpha {
list-style-type: upper-alpha;
}
ol.lowerroman {
list-style-type: lower-roman;
}
ol.upperroman {
list-style-type: upper-roman;
}
div.compact ul, div.compact ol,
div.compact p, div.compact p,
div.compact div, div.compact div {
margin-top: 0.1em;
margin-bottom: 0.1em;
}
div.tableblock > table {
border: 3px solid #527bbd;
}
thead, p.table.header {
font-family: sans-serif;
font-weight: bold;
}
tfoot {
font-weight: bold;
}
td > div.verse {
white-space: pre;
}
p.table {
margin-top: 0;
}
/* Because the table frame attribute is overriden by CSS in most browsers. */
div.tableblock > table[frame="void"] {
border-style: none;
}
div.tableblock > table[frame="hsides"] {
border-left-style: none;
border-right-style: none;
}
div.tableblock > table[frame="vsides"] {
border-top-style: none;
border-bottom-style: none;
}
div.hdlist {
margin-top: 0.8em;
margin-bottom: 0.8em;
}
div.hdlist tr {
padding-bottom: 15px;
}
dt.hdlist1.strong, td.hdlist1.strong {
font-weight: bold;
}
td.hdlist1 {
vertical-align: top;
font-style: normal;
padding-right: 0.8em;
color: navy;
}
td.hdlist2 {
vertical-align: top;
}
div.hdlist.compact tr {
margin: 0;
padding-bottom: 0;
}
.comment {
background: yellow;
}
.footnote, .footnoteref {
font-size: 0.8em;
}
span.footnote, span.footnoteref {
vertical-align: super;
}
#footnotes {
margin: 20px 0 20px 0;
padding: 7px 0 0 0;
}
#footnotes div.footnote {
margin: 0 0 5px 0;
}
#footnotes hr {
border: none;
border-top: 1px solid silver;
height: 1px;
text-align: left;
margin-left: 0;
width: 20%;
min-width: 100px;
}
@media print {
div#footer-badges { display: none; }
}
div#toc {
margin-bottom: 2.5em;
}
div#toctitle {
color: #527bbd;
font-family: sans-serif;
font-size: 1.1em;
font-weight: bold;
margin-top: 1.0em;
margin-bottom: 0.1em;
}
div.toclevel1, div.toclevel2, div.toclevel3, div.toclevel4 {
margin-top: 0;
margin-bottom: 0;
}
div.toclevel2 {
margin-left: 2em;
font-size: 0.9em;
}
div.toclevel3 {
margin-left: 4em;
font-size: 0.9em;
}
div.toclevel4 {
margin-left: 6em;
font-size: 0.9em;
}
/* Workarounds for IE6's broken and incomplete CSS2. */
div.sidebar-content {
background: #ffffee;
border: 1px solid silver;
padding: 0.5em;
}
div.sidebar-title, div.image-title {
color: #527bbd;
font-family: sans-serif;
font-weight: bold;
margin-top: 0.0em;
margin-bottom: 0.5em;
}
div.listingblock div.content {
border: 1px solid silver;
background: #f4f4f4;
padding: 0.5em;
}
div.quoteblock-attribution {
padding-top: 0.5em;
text-align: right;
}
pre.verseblock-content {
font-family: inherit;
}
div.verseblock-attribution {
padding-top: 0.75em;
text-align: left;
}
div.exampleblock-content {
border-left: 3px solid #dddddd;
padding-left: 0.5em;
}
/* IE6 sets dynamically generated links as visited. */
div#toc a:visited { color: blue; }
</style>
<script type="text/javascript">
/*<+'])');
// Function that scans the DOM tree for header elements (the DOM2
// nodeIterator API would be a better technique but not supported by all
// browsers).
var iterate = function (el) {
for (var i = el.firstChild; i != null; i = i.nextSibling) {
if (i.nodeType == 1 /* Node.ELEMENT_NODE */) {
var mo = re.exec(i.tagName);
if (mo && (i.getAttribute("class") || i.getAttribute("className")) != "float") {
result[result.length] = new TocEntry(i, getText(i), mo[1]-1);
}
iterate(i);
}
}
}
iterate(el);
return result;
}
var toc = document.getElementById("toc");
var entries = tocEntries(document.getElementById("content"), toclevels);
for (var i = 0; i < entries.length; ++i) {
var entry = entries[i];
if (entry.element.id == "")
entry.element.id = "_toc_" + i;
var a = document.createElement("a");
a.href = "#" + entry.element.id;
a.appendChild(document.createTextNode(entry.text));
var div = document.createElement("div");
div.appendChild(a);
div.className = "toclevel" + entry.toclevel;
toc.appendChild(div);
}
if (entries.length == 0)
toc.parentNode.removeChild(toc);
},
/////////////////////////////////////////////////////////////////////
// Footnotes generator
/////////////////////////////////////////////////////////////////////
/* Based on footnote generation code from:
* http://www.brandspankingnew.net/archive/2005/07/format_footnote.html
*/
footnotes: function () {
var cont = document.getElementById("content");
var noteholder = document.getElementById("footnotes");
var spans = cont.getElementsByTagName("span");
var refs = {};
var n = 0;
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnote") {
n++;
// Use [\s\S] in place of . so multi-line matches work.
// Because JavaScript has no s (dotall) regex flag.
note = spans[i].innerHTML.match(/\s*\[([\s\S]*)]\s*/)[1];
noteholder.innerHTML +=
"<div class='footnote' id='_footnote_" + n + "'>" +
"<a href='#_footnoteref_" + n + "' title='Return to text'>" +
n + "</a>. " + note + "</div>";
spans[i].innerHTML =
"[<a id='_footnoteref_" + n + "' href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
var id =spans[i].getAttribute("id");
if (id != null) refs["#"+id] = n;
}
}
if (n == 0)
noteholder.parentNode.removeChild(noteholder);
else {
// Process footnoterefs.
for (i=0; i<spans.length; i++) {
if (spans[i].className == "footnoteref") {
var href = spans[i].getElementsByTagName("a")[0].getAttribute("href");
href = href.match(/#.*/)[0]; // Because IE return full URL.
n = refs[href];
spans[i].innerHTML =
"[<a href='#_footnote_" + n +
"' title='View footnote' class='footnote'>" + n + "</a>]";
}
}
}
}
}
/*]]>*/
</script>
</head>
<body>
<div id="header">
<h1>RV/Shotgun Integration (v1.30)</h1>
<div id="toc">
<div id="toctitle">Table of Contents</div>
<noscript><p><b>JavaScript must be enabled in your browser to display the table of contents.</b></p></noscript>
</div>
</div>
<div id="content">
<div id="preamble">
<div class="sectionbody">
<style type="text/css">
a:link {
color: blue;
color:#4444dd;
}
a:visited {
color: darkgray;
color: #666666;
}
a:hover {
color: #ff5555;
}
</style>
<div class="paragraph"><p>© 2010 <a href="http://tweaksoftware.com">Tweak Software</a></p></div>
</div>
</div>
<h2 id="_quick_start">Quick Start</h2>
<div class="sectionbody">
<div class="paragraph"><p>The quickest possible route to seeing what RV and Shotgun can do
together is to <a href="#general_install">setup RV 3.8.6 as the rvlink
protocol handler</a> then <a href="#demo_setup">use the demo shotgun site
we’ve set up</a>.</p></div>
</div>
<h2 id="_introduction">Introduction</h2>
<div class="sectionbody">
<div class="paragraph"><p>Because production tracking and media playback are both so
ubiquitous in the production workflow, tightly integrating Shotgun
and RV holds the promise of making almost every part of your
workflow a little bit more efficient.</p></div>
<div class="paragraph"><p>This first release of the RV/Shotgon integration package includes
the following features:</p></div>
<div class="ulist"><ul>
<li>
<p>
Click on links in Shotgun to play media
</p>
</li>
<li>
<p>
Exchange URLs that will load the designated shotgun versions into RV with one click
</p>
</li>
<li>
<p>
Play sets of media from any Shotgun page displaying Versions
</p>
</li>
<li>
<p>
Compare two or more Versions in RV after selecting in Shotgun
</p>
</li>
<li>
<p>
Play media arranged in Shotgun Playlists
</p>
</li>
<li>
<p>
Display Shotgun information (from any shotgun entities) in RV
</p>
</li>
<li>
<p>
From RV, go directly to Shotgun pages corresponding to loaded media
</p>
</li>
<li>
<p>
From RV, update media to the latest version registered in Shotgun
</p>
</li>
<li>
<p>
Store Shotgun information in RV session files
</p>
</li>
<li>
<p>
Swap media type (movies or hires frames or whatever) from within RV
</p>
</li>
<li>
<p>
Use editorial information stored in Shotgun to adjust media EDL in RV, or to find and load media corresponding to neighboring shots
</p>
</li>
<li>
<p>
Configurability. After a configuration step, the integration package should be able to handle most shotgun schemas
</p>
</li>
</ul></div>
</div>
<h2 id="_installation">Installation</h2>
<div class="sectionbody">
<div class="paragraph"><p>The most important part of getting the RV/Shotgun integration
package working is the custom config module, which may require some
back-and-forth to get working the first time. But much of the
following can be completed before the config module is ready.</p></div>
<div class="paragraph"><p><a id="general_install"></a></p></div>
<h3 id="_general_installation">General Installation</h3><div style="clear:left"></div>
<div class="paragraph"><p>There are a couple different ways to use the integration package but
in all cases the following steps need to be completed first.</p></div>
<h4 id="_rv_3_8_6">RV 3.8.6</h4>
<div class="paragraph"><p>Make sure you have RV 3.8.6 or later installed (Any OS).
As always you can download RV
<a href="http://www.tweaksoftware.com/downloads">here</a>.</p></div>
<h4 id="_register_rvlink_protocol_handler">Register RVLINK Protocol Handler</h4>
<div class="paragraph"><p>The Shotgun integration relies on the general <em>rvlink</em> functionality
added in RV 3.8 that allows RV to act as a protocol handler for
<tt>rvlink://</tt> URLs. The registration of the protocol handler
depends on the OS (and the desktop environment). That process is
described in this Knowledge Base
<a href="http://tweaksoftware.zendesk.com/forums/55304/entries/74814">Article</a>.</p></div>
<div class="paragraph"><p>Once the protocol handler is registered, you can test it with the
links on
<a href="http://tweaksoftware.com/rvlink-test-page">this page</a>.</p></div>
<div class="paragraph"><p><a id="package_install"></a></p></div>
<h4 id="_install_shotgun_integration_package">Install Shotgun Integration Package</h4>
<div class="paragraph"><p>The shotgun integration package comes as a zip file (<tt>shotgun.zip</tt>).
To install it,</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
Save it anywhere (don’t unzip it)
</p>
</li>
<li>
<p>
Start RV and go to the <em>Packages</em> tab of the <em>Preferences</em> dialog
</p>
</li>
<li>
<p>
Click <em>Add Package</em>, browse to your saved package, choose a location for the package
</p>
</li>
<li>
<p>
Make sure both the <em>Install</em> and <em>Load</em> boxes are checked
</p>
</li>
<li>
<p>
Restart RV
</p>
</li>
</ol></div>
<div class="paragraph"><p><a id="demo_setup"></a></p></div>
<h3 id="_rv_shogun_evaluation_using_demo_site">RV/Shogun Evaluation Using Demo Site</h3><div style="clear:left"></div>
<div class="paragraph"><p>After completing the <a href="#general_install"><strong>General Installation</strong></a> steps described above, if
you don’t actually have Shotgun set up yet, or you’d like to see how
RV and Shotgun can work together without fiddling with your shotgun
instance, you can evaluate the integration with some test data as follows:</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
Start RV and set the <em>config style</em> to “demo” (<em>Shotgun</em> → <em>Preferences</em> → <em>Set Shotgun Config Style</em>)
</p>
</li>
<li>
<p>
Point your browser at the BBB_Short project on the demo site
<a href="https://rvdemo.shotgunstudio.com/page/1096">https://rvdemo.shotgunstudio.com/page/1096</a>. You can use the
user/password <tt>rvdemo</tt>/<tt>rvdemo007</tt>.
</p>
</li>
</ol></div>
<div class="paragraph"><p>At this point you can use the <em>Play In RV</em> and <em>Compare In RV</em>
Shotgun action menu items, and try out the Items on the Shotgun menu
in RV, including viewing shotgun information in the heads-up display
with the Shotgun Info Widget. But it’s a lot more fun with actual
media.</p></div>
<div class="paragraph"><p>To install the media package, down load it from
<a href="http://tweaksoftware.com/static/downloads/rvshotgundemo.zip">here</a>
and unpack it into a directory of your choice (on linux or mac) or
to <tt>C:\</tt> on windows. On linux or mac, add a symbolic link
from <tt>/rvshotgundemo</tt> to the location where you unpacked the media.</p></div>
<div class="paragraph"><p>Now RV should find the appropriate media for all the BBB_Short
Versions.</p></div>
<h4 id="_site_wide_demo">Site-Wide Demo</h4>
<div class="paragraph"><p>If you want to demo site-wide without everyone having to set their
"Config Style preference, you can</p></div>
<div class="olist arabic"><ol class="arabic">
<li>
<p>
Find the file <em>shotgun_fields_config_demo.mu</em> in
<em>RV_HOME</em><tt>/plugins/Mu</tt> or wherever you installed the <tt>shotgun.zip</tt>
package.
</p>
</li>
<li>
<p>
Copy the demo file to <tt>shotgun_fields_config_custom.mu</tt>
</p>
</li>
<li>
<p>
Edit <tt>shotgun_fields_config_custom.mu</tt> and change the module
definition line to
</p>
<div class="listingblock">
<div class="content">
<pre><tt>module: shotgun_fields_config_custom</tt></pre>
</div></div>
</li>
</ol></div>
<h4 id="_switching_to_a_8220_real_8221_install">Switching To A “Real” Install</h4>
<div class="paragraph"><p>After a successful demo, please see the following section,
<em>Site-Specific Custom Configuration</em> in order to move to using your
own Shotgun instance in place of the demo site.</p></div>
<h3 id="_site_specific_custom_configuration">Site-Specific Custom Configuration</h3><div style="clear:left"></div>
<div class="paragraph"><p>After completing the <a href="#general_install"><strong>General Installation</strong></a>
steps described above, if
you want to use RV with your Shotgun instance, you’ll need a custom
config module (this module adapts the actual arrangement of fields
and entities in your Shotgun database to RV’s idea of the “standard” fields).
If you’re not already in communication with us about this, please
<a href="mailto:[email protected]">email us</a>.</p></div>
<div class="admonitionblock">
<table><tr>
<td class="icon">
<div class="title">Note</div>
</td>
<td class="content">
<div class="paragraph"><p>In order to understand what RV can and cannot do in terms of adapting
to arbitrary Shotgun configurations, a good first step is to review
the information in this <a href="#survey">Appendix</a></p></div>
</td>
</tr></table>
</div>
<h4 id="_create_shotgun_script_key">Create Shotgun "Script Key"</h4>
<div class="paragraph"><p>In order for RV to authenticate itself to the shotgun server, it
needs to know the <em>script key</em>. To set this up, a shotgun admin
needs to add a shotgun script called “rv”. That means go to the
<em>Scripts</em> page listed in the <em>Admin</em> section of the standard
navigation bar, click the <em>+</em> (Add Script) button to add a
script, and name the script “rv”. The key for this
script (in the <em>Application Key</em> field) will be passed to RV from
the custom config module.</p></div>
<div class="paragraph"><p>Note that if the script key is incorrect, you’ll get an error about
“Can’t authenticate script rv”.</p></div>
<h4 id="_turn_on_rv_action_items_in_shotgun">Turn On RV Action Items In Shotgun</h4>
<div class="paragraph"><p>Contact <a href="mailto:[email protected]">Shotgun Support</a>
and ask them to activate the <em>Play in RV</em> and <em>Compare in RV</em> action
menu items in your Shotgun instance.</p></div>
<h4 id="_install_your_config_module">Install Your Config Module</h4>
<div class="paragraph"><p>To use a custom config module we built for you, you need to
install it in RV’s <em>MU_MODULE_PATH</em>. You can add your own directories to
this path, but by default it includes a location in your home
directory, and one the directory in which RV is installed
(<em>RV_HOME</em>):</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
</dt>
<dd>
<div class="hdlist"><table>
<tr>
<td class="hdlist1">
Linux
<br />
</td>
<td class="hdlist2">
<p style="margin-top: 0;">
<tt>~/.rv/Mu</tt><br />
<tt><em>RV_HOME</em>/plugins/Mu</tt>
</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Windows
<br />
</td>
<td class="hdlist2">
<p style="margin-top: 0;">
<tt>~/Application Support/RV/Mu</tt><br />
<tt><em>RV_HOME</em>/plugins/Mu</tt>
</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Mac
<br />
</td>
<td class="hdlist2">
<p style="margin-top: 0;">
<tt>~/Library/Application Support/RV/Mu</tt><br />
<tt><em>RV_HOME</em>/PlugIns/Mu</tt>
</p>
</td>
</tr>
</table></div>
</dd>
</dl></div>
<div class="paragraph"><p>If we’ve provided you with a custom config module (it’ll be called
“shotgun_fields_config_custom.mu”), you just need to copy it
to somewhere in the <em>MU_MODULE_PATH</em> and it should be picked up
by the RV/Shotgun integration package at runtime.</p></div>
<h3 id="_testing_and_troubleshooting_your_installation">Testing And Troubleshooting Your Installation</h3><div style="clear:left"></div>
<div class="paragraph"><p>If the <em>Play in RV</em> and <em>Compare in RV</em> items on the Shotgun action
menu seem to work perfectly, then you’re done. But if not, it’s
useful to separate the testing of the integration code from the
protocol handler. . You can assemble your own
rvlink url and test the Shotgun integration from the command line like so:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>% rv "rvlink:// -play -l -eval 'shotgun.sessionFromVersionIDs(int[] {VID});'"</tt></pre>
</div></div>
<div class="paragraph"><p>Where <tt>VID</tt> should be replaced by the ID of any valid Version
entity in your Shotgun database.</p></div>
<div class="paragraph"><p>To make sure you’re loading the right config module and connecting
to the right server, you can bring up RV’s Console window (<em>Windows</em>
→ <em>Console</em>). You should see something like:</p></div>
<div class="listingblock">
<div class="content">
<pre><tt>INFO: loaded shotgun config module 'shotgun_fields_config_demo'
(/Users/alan/Library/Application Support/RV/Mu/shotgun_fields_config_demo.mu)
INFO: using shotgun server 'https://rvdemo.shotgunstudio.com'
INFO: Loaded "shotgun_mode"
INFO: Loaded "shotgun_info_mode"</tt></pre>
</div></div>
<div class="paragraph"><p>To test the protocol handler registration independent of the
integration code, try the links on
<a href="http://tweaksoftware.com/rvlink-test-page">this page</a>.</p></div>
</div>
<h2 id="_usage">Usage</h2>
<div class="sectionbody">
<h3 id="_heads_up_8220_shotgun_info_widget_8221">Heads-Up “Shotgun Info Widget”</h3><div style="clear:left"></div>
<div class="paragraph"><p><em>In Progress</em></p></div>
<h3 id="_switching_media_types">Switching Media Types</h3><div style="clear:left"></div>
<div class="paragraph"><p><em>In Progress</em></p></div>
<h3 id="_changing_the_edit">Changing The Edit</h3><div style="clear:left"></div>
<div class="paragraph"><p><em>In Progress</em></p></div>
<h3 id="_new_sessions">New Sessions</h3><div style="clear:left"></div>
<div class="paragraph"><p><em>In Progress</em></p></div>
<h3 id="_preferences">Preferences</h3><div style="clear:left"></div>
<div class="paragraph"><p><em>In Progress</em></p></div>
</div>
<h2 id="_faq">FAQ</h2>
<div class="sectionbody">
<div class="paragraph"><p><em>In Progress</em></p></div>
<div class="paragraph"><p><a id="survey"></a></p></div>
</div>
<h2 id="_appendix_shotgun_entity_field_survey">Appendix: Shotgun Entity/Field Survey</h2>
<div class="sectionbody">
<div class="paragraph"><p>In order to use the RV Shotgun integration package, we need to be
able to translate your shotgun structure into something that looks
“standard” to RV. In general, the config module is very flexible
and can make use of information stored in arbitrarilly-named fields
on arbitrary entities. But there are some restrictions as follows:</p></div>
<div class="dlist"><dl>
<dt class="hdlist1">
<strong>The <em>entity</em> field of a <em>Version</em> must be connected to a <em>Shot</em> or an <em>Asset</em></strong>
</dt>
<dd>
<p>
Otherwise we won’t be able to find the latest version of a shot
or asset, or all the versions of a given shot or asset, and in the case of shot’s we won’t be able to put the
Version in context with it’s neighbors in the cut.
</p>
</dd>
<dt class="hdlist1">
<strong>Some field of a <em>Version</em> must be connected to a <em>Project</em> entity</strong>
</dt>
<dd>
<p>
So that several kinds of searchs can be limited to a single Project.
</p>
</dd>
<dt class="hdlist1">
<strong>Some field of a <em>Version</em> must be connected to a <em>Human User</em> entity</strong>
</dt>
<dd>
<p>
So that notes can be addressed properly by default.
</p>
</dd>
<dt class="hdlist1">
<strong>An integer order in the cut must be computable from a field on the <em>Shot</em></strong>
</dt>
<dd>
<p>
Otherwise we won’t be able to find the neighbors of the Version
of a Shot in order to play it in context.
</p>
</dd>
<dt class="hdlist1">
<strong>Some field of a <em>Shot</em> must be connected to some entity that represents a sequence</strong>
</dt>
<dd>
<p>
Otherwise we won’t be able to find the neighbors of the Version
of a Shot in order to play it in context.
</p>
</dd>
</dl></div>
<div class="paragraph"><p>For us to get started writing a config module for your shotgun
setup, we need some information about the way you store information
in shotgon. Hence the following survey. Please answer the
questions below as completely as you can. In particular when we ask
for name/type, please include the name <strong>and</strong> the type !</p></div>
<div class="paragraph"><p>You can send your survey answers to
<a href="mailto:[email protected]">Shotgun Support</a>
to start the process.</p></div>
<div class="paragraph"><p> </p></div>
<hr />
<div class="paragraph"><p> </p></div>
<div class="paragraph"><p>For convenience we refer to each of these bits of information as a
"field", but remember that they can actually be computed from
several fields or even from an environment variable or other outside
source. For each field that RV can make use of in the shotgun
integration, we list</p></div>
<div class="hdlist"><table>
<tr>
<td class="hdlist1">
Internal Field Name
<br />
</td>
<td class="hdlist2">
<p style="margin-top: 0;">
The name that RV uses to refer to this bit of info.
In general the actual name of the field is not important (can be
easily set in the config module).
</p>
</td>
</tr>
<tr>
<td class="hdlist1">
Recommended Entity
<br />
</td>
<td class="hdlist2">
<p style="margin-top: 0;">
The type of entity we’re thinking is most