50
CreatingaContentTransformationServicesWebServicesActivity
Whentransformation.warisdeployed,TransformationServicewsdlwilllooklike:
http://<CTSWS_HostName_or_IP>:<port>/transformation/services/transformation
/TransformationService?wsdl
Note:ThexCPDesignerHelpcontainsdetailedinformationforprovidingvalidnamestoendpoints.
TocreateaprocesswithaContentTransformationServicesWebServicesActivity:
1. InxCPDesigner,navigatetoProcessesandcreateanewprocess.
2. ClickProcessPropertiestoopenadialogbox.
3. UnderData,addanewpackagewiththeNamesourcedocandtheTypeBaseContent.
4. Createtheprocessvariablesasshowninthefollowingtable:
Table7. ProcessVariables
ProcessVariable
Name
ValueDescription
profilename
Defaultvalue: document_to_pdf(canbeanyprofilenamewhichhasto
beexecuted). Type: String
profileid
Leavethevalueempty. Type:String
parametername
Defaultvalue:anyparameteryouwanttopass.Type:String
parametervalue
Defaultvalue:anydefaultvaluefortheparameter.Type:String
targetformat
Defaultvalue:pdf(canbeanyvaluedependingontheprofileselected).
Type: String
objectidvaluetype
SetthedefaultvaluetoOBJECT_ID.Type:String
Note: Thevariablenames,"parametername”and"parametervalue”inthetableabove,are
providedasexamples. Iftheprofilechosenrequiresmoreparameters,youmustsupplyall
parameternamesandvalues,asappropriate.
5. CreateaCallWebServiceactivityusingdraganddropoftheiconfromActivitiestoProcess
Designer.
6. Double-clickCallWebServiceinProcessDesignertoopentheActivityInspectordialogbox.
7. Selecttheendpointthatyoucreatedforprofileservice.IntheOperationdrop-downlist,select
getProfileByNameandclickNext.
8. AuthenticationforaContentTransformationServiceswebservicecanbedoneinasingleor
chainedmanner. ThexCPDesignerHelpcontainsinstructionsforsettinguptheSOAPHeader
requiredforcallingaDocumentumFoundationServices(DFS)-basedwebservice.
Thefollowingcodeexampleusesasingleauthenticationprocessbyprovidinga<ServiceContext>
toeachwebservicecall. Inthe"SOAPHeaderElement[0]"createa"Concat"functionand
appendthefollowingtwostrings,changingtheuserName,password,andrepositoryName
asappropriate.
<ServiceContext xmins="http://context.core.datamodel.fs.documentum.emc.com/"
xmlns:ns2="http://properties.core.datamodel.fs.documentum.emc.com/"
xmlns:ns3="http://profiles.core.datamodel.fs.documentum.emc.com/"> <identities
xmins:xsi="http://www.w3.org/2001/XMLSchema=instance" repositoryName="<RepoName>"
password="<Password>" userName="<UserName>" " xsi:type="RepositoryIdentity"/>
112
EMCDocumentumContentTransformationServicesTransformationSuiteVersion7.2AdministrationGuide
57
CreatingaContentTransformationServicesWebServicesActivity
</ServiceCeontext>
9. MaptheprofilenameprocessvariablecreatedabovetoSOAPBody>parameters>
getProfileByName>profileName.
10. MaptheProcessData>ExecutionData>docbase>nametoSOAPBody>parameters>
getProfileByName>repository.
11. ClickNexttoviewtheOutputMessageMappingintheActivityInspectordialogbox.Mapthe
SOAPBody>parameters>getProfileByNameResponse>return>ProfileId>ObjectId>idto
ProcessData>Variables>profileid.
12. CreateasecondCallWebServiceactivityusingdraganddropoftheiconfromActivities.
Double-clickCallWebServicetoopentheActivityInspectordialogbox.
13. Selecttheendpointthatyoucreatedfortransformationservice. . IntheOperationdrop-down
list,selectaddJobandclickNext.
14. InInputMessageMapping,select"SOAPHeaderElement[0]"andcreatea"Concat"functioninit.
IntheConcatfunction,addthefollowingstringstoprovidetherepositoryname,username,and
password,asappropriate:
<ServiceContext xmins="http://context.core.datamodel.fs.documentum.emc.com/"
xmlns:ns2="http://properties.core.datamodel.fs.documentum.emc.com/"
xmlns:ns3="http://profiles.core.datamodel.fs.documentum.emc.com/"> <identities
xmins:xsi="http://www.w3.org/2001/XMLSchema=instance" repositoryName="<RepoName>"
password="<Password>" userName="<UserName>" xsi:type="RepositoryIdentity"/>
</ServiceCeontext>
15. Maptheparametersasshowninthefollowingtable:
Table8. ProcessDataParameters
ProcessDataParameters
SOAPInput
ProcessData>packages>
sourcedoc>ObjectID
SOAPBody>parameters>addJob>jobticket>@sourceObjectId
ProcessData>packages
>sourcedoc>Content>
Format
SOAPBody>parameters>addJob>jobticket>@sourceFormat
ProcessData>Variables>
profileid
SOAPBody>parameters>addJob>jobticket>Profile>
ProfileId>ObjectId>@id
ProcessData>Variables>
targetFormat
SOAPBody>parameters>addJob>jobticket>@targetFormat
ProcessData>Variables>
parametername
SOAPBody>parameters>addJob>jobticket>
ParamProperties[0]>@name
ProcessData>Variables>
parametervalue
SOAPBody>parameters>addJob>jobticket>
ParamProperties[0]>@value
ProcessData>Variables>
objectIdValueType
SOAPBody>parameters>addJob>jobticket>Profile>
ProfileId>@valueType
ProcessData>Variables>
profileName
SOAPBody>parameters>addJob>jobticket>Profile>@name
EMCDocumentumContentTransformationServicesTransformationSuiteVersion7.2AdministrationGuide
113
VB.NET PDF: Basic SDK Concept of XDoc.PDF features can be integrated into your VB.NET project, such as annotation creating, deleting, modifying This class describes bookmarks in a PDF document.
bookmark pdf in preview; copy bookmarks from one pdf to another
7
CreatingaContentTransformationServicesWebServicesActivity
16. ClickNext.Youcanmaptheresponsetoanyprocessvariablesyoupreferorleaveitempty.
17. DeploytheprocessaspartofthexCPapplication,usingthexMSserveroradifferentmethod
(accordingtothexCPdocumentation).Theprocessorworkflowisreadyforexecutionusing
anyclientapplication(forexample,DocumentAdministrator).
114
EMCDocumentumContentTransformationServicesTransformationSuiteVersion7.2AdministrationGuide
How to C#: Basic SDK Concept of XDoc.PDF for .NET annotation features can be integrated into your C# project, such as annotation creating, deleting, modifying This class describes bookmarks in a PDF document
create pdf bookmarks from word; create bookmarks pdf How to C#: Basic SDK Concept of XDoc.Word Conversely, conversion from PDF to Word (.docx) is C# project, such as annotation creating, deleting, modifying This class describes bookmarks in a Word document
bookmark template pdf; convert excel to pdf with bookmarks
29
Chapter5
Troubleshooting
ThischapterprovidestroubleshootinginformationforerrorsencounteredfromContent
TransformationServicesproducts.Inaddition,consulttheEMCDocumentumContentTransformation
ServicesTransformationSuiteInstallationGuideforadditionalinformationregardingitemsthatcan
affecttheinstallationofyourproducts.
Troubleshooting tipsfor Content
TransformationServicesproducts
ThefollowingaretroubleshootingtipsandtopicsforContentTransformationServicesproducts.
• Storingtheintermediateoutputofchainprofiletodocbase,page116
• Preservingtemporaryorintermediatefilestodebugaproblem,page116
• Erroreventsandlogfiles,page117
• Atransformationrequestfails,page118
• Aprofileerroroccurs,page118
• Cannotaddarenditiontoaparticularformat,page119
• IfContentTransformationServicesservercannotcommunicatetotherepository,page119
• ContentTransformationServicesfailstofunction,page120
• ContentTransformationServicesAdministrationAgentgivesAGENT_INACCESSIBLEmessage,
page120
• ContentTransformationServicesfailstotransformanydocumenttoPDF(usingTools->Transform)
thatisimportedtoawebcabinetasWPadminuser,page121
• ContentTransformationServicesisnotresponsiveafterasetoftransformations,page121
• Manualre-configurationofContentTransformationServicesinstanceiftherepositoryisdeleted,
page122
• Profilemodifications,page123
• Renditionfailuresduetoexpiredlogintickets,page123
• ContentTransformationServicesQueueItemCleanup—Pre-Processingdelay,page124
EMCDocumentumContentTransformationServicesTransformationSuiteVersion7.2AdministrationGuide
115
How to C#: Basic SDK Concept of XDoc.PowerPoint Conversely, conversion from PDF to PowerPoint (.PPTX C# project, such as annotation creating, deleting, modifying This class describes bookmarks in a PowerPoint
how to bookmark a pdf file; create pdf bookmarks online PDF Image Viewer| What is PDF such as text extraction, hyperlinks, bookmarks and metadata as to develop specifications for creating, viewing, and convert word document without need for PDF.
adding bookmarks to a pdf; pdf bookmark
38
Troubleshooting
• AfterrestartingContentServer,ContentTransformationServicesthrowsa"servercommunication
failure”exception,page124
• UserswithversionpermissiongetInboxnotificationonlegacytransformations,page125
• TransparencyinPNGrenditionslostforIllustratorfiles,page125
• PreservingICCprofilesduringtransformations,page125
• Textwrappingproblemswithlargedoublebytecharacters,page126
• Embeddingmetadatafordatedatatypeotherthandefault,page126
• TroubleshootingstoryboardissuesgeneratedbythePDFStoryboardplug-in,page126
• Resolvingissueswithemailcontentcontainingdoublebytecharacters,page126
• Performancedegradationduetoadd_rendition_propertiessettings,page126
Storingtheintermediateoutputofchainprofileto
docbase
Thereisanoptiontostoretheoutputofanintermediateprofiletothedocbase.
Note: Thisoptionisavailableonlyforchainprofiles.
AddthefollowingasoneoftheInnerTokenMappingtotheInnerProfileentriesofrequiredprofiles:
<InnerTokenMapping LocalProfileToken="true"
InnerProfileToken="store_result_in_repo" Literal="true"/>
Example5-1.
TostoretheintermediatePDFoutputfromthedocument_to_pdfprofilewhichispartofthe
document_registration_xcpchainprofile,addInnerTokenMappingtodocument_to_pdfInnerProfile
asshowninthefollowingcodesnippet:
<ProfileChain>
<InnerProfile path="/System/Media a Server/System m Profiles/document_to_pdf"
waitOnCompletion="true" useTargetFormat="true">
<InnerTokenMapping LocalProfileToken="true"
InnerProfileToken="store_result_in_repo" Literal="true"/>
...
</InnerProfile>
...
</ProfileChain>
Preservingtemporaryorintermediatefilestodebuga
problem
Thereisaconfigurationoptiontopreservetemporaryorintermediatefiles.Thisconfigurationshould
onlybeusedwhendebuggingaproblemanddisabledassoonasitisnolongerrequired.
Theconfigurationcanbeoverwritten(when"false”)viaprofile.Fortheprofile,thevaluesare:
116
EMCDocumentumContentTransformationServicesTransformationSuiteVersion7.2AdministrationGuide
How to C#: Basic SDK Concept of XDoc.Excel Conversely, conversion from PDF to Excel (.XLSX) is also C# project, such as annotation creating, deleting, modifying This class describes bookmarks in a Excel
create bookmarks pdf files; how to add bookmarks to pdf files
39
Troubleshooting
0–NO(donotkeeptempfiles)
1–YES(keeptempfiles)
TheconfigurationelementisinCTSServerService.xml(%CTS_HOME%\Config):
<KeepTempFiles>NO</KeepTempFiles>
ByswitchingthisvaluetoYES,inputfilesaswellasplug-inresultswillnotbedeletedaftera
transformation.Also,thisvaluecanbeoverwrittenbyaprofileparameter:
<Parameter name="keep_temp" label="Keep temporary files" controltype="list"
datatype="string" default="0" isRequired="false">
<ValueList>
<Value label="No">0</Value>
<Value label="Yes">1</Value>
</ValueList>
</Parameter>
Theoutputandsourcefilescanbefoundatthefollowinglocations:
• foroutputs—%CTS_HOME%\cache
• forsourcefiles—%CTS_HOME%\docbases\<docbase_name>\config\temp_sessions
Note:Thedefaultlocationfor%CTS_HOME% is C:\Documentum\CTS
Note: ToreflectchangesmadetoCTSServerService.xml,ContentTransformationServices
mustberestarted.
Erroreventsandlogfiles
AnytimeContentTransformationServicesfailstoprocessaparticularitem,itqueuesanevent
(dm_mediaserver_error)totheInboxoftherepositoryuserdefinedasthesystemoperatorinthe
serverconfigurationfile.Thefirststepintroubleshootingistocheckthesystemoperator’sInbox
foranymessagesthatmightexplaintheerror.
Additionally,reviewtheCTS_Log.txtlogfile.Thislogfilecontainserrorsandexceptionsthatare
specifictotheserver.ThedefaultlocationofthelogfileontheContentTransformationServiceshost,
isinthefollowingdirectory:
%CTS_HOME%\logs
Plug-inerrorexceptionsaresenttoindividuallogfilesthatarespecifictoeachplug-in.Theseplug-in
logfilesallowyoutoquicklytroubleshootexceptionsthatarespecifictoeachplug-in. Forexample,
errorsrelatingtotheImage3plug-inarefoundintheImage3_Log.txtlogfile.
Theplug-inlogfilesarelocatedinthe%CTS_HOME%\logsdirectoryontheContentTransformation
Serviceshost.
Note: Ifloggingisenabledseparatelyinlog4j.properties,logfileswillbeinthe
%CTS_HOME%\docbases\<docbasename>\config\logsfolder.Otherwise,theyareinthemainlogs
directoryat%CTS_HOME%\logs.
EMCDocumentumContentTransformationServicesTransformationSuiteVersion7.2AdministrationGuide
117
37
Troubleshooting
Atransformationrequestfails
Occasionally,atransformationrequestmayfailtoprocess,ormayprocessincorrectly.Typically,an
examinationofanyerrormessageswillindicatetheproblem.
Thefollowingactionscanbeperformedtodeterminethecauseofatransformationrequestfailure.
Totroubleshootthefailureofatransformationrequest:
1. Checkforerrormessagesinthesystemoperator’sInboxindicatingthatthesourcefilemaynot
adheretosystemspecifications.Forexample,thefilemaybecorrupted,orcompressionorother
similarfeatures(suchascodec)ofthefilemaynotbesupportedbyContentTransformation
Services.
2. CheckthatdiskspaceandmemoryontheContentTransformationServicesserverhost,andthe
ContentServerhost,issufficienttohandletherequestedfiletransformation.
3. RestarttheContentTransformationServicesserverhostandattemptthetransformationagain.
Restartingtheserverwillnotaffectthequeue.
Aprofileerroroccurs
Errorsrelatedtoprofilesmayoccur.Forexample,ifaprofilewaseditedandupdatedmanually,
theremaybeissueswiththeXMLfile.
Thereareanumberofwaystodeterminethecauseofaprofileerror.
Toidentifythecauseofaprofile-relatederror:
1. ChecktheInboxofthesystemoperatorforerrormessages.Errormessagesheremayindicate
thecauseoftheerror.
2. ChecktheCTS_log.txtlogfileorthemainDocumentumlogfile,log4j.log,forexceptions.
3. Ifyoususpecttheprofileitselftobethecauseoftheerror,useDocumentumAdministratoror
WDKclienttomakesureyouhavethreefoldersintherepositoryforprofiles:
• /System/MediaServer/Profiles
• /System/MediaServer/SystemProfiles
• /System/MediaServer/CommandLineProfiles
ThesefoldersshouldbecreatedwhenyouinstallContentTransformationServices.Makesure
theprofileisinthecorrectfolder.
4. Ensurethatthecommand-linefilereferencedbytheprofile(dm_media_profileobject)existsinthe
appropriatefolder(above)andthatthenameintheprofileisidenticaltotheactualfilename.For
example,ifadm_media_profileobjectresizecontainsthefollowinglinktoitscommand-linefile,
/System/Media Server/Command Line e Profiles/resize.xml
5. EnsurethattheProfileSchema.dtdisstoredintherepositoryfolder:
/System/Media Server/Profiles
118
EMCDocumentumContentTransformationServicesTransformationSuiteVersion7.2AdministrationGuide
38
Troubleshooting
6. IfanewuserprofileisnotappearingintheWDKapplication,butthelogfileindicatesthat
theprofilewassuccessfullyimported,ensurethatthefollowingtagsappearintheprofilefile
(typicallyafterthe<Formats>section):
<Filters>
<Filter name="CTSProduct" value="<CTS product initialism>" " />
<Filter name="Visibility" value="Public" " />
</Filters>
Caution: Thevalueof<CTSproduct>mustONLYbethatproductthatisconfiguredto
thedocbase,whichmeansthat,itcanbeanyoneofthefollowingthreevalues: MTS,
ADTSandAVTS.IfMediaTransformationServicesisconfiguredandthevalueof<CTS
productinitialism>issetto"AVTS”,thenthisprofilewillnotbeexecutedbytheMedia
TransformationServicesserver.
7. RestarttheContentTransformationServices.
Cannotaddarenditiontoaparticularformat
IfContentTransformationServicescannotaddarenditiontoaparticularformat,firstcheckthe
Inboxofthesystemoperatorforerrormessages,andthenchecktheCTS_log.txtfile. Lookfora
detailedmessagethatdescribestheproblem.Forexample,themessage"Objectwithid=...doesnot
exist”wouldindicatethattheobjectwasdeletedfromtherepositorybeforetheservercouldadd
arenditiontoit.
IfContentTransformationServicesservercannot
communicatetotherepository
ContentTransformationServicesconnectstotherepositoryusingarepositorySuperUseraccount.
IftheContentTransformationServicesservercannotlogintotherepository,ensurethatavalid
repositorySuperUserisidentifiedfortheproducttouse.
ToidentifythecauseofaContentTransformationServicesservernotloggingin
totherepository:
1. Ensurethattherepositoryisrunning.
2. Checkyournetworkconnections.
3. CheckthattheConnectionBrokerisrunning.
4. Checkthatthedfc.propertiesfilepointstotheConnectionBrokerthatrecognizesyour
repository.
5. LogintotheContentTransformationServiceshostasanadministrator.
6. OpentheContentTransformationServicesservicedirectory,locatedinthedirectory:
%CTS_HOME%\config
7. OpentheSessionService.xml l fileinanytextorXMLeditor.
EMCDocumentumContentTransformationServicesTransformationSuiteVersion7.2AdministrationGuide
119
39
Troubleshooting
8. CheckthevaluesoftheMediaServerNameattributesuserNameandpasswordFileoftheContent
TransformationServiceselement:
<CTSServer AttributeName="userName" " AttributeValue="<admin_user"/>
<CTSServer AttributeName="passwordFile" AttributeValue="C:\
DOCUME~1\CTS\docbases\<repository_name>\config\pfile\
mspassword.txt"/>
9. EnsurethatyouhaveconfiguredtheSessionService.xmlfiletotheproperuserinthe
repositorywhohasSuperUseraccess.Ifnecessary,checkwiththerepositoryadministratorto
verifyusernameandpasswordinformation.
Chapter2,AdministeringandConfiguringContentTransformationServicesthrough
DocumentumAdministratorprovidesmoreinformationontherepositoryusernameand
password.
10. SaveandclosetheSessionService.xmlfile.
11. RestarttheContentTransformationServicesserverand/ortherepository.
ContentTransformationServicesfailstofunction
IfContentTransformationServicesfailstofunctionandyoureceiveanerrormessagewhen
attemptingtransformations,theerrormayoccuriftheGlobalRegistrydoesnothavethecurrent
versionofContentTransformationServicesDARsconfiguredagainstit. TheGlobalRegistryisa
commonrepositorywherecommonlyusedDARfilesareinstalled.
EnsurethatRich_Media_ServicesandTransformationDARfilesarerunagainsttheGlobalRegistry
repository.EMCDocumentumContentTransformationServicesTransformationSuiteInstallationGuide
providesmoreinformation.
ContentTransformationServicesAdministrationAgent
givesAGENT_INACCESSIBLEmessage
IftheContentTransformationServicesAdministrationnodeinDocumentumAdministratoris
showinganAGENT_INACCESSIBLEmessage,itindicatesthatDocumentumAdministratorwas
unabletoconnecttotheagent.Thiscouldbeasaresultofanumberofreasons:
1. TheservermethodontheContentServerisnotrunning.
ChecktheserviceontheContentServermachine.ThereshouldbeaservicecalledDocumentum
JavaServerMethod.DocumentumAdministrator
2. TheContentTransformationServicesAdministrationAgentisnotrunning.
ThereisaservicecalledDocumentumContentTransformationServicesAdminAgent
ontheContentTransformationServicesmachinefortheagent. Ifthisserviceisrunning,
youshouldbeabletopingtheagentbyopeningyourbrowserandpointingitto
http://machinename:<port>/CTSAgent/CTSAgent(thedefaultportis9095).Itshouldrespond
withapagesaying"ContentTransformationServicesAgent"ifitisrunning.
120
EMCDocumentumContentTransformationServicesTransformationSuiteVersion7.2AdministrationGuide
Documents you may be interested
Documents you may be interested
