123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899490049014902490349044905490649074908490949104911491249134914491549164917491849194920492149224923492449254926492749284929493049314932493349344935493649374938493949404941494249434944494549464947494849494950495149524953495449554956495749584959496049614962496349644965496649674968496949704971497249734974497549764977497849794980498149824983498449854986498749884989499049914992499349944995499649974998499950005001500250035004500550065007500850095010501150125013501450155016501750185019502050215022502350245025502650275028502950305031503250335034503550365037503850395040504150425043504450455046504750485049505050515052505350545055505650575058505950605061506250635064506550665067506850695070507150725073507450755076507750785079508050815082508350845085508650875088508950905091509250935094509550965097509850995100510151025103510451055106510751085109511051115112511351145115511651175118511951205121512251235124512551265127512851295130513151325133513451355136513751385139514051415142514351445145514651475148514951505151515251535154515551565157515851595160516151625163516451655166516751685169517051715172517351745175517651775178517951805181518251835184518551865187518851895190519151925193519451955196519751985199520052015202520352045205520652075208520952105211521252135214521552165217521852195220522152225223522452255226522752285229523052315232523352345235523652375238523952405241524252435244524552465247524852495250525152525253525452555256525752585259526052615262526352645265526652675268526952705271527252735274527552765277527852795280528152825283528452855286528752885289529052915292529352945295529652975298529953005301530253035304530553065307530853095310531153125313531453155316531753185319532053215322532353245325532653275328532953305331533253335334533553365337533853395340534153425343534453455346534753485349535053515352535353545355535653575358535953605361536253635364536553665367536853695370537153725373537453755376537753785379538053815382538353845385538653875388538953905391539253935394539553965397539853995400540154025403540454055406540754085409541054115412541354145415541654175418541954205421542254235424542554265427542854295430543154325433543454355436543754385439544054415442544354445445544654475448544954505451545254535454545554565457545854595460546154625463546454655466546754685469547054715472547354745475547654775478547954805481548254835484548554865487548854895490549154925493549454955496549754985499550055015502550355045505550655075508550955105511551255135514551555165517551855195520552155225523552455255526552755285529553055315532553355345535553655375538553955405541554255435544554555465547554855495550555155525553555455555556555755585559556055615562556355645565556655675568556955705571557255735574557555765577557855795580558155825583558455855586558755885589559055915592559355945595559655975598559956005601560256035604560556065607560856095610561156125613561456155616561756185619562056215622562356245625562656275628562956305631563256335634563556365637563856395640564156425643564456455646564756485649565056515652565356545655565656575658565956605661566256635664566556665667566856695670567156725673567456755676567756785679568056815682568356845685568656875688568956905691569256935694569556965697569856995700570157025703570457055706570757085709571057115712571357145715571657175718571957205721572257235724572557265727572857295730573157325733573457355736573757385739574057415742574357445745574657475748574957505751575257535754575557565757575857595760576157625763576457655766576757685769577057715772577357745775577657775778577957805781578257835784578557865787578857895790579157925793579457955796579757985799580058015802580358045805580658075808580958105811581258135814581558165817581858195820582158225823582458255826582758285829583058315832583358345835583658375838583958405841584258435844584558465847584858495850585158525853585458555856585758585859586058615862586358645865586658675868586958705871587258735874587558765877587858795880588158825883588458855886588758885889589058915892589358945895589658975898589959005901590259035904590559065907590859095910591159125913591459155916591759185919592059215922592359245925592659275928592959305931593259335934593559365937593859395940594159425943594459455946594759485949595059515952595359545955595659575958595959605961596259635964596559665967596859695970597159725973597459755976597759785979598059815982598359845985598659875988598959905991599259935994599559965997599859996000600160026003600460056006600760086009601060116012601360146015601660176018601960206021602260236024602560266027602860296030603160326033603460356036603760386039604060416042604360446045604660476048604960506051605260536054605560566057605860596060606160626063606460656066606760686069607060716072607360746075607660776078607960806081608260836084608560866087608860896090609160926093609460956096609760986099610061016102610361046105610661076108610961106111611261136114611561166117611861196120612161226123612461256126612761286129613061316132613361346135613661376138613961406141614261436144614561466147614861496150615161526153615461556156615761586159616061616162616361646165616661676168616961706171617261736174617561766177617861796180618161826183618461856186618761886189619061916192619361946195619661976198619962006201620262036204620562066207620862096210621162126213621462156216621762186219622062216222622362246225622662276228622962306231623262336234623562366237623862396240624162426243624462456246624762486249625062516252625362546255625662576258625962606261626262636264626562666267626862696270627162726273627462756276627762786279628062816282628362846285628662876288628962906291629262936294629562966297629862996300630163026303630463056306630763086309631063116312631363146315631663176318631963206321632263236324632563266327632863296330633163326333633463356336633763386339634063416342634363446345634663476348634963506351635263536354635563566357635863596360636163626363636463656366636763686369637063716372637363746375637663776378637963806381638263836384638563866387638863896390639163926393639463956396639763986399640064016402640364046405640664076408640964106411641264136414641564166417641864196420642164226423642464256426642764286429643064316432643364346435643664376438643964406441644264436444644564466447644864496450645164526453645464556456645764586459646064616462646364646465646664676468646964706471647264736474647564766477647864796480648164826483648464856486648764886489649064916492649364946495649664976498649965006501650265036504650565066507650865096510651165126513651465156516651765186519652065216522652365246525652665276528652965306531653265336534653565366537653865396540654165426543654465456546654765486549655065516552655365546555655665576558655965606561656265636564656565666567656865696570657165726573657465756576657765786579658065816582658365846585658665876588658965906591659265936594659565966597659865996600660166026603660466056606660766086609661066116612661366146615661666176618661966206621662266236624662566266627662866296630663166326633663466356636663766386639664066416642664366446645664666476648664966506651665266536654665566566657665866596660666166626663666466656666666766686669667066716672667366746675667666776678667966806681668266836684668566866687668866896690669166926693669466956696669766986699670067016702670367046705670667076708670967106711671267136714671567166717671867196720672167226723672467256726672767286729673067316732673367346735673667376738673967406741674267436744674567466747674867496750675167526753675467556756675767586759676067616762676367646765676667676768676967706771677267736774677567766777677867796780678167826783678467856786678767886789679067916792679367946795679667976798679968006801680268036804680568066807680868096810681168126813681468156816681768186819682068216822682368246825682668276828682968306831683268336834683568366837683868396840684168426843684468456846684768486849685068516852685368546855685668576858685968606861686268636864686568666867686868696870687168726873687468756876687768786879688068816882688368846885688668876888688968906891689268936894689568966897689868996900690169026903690469056906690769086909691069116912691369146915691669176918691969206921692269236924692569266927692869296930693169326933693469356936693769386939694069416942694369446945694669476948694969506951695269536954695569566957695869596960696169626963696469656966696769686969697069716972697369746975697669776978697969806981698269836984698569866987698869896990699169926993699469956996699769986999700070017002700370047005700670077008700970107011701270137014701570167017701870197020702170227023702470257026702770287029703070317032703370347035703670377038703970407041704270437044704570467047704870497050705170527053705470557056705770587059706070617062706370647065706670677068706970707071707270737074707570767077707870797080708170827083708470857086708770887089709070917092709370947095709670977098709971007101710271037104710571067107710871097110711171127113711471157116711771187119712071217122712371247125712671277128712971307131 |
- <?xml version="1.0" encoding="UTF-8"?>
- <!--
- Licensed Materials - Property of IBM
- IBM Cognos Products: fmmd
- (C) Copyright IBM Corp. 2003, 2010
- US Government Users Restricted Rights - Use, duplication or disclosure
- restricted by GSA ADP Schedule Contract with IBM Corp.
- -->
- <!--
- Copyright (C) 2008 Cognos ULC, an IBM Company. All rights reserved.
- Cognos (R) is a trademark of Cognos ULC, (formerly Cognos Incorporated).
- -->
- <!--xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" elementFormDefault="qualified" attributeFormDefault="unqualified"-->
- <xsd:schema xmlns:fmsdk="http://www.developer.cognos.com/schemas/fmsdk/1/0" xmlns:xsd="http://www.w3.org/2001/XMLSchema" targetNamespace="http://www.developer.cognos.com/schemas/fmsdk/1/0" elementFormDefault="qualified" attributeFormDefault="unqualified">
- <xsd:annotation>
- <xsd:documentation>
- <para>This section contains information to assist users in building action log scripts that can be executed either by the Framework Manager (FM) Software Developer Kit (SDK) or directly in Framework Manager.</para>
- <para>Action log files do not conform directly to this specification (mdActions.xsd). There is, however, a direct one-to-one mapping between the parameter lists in this specification and the parameters as found in the action logs. The mapping is handled by the type specified for a parameter. The set of defined types described at the end of this section (see the heading entitled Types) describes the valid types and the parameters to which they map in the action logs.</para>
- <para>Note: Sample action log entries are provided for many of the actions in this section. They illustrate the proper encoding for the action logs.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType name="action">
- <xsd:annotation>
- <xsd:documentation>
- <para>Every action element is encoded in the action logs as an action and its type attribute is set to the name of the element. For example, the element AddLocale is encoded as an action element in the action logs, with its type attribute set to AddLocale. For an example of this encoding, see the Sample action log entry for the AddLocale element. </para>
- <para>Note: The action element is documented in the Metadata Provider (Wrapper) Reference. </para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:complexType>
- <xsd:complexType name="complexPropertyValue">
- <xsd:annotation>
- <xsd:documentation>
- <para>If the value is an XML fragment, new child properties are created under the property in question from the child elements or attributes that exist in this value.</para>
- <para>For example, in the following value being set on an instance of an existing package/functionSets property:</para>
- <para> <functionSet><functionSetID>V_DB2</functionSetID> </functionSet></para>
- <para> <functionSet><functionSetID>V_MSAccess</functionSetID></functionSet></para>
- <para> <functionSet><functionSetID>V_Oracle</functionSetID></functionSet></para>
- <para>Three instances of functionSetID child properties will be created under the functionSets property, and their values set to V_DB2, V_MSAccess, and V_Oracle, respectively. </para>
- <para>This type of value applies to a complex property. A complex property is one that can contain child properties of its own. In general, when dealing with a property that can have children, specify this option.</para>
- <para>Note: All reserved XML characters must be escaped, even if the value is specified as an XML fragment.</para>
- <para>For more information, see the Framework Manager model schema.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleContent>
- <xsd:restriction base="fmsdk:propertyValue"/>
- </xsd:simpleContent>
- </xsd:complexType>
- <xsd:simpleType name="delimitedFilePath">
- <xsd:annotation>
- <xsd:documentation>
- <para>Represents a path to a text file containing multiple columns of data, each column separated by a fixed delimiter character.</para>
- <para>If the extension specified for the file is .csv, the delimiter is assumed to be a comma and the file is assumed to be in comma-separated values format and encoded according to the ISO 8859-1 (Latin-1) standard. Otherwise, the delimiter is assumed to be the tab character and the file is assumed to be in tab-delimited format, encoded according to the ISO 10646 UTF-8 (Unicode) standard.</para>
- <para>Note: Path separator is "\" for Windows, "/" for UNIX.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:restriction base="xsd:string"/>
- </xsd:simpleType>
- <xsd:complexType name="localeCollection">
- <xsd:annotation>
- <xsd:documentation>
- <para>Maps to a parameter of type stringCollection in the action logs.</para>
- <para>Encoded in the same way as stringCollection, but the value for every item must be a valid XML language code.</para>
- <para>For example, a parameter containing the languages English, German and French (Canada) would be encoded as: <stringCollection><item>en</item><item>de</item><item>fr-ca</item></stringCollection></para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:sequence>
- <xsd:element name="locale" type="xsd:language" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- <xsd:simpleType name="node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Maps to a parameter of type cclnode in the action logs.</para>
- <para>Encoded as an XML fragment contained within a CDATA element.</para>
- <para>For example:</para>
- <para>![CDATA[<setObjectAccess><object rule="include" refobj="[1 - GOSales - OLE-DB].[CONVERSIONRATE]"><access type="group" displayPath="All Authenticated Users [Directory > Cognos]" cmSearchPath="CAMID("::All Authenticated Users")"/><access type="role" displayPath="Authors [Directory > Cognos]" cmSearchPath="CAMID(":Authors")"/></object></setObjectAccess>]]</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:restriction base="xsd:string"/>
- </xsd:simpleType>
- <xsd:simpleType name="objectHandle">
- <xsd:annotation>
- <xsd:documentation>
- <para>Maps to a parameter of type handle in the action logs.</para>
- <para> Refers to an object in the model, encoded in the same manner as a standard object reference in the model. An object reference is a concatenation of object names from an object to the nearest ancestor namespace.</para>
- <para>For example, [gosales_ml].[CONVERSION_RATE].[COUNTRY_CODE] - the query item COUNTRY_CODE which is contained in query subject CONVERSION_RATE, which in turn is contained in namespace gosales_m.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:restriction base="xsd:string"/>
- </xsd:simpleType>
- <xsd:simpleType name="objectName">
- <xsd:annotation>
- <xsd:documentation>
- <para>Maps to a parameter of type i18nstring in the action logs.</para>
- <para> The object name follows similar constraints to that of W3C NMTOKEN:</para>
- <bulletList>
- <listElement>Cannot be blank. If specified, an exception is thrown.</listElement>
- <listElement>Cannot have either leading or trailing whitespace. If specified, the leading and trailing whitespace is implicitly trimmed from the name.</listElement>
- <listElement>Cannot have consecutive blanks. If specified, any such occurrence is implicitly truncated to a single blank.</listElement>
- </bulletList>
- <para>For example, an object name of " My Object " is implicitly truncated by Framework Manager to "My Object".</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:restriction base="xsd:string"/>
- </xsd:simpleType>
- <xsd:simpleType name="objectReference">
- <xsd:annotation>
- <xsd:documentation>
- <para>Maps to a parameter of type i18nstring in the action logs.</para>
- <para>Essentially the same as objectHandle, but is slightly different with respect to how it is handled internally.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:restriction base="xsd:string"/>
- </xsd:simpleType>
- <xsd:complexType name="optionalLocaleCollection">
- <xsd:annotation>
- <xsd:documentation>
- <para>Maps to a parameter of type stringCollection in the action logs.</para>
- <para>Encoded the same as stringCollection, but the value for every item must be a valid ISO-639 language code.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:sequence>
- <xsd:element name="locale" type="xsd:language" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- <xsd:simpleType name="propertyHandle">
- <xsd:annotation>
- <xsd:documentation>
- <para>Maps to a parameter of type handle in the action logs.</para>
- <para>Refers to a property in the model, encoded as</para>
- <bulletList>
- <listElement>the same as an object reference is encoded in Framework Manager to identify the object containing the property, but</listElement>
- <listElement>prefixed with an XPath-like expression to the property instance.</listElement>
- </bulletList>
- <para>For example, /O/screenTip[0]/O/[gosales_ml].[Order Discount] - Property screenTip of Order Discount object.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:restriction base="xsd:string"/>
- </xsd:simpleType>
- <xsd:complexType name="propertyValue" abstract="true">
- <xsd:annotation>
- <xsd:documentation>
- <para>Maps to a parameter of type i18nstring in the action logs.</para>
- <para>Represents the value being set on a property being created or updated. If it is an XML fragment, all reserved XML characters must be escaped, according to W3C standards. For example, the less than character must be encoded as "<".</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleContent>
- <xsd:extension base="xsd:string"/>
- </xsd:simpleContent>
- </xsd:complexType>
- <xsd:simpleType name="propertyValueTypeIdentifier">
- <xsd:annotation>
- <xsd:documentation>Identifies whether a given property value is a simple or a complex property.</xsd:documentation>
- </xsd:annotation>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Complex. Specifies that the corresponding property value is of type complexPropertyValue. The value is an XML fragment, and child properties are created from any element or attribute definitions that exist in the value. </xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Simple. Specifies that the corresponding property value is of type simplePropertyValue. The specified value is set explicitly on the property, and no child properties are created even if the value is an XML fragment. </xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- <xsd:complexType name="simplePropertyValue">
- <xsd:annotation>
- <xsd:documentation>
- <para>Maps to a string and represents a simple value being set on a property. The value is simple in that child properties will not be inferred from it, even if the value is an XML fragment and the property in question is complex, in that it can contain child properties.</para>
- <para>For example, the following value being set on an instance of an existing package/functionSets property:</para>
- <para> <functionSet><functionSetID>V_DB2</functionSetID> </functionSet></para>
- <para> <functionSet><functionSetID>V_MSAccess</functionSetID></functionSet></para>
- <para> <functionSet><functionSetID>V_Oracle</functionSetID></functionSet></para>
- <para>The value of the functionSets property will be set to this XML fragment and child properties are not created for the functionSetID elements that appear in the value. </para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleContent>
- <xsd:restriction base="fmsdk:propertyValue"/>
- </xsd:simpleContent>
- </xsd:complexType>
- <xsd:complexType name="stringCollection">
- <xsd:annotation>
- <xsd:documentation>
- <para>Maps to a parameter of type stringCollection in the action logs.</para>
- <para>Represents a collection of strings that are encoded as an XML fragment with a root element called stringCollection and each string in its own item element. However, all reserved XML characters are escaped in the encoded value.</para>
- <para>For example, a parameter of this type with strings "COUNTRY", "SALES", and "PRODUCTS" would be encoded as <stringCollection><item>COUNTRY</item><item>SALES</item><item>PRODUCT</item></stringCollection></para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:sequence>
- <xsd:element name="stringValue" maxOccurs="unbounded">
- <xsd:simpleType>
- <xsd:restriction base="xsd:string"/>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- <xsd:group name="dbImportInputParametersRelational">
- <xsd:annotation>
- <xsd:documentation>
- <para>A set of parameters representing the parameter list applicable to the DBImport action being executed against a relational data source.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:sequence>
- <xsd:element ref="fmsdk:joinOptionProcessExternalJoins"/>
- <xsd:element ref="fmsdk:joinOptionProcessInternalJoins"/>
- <xsd:element ref="fmsdk:joinOptionProcessKeys"/>
- <xsd:element ref="fmsdk:joinOptionProcessMatchingIndexColumns"/>
- <xsd:element ref="fmsdk:joinOptionProcessMatchingQueryItemNames"/>
- <xsd:element ref="fmsdk:joinOptionProcessOuterJoinOption"/>
- <xsd:element ref="fmsdk:nameConflictOptionImport"/>
- <xsd:element ref="fmsdk:displaySummaryMessageOption" minOccurs="0"/>
- <xsd:element ref="fmsdk:storedProcedureOptionThrowExceptionOption" minOccurs="0"/>
- </xsd:sequence>
- </xsd:group>
- <xsd:group name="dbImportInputParametersSAPBW">
- <xsd:annotation>
- <xsd:documentation source="sapbw">
- <para>Represents the parameter list applicable to the DBImport action being executed against a multidimensional (SAP BW) data source.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:sequence>
- <xsd:element name="sapbwImportOptionUseOrLongNames">
- <xsd:annotation>
- <xsd:documentation source="sapbw"/>
- <xsd:documentation>
- <para>SAP BW objects have a short name (short description or caption), a long name (long description), and a technical name (unique name). Specifies which name to use for the imported objects.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Use short names.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Use technical names.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="2">
- <xsd:annotation>
- <xsd:documentation>Use long names.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="sapbwImportOptionObjectOrganization">
- <xsd:annotation>
- <xsd:documentation source="sapbw"/>
- <xsd:documentation>
- <para>Specifies whether or not to enhance the model for SAP BW organization of objects.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Enhance the organization of objects to reflect SAP BW objects more closely.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Use the default object organization.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="sapbwImportLocales" type="fmsdk:optionalLocaleCollection">
- <xsd:annotation>
- <xsd:documentation source="sapbw"/>
- <xsd:documentation>
- <para>Specifies which languages from the SAP BW data source should be imported into the model. These languages are added to the model if they do not already exist in the model.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="sapbwImportOptionCreateConformedDimensions">
- <xsd:annotation>
- <xsd:documentation source="sapbw"/>
- <xsd:documentation>
- <para>Specifies whether or not to create conformed dimensions for all applicable imported dimensions.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element ref="fmsdk:nameConflictOptionImport"/>
- </xsd:sequence>
- </xsd:group>
- <xsd:group name="inputParamsCreate">
- <xsd:annotation>
- <xsd:documentation>A set of parameters representing the input parameter list specific to the Create action, and the Verify action for Create.</xsd:documentation>
- </xsd:annotation>
- <xsd:sequence>
- <xsd:element name="objectType">
- <xsd:annotation>
- <xsd:documentation>Specifies the object type to create.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Query Subject</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="2">
- <xsd:annotation>
- <xsd:documentation>Query Item</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="3">
- <xsd:annotation>
- <xsd:documentation>Relationship</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="4">
- <xsd:annotation>
- <xsd:documentation>Shortcut</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="5">
- <xsd:annotation>
- <xsd:documentation>Folder</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="6">
- <xsd:annotation>
- <xsd:documentation>Package</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="8">
- <xsd:annotation>
- <xsd:documentation>Project</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="9">
- <xsd:annotation>
- <xsd:documentation>Relationship Shortcut</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="10">
- <xsd:annotation>
- <xsd:documentation>Custom Object. RESERVED for future use.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="11">
- <xsd:annotation>
- <xsd:documentation>Runtime Object. RESERVED for future use.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="12">
- <xsd:annotation>
- <xsd:documentation>Calculation</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="13">
- <xsd:annotation>
- <xsd:documentation>Filter</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="14">
- <xsd:annotation>
- <xsd:documentation>Parameter Map</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="15">
- <xsd:annotation>
- <xsd:documentation>Parameter Map Entry</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="16">
- <xsd:annotation>
- <xsd:documentation>Security View</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="17">
- <xsd:annotation>
- <xsd:documentation>Query Item Folder</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="18">
- <xsd:annotation>
- <xsd:documentation>Function</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="19">
- <xsd:annotation>
- <xsd:documentation>Namespace</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="20">
- <xsd:annotation>
- <xsd:documentation>Data Source</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="21">
- <xsd:annotation>
- <xsd:documentation>Dimension</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="22">
- <xsd:annotation>
- <xsd:documentation>Level</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="23">
- <xsd:annotation>
- <xsd:documentation>Scope Relationship</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="24">
- <xsd:annotation>
- <xsd:documentation>Hierarchy</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="25">
- <xsd:annotation>
- <xsd:documentation>Update Subject</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="26">
- <xsd:annotation>
- <xsd:documentation>Measure Folder</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="27">
- <xsd:annotation>
- <xsd:documentation>Measure</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element ref="fmsdk:targetParent"/>
- <xsd:sequence minOccurs="0">
- <xsd:element ref="fmsdk:newObjectName"/>
- <xsd:sequence minOccurs="0">
- <xsd:element ref="fmsdk:nameConflictOptionCreate"/>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:group>
- <xsd:group name="inputParamsDelete">
- <xsd:annotation>
- <xsd:documentation>
- <para>A set of parameters representing the input parameter list specific to the Delete action, and the Verify action for Delete.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:choice>
- <xsd:element name="deleteObject" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>
- <para>Can be any object in the model except:
- <bulletList>
- <listElement>root container objects. These are objects within the root project object, namely dataSources, packages, parameterMaps, securityViews, and the root namespace.</listElement>
- <listElement>query items that belong to datasource query subjects (dbQuery).</listElement>
- </bulletList>
- </para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="deleteProperty" type="fmsdk:propertyHandle">
- <xsd:annotation>
- <xsd:documentation>
- <para>Can be any property in the model.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:choice>
- </xsd:group>
- <xsd:group name="inputParamsImportTranslations">
- <xsd:annotation>
- <xsd:documentation>
- <para>A set of parameters representing the input parameter list specific to the ImportTranslations action, and the Verify action for ImportTranslations.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:sequence>
- <xsd:element ref="fmsdk:translationsFilePath"/>
- <xsd:sequence minOccurs="0">
- <xsd:element name="keyLocale" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the locale used as the search criteria for properties that are being translated. The default is the locale ID of defaultLocale in the model.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:element name="applyLocales" type="fmsdk:localeCollection">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies that only the properties in these locales are updated when importing the translations. If not specified, all locales in the model except for the input parameter keyLocale are processed.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:element name="importTranslationsRootObject" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>
- <para>The set of objects to which to apply the translations are restricted to this object or any of its descendants. If not specified, all objects in the model are processed.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:element ref="fmsdk:selectedObjectsProcessingLevel"/>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:group>
- <xsd:group name="inputParamsMove">
- <xsd:annotation>
- <xsd:documentation>
- <para>A set of parameters representing the input parameter list specific to the Move action, and the Verify action for Move.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:sequence>
- <xsd:element ref="fmsdk:targetParent"/>
- <xsd:element name="moveObject" type="fmsdk:objectHandle" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the object being moved.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:group>
- <xsd:group name="inputParamsModify">
- <xsd:annotation>
- <xsd:documentation>
- <para>A set of parameters representing the input parameter list specific to the Modify action, and the Verify action for Modify.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:sequence>
- <xsd:element name="simpleProperty" type="fmsdk:propertyHandle">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the simple property being updated. The property is simple in that it is does not have any child properties.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="newSimpleValue" type="fmsdk:simplePropertyValue">
- <xsd:annotation>
- <xsd:documentation>
- <para>The value used to update the property.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:group>
- <xsd:group name="inputParamsDynamicImportPublish">
- <xsd:annotation>
- <xsd:documentation>
- <para>A set of parameters representing the input parameter list specific to the DynamicImportPublish action.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:sequence>
- <xsd:element ref="fmsdk:crnDataSourceName"/>
- <xsd:element name="targetPackageName" type="xsd:string" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>The name of the package to be published. If omiited, the package will be named after the cube name.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>The following parameters are for DB2, MSAS, Finance (CL), and Planning (CR).</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:element name="catalogName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The name of the parent catalog. This name is required for all datasource types except Powercube.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>The following parameter is for Finance (CL) and Planning (CR).</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:element name="schemaName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The name of the parent schema. This name is required for Cognos Finance and Planning datasources.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- <xsd:element name="cubeName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The name of the cube. This name is required for all datasource types except Powercube.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>The following two parameters are optional for DB2 (DO).</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:element name="DB2AliasLocales" type="fmsdk:localeCollection">
- <xsd:annotation>
- <xsd:documentation>
- <para>The collection of the locales to be imported.</para>
- <para>This collection is used to create a map between a locale and an alias table (see the input parameter below.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="DB2AliasNames" type="fmsdk:stringCollection">
- <xsd:annotation>
- <xsd:documentation>
- <para>The collection of the alias names corresponding to the above collection of locales.</para>
- <para>This collection and the locale collection is used to create a map between a locale and an alias caption table.</para>
- <para>The sizes of the two collections must be equal.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:group>
- <xsd:group name="inputParamsPublish">
- <xsd:annotation>
- <xsd:documentation>
- <para>A set of parameters representing the input parameter list specific to the Publish action, and the Verify action for Publish.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:sequence>
- <xsd:element ref="fmsdk:regularPackage"/>
- <xsd:element ref="fmsdk:publishTargetType"/>
- <xsd:element ref="fmsdk:targetLocation"/>
- <xsd:element ref="fmsdk:targetPackageName"/>
- <xsd:element ref="fmsdk:packageExists"/>
- <xsd:element name="temporaryRetentionValue" type="xsd:integer" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the maximum number of versions that the published package can have in IBM Cognos 10. If the value is -1, then versioning is turned off.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="permanentRetentionValue" type="xsd:integer" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the maximum number of versions that the published package can have in the Framework Manager model. If the value is -1, then versioning is turned off.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="externalizeQuerySubjects" default="0" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>Indicates whether or not to externalize the query subjects included in the package that are marked for externalization.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Do not externalize the query subjects.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Externalize the query subjects.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element ref="fmsdk:externalizeRootDirectory" minOccurs="0"/>
- </xsd:sequence>
- </xsd:group>
- <xsd:element name="fmsdkScript">
- <xsd:complexType>
- <xsd:choice>
- <xsd:element name="actionLog">
- <xsd:annotation>
- <xsd:documentation>Maps to the bmtactionlog root element that appears in a Framework Manager action log. An action log can be executed from within Framework Manager, by the Framework Manager script player, or by the Framework Manager Metadata Service.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:transaction" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="metaDataServiceRequest">
- <xsd:annotation>
- <xsd:documentation>Maps to a SOAP request intended to be handled by the Framework Manager Metadata Service.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:transaction" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:choice>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="catalogName">
- <xsd:annotation>
- <xsd:documentation>Specifies the name of the catalog.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:string"/>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="schemaName">
- <xsd:annotation>
- <xsd:documentation>Specifies the name of the schema.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:string"/>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="cubeName">
- <xsd:annotation>
- <xsd:documentation>Specifies the name of the cube.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:string"/>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="conformedDimensionCandidate" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation source="sapbw"/>
- <xsd:documentation>
- <para>A dimension that can be conformed to the target.</para>
- <para>Note: Applies to multidimensional dimensions (specifically of type SapBW) only.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="createAutoSummary" type="xsd:boolean">
- <xsd:annotation>
- <xsd:documentation>
- <para>If set to true, a grouping and aggregation of the projection items is triggered.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="crnDataSourceConnectionName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The name of an IBM Cognos 10 data source connection object.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="crnDataSourceConnectionSignonName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The name of an IBM Cognos 10 data source connection signon object.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="crnDataSourceConnectionSignonPassword" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The password for authenticating to a given IBM Cognos 10 data source connection.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="crnDataSourceConnectionSignonUser" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The user name for authenticating to a given IBM Cognos 10 data source connection.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="crnDataSourceConnectionCubePassword" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The password for authenticating to a given Cognos PowerCube data source connection.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="crnDataSourceConnectionCubePasswordEncrypted" type="xsd:integer">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies if the cube password for authenticating to a given Cognos PowerCube data source connection is encrypted (0 means not encrypted).</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="crnDataSourceName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The name of an IBM Cognos 10 data source object.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="dataSource" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>
- <para>A data source object in the model.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="dataSourceName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies the name of the data source.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="executionReportDetailLevel" default="1">
- <xsd:annotation>
- <xsd:documentation>Represents the level of detail for the report.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Only errors are reported.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="2">
- <xsd:annotation>
- <xsd:documentation>Errors and warnings are reported.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="3">
- <xsd:annotation>
- <xsd:documentation>Errors, warnings and information about key transformations that might have been used are reported.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="4">
- <xsd:annotation>
- <xsd:documentation>The highest level of detail. In addition to any of the above items, planning or execution information are reported.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="expression" type="fmsdk:propertyHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the expression to be executed.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="gatewayURI" type="xsd:anyURI">
- <xsd:annotation>
- <xsd:documentation>
- <para>The gateway configuration parameter.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="importSourceSpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Must conform to the ImportSpec.xsd. Value represents a tree of the objects found in a given import source, and indicates which object is selected to be processed. For the browse actions, an item containing the "namePattern" element is the item to be expanded. For the import actions, items having a value attribute of "true" or "partial" are the items to be imported. The import source can be either a data source or a Framework Manager model.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="importSourceSpecDataSource" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Must conform to the ImportSpec.xsd. Value represents a tree of the objects found in a given import source, and indicates which object is selected to be processed. For the browse actions, an item containing the "namePattern" element is the item to be expanded. For the import actions, items having a value attribute of "true" or "partial" are the items to be imported. The import source can be either a data source or a Framework Manager model.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="importSourceSpecModel" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Must conform to the ImportSpec.xsd. The value represents a tree of the objects found in a given import source, and indicates which object is selected to be processed. For the browse actions, an item containing the "namePattern" element is the item to be expanded. For the import actions, items having a value attribute of "true" or "partial" are the items to be imported. The import source can be either a data source or a Framework Manager model.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="includeRule">
- <xsd:annotation>
- <xsd:documentation>Specifies the rule that governs publication and visibility of the object.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Exclude. The object is not published unless it is required. For example, if it is referenced by another object that is being published, or if it is involved in the relationship path between two objects that are being published. If this object is required, it is published but not visible.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Hide. The object is published but not visible.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="2">
- <xsd:annotation>
- <xsd:documentation>Include. The object is published and is visible.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="joinOptionProcessOuterJoinOption" type="xsd:boolean">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies a join option to create outer joins.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="joinOptionProcessExternalJoins" type="xsd:boolean">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies a join option between each imported query subject and all existing query subjects in the model.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="joinOptionProcessInternalJoins" type="xsd:boolean">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies a join option between the imported query subjects.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="joinOptionProcessKeys" type="xsd:boolean">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies a join option to use primary and foreign keys.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="joinOptionProcessMatchingIndexColumns" type="xsd:boolean">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies a join option to use matching query item names that represent uniquely indexed columns.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="joinOptionProcessMatchingQueryItemNames" type="xsd:boolean">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies a join option to use matching query item names.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="linkSegmentRootObject">
- <xsd:annotation>
- <xsd:documentation>
- <para>Either a namespace, a folder, the parameterMaps container object or the dataSources container object.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="maximumRowsToBeRetrieved">
- <xsd:annotation>
- <xsd:documentation>
- <para>A value of 0 means Do not execute.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:nonNegativeInteger"/>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="modelLocale" type="xsd:language">
- <xsd:annotation>
- <xsd:documentation>
- <para>Represents a locale that must exist in the model, under the project/locales property.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="modelPath" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>Represents the network path to an existing Framework Manager project. It could be a relative path to the base project. To be used in case of running action log stripts on temporary location.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="multidimensionalDimension" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>
- <para>The multidimensional dimension that represents the conformed dimension target.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="nameConflictOptionCreate" default="1">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies what to do if another object exists with the same name.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>The object is not created and an exception is thrown.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Create the object but make its name unique by appending a sequence number to it.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="nameConflictOptionImport">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies what to do with an imported object if its name conflicts with that of an object that already exists in the model.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Do not import the object. </xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Import the object but make its name unique by appending a sequence number to it.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="object">
- <xsd:annotation>
- <xsd:documentation>Can be any object in the model.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="newObjectName" type="fmsdk:objectName">
- <xsd:annotation>
- <xsd:documentation>Specifies a name for the new object.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="packageExists">
- <xsd:annotation>
- <xsd:documentation>Indicates whether or not the package already exists in the target location. In Framework Manager, this value is based on the result from a prior call to the IsModelViewPresent action.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>A package already exists with the same name and is in the same location as that of the specified package.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>No package exists with the same name in the same location as that of the specified package.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="parameterName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies the name of the parameter.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="parameterValue" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies the value of the parameter.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="promptName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies the name of a prompt.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="promptValue" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies the value of a prompt.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="publishTargetType">
- <xsd:annotation>
- <xsd:documentation>Specifies the type for the requested package.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>RESERVED for internal use only.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Framework Manager project on the network.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="2">
- <xsd:annotation>
- <xsd:documentation>Cognos 10 Content Manager package.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="3">
- <xsd:annotation>
- <xsd:documentation>RESERVED for internal use only.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="dependencySpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Conforms to the ImportSpec.xsd. Value represents a tree of the objects that depend on the upper-level objects, which in turn depend on the selected object (not shown on the tree).</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="qsapiResponseSpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specification not yet available.</para>
- <writerComment>need details from CQE</writerComment>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="parameterMap">
- <xsd:annotation>
- <xsd:documentation>Contains a collection of key-value pairs used to query a database.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="queryItemOrCalculation" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Either a query item or calculation object in the model.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="querySubject" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>A query subject in the Framework Manager model.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="querySubjectOrDimension" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>A query subject or dimension in the Framework Manager model. </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="reportItemOrReportItemContainer" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Any object in the Framework Manager model that can be reported against, or can contain such an object. These objects are: query subject, dimension, query item, query item folder, measure, measure folder, hierarchy, level and calculation. </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="updateSubject" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>An update subject in the Framework Manager model.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="regularPackage" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>A package object in the model whose isRoleBased property is set to false.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="reportObject" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>The objects that can be directly used in reports. For more information, see the Framework Manager model schema.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="roleBasedPackage" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>A package object in the model whose isRoleBased property is set to true.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="schemaPath" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Represents the network path to the current schema version.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="securityViewOrPackage" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Either a security view or regular package in the model. A regular package is one whose isRoleBased property is set to false.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="selectedObjectsProcessingLevel">
- <xsd:annotation>
- <xsd:documentation>Indicates whether to process only the selected objects or the selected objects and their children.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Process selected objects only.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Process selected objects and their children.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="shortcut">
- <xsd:annotation>
- <xsd:documentation>Defines a shortcut to an object.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="fmsdk:objectHandle"/>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="sourceObject" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Represents the source object for the action.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="targetLocation" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies the location of the Cognos 10 server.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="targetPackageName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies the name of the package.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="targetParent" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Represents the target parent object for the action.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="targetContainer" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Either a namespace or a folder.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="targetDimension" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>A multidimensional query subject that serves as the target of the conformed dimension.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="transaction">
- <xsd:annotation>
- <xsd:documentation>Maps to a transaction element in the action log.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:choice minOccurs="0" maxOccurs="unbounded">
- <xsd:element ref="fmsdk:AddLocale"/>
- <xsd:element ref="fmsdk:AddProperty"/>
- <xsd:element ref="fmsdk:BuildObjectReference"/>
- <xsd:element ref="fmsdk:Cancel"/>
- <xsd:element ref="fmsdk:CheckModel"/>
- <xsd:element ref="fmsdk:ClearDataSourceCache"/>
- <xsd:element ref="fmsdk:ConformedDimensionsCandidates"/>
- <xsd:element ref="fmsdk:ConformedDimensionsCreate"/>
- <xsd:element ref="fmsdk:ConformedDimensionsDetect"/>
- <xsd:element ref="fmsdk:Copy"/>
- <xsd:element ref="fmsdk:CountQuerySubject"/>
- <xsd:element ref="fmsdk:Create"/>
- <xsd:element ref="fmsdk:CreateCalculationInFolder"/>
- <xsd:element ref="fmsdk:CreateShortcut"/>
- <xsd:element ref="fmsdk:DBBrowse"/>
- <xsd:element ref="fmsdk:DBImport"/>
- <xsd:element ref="fmsdk:DBImportJoinsOnKeys"/>
- <xsd:element ref="fmsdk:DBMakePhysicalSqlName"/>
- <xsd:element ref="fmsdk:DBRelationshipPath"/>
- <xsd:element ref="fmsdk:DBRelease"/>
- <xsd:element ref="fmsdk:DBStoredProcedure"/>
- <xsd:element ref="fmsdk:DoDependencyAnalysis"/>
- <xsd:element ref="fmsdk:CloseQueryServicesConnection"/>
- <xsd:element ref="fmsdk:Delete"/>
- <xsd:element ref="fmsdk:DoReportsExist"/>
- <xsd:element ref="fmsdk:DoQueryServicesRequest"/>
- <xsd:element ref="fmsdk:doUpgrade"/>
- <xsd:element ref="fmsdk:EvaluateSecurityView"/>
- <xsd:element ref="fmsdk:ExpandParameters"/>
- <xsd:element ref="fmsdk:ExplainLogFile"/>
- <xsd:element ref="fmsdk:ExportTranslations"/>
- <xsd:element ref="fmsdk:ExpressionQuery"/>
- <xsd:element ref="fmsdk:externalizeQuerySubject"/>
- <xsd:element ref="fmsdk:FindOrCreateDataSource"/>
- <xsd:element ref="fmsdk:GenerateID"/>
- <xsd:element ref="fmsdk:GetApplicationVersion"/>
- <xsd:element ref="fmsdk:GetCandidateRelationships"/>
- <xsd:element ref="fmsdk:GetContentManagerGateway"/>
- <xsd:element ref="fmsdk:GetDataSourceConnectionSelections"/>
- <xsd:element ref="fmsdk:GetDataSourceInfo"/>
- <xsd:element ref="fmsdk:GetDefaultLocale"/>
- <xsd:element ref="fmsdk:GetNearestCommonParentObject"/>
- <xsd:element name="GetObjectAccess">
- <xsd:annotation>
- <xsd:documentation>
- <para>Returns the object security specifications on an object or set of objects. The resulting specifications consist of every role, account, and group currently in use in the model, with a corresponding rule (either allow, deny, or unspecified) for each. If an object is not directly secured, the rules are taken from the nearest parent object that is directly secured. If no such object exists, the rule returned for every role in the model is set to unspecified. If no roles exist in the model (that is, object security has not been specified on any object in the model), only the role called Everyone is returned, and its rule is set to unspecified.</para>
- <para>If multiple objects are specified, the rules for every role are merged. Conflicting rules are resolved in the following order of precedence: deny, allow, and then unspecified.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:object" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:objectAccess"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element ref="fmsdk:GetObjectAncestry"/>
- <xsd:element ref="fmsdk:GetPackageInclusionsForObject"/>
- <xsd:element ref="fmsdk:GetPassportFromCM"/>
- <xsd:element ref="fmsdk:GetPromptValues"/>
- <xsd:element ref="fmsdk:GetQueryProcessingMode"/>
- <xsd:element ref="fmsdk:GetRuntimeParameters"/>
- <xsd:element ref="fmsdk:GetSecurityObjectUsage"/>
- <xsd:element ref="fmsdk:GetSupportedLocales"/>
- <xsd:element ref="fmsdk:ImportTranslations"/>
- <xsd:element ref="fmsdk:IsModelViewPresent"/>
- <xsd:element ref="fmsdk:LinkModel"/>
- <xsd:element ref="fmsdk:MakeExpressionGlobal"/>
- <xsd:element ref="fmsdk:MakeObjectNameUnique"/>
- <xsd:element ref="fmsdk:Merge"/>
- <xsd:element ref="fmsdk:ModelBrowse"/>
- <xsd:element ref="fmsdk:ModelDiff"/>
- <xsd:element ref="fmsdk:ModelImport"/>
- <xsd:element ref="fmsdk:Modify"/>
- <xsd:element ref="fmsdk:ModifyComplex"/>
- <xsd:element ref="fmsdk:Move"/>
- <xsd:element ref="fmsdk:PopulateParameterMap"/>
- <xsd:element ref="fmsdk:PreviewSecurityFilter"/>
- <xsd:element ref="fmsdk:Publish"/>
- <xsd:element ref="fmsdk:RemoveLocale"/>
- <xsd:element ref="fmsdk:RemoveRuntimeParameters"/>
- <xsd:element ref="fmsdk:ReorderBefore"/>
- <xsd:element ref="fmsdk:Repair"/>
- <xsd:element ref="fmsdk:RepairReports"/>
- <xsd:element ref="fmsdk:ResetPromptValues"/>
- <xsd:element ref="fmsdk:RetargetObjectReferences"/>
- <xsd:element ref="fmsdk:RetrieveQueryItemParameters"/>
- <xsd:element ref="fmsdk:SegmentModel"/>
- <xsd:element ref="fmsdk:SelectDataSourceConnection"/>
- <xsd:element ref="fmsdk:SelectDataSourceCredentials"/>
- <xsd:element ref="fmsdk:SelectDataSourceDom"/>
- <xsd:element ref="fmsdk:SetActiveLocale"/>
- <xsd:element ref="fmsdk:SetDefaultLocale"/>
- <xsd:element ref="fmsdk:SetObjectAccess"/>
- <xsd:element ref="fmsdk:SetPackageLocales"/>
- <xsd:element ref="fmsdk:SetPromptValue"/>
- <xsd:element ref="fmsdk:SetQueryItemParameterMap"/>
- <xsd:element ref="fmsdk:SetSecurityViewAccess"/>
- <xsd:element ref="fmsdk:SetRuntimeParameters"/>
- <xsd:element ref="fmsdk:SetSecurityViewDefinition"/>
- <xsd:element ref="fmsdk:shouldUpgrade"/>
- <xsd:element ref="fmsdk:ShowImpact"/>
- <xsd:element ref="fmsdk:SQLPlanAssociation"/>
- <xsd:element ref="fmsdk:TestDataSource"/>
- <xsd:element ref="fmsdk:TestQuerySubject"/>
- <xsd:element ref="fmsdk:TransformCreateStarGrouping"/>
- <xsd:element ref="fmsdk:TransformFunction"/>
- <xsd:element ref="fmsdk:TransformObjectNames"/>
- <xsd:element ref="fmsdk:TransformQueryItemAggregateRule"/>
- <xsd:element ref="fmsdk:TransformQueryItemUsage"/>
- <xsd:element ref="fmsdk:TransformRelationship"/>
- <xsd:element ref="fmsdk:TranslateReference"/>
- <xsd:element ref="fmsdk:UseContentManager4Authentication"/>
- <xsd:element ref="fmsdk:Verify"/>
- <xsd:element ref="fmsdk:VerifyCMAuthentication"/>
- <xsd:element ref="fmsdk:GetAllPackages"/>
- <xsd:element ref="fmsdk:EvaluateObject"/>
- <xsd:element ref="fmsdk:UpdateQuerySubject"/>
- </xsd:choice>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="translationsFilePath" type="fmsdk:delimitedFilePath">
- <xsd:annotation>
- <xsd:documentation>
- <para>The translations file contains a special header record, with each field being the XML language ID of a locale in the model.</para>
- <para>For every multilingual property found, a record is created in the translations file. For every multilingual instance of the property, a field within the record is created.</para>
- <para>For example, if an object has a name property that has the value "my value" in English and the value "mon valeur" in French, the translations file will contain a header record containing fields "en" and "fr", as well as another record containing fields "my value" in the "en" column, and "mon valeur" in the "fr" column.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="AddLocale">
- <xsd:annotation>
- <xsd:documentation>
- <para>Adds a set of locales to the model.</para>
- <para>For each locale, the following occurs:</para>
- <bulletList>
- <listElement>A new instance of the locale property is created under project/locales in the model. The locale property value is set to the locale ID.</listElement>
- <listElement>For every multilingual property collection in the model that has a locale attribute, a new property instance is created. The locale attribute of the new property instance is set to the locale ID. The value of the new property instance is set to the same value as the property instance whose locale attribute matches the locale ID of the active locale, but is prefixed with the locale ID. For more information about multilingual properties, see the Framework Manager model schema. For more information about the active locale, see SetActiveLocale.</listElement>
- </bulletList>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="addLocales" type="fmsdk:localeCollection">
- <xsd:annotation>
- <xsd:documentation>The set of locales to be added to the model.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="keyLocale" type="xsd:language" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>Represents a language that must exist in the model, under the project/locales property. When creating the new multilingual property instances, the property values are based on the corresponding values of the same property in this locale. If not specified, the active locale is used as the key. For more information about the active locale, see SetActiveLocale.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="AddLocale">
- <inputparams>
- <param seq="1" type="stringCollection">
- <value>
- <stringCollection>
- <item>fr-ca</item>
- </stringCollection>
- </value>
- </param>
- <param seq="2" type="i18nstring">
- <value>en-us</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="AddProperty">
- <xsd:annotation>
- <xsd:documentation>Creates a new property and optionally sets its value.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:choice>
- <xsd:element name="parentObject" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the object to which this property relates.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="parentProperty" type="fmsdk:propertyHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the parent property to which this property relates.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:choice>
- <xsd:element name="propertyPath" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies the name and location of the property to be created.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:choice>
- <xsd:sequence>
- <xsd:element name="propertyValueTypeSimple" type="fmsdk:propertyValueTypeIdentifier" fixed="1">
- <xsd:annotation>
- <xsd:documentation>Identifies that the corresponding property value is simple.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="addPropertyValueSimple" type="fmsdk:simplePropertyValue">
- <xsd:annotation>
- <xsd:documentation>Identifies that the value set on the newly created property is simple.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- <xsd:sequence>
- <xsd:element name="propertyValueTypeComplex" type="fmsdk:propertyValueTypeIdentifier" fixed="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>Identifies that the corresponding property value is complex.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="addPropertyValueComplex" type="fmsdk:complexPropertyValue">
- <xsd:annotation>
- <xsd:documentation>
- <para>Identifies that the value set on the newly created property is complex.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:choice>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence maxOccurs="unbounded">
- <xsd:element name="createdProperty" type="fmsdk:propertyHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the name of the property added to the object or parent property.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="9" type="AddProperty">
- <inputparams>
- <param seq="1" type="handle">
- <value>[].[securityViews].[db2_pkg]</value>
- </param>
- <param seq="2" type="i18nstring">
- <value>securityView/functionSets</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="BuildObjectReference">
- <xsd:annotation>
- <xsd:documentation>
- <para>Takes in a parent object and a child object, and returns a virtual reference prefixed with the ID of the parent and suffixed with the last part of the ID of the child. Can assist in the communication of a refobjViaShortcut property as a single virtual object reference.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="parentObject" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the object to which the reference relates.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="childObjectHandle" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the handle of the child object to which the reference relates.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="builtObjectReference" type="fmsdk:objectReference">
- <xsd:annotation>
- <xsd:documentation>Specifies the compound name of the output object reference.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="Cancel">
- <xsd:annotation>
- <xsd:documentation>
- <para>Sets or resets the flag to cancel any currently running action.</para>
- <para>Note: This is the only action that must be called in a separate thread, concurrent with another running action in the same session.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="cancelFlagOption">
- <xsd:annotation>
- <xsd:documentation>Represents the value of the cancel flag. When its value is set to 1, the next operation is cancelled and the flag is cleared (reset to 0).</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Clears the cancel flag. Done immediately before calling an action, this clears any residual cancel setting.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Sets the cancel flag.
- <indent>
- <para>Use in a separate thread to stop waiting for the result of the last action.</para>
- </indent>
- <indent>
- <para>The cancel action returns normally, and a cancelled exception is thrown by the thread running the cancelled action.</para>
- </indent>
- <indent>
- <para>Cancel is checked at different points by different service components (including database servers). An exception is thrown as soon as the cancel has been detected and acted on by any part of the currently running action.</para>
- </indent>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="CheckModel">
- <xsd:annotation>
- <xsd:documentation>
- <para>Verifies the integrity of the model. </para>
- <writerComment>For a complete list of the tests that are performed, see "Verify_Model_tests.xls". </writerComment>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="verifyRoot" type="fmsdk:objectHandle" minOccurs="0" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>
- <para>If specified, this object and its descendants are verified. If not specified, the entire model is verified.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="modelErrorsDom" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Value conforms to the modelErrors.xsd. Contains the errors and warnings that were encountered as a result of running this action.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ConformedDimensionsCandidates">
- <xsd:annotation>
- <xsd:documentation source="sapbw"/>
- <xsd:documentation>
- <para>Takes in dimensiont that represents the conformed dimension target, and returns the list of every multidimensional dimension that belongs to a different data source than the data source of the conformed dimension target. Use this action to generate candidates for ConformedDimensionsDetect.</para>
- <para>Note: Applies to multidimensional dimensions (specifically of type SapBW) only.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:multidimensionalDimension"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:conformedDimensionCandidate" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ConformedDimensionsCreate">
- <xsd:annotation>
- <xsd:documentation source="sapbw">
- <para>Takes in a dimension that represents the conformed dimension target and a list of dimensions that represent conformed dimension candidates, and transforms the candidates into conformed dimensions of the target. The conformed dimension becomes a shortcut to the target dimension, and the references to its attributes are redirected to the query items of the target dimensions.</para>
- <para>Note: Applies to multidimensional dimensions (specifically of type SapBW) only.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:targetDimension"/>
- <xsd:element ref="fmsdk:conformedDimensionCandidate" maxOccurs="unbounded"/>
- <xsd:element name="conformedDimensionsCreateErrorOption">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies what to do if one of the candidates cannot be conformed.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Conformed dimensions are created for the candidates that can be conformed.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>No conformed dimensions are created and an exception is thrown specifying which candidates cannot be conformed.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="conformedDimension" type="fmsdk:objectHandle" minOccurs="0" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation source="sapbw">
- <para>A shortcut to a multidimensional dimension that serves as the conformed dimension target.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ConformedDimensionsDetect">
- <xsd:annotation>
- <xsd:documentation source="sapbw">
- <para>Takes in a dimension that represents the conformed dimension target and a list of dimensions that represent conformed dimension candidates, and returns the subset that can be conformed. Result is intended to serve as input to ConformedDimensionsCreate.</para>
- <para>Note: Applies to multidimensional dimensions (specifically of type SapBW) only.</para>
- <writerComment>(more details about conformed dimension can be found in CR0172 "DBC0033, SAP BW Conformed Dimension Support in Framework Manager.doc"</writerComment>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:targetDimension"/>
- <xsd:element ref="fmsdk:conformedDimensionCandidate" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:conformedDimensionCandidate" minOccurs="0" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="Copy">
- <xsd:annotation>
- <xsd:documentation>
- <para>Copies a set of objects and returns a reference to each created copy.</para>
- <para>Relationships or relationship shortcuts cannot be copied directly. Instead, they are copied if either one or both of their ends is specified to be copied. If both ends are specified, then the copied relationship has both copies as its own ends. Otherwise, if only one end is specified, the copied relationship has the specified end's copy as one end but its other end remains the same as that for the source relationship. The copied relationship is placed in the nearest common ancestor folder or namespace of its two ends.</para>
- <para>If you copy object A, and it has references to another object, object B that is also being copied, any references within the object A copy will refer to the object B copy.</para>
- <para>If a package is specified, then the sole securityView it references is also copied and the copied package then references the copied securityView.</para>
- <para>A copied object is always left unsecured, regardless of whether or not its corresponding source object was secured. For more information, see the SetObjectAccess action.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:targetParent"/>
- <xsd:element ref="fmsdk:sourceObject" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="copiedObject" type="fmsdk:objectHandle" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>Represents the reference to the created copy.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="Copy">
- <inputparams>
- <param seq="1" type="handle">
- <value>[oracle_gosales].[New Folder]</value>
- </param>
- <param seq="2" type="handle">
- <value>[oracle_gosales].[EUROCONVERSION]</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="CountQuerySubject">
- <xsd:annotation>
- <xsd:documentation>
- <para>Counts the number of rows in the result set of a given query subject or a dimension.</para>
- <para>Note: For the query subject representing the facts of an SAP BW data source, the number of rows is always 1.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:querySubject"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="rowCount" type="xsd:nonNegativeInteger">
- <xsd:annotation>
- <xsd:documentation>Contains the number of rows in the result set. </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited"/>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="Create">
- <xsd:annotation>
- <xsd:documentation>
- <para>Creates a new object under a given target parent.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:group ref="fmsdk:inputParamsCreate"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="createdObject" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Defines the object created by the action.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="Create">
- <inputparams>
- <param seq="1" type="integer">
- <value>1</value>
- </param>
- <param seq="2" type="handle">
- <value>[db2_gosales1]</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="CreateCalculationInFolder">
- <xsd:annotation>
- <xsd:documentation>
- <para>Takes in a number of query items and creates standalone calculations in the specified folder or namespace.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:targetContainer"/>
- <xsd:element name="sourceQueryItem" type="fmsdk:objectHandle" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>Specifies the input query items for the action.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="calculation" type="fmsdk:objectHandle" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>Represents the calculation that is created in the specified folder.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="CreateShortcut">
- <xsd:annotation>
- <xsd:documentation>
- <para>Creates shortcuts to a given set of objects, places them under a given target, and returns a reference to each created shortcut.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:targetContainer" minOccurs="0"/>
- <xsd:element name="shortcutSourceObject" type="fmsdk:objectHandle" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the object for which a shortcut is created.</para>
- <para>Note: The model does not support shortcuts to shortcuts. If the specified object is a shortcut, the new shortcut is created to its target, not to itself.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="relationshipShortcutOption" default="0" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies whether or not relationship shortcuts should be created.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>No relationship shortcuts are created.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Relationship shortcuts are created to relationships found between the selected query subjects, and between any selected query subject and any other query subject in the model.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="2">
- <xsd:annotation>
- <xsd:documentation>Relationship shortcuts are created only for relationships found between the selected query subjects.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="createdShortcut" type="fmsdk:objectHandle" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>Represents the created shortcut.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="CreateShortcut">
- <inputparams>
- <param seq="1" type="handle">
- <value>NULL</value>
- </param>
- <param seq="2" type="handle">
- <value>[SQL_GoSales].[ORDERDETAIL]</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="DBBrowse">
- <xsd:annotation>
- <xsd:documentation>
- <para>Expands a database tree view from which objects can be selected and imported. This action does not impact the model. The browse tree is intended as a base to modify for input to either the DBimport or ModelImport actions.</para>
- <para>Note: Modifies input parameters.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:importSourceSpecDataSource"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="2" type="DBBrowse">
- <inputparams>
- <param seq="1" type="node">
- <value>
- <importSpec>
- <item Name="SQL_GoSales" Type="database" Value="partial">
- <item Name="GOSALES" Type="catalog" Value="partial">
- <item Name="dbo" Type="schema" Value="partial">
- <item Name="Tables" Type="tables" Value="true">
- <item Name="CONVERSIONRATE" Type="table" Value="true"/>
- <item Name="COUNTRY" Type="table" Value="true"/>
- <item Name="EUROCONVERSION" Type="table" Value="true"/>
- <item Name="ORDERDETAIL" Type="table" Value="true"/>
- <item Name="ORDERHEADER" Type="table" Value="true"/>
- <item Name="ORDERMETHOD" Type="table" Value="true"/>
- <item Name="PRODUCT" Type="table" Value="true"/>
- <item Name="PRODUCTFORECAST" Type="table" Value="true"/>
- <item Name="PRODUCTLINE" Type="table" Value="true"/>
- <item Name="PRODUCTTYPE" Type="table" Value="true"/>
- <item Name="RETURNEDITEM" Type="table" Value="true"/>
- <item Name="RETURNREASON" Type="table" Value="true"/>
- <item Name="SALESBRANCH" Type="table" Value="true"/>
- <item Name="SALESSTAFF" Type="table" Value="true"/>
- <item Name="SALESTARGET" Type="table" Value="true"/>
- </item>
- <item Name="Views" Type="views" Value="false"/>
- <item Name="Synonyms" Type="synonyms" Value="false"/>
- <item Name="Procedures" Type="procedures" Value="false"/>
- <item Name="Functions" Type="functions" Value="false"/>
- </item>
- </item>
- </item>
- </importSpec>
- </value>
- </param>
- </inputparams>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="DBImport">
- <xsd:annotation>
- <xsd:documentation>
- <para>Imports database objects. This action impacts the model.</para>
- <writerComment>Please consult "FM Relational Database Import FS.doc" for more information.</writerComment>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:targetContainer"/>
- <xsd:element ref="fmsdk:importSourceSpecDataSource"/>
- <xsd:choice>
- <xsd:group ref="fmsdk:dbImportInputParametersRelational"/>
- <xsd:group ref="fmsdk:dbImportInputParametersSAPBW"/>
- </xsd:choice>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="2" type="DBImport">
- <inputparams>
- <param seq="1" type="handle">
- <value>[SQL_GoSales]</value>
- </param>
- <param seq="2" type="node">
- <value>
- <importSpec>
- <item Name="SQL_GoSales" Type="database" Value="partial">
- <item Name="GOSALES" Type="catalog" Value="partial">
- <item Name="dbo" Type="schema" Value="partial">
- <item Name="Tables" Type="tables" Value="true">
- <item Name="CONVERSIONRATE" Type="table" Value="true"/>
- <item Name="COUNTRY" Type="table" Value="true"/>
- <item Name="EUROCONVERSION" Type="table" Value="true"/>
- <item Name="ORDERDETAIL" Type="table" Value="true"/>
- <item Name="ORDERHEADER" Type="table" Value="true"/>
- <item Name="ORDERMETHOD" Type="table" Value="true"/>
- <item Name="PRODUCT" Type="table" Value="true"/>
- <item Name="PRODUCTFORECAST" Type="table" Value="true"/>
- <item Name="PRODUCTLINE" Type="table" Value="true"/>
- <item Name="PRODUCTTYPE" Type="table" Value="true"/>
- <item Name="RETURNEDITEM" Type="table" Value="true"/>
- <item Name="RETURNREASON" Type="table" Value="true"/>
- <item Name="SALESBRANCH" Type="table" Value="true"/>
- <item Name="SALESSTAFF" Type="table" Value="true"/>
- <item Name="SALESTARGET" Type="table" Value="true"/>
- </item>
- <item Name="Views" Type="views" Value="false"/>
- <item Name="Synonyms" Type="synonyms" Value="false"/>
- <item Name="Procedures" Type="procedures" Value="false"/>
- <item Name="Functions" Type="functions" Value="false"/>
- </item>
- </item>
- </item>
- </importSpec>
- </value>
- </param>
- <param seq="3" type="integer">
- <value>0</value>
- </param>
- <param seq="4" type="integer">
- <value>1</value>
- </param>
- <param seq="5" type="integer">
- <value>1</value>
- </param>
- <param seq="6" type="integer">
- <value>0</value>
- </param>
- <param seq="7" type="integer">
- <value>0</value>
- </param>
- <param seq="8" type="integer">
- <value>0</value>
- </param>
- <param seq="9" type="integer">
- <value>0</value>
- </param>
- </inputparams>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="DBImportJoinsOnKeys">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for internal use. Detects relationships in a given set of query subjects. Relationships are detected through the primary keys and foreign keys in a given data source against a specific data source. Used by TransformRelationship when the value for its joinOptionProcessKeys input parameter is 1 (use primary and foreign keys). This action impacts the model.</para>
- <para>Note: Not applicable for SAP BW data sources.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="joinOptionProcessInternalOrExternalJoins">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies whether to create joins between selected query subjects or between each of them and others.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Joins are created between selected query subjects.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Joins are created between each selected query subject and existing query subjects.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element ref="fmsdk:joinOptionProcessOuterJoinOption"/>
- <xsd:element ref="fmsdk:dataSource"/>
- <xsd:element ref="fmsdk:querySubject" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="DBMakePhysicalSqlName">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for internal use. Converts an arbitrary string into a valid SQL name. This action does not impact the model.</para>
- <para>Note: Not applicable for SAP BW data sources.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="dbObjectName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The original name.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="sqlObjectName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The output name that is suitable for the Cognos Query Engine parser.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="DBRelationshipPath">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for internal use. Retrieves all joins, using primary and foreign keys, between two database tables, based on corresponding query subject names. This action does not impact the model.</para>
- <para>Note: Not applicable for SAP BW data sources.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="ImportSpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>The database ImportSpec. This ImportSpec node contains at least two child nodes representing the two tables. Each child node must contain a "namePattern" element. For more information, see the file called ImportSpec.xsd.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="expressionList" type="fmsdk:stringCollection">
- <xsd:annotation>
- <xsd:documentation>Represents the list of joins between the two input database tables.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ImportIQD">
- <xsd:annotation>
- <xsd:documentation>
- <para>Imports an IQD (Impromptu Query Definition) file. This action creates a database query subject based on the sql statement specified in the IQD file.</para>
- <para>Note: This action is used by Cognos Metrics Loader (PD).</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="IQDFilePath" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The IQD file path location.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="ImportedFolder" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>
- <para>A folder in the model where the query subject will be created in.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="IQDFileSpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>The specification of the IQD file. This spec node conforms to either the "dbConnectionsSpec.xsd" or "iqdFileSpec.xsd".</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="TestConnectionString">
- <xsd:annotation>
- <xsd:documentation>
- <para>Tests a relational or multidimensional database connection string.</para>
- <para>Note: This action is used by Cognos Metrics Loader (PD).</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="connectionString" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The raw or full connection string.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="username" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The optional user name (if the first param is a raw connection string specified a prompt for user name.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="password" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The optional password (if the first param is a raw connection string specified a prompt for password.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="DBRelease">
- <xsd:annotation>
- <xsd:documentation>
- <para>Releases the connections to all databases currently connected. Should be called after a DBImport or a TransformRelationship action. This action does not impact the model.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="3" type="DBRelease">
- <inputparams/>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="DBStoredProcedure">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for internal use.</para>
- <para>Imports an individual stored procedure. Used for creating a query subject from a database stored procedure. This action impacts the model.</para>
- <para>Note: Not applicable for SAP BW data sources.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="storedProcedureQuerySubject" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>
- <para>A stored procedure query subject in the model.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="storedProcedureSpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>An ImportSpec node that contains the specified stored procedure in the data source. This specified item must contain the "namePattern" element. For more information, see the file called ImportSpec.xsd.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="Delete">
- <xsd:annotation>
- <xsd:documentation>
- <para>Removes a set of objects and/or properties.</para>
- <para>Whenever an object is deleted, any references to it become broken. Each broken reference is handled as follows:</para>
- <bulletList>
- <listElement>If the property containing the reference has allowMissingTarget=true specified in the mapping section of the file CR1 Behaviors.xml, the property is left untouched. If the object containing the reference property has a status property (for example, a relationship) or is a child of an object that has a status property (for example, a query subject), the status property is set to needsReevaluation. To see which objects have a status property, see the Framework Manager model schema.</listElement>
- <listElement>If the property containing the reference does not have allowMissingTarget=true, the deletion cascades as follows:
- <bulletList>
- <listElement>the property is deleted, and</listElement>
- <listElement>if the property is mandatory (as defined in the model schema) with respect to its parent (property or object), that parent is also deleted. The deletion propagates up the ancestry until either the deleted parent is an object (such as a query subject or query item), or a property that is non-mandatory with respect to its parent.</listElement>
- </bulletList>
- </listElement>
- <listElement>Typically, properties that allow missing (broken) references are complex properties that contain valuable information which would be lost if the property were deleted, and that can be manually repaired. Examples include expressions and compound keys.</listElement>
- <listElement>Properties that do not allow missing references are simple properties. Examples include shortcut targets and relationship ends.</listElement>
- </bulletList>
- <para>If a package is specified, its corresponding security view is also deleted. If the package is role-based, any object specified within that package that is not referenced by any other role-based package has its secured property reset to unsecured.</para>
- <para>Note: Not applicable to query items and query item folders belonging to query subjects of type database or multidimensional.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:group ref="fmsdk:inputParamsDelete" maxOccurs="unbounded"/>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="Delete">
- <inputparams>
- <param seq="1" type="handle">
- <value>[].[packages].[P3]</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="DoReportsExist">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for future use.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="DoQueryServicesRequest">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for internal use. Executes a query services (QSAPI) request.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="qsapiRequestSpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>For more information, see the files qsapi2.xsd and query_cr1.xsd.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:qsapiResponseSpec"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="doUpgrade">
- <xsd:annotation>
- <xsd:documentation>RESERVED for internal use only. Upgrades the model to conform to the current schema version.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:modelPath"/>
- <xsd:element ref="fmsdk:schemaPath"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="EvaluateSecurityView">
- <xsd:annotation>
- <xsd:documentation>
- <para>Takes in a set of security views and/or packages and returns a unique set of pairs, each pair containing an object and its corresponding rule. The includeRule is set to either Include or Hide. The process is as follows:</para>
- <bulletList>
- <listElement>Initialize result set for this view to be empty.</listElement>
- <listElement>Iterate through each set S in the view and group all viewRefs in a set V and all objects in a set O</listElement>
- <listElement>Recursively evaluate every view in V and add each object/rule combination to the result set for this view. In the case of a conflict, that is if the same object occurs repeatedly in the views with conflicting rules, Include takes precedence over Hide.</listElement>
- <listElement>Process every object in O in order of shallowest, or nearest to the root namespace in the model, to the deepest, and do the following:
- <bulletList>
- <listElement>If the includeRule is Include or Hide, add the object and all its descendants to the result set with the given rule. If any of the objects being added already exist in the result set, then replace its current rule.</listElement>
- <listElement>If the includeRule is Exclude, then remove the object and all its descendants from the result set.</listElement>
- </bulletList>
- </listElement>
- </bulletList>
- <para>If multiple views are passed into the action, each is evaluated on its own, and all result sets are unioned with Include taking precedence over Hide in the case of conflicts.</para>
- <para>Note: Not applicable to models based on SAP BW data sources in this release.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:securityViewOrPackage" maxOccurs="unbounded"/>
- <xsd:element name="roleBasedViewEvaluationLevel" default="0" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>When role-based packages are specified to this action, this option specifies whether or not to merge their evaluation results with those for the "Everyone" role.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>When evaluating role-based packages, do not merge the evaluation results with those for the "Everyone" role.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>When evaluating role-based packages, merge the evaluation results with those for the "Everyone" role.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:reportObject" maxOccurs="unbounded"/>
- <xsd:element ref="fmsdk:includeRule"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ExpandParameters">
- <xsd:annotation>
- <xsd:documentation>Expands (resolves) a parameterized string based on the current settings of session parameters and parameter maps. Examples of session parameters are "account.defaultName", "account.personalInfo.userName", and "runLocale".</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="parameterizedValue" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Represents the input parameter value.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="expandedValue" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Represents the expanded value of the input parameter.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ExplainLogFile">
- <xsd:annotation>
- <xsd:documentation>Provides an explanation for an action found in an action log.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:choice>
- <xsd:element name="actionSpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the action.</para>
- <writerComment>Need a schema for this?</writerComment>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="actionXML" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the action.</para>
- <writerComment>Need a schema for this?</writerComment>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:choice>
- <xsd:element name="explainLevel">
- <xsd:annotation>
- <xsd:documentation>Specifies the level of explanation that will be provided. When set to 1, detailed explanations are provided.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>A summary-level explanation is returned for the given action.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>A detailed explanation is returned for the given action.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="explainMessage" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Contains the text of the explanation.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ExportTranslations">
- <xsd:annotation>
- <xsd:documentation>
- <para>Builds a translations file from the multilingual properties in the model.</para>
- <para>Note: SAP BW variable information is stored using custom properties. Locale-specific information is stored in these custom properties, but is currently not exported to, or imported from, translation files.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:translationsFilePath"/>
- <xsd:sequence minOccurs="0">
- <xsd:element name="exportLocales" type="fmsdk:localeCollection">
- <xsd:annotation>
- <xsd:documentation>
- <para>The set of locales to be exported. All must exist in the model. If not specified, all locales in the model are exported.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:element name="exportTranslationsRootObject" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>
- <para>The set of objects from which to extract the multilingual values that are restricted to this object or any of its descendants. If no objects are specified, all objects in the model are processed.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:element ref="fmsdk:selectedObjectsProcessingLevel"/>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="ExportTranslations">
- <inputparams>
- <param seq="1" type="i18nstring">
- <value>E:\sanity\fm_690\win32\bin\myTranslations.csv</value>
- </param>
- <param seq="2" type="stringCollection">
- <value>
- <stringCollection>
- <item>fr-ca</item>
- </stringCollection>
- </value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ExpressionQuery">
- <xsd:annotation>
- <xsd:documentation>Executes an expression and returns the result set.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:createAutoSummary"/>
- <xsd:element name="expression" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Represents the expression to be executed.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element ref="fmsdk:maximumRowsToBeRetrieved"/>
- <xsd:element ref="fmsdk:executionReportDetailLevel"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:qsapiResponseSpec"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="FindOrCreateDataSource">
- <xsd:annotation>
- <xsd:documentation>Used as part of centralized management of data sources. Given a set of data source identifiers, the action looks up a data source in the model and if it is not found, creates a new one.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="dataSourceIndicator" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>Place holder only. Sets the value to a symbolic indicator of the data source that is used in qualifying table names in the SQL of query subjects.</para>
- <para>Note: Also an output parameter, if overwritten during execution.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element ref="fmsdk:crnDataSourceName"/>
- <xsd:sequence minOccurs="0">
- <xsd:element ref="fmsdk:catalogName"/>
- <xsd:sequence minOccurs="0">
- <xsd:element ref="fmsdk:schemaName"/>
- <xsd:sequence minOccurs="0">
- <xsd:element name="cubeName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the name of a cube.</para>
- <para>Note: Applies only to multidimensional data sources</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:dataSource"/>
- <xsd:element name="findOrCreateDataSourceStatus">
- <xsd:annotation>
- <xsd:documentation>
- <para>Indicates whether a matching data source existed in the model or needed to be created as a result of executing this action.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Data source already exists in the model.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Data source was created.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="FindOrCreateDataSource">
- <inputparams>
- <param seq="1" type="i18nstring">
- <value/>
- </param>
- <param seq="2" type="i18nstring">
- <value>oracle_gosales</value>
- </param>
- <param seq="3" type="i18nstring">
- <value/>
- </param>
- <param seq="4" type="i18nstring">
- <value>GOSALES</value>
- </param>
- </inputparams>
- <domchanges/>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GenerateID">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for internal use.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetApplicationVersion">
- <xsd:annotation>
- <xsd:documentation>Returns the current Framework Manager SDK version.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="version" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Contains the current version of the Framework Manager SDK.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetCandidateRelationships">
- <xsd:annotation>
- <xsd:documentation>
- <para>Takes in a pair of query subjects and determines if there are any relationships between them.</para>
- <para>Note: Not applicable to models based on SAP BW data sources.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="firstRelationshipEndCandidate" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the first query subject.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="secondRelationshipEndCandidate" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the second query subject.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="relationshipSearchType">
- <xsd:annotation>
- <xsd:documentation>Specifies the type of search to perform. When set to 0, a quick search is performed. When set to 1, an exhaustive search is performed.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Quick. Finds any relationship having both:
- <bulletList>
- <listElement>one of its ends matching one of the ends passed into this action, AND</listElement>
- <listElement>its other end matching the other end passed into this action, OR any shortcut to it.</listElement>
- </bulletList>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Exhaustive. Finds any relationship having:
- <bulletList>
- <listElement>one of its ends matching one of the ends passed into this action, OR any shortcut to it, AND </listElement>
- <listElement>its other end matching the other object passed into this action, OR any shortcut to it.</listElement>
- </bulletList>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="relatonship" type="fmsdk:objectHandle" minOccurs="0" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>
- <para>Represents a relationship object in the model.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetContentManagerGateway">
- <xsd:annotation>
- <xsd:documentation>
- <para>Returns the gateway configuration parameter.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence maxOccurs="unbounded">
- <xsd:element ref="fmsdk:gatewayURI"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetDataSourceConnectionSelections">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for internal use.</para>
- <para>Returns user selection for ambiguous connection and/or sign-on for a given data source that is set by SelectDataSourceConnection.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:dataSourceName"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:crnDataSourceConnectionName"/>
- <xsd:element ref="fmsdk:crnDataSourceConnectionSignonName"/>
- <xsd:element ref="fmsdk:crnDataSourceConnectionSignonUser"/>
- <xsd:element ref="fmsdk:crnDataSourceConnectionSignonPassword"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ClearDataSourceCache">
- <xsd:annotation>
- <xsd:documentation>
- <para>Clears the cache of all datasource connection information for the current session. ClearDataSourceCache should be called when logging off or resetting any cached datasource values. This action does not impact the model.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetDataSourceInfo">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for internal use.</para>
- <para>Returns information about a given data source.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:dataSourceName"/>
- <xsd:element name="dataSourceQuery" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>Note: Also an output parameter, if overwritten during execution.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="interfaceClass" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>Note: Also an output parameter, if overwritten during execution.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetDefaultLocale">
- <xsd:annotation>
- <xsd:documentation>
- <para>Returns the default locale in the model. For more information, see SetDefaultLocale.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="defaultLocale" type="xsd:language">
- <xsd:annotation>
- <xsd:documentation>
- <para>Value is that of the project/defaultLocale property in the Framework Manager model.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetMatchingModelLocale">
- <xsd:annotation>
- <xsd:documentation>
- <para>Takes in a locale ID and returns the ID of the locale in the model that best matches it, using CRN's standard locale-matching algorithm. If multiple matches are found, the first matching locale is retuend. If no matches are found, the default locale (refer to SetDefaultLocale action) is returned.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="candidateLocale" type="xsd:language"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:modelLocale"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="Delete">
- <inputparams>
- <param seq="1" type="handle">
- <value>[].[packages].[P3]</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetNearestCommonParentObject">
- <xsd:annotation>
- <xsd:documentation>Takes in a set of objects and returns the nearest common ancestor between them.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:object" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="nearestCommonAncestor" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Returns the nearest parent object for the input object.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetObjectAncestry">
- <xsd:annotation>
- <xsd:documentation>
- <para>Returns the ancestry of a given object, in top-down order starting from the root.</para>
- <para>Note: The object passed in is also returned as one of the ancestors.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:object"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence maxOccurs="unbounded">
- <xsd:element name="ancestor">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies an ancestor of the object passed to the action.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetPackageInclusionsForObject">
- <xsd:annotation>
- <xsd:documentation>
- <para>Returns information about an object, specifically whether or not the object is included, excluded or hidden with respect to every package or security view in the model. The role-based packages for which the object is unsecured, that is no rule is specified for it or any of its ancestors, are not returned.</para>
- <para>A triplet is returned for each security view or package that gets returned, consisting of:</para>
- <bulletList>
- <listElement>the same source report object passed into the action,</listElement>
- <listElement>the current security view or package, and</listElement>
- <listElement>the inclusion rule for the report object current security view or package.</listElement>
- </bulletList>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:reportObject"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence minOccurs="0" maxOccurs="unbounded">
- <xsd:element ref="fmsdk:reportObject"/>
- <xsd:element ref="fmsdk:securityViewOrPackage"/>
- <xsd:element ref="fmsdk:includeRule"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetPassportFromCM">
- <xsd:annotation>
- <xsd:documentation>
- <para>Takes in a set of credentials and attempts to authenticate to the Cognos 10 server whose location is specified in the configuration parameter called sdk. If authentication is successful, a session is established with the Cognos 10 server and the session's passport ID is returned. If authentication fails, an exception is thrown.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="credentialsSpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Must conform to the formFieldVars section of BI Bus Header specification. It can be NULL, which means that the authentication is attempted as anonymous.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="passportID" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies the ID of the established Cognos 10 server session.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetPromptValues">
- <xsd:annotation>
- <xsd:documentation>Returns a list of prompt values set during the session, either as a list of prompt-value pairs, or as a DOM element.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:choice>
- <xsd:sequence>
- <xsd:element name="promptNames" type="fmsdk:stringCollection">
- <xsd:annotation>
- <xsd:documentation>Specifies the names of the prompts.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="promptValues" type="fmsdk:stringCollection">
- <xsd:annotation>
- <xsd:documentation>Specifies the prompt values.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- <xsd:element name="parametersNode" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>A node that conforms to the "parameters" element of query services request (for more information, refer to the "Parameters" section of the Cognos 10 SDK documentation).</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:choice>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetQueryProcessingMode">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for internal use.</para>
- <para>Returns the query processing model, databaseOnly versus limitedLocal, for a given data source.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:dataSourceName"/>
- <xsd:element name="processingMode" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies the mode of processing for this data source.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetRuntimeParameters">
- <xsd:annotation>
- <xsd:documentation>
- <para>Returns session parameters and their values for the current user for the current session.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="getRuntimeParameterType">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies whether to retrieve original parameter values or overrides. For more information, see SetRuntimeParameters.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Only original values are requested, no overrides.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Only overridden values are requested.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="runtimeParametersSpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specified in runtimeParameters.xsd.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetSecurityObjectUsage">
- <xsd:annotation>
- <xsd:documentation>
- <para>Determines the set of security objects found in the access list of each security view in the model, and returns this set in the form of a one-to-many mapping between the security object and the security views that contain it.</para>
- <para>Note: A security object is either an account, a group, or a role.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="packageType" default="0" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>Specifies whether to return information pertaining to regular packages, role-based packages, or both.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Return information pertaining to both "regular" and "role-based" packages.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Return information pertaining to "regular" packages only.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="2">
- <xsd:annotation>
- <xsd:documentation>Return information pertaining to "role-based" packages only.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="securityObjectSpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Conforms to the securityObjectSpec.xsd.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="GetSupportedLocales">
- <xsd:annotation>
- <xsd:documentation>Returns all locales that exist in the model, as found in the project/locales property.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="modelLocales" type="fmsdk:localeCollection">
- <xsd:annotation>
- <xsd:documentation>Represents all locales that are supported for the model.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ImportTranslations">
- <xsd:annotation>
- <xsd:documentation>
- <para>Imports a set of translations into the model.</para>
- <para>For any multilingual property, its value in the keyLocale parameter is searched against the corresponding keyLocale column in the translations file. If a matching record is found in the translations file, then any other value for the property, that is any other value in the other locales, is updated with the value in the corresponding locale (if one exists) from the found translations record. For more information about the translations file format, see ExportTranslations.</para>
- <para>If the value being updated refers to an object name which collides with the name of another object, then the update still occurs but the name of the value is made unique by appending a sequence number to it.</para>
- <para>Note: SAP BW variable information is stored using custom properties. Locale-specific information is stored in these custom properties, but is currently not exported to, or imported from, translation files.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:group ref="fmsdk:inputParamsImportTranslations"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="updatedMultilingualProperty" type="fmsdk:propertyHandle" minOccurs="0" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>
- <para>Represents the set of multilingual properties that were updated as a result of this action.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="ImportTranslations">
- <inputparams>
- <param seq="1" type="i18nstring">
- <value>E:\sanity\fm_690\win32\bin\languages.csv</value>
- </param>
- <param seq="2" type="i18nstring">
- <value>en-us</value>
- </param>
- <param seq="3" type="stringCollection">
- <value>
- <stringCollection>
- <item>fr-ca</item>
- </stringCollection>
- </value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="IsModelViewPresent">
- <xsd:annotation>
- <xsd:documentation>
- <para>Determines if a given package has already been published to the Cognos 10 server and, if so, returns its path as found in Cognos 10, as well as corresponding versioning information.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:regularPackage"/>
- <xsd:element ref="fmsdk:publishTargetType"/>
- <xsd:element ref="fmsdk:targetLocation"/>
- <xsd:element ref="fmsdk:targetPackageName"/>
- <xsd:element name="packageNames" type="xsd:string" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>Lists the names of the packages that are found in Cognos 10 that match the name of the selected package.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:packageExists"/>
- <xsd:element name="currentRetentionValue" type="xsd:integer">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the retention value from Cognos 10 for model objects with the selected package.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="existingModelCount" type="xsd:nonNegativeInteger">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the number of models versions that already exist in the package in Cognos 10.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="LinkModel">
- <xsd:annotation>
- <xsd:documentation>
- <para>Establishes a link to the given object under the selected parent.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="linkParent">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the parent object that contains the link in the current model. The object must be either a namespace, a folder, the parameterMaps container object, or the dataSources container object.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="targetModelConnection" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the connection string of the project that contains the object to be linked.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="linkObjectPath" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the object to link to in the target model and is encoded as an Xpath-like expression.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="persistLink">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies whether to persist the link or not.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>The link only exists for the current user session and is not saved when the model is saved.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>The link is saved when the model is saved.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="LinkModel">
- <inputparams>
- <param seq="1" type="handle">
- <value>[link]</value>
- </param>
- <param seq="2" type="i18nstring">
- <value>E:\my_projects\link_segment_master\New Folder\NewFolder.cpf</value>
- </param>
- <param seq="3" type="i18nstring">
- <value>/project/namespace/folder</value>
- </param>
- <param seq="4" type="integer">
- <value>0</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="MakeExpressionGlobal">
- <xsd:annotation>
- <xsd:documentation>
- <para>Transforms an embedded filter or calculation into a stand-alone filter or calculation, and replaces the embedded filter or calculation with a reference to the newly created object.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:expression"/>
- <xsd:element name="suggestedName" type="xsd:string" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>If not specified, a default name is provided for the newly created object.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="createdExpressionObject">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies either a calculation or filter.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="MakeObjectNameUnique">
- <xsd:annotation>
- <xsd:documentation>
- <para>Takes in an object type and a target parent and returns a name for the specified object type that is unique in the context of the specified target parent.</para>
- <para>The base name for the object can be optionally specified as the newObjectName parameter. If not specified, a reasonable default is provided. The base name is returned as the new name if it is unique in the target context, otherwise a unique name is created by appending a sequence number to the base name.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="objectType" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies the type of the input object.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element ref="fmsdk:targetParent"/>
- <xsd:sequence minOccurs="0">
- <xsd:element ref="fmsdk:newObjectName"/>
- <xsd:sequence minOccurs="0">
- <xsd:element name="uniquenessNamingSpecification">
- <xsd:annotation>
- <xsd:documentation>Specifies the action to take in the event the new object name already exists.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>If the value of newObjectName collides with another object name, an appropriate sequence number is appended to it.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation source="1">If the value of newObjectName collides with another object name, it is prefixed with "Copy of".</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="2">
- <xsd:annotation>
- <xsd:documentation>The value of newObjectName is always prefixed with "Shortcut to".</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="3">
- <xsd:annotation>
- <xsd:documentation>If the value of newObjectName collides with another object name, it is prefixed with "Shortcut to".</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="uniqueObjectName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Represents the assigned unique name for the new object.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="Merge">
- <xsd:annotation>
- <xsd:documentation>
- <para>Merges the specified source objects into a new model query. Sources can be query subjects, dimensions, query items, query item folders, measures, measure folders, shortcuts, calculations, filters, relationships and relationship shortcuts. Selecting a relationship or a relationship shortcut has the same effect as selecting the left and right end objects as the sources. The Merge action may optionally create new relationships (or relationship shortcuts) between the target and the query subjects that were related to any of the source query subjects, unless the other end of the relationship also appears in the selected sources, and the expression of the relationship includes a query item that no longer appears in the target. </para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="mergeSourceObject" type="fmsdk:objectHandle" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>Specifies the source object to merge.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="mergeCreateRelationship">
- <xsd:annotation>
- <xsd:documentation>Specifies whether or not to create a relationship (and relationship shortcut) between the new merged query subject and the query subjects (and shortcuts) that were related to the sources. </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Retain the merge source objects passed into this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Delete the merge source objects passed into this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="mergeResultTargetObject" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the merged target query subject that was either specified as the mergeTargetObject input parameter or created if the input parameter was NULL. </para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="Merge">
- <inputparams>
- <param seq="1" type="handle">
- <value>NULL</value>
- </param>
- <param seq="2" type="handle">
- <value>[oracle_gosales].[New Query Subject1]</value>
- </param>
- <param seq="3" type="handle">
- <value>[oracle_gosales].[New Query Subject2]</value>
- </param>
- <param seq="4" type="integer">
- <value>0</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ModelBrowse">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for future use. </para>
- <para>Expands a node in a model browse tree. This action does not impact the model.</para>
- <para>Note: This action modifies input parameters.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:modelPath"/>
- <xsd:element ref="fmsdk:importSourceSpecModel"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ModelDiff">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for future use.</para>
- <para>Compares the current package in the model with a version that already exists in Cognos 10 and returns a difference result document.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="passport" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The passport to a valid Cognos 10 session.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element ref="fmsdk:regularPackage"/>
- <xsd:element name="outputResults" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>An XML document that describes the difference results.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="returnCode" type="xsd:nonNegativeInteger">
- <xsd:annotation>
- <xsd:documentation>
- <para>A numeric return code to indicate success or failure.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ModelImport">
- <xsd:annotation>
- <xsd:documentation>
- <para>Imports a Framework Manager model into a specified namespace or folder in a Framework Manager model. This action impacts the model.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:modelPath"/>
- <xsd:element ref="fmsdk:importSourceSpecModel"/>
- <xsd:element ref="fmsdk:targetContainer"/>
- <xsd:element ref="fmsdk:nameConflictOptionImport"/>
- <xsd:sequence minOccurs="0">
- <xsd:element name="displaySummaryOption" default="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies whether to display information regarding the results of the action.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Do not display summary information.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Display summary information.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:element name="containerConflictOption" default="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies how to process namespaces or folder objects that are in conflict with existing objects.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Do nothing for conflicting namespaces or folders, except what is specified for the nameConflictOptionImport parameter.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Do not import the namespace or folder but keep processing its children, using the existing namespace or folder as the target parent for the copied children. In this case, the value for the nameConflictOptionImport parameter is not taken into effect for namespaces or folders.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:element name="emptyContainerOption" default="1">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies whether or not to permit empty namespaces or folders to be imported.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Do not import empty namespaces or folders.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Import empty namespaces or folders.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="ModelImport">
- <inputparams>
- <param seq="1" type="i18nstring">
- <value>../temp/CRN_model_import/CRN_model_import.cpf</value>
- </param>
- <param seq="2" type="cclnode">
- <value>
- <item Name="Model" Type="folder" Value="true" uniqueName="[oracle_gosales]">
- <item Name="CONVERSIONRATE" Type="querySubject" Value="true" uniqueName="[oracle_gosales].[CONVERSIONRATE]"/>
- <item Name="COUNTRY" Type="querySubject" Value="true" uniqueName="[oracle_gosales].[COUNTRY]"/>
- <item Name="EUROCONVERSION" Type="querySubject" Value="true" uniqueName="[oracle_gosales].[EUROCONVERSION]"/>
- </item>
- </value>
- </param>
- <param seq="3" type="handle">
- <value>[oracle_gosales]</value>
- </param>
- <param seq="4" type="integer">
- <value>1</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="Modify">
- <xsd:annotation>
- <xsd:documentation>
- <para>Updates the value of an existing simple property, that is, one that has no child properties.</para>
- <para>In most cases, the property is updated with the specified value and the lastChanged property of the parent object is also updated accordingly. However, additional behavior can occur depending on the type of the property, as follows:</para>
- <bulletList>
- <listElement>
- <para>If the specified property is the object's name, all references to that object, or any of its children, are updated with its name.</para>
- <para>For example, if the name of a query subject in namespace NS is being modified from "CTRY" to "COUNTRY", any object references with the value of [NS]. [CTRY] are updated to [NS.[COUNTRY]. Also, if the query subject has a query item named COUNTRY_CODE, any reference to that query item is also updated from [NS].[CTRY].[COUNTRY_CODE] to [NS].[COUNTRY].[COUNTRY_CODE].</para>
- </listElement>
- <listElement>If the specified property is the name of a package, the package's corresponding security view is also updated with the same name.</listElement>
- <listElement>If the specified property is the object being referenced on one end of a relationship or relationship shortcut, the parentage of the relationship or relationship shortcut needs to be re-assessed, as it must exist in the nearest common ancestor of its two ends.</listElement>
- <listElement>
- <para>If the property being modified is the secured property of an object, all references to that object within role-based packages are removed.</para>
- <writerComment>See GMS068 "Object Based Security".</writerComment>
- </listElement>
- <listElement>
- <para>If the specified property is a calculation's data type, its usage and aggregate rules may also change in accordance with the aggregate transformation rules of Framework Manager.</para>
- <writerComment>For more information, see "FM Usage AggregateTransformations.doc"</writerComment>
- </listElement>
- <listElement>If the specified property is a query item's usage, and
- <bulletList>
- <listElement>it has changed from fact to some other value, both its regularAggregate and semiAggregate properties are set to unsupported.</listElement>
- <listElement>it has changed from some value other than fact, both its regularAggregate and semiAggregate properties are set to sum.</listElement>
- <listElement>it has changed from some value other to fact, its existing value for the corresponding promptType property must be set to serverDetermined.</listElement>
- </bulletList>
- </listElement>
- <listElement>If the specified property is a query item's promptType and the corresponding usage property has a value of fact, then the value being set on promptType must be serverDetermined.
- </listElement>
- <listElement>If the specified property is a package's maxVersions property, and the value passed in is an empty string, then the property is removed from the model. Removal means that model versioning is turned off when the package is published to Cognos 10.</listElement>
- </bulletList>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:group ref="fmsdk:inputParamsModify"/>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="Modify">
- <inputparams>
- <param seq="1" type="handle">
- <value>/O/name[0]/O/[]</value>
- </param>
- <param seq="2" type="i18nstring">
- <value>db2</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ModifyComplex">
- <xsd:annotation>
- <xsd:documentation>
- <para>Updates the value of an existing complex property, one that contains other properties. </para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="complexProperty" type="fmsdk:propertyHandle">
- <xsd:annotation>
- <xsd:documentation>
- <para>A property that can contain child properties as defined in the schema.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:choice>
- <xsd:element name="newComplexValueString" type="fmsdk:complexPropertyValue">
- <xsd:annotation>
- <xsd:documentation>Specifies that the value of the complex property being updated is a string. </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="newComplexValueSpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>Must conform to the same specification as the property in question. For more information, see the Framework Manager model schema.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:choice>
- <xsd:element name="forceModify" type="xsd:boolean" default="false" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>If true, an update is forced, even if the specified value is not valid. </para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="Move">
- <xsd:annotation>
- <xsd:documentation>
- <para>Moves a set of objects to a new target parent object. The following behavior may also occur:</para>
- <bulletList>
- <listElement>If an object is being moved to a different namespace, and the name of the object collides with that of another object in that namespace, the object is made unique by appending a sequence number to it.</listElement>
- <listElement>A relationship or relationship shortcut must always exist in the nearest common ancestor of its two ends. Whenever a query subject, or shortcut to a query subject, is moved, the location of any relationship to it may also be moved in order to meet this constraint. Conversely, if the user tries to explicitly move a relationship, then either or both of its ends may also be moved in order to meet this constraint.</listElement>
- </bulletList>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:group ref="fmsdk:inputParamsMove"/>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="2" type="Move">
- <inputparams>
- <param seq="1" type="handle">
- <value>[New Namespace]</value>
- </param>
- <param seq="2" type="handle">
- <value>[SQL_GoSales].[CONVERSIONRATE]</value>
- </param>
- <param seq="3" type="handle">
- <value>[SQL_GoSales].[COUNTRY]</value>
- </param>
- <param seq="4" type="handle">
- <value>[SQL_GoSales].[EUROCONVERSION]</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="PopulateParameterMap">
- <xsd:annotation>
- <xsd:documentation>Populates a parameter map object based on entries in a specified file, where every key-value pair is delimited and appears on a separate line.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:parameterMap"/>
- <xsd:element name="parameterMapEntriesSourceFilePath" type="fmsdk:delimitedFilePath">
- <xsd:annotation>
- <xsd:documentation>Specifies the path name of the source file containing the entries for the parameter map.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="nameConflictOptionPopulateParameterMap" default="0" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>Specifies the action to take in the event that a naming conflict occurs.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Update existing entries.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Create new entries, but make their names unique by appending a sequence number to them.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="PreviewSecurityFilter">
- <xsd:annotation>
- <xsd:documentation>Security filters can be based on other security filters defined for user groups and roles. In such cases, this action constructs an expression based on all inherited security filters, when it is passed a security filter definition.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="securityFilter" type="fmsdk:propertyHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the input security filter definition.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="inheritedSecurityFilterExpression" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies an expression that results from the AND-ing of relevant security filters.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="Publish">
- <xsd:annotation>
- <xsd:documentation>
- <para>Publishes a package to either the network or Cognos 10.</para>
- <para>Builds a new model containing the subset of the existing model as defined in the package. The published model contains the objects included in the package. Any objects that are required by the included objects are also published, to ensure that no broken object references exist in the published model and no unexpected cross-join errors occur.</para>
- <para>If object security exists in the model, then the security views for all role-based packages are written to the published model; however, the only objects in these views are those being published. Objects that are not being published are ignored. A special role-based view named with an underscore (_) is also created, which contains an evaluation of only the secured objects within the root namespace hierarchy.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:group ref="fmsdk:inputParamsPublish"/>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence minOccurs="0">
- <xsd:element name="publishedPackageDisplayPath" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the path to the published package using the active locale. For more information, see the "SetActiveLocale" action.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:element name="adminAccessSpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Must conform to the securityObjectSpec.xsd. Its value represents the list of those who can administer (which includes republishing and deleting) a package that has been published to Cognos 10. The list is usually the same as the list found in the Framework Manager model as the value of the property package/adminAccess/decisionRole. If the package is being published for the first time and the list in the Framework Manager model is empty, the value is set to whomever has SetPolicy permission on the published package in Cognos 10.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- <xsd:element ref="fmsdk:externalizeReport" minOccurs="0"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="11" type="Publish">
- <inputparams>
- <param seq="1" type="handle">
- <value>[].[packages].[db2_pkg]</value>
- </param>
- <param seq="2" type="integer">
- <value>2</value>
- </param>
- <param seq="3" type="i18nstring">
- <value>/content</value>
- </param>
- <param seq="4" type="i18nstring">
- <value>db2_pkg</value>
- </param>
- <param seq="5" type="integer">
- <value>0</value>
- </param>
- <param seq="6" type="integer">
- <value>0</value>
- </param>
- <param seq="7" type="integer">
- <value>0</value>
- </param>
- </inputparams>
- <domchanges/>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="RemoveLocale">
- <xsd:annotation>
- <xsd:documentation>
- <para>Removes a set of locales from the model.</para>
- <para>For every locale that is requested for removal, the following occurs:</para>
- <bulletList>
- <listElement>The instance of the locale property under project/locales that matches the locale ID is deleted.</listElement>
- <listElement>The locale instance of any multilingual property whose locale ID matches is deleted. For a description of multilingual properties, see AddLocale.</listElement>
- </bulletList>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="removeLocales" type="fmsdk:localeCollection">
- <xsd:annotation>
- <xsd:documentation>Specifies the set of locales to be removed from the model.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="RemoveLocale">
- <inputparams>
- <param seq="1" type="i18nstring">
- <value>ja-jp</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="RemoveRuntimeParameters">
- <xsd:annotation>
- <xsd:documentation>Removes specified session parameters from the session.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:parameterName" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="RemoveRuntimeParameters">
- <inputparams>
- <param seq="1" type="i18nstring">
- <value>runLocale</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ReorderBefore">
- <xsd:annotation>
- <xsd:documentation>
- <para>Reorders a set of object(s) before a given target parent, or at the end if the target object is NULL. All specified objects must belong to the same parent.</para>
- <para>Note: Not applicable to query items and query item folders belonging to multidimensional query subjects.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="reorderObject" type="fmsdk:objectHandle" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the object being reordered.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="reorderBeforeObject" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies that all objects are moved before this object. Parameter can be NULL, in which case the reordered objects are moved to the end.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="ReorderBefore">
- <inputparams>
- <param seq="1" type="handle">
- <value>[oracle_gosales].[EUROCONVERSION].[EUROYEAR]</value>
- </param>
- <param seq="2" type="handle">
- <value>[oracle_gosales].[EUROCONVERSION].[COUNTRYCODE]</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="Repair">
- <xsd:annotation>
- <xsd:documentation>
- <para>Reruns a Verify action on a given set of objects, and runs any possible repairs on them, if necessary.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="repairObject" type="fmsdk:objectReference" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>Specifies the object to be repaired.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="Repair">
- <inputparams>
- <param seq="1" type="i18nstring">
- <value>[oracle_gosales].[New Query Subject]</value>
- </param>
- <param seq="2" type="i18nstring">
- <value>[oracle_gosales].[New Query Subject]</value>
- </param>
- <param seq="3" type="i18nstring">
- <value>[oracle_gosales].[New Query Subject]</value>
- </param>
- <param seq="4" type="i18nstring">
- <value>[oracle_gosales].[New Query Subject]</value>
- </param>
- <param seq="5" type="i18nstring">
- <value>[oracle_gosales].[New Query Subject]</value>
- </param>
- <param seq="6" type="i18nstring">
- <value>[oracle_gosales].[New Query Subject]</value>
- </param>
- <param seq="7" type="i18nstring">
- <value>[oracle_gosales].[New Query Subject]</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="RepairReports">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for future use.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ResetPromptValues">
- <xsd:annotation>
- <xsd:documentation>
- <para>When no argument is specified, all prompts set during the session are removed.</para>
- <para>The overloaded form, with the single argument, only sets a flag to either use prompt values that are set during the session, or not use them.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence minOccurs="0">
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="useSetPromptValues" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>Specifies whether prompt values that are set during the session are to be used.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Use the prompt values set during the session</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Do not use the prompt values set during the session.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="2" type="ResetPromptValues">
- <inputparams/>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="RetargetObjectReferences">
- <xsd:annotation>
- <xsd:documentation>
- <para>Changes a set of specified object references to point to a specified object.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="retargetObjectReferencesSpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>Specified in the file called retargetObjectReferencesSpec.xsd.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="updatedRefobj" type="fmsdk:propertyHandle" minOccurs="0" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the object reference properties updated as a result of executing this action.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="RetrieveQueryItemParameters">
- <xsd:annotation>
- <xsd:documentation>
- <para>Retrieves and returns key-value pairs for a given query item-based parameter map.</para>
- <para>Note: Query item-based parameter maps for SAP BW data sources are not supported in this release.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="queryItemBasedParameterMap" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the query item-based parameter map for which to return the key-value pairs.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="retrievedKeys" type="fmsdk:stringCollection">
- <xsd:annotation>
- <xsd:documentation>Represents the keys retrieved for the specified parameter map.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="retrievedValues" type="fmsdk:stringCollection">
- <xsd:annotation>
- <xsd:documentation>Represents the values retrieved for the specified parameter map.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="SegmentModel">
- <xsd:annotation>
- <xsd:documentation>
- <para>Takes in a specified object and creates a new project that contains a copy of the specified object and all its descendents. The specified object is then removed from the current project and replaced with a link to the copied object in the newly created project.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="segmentObject" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the object to be segmented, whose type must be one of the following: namespace, folder, parameter map, data source.
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="segmentTargetModelPath" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>The path of the model to be created that will contain the new segment.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="sourceControlRepositoryPath" type="xsd:string" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies that the model to be created will be placed under source control, and will be in the path within the repository, as specified here.</para>
- <para>Value syntax is dependent on the source control system in use.</para>
- <writerComment>We should still clarify this syntax.</writerComment>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="SegmentModel">
- <inputparams>
- <param seq="1" type="handle">
- <value>[oracle_gosales].[New Folder]</value>
- </param>
- <param seq="2" type="i18nstring">
- <value>E:\my_projects\link_segment_master\New Folder\New Folder.cpf</value>
- </param>
- <param seq="3" type="i18nstring">
- <value/>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="SelectDataSourceConnection">
- <xsd:annotation>
- <xsd:documentation>
- <para>Captures user selections for connection and/or signon information, when more than one is available to this user for a data source.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:crnDataSourceName"/>
- <xsd:element ref="fmsdk:crnDataSourceConnectionName"/>
- <xsd:element ref="fmsdk:crnDataSourceConnectionSignonName" minOccurs="0"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="SelectDataSourceConnection">
- <inputparams>
- <param seq="1" type="i18nstring">
- <value>FM_UNITTESTS_SAMPLEDB_OR</value>
- </param>
- <param seq="2" type="i18nstring">
- <value>Market_Research</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="SelectDataSourceCredentials">
- <xsd:annotation>
- <xsd:documentation>
- <para>Captures user selections for data source signon information when none is provided in the connection string.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:crnDataSourceName"/>
- <xsd:element ref="fmsdk:crnDataSourceConnectionName"/>
- <xsd:element ref="fmsdk:crnDataSourceConnectionSignonUser"/>
- <xsd:element ref="fmsdk:crnDataSourceConnectionSignonPassword"/>
- <xsd:element ref="fmsdk:crnDataSourceConnectionCubePassword" minOccurs="0"/>
- <xsd:element ref="fmsdk:crnDataSourceConnectionCubePasswordEncrypted" minOccurs="0"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="2" type="SelectDataSourceCredentials">
- <inputparams>
- <param seq="1" type="i18nstring">
- <value>FM_UNITTESTS_SAMPLEDB_OR</value>
- </param>
- <param seq="2" type="i18nstring">
- <value>Market_Research</value>
- </param>
- <param seq="3" type="i18nstring">
- <value>GOMR0104</value>
- </param>
- <param seq="4" type="i18nstring">
- <value>GOMR0104</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="SelectDataSourceDom">
- <xsd:annotation>
- <xsd:documentation>
- <para>Captures user selections for connection and/or signon information. This action works similarly to the SelectDataSourceConnection and SelectDataSourceCredentials actions. The difference is in the input parameters.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="ConnectionDom" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Value conforms to RS_API/specification/QF_XML_API.xsd.</para>
- <para>When connecting to Cognos Planning or Cognos Finance, an ASTicket element is required.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="SelectDataSourceDom">
- <inputparams>
- <param seq="1" type="node">
- <value>
- <connection>
- <QFProviderType value="MQProvider"/>
- <productLocale value="en"/>
- <runLocale value="en-us"/>
- <serviceID value="RSVP"/>
- <sessionID value="G89C2G48hvhGh8yM44yhvMdvyydvj4CG92yjCM2y"/>
- <CAMPassport value="010:deeeb2a5-9588-11d9-9583-9f7582494569:0293004495"/>
- <contentManagerURI value="http://127.0.0.1:9300/p2pd/servlet"/>
- <dataSource value="/content/package[@name='cubePassword11']/model[@name='2005-03-15T19:38:26.121Z']"/>
- <connection>
- <QFProviderType value="Database"/>
- <dataSource value="cubePassword"/>
- <cubePassword encrypted="" value="olap"/>
- <searchPath value="CAMID(":")/dataSource[@name='cubePassword']/dataSourceConnection[@name='cubePassword']"/>
- </connection>
- </connection>
- </value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="SetActiveLocale">
- <xsd:annotation>
- <xsd:documentation>
- <para>Sets the active locale in the current user session.</para>
- <para>The active locale is the locale that is used by the Framework Manager SDK as the basis for specifying default object names. For example, in a model that has both English and French locales, if you call the Create action to create a query subject and do not specify a name for it:</para>
- <bulletList>
- <listElement>If the active locale is English, the default name of the object will be "New Query Subject".</listElement>
- <listElement>If the active locale is French, the default name of the object will be "Nouveau sujet de requeste".</listElement>
- </bulletList>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:modelLocale"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="SetActiveLocale">
- <inputparams>
- <param seq="1" type="i18nstring">
- <value>en-us</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="SetDefaultLocale">
- <xsd:annotation>
- <xsd:documentation>
- <para>Changes the default locale, the property project/defaultLocale, in the model. All object references are also updated, as the default locale is the locale in which they are encoded.</para>
- <para>For example, in a model that contains both English and French locales, where the default locale is English, if an object has the name "object" in English and "objet" in French, all references to that object appear as "object". If this action is called on the same model to change the default locale to French, then all references to the same object will now be changed to "objet".</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:modelLocale"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="SetDefaultLocale">
- <inputparams>
- <param seq="1" type="i18nstring">
- <value>en-us</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="SetObjectAccess">
- <xsd:annotation>
- <xsd:documentation>
- <para>Sets object-based security in the model.</para>
- <para>For more information, see the file called objectAccess.xsd.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:object" maxOccurs="unbounded"/>
- <xsd:element ref="fmsdk:objectAccess"/>
- <xsd:element name="unspecifiedRolesProcessing" default="0" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies what the rule should be set for roles that exist in the model but not accounted for in the "objectAccess" parameter above.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Remove any existing "allow" or "deny" rule(s) specified for the role(s).</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>For any of the specified objects that are directly secured, leave all existing security rights specified on the give role(s) as is.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="2">
- <xsd:annotation>
- <xsd:documentation>Leave all existing security rights specified on the give role(s) as is for all specified objects, regardless of whether they are directly secured or secured via a parent object that is directly secured.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="SetPackageLocales">
- <xsd:annotation>
- <xsd:documentation>
- <para>Updates the list of locales in a given package, in the package/locales property. This list represents the set of locales that appear in the published model. For example, in a model containing English, French, and German, if you publish a package, and this package has only English and French in its locales list, the published model will only contain English and French property values.</para>
- <para>Updating the list of locales has the following restrictions:</para>
- <bulletList>
- <listElement>The default locale must always appear in this list. For more information, see SetDefaultLocale.</listElement>
- <listElement>If this package includes another package, the set of locales must contain as a minimum all of the locales specified in that other package.</listElement>
- </bulletList>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:regularPackage"/>
- <xsd:sequence minOccurs="0" maxOccurs="unbounded">
- <xsd:element ref="fmsdk:modelLocale"/>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="6" type="SetPackageLocales">
- <inputparams>
- <param seq="1" type="handle">
- <value>[].[packages].[db2_pkg]</value>
- </param>
- <param seq="2" type="i18nstring">
- <value>en-us</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="SetPromptValue">
- <xsd:annotation>
- <xsd:documentation>Associates a value, simple or complex, with a prompt name for the duration of a Framework Manager session. The values are used in subsequent actions that involve expressions containing prompts, for example TestQuerySubject, ExpressionQuery, or for modifying the definition of a model querySubject that uses that prompt.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:promptName"/>
- <xsd:choice>
- <xsd:element ref="fmsdk:promptValue"/>
- <xsd:element name="promptValueDom" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies a complex prompt value (for more information, refer to the "Parameters" section of the Cognos 10 SDK documentation).</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:choice>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="SetQueryItemParameterMap">
- <xsd:annotation>
- <xsd:documentation>
- <para>Sets the definition of a specified parameter map based on a pair of key-value query items. The key and value query items must belong to the same query subject.</para>
- <para>Note: Query item-based parameter maps for SAP BW data sources are not supported in this release.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="parameterMap" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Contains a collection of key-value pairs used to query a database.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="parameterMapKeyQueryItem" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the key for the query item.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="parameterMapValueQueryItem" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the value for the query item.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="2" type="SetQueryItemParameterMap">
- <inputparams>
- <param seq="1" type="handle">
- <value>[].[parameterMaps].[pM3]</value>
- </param>
- <param seq="2" type="handle">
- <value>[SQL_GoSales].[PRODUCT].[PRODUCTNUMBER]</value>
- </param>
- <param seq="3" type="handle">
- <value>[SQL_GoSales].[PRODUCT].[PRODUCTNAME]</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="SetSecurityViewAccess">
- <xsd:annotation>
- <xsd:documentation>
- <para>Takes in either a package or a security view and a list of user groups or roles and does the following:</para>
- <bulletList>
- <listElement>If the specified object is a security view, its corresponding access list is updated with the specified user groups or roles. The access list of a security view specifies those who can use the published package corresponding to the security view.</listElement>
- <listElement>If the specified object is a package, its corresponding admin access list is updated with the specified user groups or roles. The admin access list of a package specifies those who can administer the published package, including republishing and deleting it.</listElement>
- </bulletList>
- <para>Note: Security views are not supported for models based on SAP BW data sources in this release.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:securityViewOrPackage"/>
- <xsd:element name="securePackage">
- <xsd:annotation>
- <xsd:documentation>Specifies whether or not the package is to be secured.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Not secured. If specified, the corresponding input accessList parameter is ignored.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Secured. If specified, the corresponding input accessList must be specified.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="accessListSpec" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Must conform to the securityObjectSpec.xsd. Its value specifies the list of those who can access the package or security view for report authoring and/or execution purposes in Cognos 10.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="3" type="SetSecurityViewAccess">
- <inputparams>
- <param seq="1" type="handle">
- <value>[].[securityViews].[db2_pkg]</value>
- </param>
- <param seq="2" type="integer">
- <value>1</value>
- </param>
- <param seq="3" type="cclnode">
- <value>
- <securityObjects>
- <securityObject type="group">
- <displayPath>Everyone [Directory > Cognos]</displayPath>
- <cmSearchPath>CAMID("::Everyone")</cmSearchPath>
- </securityObject>
- </securityObjects>
- </value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="SetRuntimeParameters">
- <xsd:annotation>
- <xsd:documentation>
- <para>Changes the value of a session parameter for the duration of the Framework Manager session. Effectively overrides the value initially associated with this parameter, for the current session.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence minOccurs="0" maxOccurs="unbounded">
- <xsd:element ref="fmsdk:parameterName"/>
- <xsd:element ref="fmsdk:parameterValue"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="SetRuntimeParameters">
- <inputparams>
- <param seq="1" type="i18nstring">
- <value>runLocale</value>
- </param>
- <param seq="2" type="i18nstring">
- <value>EN</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="SetSecurityViewDefinition">
- <xsd:annotation>
- <xsd:documentation>
- <para>Replaces the definition for a given security view or package.</para>
- <para>Note: Security views are not supported for models based on SAP BW data sources in this release.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:securityViewOrPackage"/>
- <xsd:sequence maxOccurs="unbounded">
- <xsd:choice>
- <xsd:element ref="fmsdk:reportObject"/>
- <xsd:element name="securityView" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies a security view object in the model.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:choice>
- <xsd:element ref="fmsdk:includeRule"/>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="2" type="SetSecurityViewDefinition">
- <inputparams>
- <param seq="1" type="handle">
- <value>[].[securityViews].[db2_pkg]</value>
- </param>
- <param seq="2" type="handle">
- <value>[db2_gosales1]</value>
- </param>
- <param seq="3" type="integer">
- <value>2</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="shouldUpgrade">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for internal use only. Compares the model version and the schema version to determine if the model needs upgrading.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:modelPath"/>
- <xsd:element ref="fmsdk:schemaPath"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="modelSchemaVersionComparisonResult">
- <xsd:annotation>
- <xsd:documentation>Represents the result of the comparison between the model and the schema.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="-1">
- <xsd:annotation>
- <xsd:documentation>The specified schema path does not match the schema path that exists in the model.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>The schema version that exists in the specified model matches the version of the specified schema.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>The schema version that exists in the specified model is older than the version of the specified schema.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="2">
- <xsd:annotation>
- <xsd:documentation>The schema version that exists in the specified model is more recent than the version of the specified schema.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:element name="modelVersionNumber" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Represents the version number of the model.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="schemaVersionNumber" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Represents the version number of the schema.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="ShowImpact">
- <xsd:annotation>
- <xsd:documentation>RESERVED for internal use.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="passport" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies a passport for a valid Cognos 10 session.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="selectedModelItems" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>No specification yet.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element ref="fmsdk:gatewayURI"/>
- <xsd:element name="outputResults" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>An XML document that describes the search results.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="returnCode" type="xsd:nonNegativeInteger">
- <xsd:annotation>
- <xsd:documentation>
- <para>A numeric return code that indicates success or failure.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="SQLPlanAssociation">
- <xsd:annotation>
- <xsd:documentation>
- <para>Plans, and possibly executes, a relationship between two query subjects or dimensions based on a given join expression. Plan means to generate and prepare the SQL, and describe the result set.</para>
- <writerComment>[get details from CQE]</writerComment>
- <para>Note: Not applicable to models based on SAP BW data sources.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="relationshipName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies the name of the relationship to be generated.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="leftEndReference" type="fmsdk:objectReference">
- <xsd:annotation>
- <xsd:documentation>Specifies the reference for the left end of the relationship to be generated.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="leftEndCardinality" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies the cardinality for the left end of the relationship to be generated.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="rightEndReference" type="fmsdk:objectReference">
- <xsd:annotation>
- <xsd:documentation>Specifies the reference for the right end of the relationship to be generated.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="rightEndCardinality" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>Specifies the cardinality for the right end of the relationship to be generated.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element ref="fmsdk:expression"/>
- <xsd:element ref="fmsdk:createAutoSummary"/>
- <xsd:element ref="fmsdk:maximumRowsToBeRetrieved"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:qsapiResponseSpec"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="TestDataSource">
- <xsd:annotation>
- <xsd:documentation>
- <para>Tests a data source object based on its corresponding connection information stored in Cognos 10. An exception is thrown if the test is unsuccessful.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:dataSource"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="TestQuerySubject">
- <xsd:annotation>
- <xsd:documentation>
- <para>Executes a request based on specified objects or their contained items and returns the result set.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:reportItemOrReportItemContainer" maxOccurs="unbounded"/>
- <xsd:element ref="fmsdk:maximumRowsToBeRetrieved"/>
- <xsd:sequence minOccurs="0">
- <xsd:element name="applyRelevantDesignModeFilters" type="xsd:boolean" default="true">
- <xsd:annotation>
- <xsd:documentation>Specifies the filters to apply.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:element ref="fmsdk:executionReportDetailLevel"/>
- <xsd:sequence minOccurs="0">
- <xsd:element name="suppressDivisionByZeroErrors" type="xsd:boolean" default="true" minOccurs="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>If set to true, suppresses possible division-by-zero errors, and a NULL value is returned.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:qsapiResponseSpec"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="TransformCreateStarGrouping">
- <xsd:annotation>
- <xsd:documentation>
- <para>Creates a stand-alone grouping for a given set of query subjects or dimensions. The result is a set of query subjects that includes a single fact query subject and its neighboring query subjects or, a set of dimensions that include a measure dimension and its neighbouring dimensions. The created grouping is stand-alone in that all relationships within the grouping are self-contained and do not refer to any object outside the grouping.
- </para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:querySubjectOrDimension" maxOccurs="unbounded"/>
- <xsd:sequence minOccurs="0">
- <xsd:element name="transformType" default="0">
- <xsd:annotation>
- <xsd:documentation>
- <para>The primary distinction.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Create Shortcut. Creates a shortcut to every source query subject (or dimension), and a relationship shortcut for every relationship that exists for each source query subject (or dimension). </xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Move. Moves all source query subjects (or dimensions) to the specified target, except for any having a relationship where the other end of the relationship is not one of the source query subjects (or dimensions). In this case, creates a shortcut and new relationships between the other source query subjects (or dimensions), or the shortcuts created for them.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:element name="transformTarget" default="1">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies where the new grouping will be placed.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>New Folder. Creates a new folder where this new grouping is placed.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>New Namespace. Creates a new namespace where this new grouping is placed.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="2">
- <xsd:annotation>
- <xsd:documentation>Same. The target parent for the grouping is the nearest common parent of all source query subjects (or dimensions).</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:element name="transformSelection" default="1">
- <xsd:annotation>
- <xsd:documentation>
- <para>The overall behavior of the action changes depending on the value specified for this parameter.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Single. The first source query subject (or dimension) specified is considered a fact, and all other source query subjects (or dimensions) are considered regular dimensions. This affects behavior as follows:
- <bulletList>
- <listElement>If transformType is 1 (Move), the fact gets moved unconditionally.</listElement>
- <listElement>If transformTarget is 2 (Same), the grouping is created under the same parent as the fact, rather than the nearest common parent of all source query subjects (or dimensions) specified.</listElement>
- <listElement>If the starSchemaGroupingName parameter is not specified and transformTarget is either 0 (New Folder) or 1 (New Namespace), the name of the fact is used as the basis for the name of the folder or namespace being created to contain the grouping.</listElement>
- </bulletList>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Multiple. All query subjects (or dimensions) are treated like dimensions, and behavior does not differ from that described for the other parameters.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- <xsd:sequence minOccurs="0">
- <xsd:element name="starSchemaGroupName" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>Applicable only if transformType is 0 (New Folder) or 1 (New Namespace). If a name is not specified, a reasonable default is provided.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="starGroupingResultObject" type="fmsdk:objectHandle" maxOccurs="unbounded">
- <xsd:annotation>
- <xsd:documentation>Represents the output result set.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="TransformCreateStarGrouping">
- <inputparams>
- <param seq="1" type="handle">
- <value>[SQL_GoSales].[PRODUCT]</value>
- </param>
- <param seq="2" type="handle">
- <value>[SQL_GoSales].[ORDERDETAIL]</value>
- </param>
- <param seq="3" type="handle">
- <value>[SQL_GoSales].[PRODUCTFORECAST]</value>
- </param>
- <param seq="4" type="handle">
- <value>[SQL_GoSales].[PRODUCTTYPE]</value>
- </param>
- <param seq="5" type="integer">
- <value>0</value>
- </param>
- <param seq="6" type="integer">
- <value>1</value>
- </param>
- <param seq="7" type="integer">
- <value>0</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="TransformFunction">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for future use.</para>
- <para>Converts a query subject whose type is "stored procedure unknown" to a function object. This action impacts the model.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="storedProcedureQuerySubject" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the query subject to transform.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="procParameter" type="fmsdk:propertyHandle">
- <xsd:annotation>
- <xsd:documentation>
- <para>The return parameter of the function (selected by the user).</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="removeSourceQuerySubject">
- <xsd:annotation>
- <xsd:documentation>Specifies what to do with the source query subject, once the transformation has occurred.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Do not remove the source query subject.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Remove the source query subject.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="TransformObjectNames">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for future use.</para>
- <para>Converts all underscores, hyphens, and spaces to a single space, capitalizes the first character of each word in the name, and decapitalizes the remainder. For example, "BRANCH_CD" becomes "Branch Cd". This action impacts the model.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:object" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="TransformQueryItemAggregateRule">
- <xsd:annotation>
- <xsd:documentation>
- <para>Determines regular aggregate and semi-aggregate rules for a given set of query items and calculations. This action impacts the model and behaves as follows:</para>
- <bulletList>
- <listElement>If the data type of the item is either numeric or time interval and its usage is fact:
- <bulletList>
- <listElement>if the item is a query item, set both semiAggregate and regularAggregate to sum.</listElement>
- <listElement>otherwise (it must be a calculation), set both semiAggregate and regularAggregate to automatic.</listElement>
- </bulletList>
- </listElement>
- <listElement>If the data type of the item is either numeric or time interval but its usage is not fact, set regularAggregate to count and semiAggregate to unsupported.</listElement>
- <listElement>If the data type of the item is neither numeric nor time interval, set both regularAggregate and semiAggregate to unsupported.</listElement>
- </bulletList>
- <para>Note: Not applicable to query items belonging to multidimensional query subjects as their aggregate values are predetermined.</para>
- <para>For more information about setting aggregate rules, see the topic "Modifying How Query Items are Aggregated" in the Framework Manager User Guide. </para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:reportItemOrReportItemContainer" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="TransformQueryItemAggregateRule">
- <inputparams>
- <param seq="1" type="handle">
- <value>[oracle_gosales].[CONVERSIONRATE]</value>
- </param>
- <param seq="2" type="handle">
- <value>[oracle_gosales].[COUNTRY]</value>
- </param>
- <param seq="3" type="handle">
- <value>[oracle_gosales].[EUROCONVERSION]</value>
- </param>
- <param seq="4" type="handle">
- <value>[oracle_gosales].[ORDERDETAIL]</value>
- </param>
- <param seq="5" type="handle">
- <value>[oracle_gosales].[ORDERHEADER]</value>
- </param>
- <param seq="6" type="handle">
- <value>[oracle_gosales].[ORDERMETHOD]</value>
- </param>
- <param seq="7" type="handle">
- <value>[oracle_gosales].[PRODUCT]</value>
- </param>
- <param seq="8" type="handle">
- <value>[oracle_gosales].[PRODUCTFORECAST]</value>
- </param>
- <param seq="9" type="handle">
- <value>[oracle_gosales].[PRODUCTLINE]</value>
- </param>
- <param seq="10" type="handle">
- <value>[oracle_gosales].[PRODUCTTYPE]</value>
- </param>
- <param seq="11" type="handle">
- <value>[oracle_gosales].[RETURNEDITEM]</value>
- </param>
- <param seq="12" type="handle">
- <value>[oracle_gosales].[RETURNREASON]</value>
- </param>
- <param seq="13" type="handle">
- <value>[oracle_gosales].[SALESBRANCH]</value>
- </param>
- <param seq="14" type="handle">
- <value>[oracle_gosales].[SALESSTAFF]</value>
- </param>
- <param seq="15" type="handle">
- <value>[oracle_gosales].[SALESTARGET]</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="TransformQueryItemUsage">
- <xsd:annotation>
- <xsd:documentation>
- <para>Determines the usage for a specified set of query items and calculations and updates their corresponding usage properties accordingly. This action impacts the model and behaves as follows:</para>
- <bulletList>
- <listElement>Usage is set to identifier if
- <bulletList>
- <listElement>the item participates in a determinant key</listElement>
- <listElement>the item is involved in a relationship</listElement>
- <listElement>the item is of type date or time</listElement>
- </bulletList>
- </listElement>
- <listElement>Otherwise, usage is set to fact if the item is type numeric.</listElement>
- <listElement>Otherwise, usage is set to attribute.</listElement>
- </bulletList>
- <para>Note: Not applicable to query items belonging to multidimensional query subjects as their usage values are predetermined. </para>
- <para>For more information about setting usages, see the topic "Modifying How Query Items are Aggregated" in the Framework Manager User Guide. </para>
- <writerComment>This action is invoked explicitly during Determine Usage, implicitly on a database import, or when creating a query subject.</writerComment>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:reportItemOrReportItemContainer" maxOccurs="unbounded"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="TransformQueryItemUsage">
- <inputparams>
- <param seq="1" type="handle">
- <value>[oracle_gosales].[CONVERSIONRATE]</value>
- </param>
- <param seq="2" type="handle">
- <value>[oracle_gosales].[COUNTRY]</value>
- </param>
- <param seq="3" type="handle">
- <value>[oracle_gosales].[EUROCONVERSION]</value>
- </param>
- <param seq="4" type="handle">
- <value>[oracle_gosales].[ORDERDETAIL]</value>
- </param>
- <param seq="5" type="handle">
- <value>[oracle_gosales].[ORDERHEADER]</value>
- </param>
- <param seq="6" type="handle">
- <value>[oracle_gosales].[ORDERMETHOD]</value>
- </param>
- <param seq="7" type="handle">
- <value>[oracle_gosales].[PRODUCT]</value>
- </param>
- <param seq="8" type="handle">
- <value>[oracle_gosales].[PRODUCTFORECAST]</value>
- </param>
- <param seq="9" type="handle">
- <value>[oracle_gosales].[PRODUCTLINE]</value>
- </param>
- <param seq="10" type="handle">
- <value>[oracle_gosales].[PRODUCTTYPE]</value>
- </param>
- <param seq="11" type="handle">
- <value>[oracle_gosales].[RETURNEDITEM]</value>
- </param>
- <param seq="12" type="handle">
- <value>[oracle_gosales].[RETURNREASON]</value>
- </param>
- <param seq="13" type="handle">
- <value>[oracle_gosales].[SALESBRANCH]</value>
- </param>
- <param seq="14" type="handle">
- <value>[oracle_gosales].[SALESSTAFF]</value>
- </param>
- <param seq="15" type="handle">
- <value>[oracle_gosales].[SALESTARGET]</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="TransformRelationship">
- <xsd:annotation>
- <xsd:documentation>
- <para>Generates relationships among selected query subjects, between each of them and all other existing query subjects, or both. Also determines how to generate joins using primary and foreign keys, unique indexes, matching query item names, or all of the above, and cardinality (inner or outer joins). This action impacts the model.</para>
- <writerComment>This action is invoked during a database import or a Detect relationships. Please see details in "FM Relationship Transformations.doc".</writerComment>
- <para>Note: Not applicable to models based on SAP BW data sources.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:querySubject" maxOccurs="unbounded"/>
- <xsd:element ref="fmsdk:joinOptionProcessExternalJoins"/>
- <xsd:element ref="fmsdk:joinOptionProcessInternalJoins"/>
- <xsd:element ref="fmsdk:joinOptionProcessKeys"/>
- <xsd:element ref="fmsdk:joinOptionProcessMatchingIndexColumns"/>
- <xsd:element ref="fmsdk:joinOptionProcessMatchingQueryItemNames"/>
- <xsd:element ref="fmsdk:joinOptionProcessOuterJoinOption"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="TransformRelationship">
- <inputparams>
- <param seq="1" type="handle">
- <value>[oracle_gosales].[SALESBRANCH]</value>
- </param>
- <param seq="2" type="handle">
- <value>[oracle_gosales].[COUNTRY]</value>
- </param>
- <param seq="3" type="integer">
- <value>0</value>
- </param>
- <param seq="4" type="integer">
- <value>1</value>
- </param>
- <param seq="5" type="integer">
- <value>1</value>
- </param>
- <param seq="6" type="integer">
- <value>0</value>
- </param>
- <param seq="7" type="integer">
- <value>0</value>
- </param>
- <param seq="8" type="integer">
- <value>0</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="TranslateReference">
- <xsd:annotation>
- <xsd:documentation>
- <para>Takes in an object reference in any locale, looks up the object, and returns a corresponding reference in a specified target locale. If the object cannot be found, the source reference that was passed originally is returned.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="sourceReference" type="fmsdk:objectReference">
- <xsd:annotation>
- <xsd:documentation>Specifies the input object reference.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element ref="fmsdk:modelLocale"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence maxOccurs="unbounded">
- <xsd:element name="translatedReference" type="fmsdk:objectReference">
- <xsd:annotation>
- <xsd:documentation>Represents the returned object reference. It is the source object reference, if the required reference could not be found.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="UseContentManager4Authentication">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for internal use. </para>
- <para>Determines whether Framework Manager is using Cognos 10 or nsgeneral.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="authenticationSource">
- <xsd:annotation>
- <xsd:documentation>Represents the returned value.</xsd:documentation>
- </xsd:annotation>
- <xsd:simpleType>
- <xsd:restriction base="xsd:NMTOKEN">
- <xsd:enumeration value="0">
- <xsd:annotation>
- <xsd:documentation>Cognos 10 is not being used (nsgeneral).</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- <xsd:enumeration value="1">
- <xsd:annotation>
- <xsd:documentation>Cognos 10 is being used.</xsd:documentation>
- </xsd:annotation>
- </xsd:enumeration>
- </xsd:restriction>
- </xsd:simpleType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="Verify">
- <xsd:annotation>
- <xsd:documentation>Reports any non-intuitive behavior that will result from executing some action, without actually executing the action. If any non-intuitive behavior is found, it is reported by throwing an exception with a severity of warning. Takes in the same set of inputs that would normally be passed into the action being verified. The actions that can be verified include Delete, Move, Modify, and Publish.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:choice>
- <xsd:sequence>
- <xsd:element name="verifyCreateID" type="xsd:nonNegativeInteger" fixed="2">
- <xsd:annotation>
- <xsd:documentation>Identifies that a Create action is being verified, and checks whether the name specified for the object conflicts with that of an existing object, and whether or not the value specified for the nameConflictOptionCreate parameter is 0.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:group ref="fmsdk:inputParamsCreate"/>
- </xsd:sequence>
- <xsd:sequence>
- <xsd:element name="verifyDeleteID" type="xsd:nonNegativeInteger" fixed="4">
- <xsd:annotation>
- <xsd:documentation>
- <para>Identifies that the Delete action is being verified, and checks the following:</para>
- <bulletList>
- <listElement>If the object being deleted is the name of a parameter map, a general warning is issued stating that all references to any of its child parameter map entries are no longer valid.</listElement>
- <listElement>Any object referencing any other type of object being removed will be deleted or invalidated due to the cascaded delete rules as described for the Delete action.</listElement>
- </bulletList>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:group ref="fmsdk:inputParamsDelete"/>
- </xsd:sequence>
- <xsd:sequence>
- <xsd:element name="verifyModifyID" type="xsd:nonNegativeInteger" fixed="8">
- <xsd:annotation>
- <xsd:documentation>
- <para>Identifies that the Modify action is being verified, and checks the following:</para>
- <bulletList>
- <listElement>If the property being modified is the secured property of an object, this modification resets all other security settings on the object. For example, its entry is removed from any role-based package that contains it.</listElement>
- <listElement>If the property being modified is a query subject definition modified in such a way that one or more of its query item(s) is removed and thus impacts any objects referencing those query items in the same manner as specified for VerifyDelete.</listElement>
- </bulletList>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:group ref="fmsdk:inputParamsModify"/>
- </xsd:sequence>
- <xsd:sequence>
- <xsd:element name="verifyMoveID" type="xsd:nonNegativeInteger" fixed="6">
- <xsd:annotation>
- <xsd:documentation>
- <para>Identifies that the Move action is being verified, and checks the following:</para>
- <bulletList>
- <listElement>If the name of an object being moved conflicts with that of another that already exists in the target, the name of the object is made unique by appending a sequence number to it. For more information, see Move.</listElement>
- <listElement>If the object being moved is a relationship, checks that
- <bulletList>
- <listElement>one or both of its ends is not specified to be moved but still needs to be implicitly moved in order to ensure that the relationship still exists in the nearest common ancestor of its two ends,</listElement>
- <listElement>the end that needs to be implicitly moved does not currently reside in the same folder or namespace as the relationship being moved.</listElement>
- </bulletList>
- </listElement>
- </bulletList>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:group ref="fmsdk:inputParamsMove"/>
- </xsd:sequence>
- <xsd:sequence>
- <xsd:element name="verifyPublishID" type="xsd:nonNegativeInteger" fixed="10">
- <xsd:annotation>
- <xsd:documentation>
- <para>Identifies that the Publish action is being verified, and checks</para>
- <bulletList>
- <listElement>If the package is being re-published to Cognos 10 and, in Framework Manager, it has an empty admin access list, then if it is re-published, no one else can administer (re-publish) it other than the current Framework Manager user.</listElement>
- </bulletList>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:group ref="fmsdk:inputParamsPublish"/>
- </xsd:sequence>
- <xsd:sequence>
- <xsd:element name="verifyImportTranslationsID" type="xsd:nonNegativeInteger" fixed="56">
- <xsd:annotation>
- <xsd:documentation>
- <para>Identifies that the ImportTranslations action is being verified, in which case the header record of the specified translations file is checked against both the key locale and target locales specified in the action. The key locale must be present in the header record as well as at least one of the target locales, otherwise an error is issued. A warning is issued if there are no errors but some of the target locales are missing in the header record.
- </para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:group ref="fmsdk:inputParamsImportTranslations"/>
- </xsd:sequence>
- </xsd:choice>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="2" type="Verify">
- <inputparams>
- <param seq="1" type="integer">
- <value>10</value>
- </param>
- <param seq="1" type="handle">
- <value>[New Namespace]</value>
- </param>
- <param seq="2" type="handle">
- <value>[SQL_GoSales].[CONVERSIONRATE]</value>
- </param>
- <param seq="3" type="handle">
- <value>[SQL_GoSales].[COUNTRY]</value>
- </param>
- <param seq="4" type="handle">
- <value>[SQL_GoSales].[EUROCONVERSION]</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="VerifyCMAuthentication">
- <xsd:annotation>
- <xsd:documentation>
- <para>Ensures that the currently established Cognos 10 session has not expired. If it has expired, an exception is thrown.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>Not yet available for this action.</xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="objectAccess" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>Specifies the security for the object.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="externalizeRootDirectory" type="xsd:string">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies the root directory for the files generated as the result of query subject externalization.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="externalizeReport" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>Provides a summary report of query subjects that were externalized. The report conforms to externalizeReport.xsd.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="externalizeQuerySubject">
- <xsd:annotation>
- <xsd:documentation>
- <para>Externalizes given query subjects according to their specified externalization method. It also does the auto summary during externalize if the "Externalize Auto Summary" property is set to (true). The model path is used only when this action is called as part of the publish action.</para>
- <writerComment>(more details about query subject externalization can be found in the supporting document for CR0348 and CR0349 "MRG016, Externalize Query Subject.doc"</writerComment>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:externalizeRootDirectory"/>
- <xsd:sequence maxOccurs="unbounded">
- <xsd:element ref="fmsdk:querySubject"/>
- </xsd:sequence>
- <xsd:element ref="fmsdk:modelPath" minOccurs="0"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence minOccurs="0">
- <xsd:element ref="fmsdk:externalizeReport" minOccurs="0"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="storedProcedureOptionThrowExceptionOption" type="xsd:boolean">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies if an exception should be thrown when the first procedure cannot be imported (a value of 0 means no exception). This is an optional parameter. When there is no such parameter, the default behavior is that no exception will be thrown.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="displaySummaryMessageOption" type="xsd:boolean">
- <xsd:annotation>
- <xsd:documentation>
- <para>Specifies if displaying a summary message is required (a value of 0 means no display). The message is displayed by means of a warning exception. This is an optional parameter. If there is no such parameter, the default behavior is to display the summary message at the end of the import.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="CloseQueryServicesConnection">
- <xsd:annotation>
- <xsd:documentation>
- <para>RESERVED for internal use.</para>
- <para>Terminates the connection to the query services that is cached during a session.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- <xsd:element name="GetAllPackages">
- <xsd:annotation>
- <xsd:documentation>
- <para>Returns a list of published packages visible to the current user.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="outputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="packagesReport" type="fmsdk:node">
- <xsd:annotation>
- <xsd:documentation>
- <para>An XML document conforming to packagesReport.xsd.</para>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="EvaluateObject">
- <xsd:annotation>
- <xsd:documentation>Evaluates the definition of each input parameter. To do so, it sends a request based on each input object to the query providers. It sets the status of each input object to valid if no error is detected, or invalid if there are errors in the definition. This action is useful when the definition of the input objects is updated. An update changes the status of the object to needsReevaluation.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence maxOccurs="unbounded">
- <xsd:element name="evaluateObject">
- <xsd:annotation>
- <xsd:documentation>A query subject, dimension or relationship. </xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="UpdateQuerySubject">
- <xsd:annotation>
- <xsd:documentation>Executes the definition of each input query subject and synchronizes the query items with the projection list returned from the query. The list of updated query subjects is also returned.</xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence maxOccurs="unbounded">
- <xsd:element ref="fmsdk:querySubject"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams" minOccurs="0">
- <xsd:complexType>
- <xsd:sequence minOccurs="0" maxOccurs="unbounded">
- <xsd:element ref="fmsdk:querySubject"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="DoDependencyAnalysis">
- <xsd:annotation>
- <xsd:documentation>
- <para>Recursively analyzes the dependencies of objects on a selected object, using object references.</para>
- <para>If the selected object is a Datasource, a QuerySubject, or a Dimension, the impacted objects may include the followings.</para>
- <bulletList>
- <listElement>Stand-alone Filter and Calculation</listElement>
- <listElement>Shortcut</listElement>
- <listElement>Relationship and RelationshipShortcut</listElement>
- <listElement>Query subject and Dimension (containing impacted calculations and embedded filters)</listElement>
- </bulletList>
- <para>If the selected object is a Query Item, a Calculation, or a Filter, the impacted objects may include the followings.</para>
- <bulletList>
- <listElement>Stand-alone Filter and Calculation</listElement>
- <listElement>Embedded Filter</listElement>
- <listElement>Determinant</listElement>
- <listElement>Query Item</listElement>
- <listElement>Relationship and RelationshipShortcut</listElement>
- </bulletList>
- <para>The following objects are considered as containers, and have no direct impact on other objects: Hierarchy, Level, Folder, and Namespace. A container should be expanded to object levels in order to extract the dependent objects as described above.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="selectedObject" type="fmsdk:objectHandle"/>
- <xsd:element name="dependencyLevel" type="xsd:integer">
- <xsd:annotation>
- <xsd:documentation>Indicates the desired level of dependencies. For example, dependencyLevel = 1 means to retrieve only objects that directly depend on the selected object. Setting dependencyLevel = 2 means to also retrieve objects that directly depend on objects on level 1. A level of 0 means to retrieve all levels of dependencies.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="outputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element ref="fmsdk:dependencySpec"/>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="DoDependencyAnalysis">
- <inputparams>
- <param seq="1" type="handle">
- <value>[msgosales].[CONVERSIONRATE]</value>
- </param>
- <param seq="2" type="integer">
- <value>0</value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams>
- <item>
- <item Name="COUNTRY <--> CONVERSIONRATE" Type="relationship" uniqueName="[msgosales].[COUNTRY <--> CONVERSIONRATE]"/>
- <item Name="Shortcut to CONVERSIONRATE" Type="shortcut" uniqueName="[msgosales].[Shortcut to CONVERSIONRATE]"/>
- <item Name="CONVERSIONRATE_CONVERSIONRATE" Type="querySubject" uniqueName="[msgosales].[CONVERSIONRATE_CONVERSIONRATE]">
- <!-- the following relationship is at level 2-->
- <item Name="COUNTRY <--> CONVERSIONRATE1" Type="relationship" uniqueName="[msgosales].[COUNTRY <--> CONVERSIONRATE1]"/>
- </item>
- </item>
- </outputparams>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="DynamicImportPublish">
- <xsd:annotation>
- <xsd:documentation>
- <para> This action calls three other actions in sequence: DynamicImport, CreateDynamicPackage, and Publish. </para>
- <para> The first action performs a light-weight mport of an OLAP datasource, such as DB2Olap (DO), Powercube (PC), Microsoft SQLServer Analysis (MO), Cognos Finance (CL), or Cognos Planning (CR). </para>
- <para> The second action creates a package in the light-weight model. This dynamic package contains an ImportSpec that will be used for the actual import when the package, after being published, is expanded in the Studios. </para>
- <para> The third action publishes the dynamic package to the Content Manager. It overwrites an existing package with the same name, and sets the Security view to the Everyone role, i.e. allowing everyone accessing the package.</para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:group ref="fmsdk:inputParamsDynamicImportPublish"/>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- <xsd:attribute name="sampleLogEntry" type="xsd:anySimpleType" use="prohibited">
- <xsd:annotation>
- <xsd:documentation>
- <action seq="1" type="DynamicImportPublish">
- <inputparams>
- <param seq="1" type="i18nstring">
- <value>db2olap</value>
- </param>
- <param seq="2" type="i18nstring">
- <value>db2olap_package</value>
- </param>
- <param seq="3" type="i18nstring">
- <value>Sample</value>
- </param>
- <param seq="4" type="i18nstring">
- <value>Basic</value>
- </param>
- <param seq="5" type="stringCollection">
- <value><stringCollection><item>en</item><item>fr</item><item>de</item></stringCollection></value>
- </param>
- <param seq="6" type="stringCollection">
- <value><stringCollection><item>Default</item><item>Long Names</item><item>Long Names</item></stringCollection></value>
- </param>
- </inputparams>
- <domchanges/>
- <result success="t">
- <outputparams/>
- </result>
- </action>
- </xsd:documentation>
- </xsd:annotation>
- </xsd:attribute>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- <xsd:element name="CreateRemainingRelationships">
- <xsd:annotation>
- <xsd:documentation>
- <para>If the end of the input relationship is a model query that has no relationships with other query subjects but its referenced query subjects have some relationships, the action will generate all these relationships for the end. For example, the end Q1 is a model query referencing query subject Q2, which has a relationship to Q3. This action will create a relationship from Q1 to Q3.
- </para>
- </xsd:documentation>
- </xsd:annotation>
- <xsd:complexType>
- <xsd:complexContent>
- <xsd:extension base="fmsdk:action">
- <xsd:sequence>
- <xsd:element name="inputParams">
- <xsd:complexType>
- <xsd:sequence>
- <xsd:element name="Relationship" type="fmsdk:objectHandle">
- <xsd:annotation>
- <xsd:documentation>Specifies the relationship that has an end that needs all remaining relationships from its referenced query subjects.</xsd:documentation>
- </xsd:annotation>
- </xsd:element>
- </xsd:sequence>
- </xsd:complexType>
- </xsd:element>
- </xsd:sequence>
- </xsd:extension>
- </xsd:complexContent>
- </xsd:complexType>
- </xsd:element>
- </xsd:schema>
|