SharePoint 2010 Connector (CFS) Administration .Ektron Connector, Enterprise AWE, eRoom Connector,

  • View
    223

  • Download
    0

Embed Size (px)

Text of SharePoint 2010 Connector (CFS) Administration .Ektron Connector, Enterprise AWE, eRoom Connector,

  • IDOL

    SharePoint 2010 Connector (CFS)Version: 10.7

    SharePoint 2010 Connector (CFS) Administration Guide

    Document Revision: 0

    Document Release Date: June 2014

    Software Release Date: June 2014

  • NoticeThisdocumentationisaproprietaryproductofHPAutonomyandisprotectedbycopyrightlawsandinternationaltreaty.InformationinthisdocumentationissubjecttochangewithoutnoticeanddoesnotrepresentacommitmentonthepartofHPAutonomy.Whilereasonableeffortshavebeenmadetoensuretheaccuracyoftheinformationcontainedherein,HPAutonomyassumesnoliabilityforerrorsoromissions.Noliabilityisassumedfordirect,incidental,orconsequentialdamagesresultingfromtheuseoftheinformationcontainedinthisdocumentation.

    ThecopyrightedsoftwarethataccompaniesthisdocumentationislicensedtotheEndUserforuseonlyinstrictaccordancewiththeEndUserLicenseAgreement,whichtheLicenseeshouldreadcarefullybeforecommencinguseofthesoftware.Nopartofthispublicationmaybereproduced,transmitted,storedinaretrievalsystem,nortranslatedintoanyhumanorcomputerlanguage,inanyformorbyanymeans,electronic,mechanical,magnetic,optical,chemical,manualorotherwise,withoutthepriorwrittenpermissionofthecopyrightowner.

    Thisdocumentationmayusefictitiousnamesforpurposesofdemonstration;referencestoactualpersons,companies,ororganizationsarestrictlycoincidental.

    Trademarks and CopyrightsCopyright2014Hewlett-PackardDevelopmentCompany,L.P.ACIAPI,AlfrescoConnector,Arcpliance,AutonomyProcessAutomation,AutonomyFetchforSiebeleBusinessApplications,Autonomy,BusinessObjectsConnector,CognosConnector,ConfluenceConnector,ControlPoint,DAH,DigitalSafeConnector,DIH,DiSH,DLH,DocumentumConnector,DOH,EASConnector,EktronConnector,EnterpriseAWE,eRoomConnector,ExchangeConnector,FatWireConnector,FileSystemConnectorforNetware,FileSystemConnector,FileNetConnector,FileNetP8Connector,FTPFetch,HTTPConnector,HummingbirdDMConnector,IAS,IBMContentManagerConnector,IBMSeedlistConnector,IBMWorkplaceFetch,IDOLServer,IDOL,IDOLme,iManageFetch,IMAPConnector,ImportModule,iPlanetConnector,KeyView,KVSConnector,LegatoConnector,LiquidOffice,LiquidPDF,LiveLinkWebContentManagementConnector,MCMSConnector,MediClaim,MeridioConnector,Meridio,MoreoverFetch,NNTPConnector,NotesConnector,ObjectiveConnector,OCSConnector,ODBCConnector,OmniFetchSDK,OpenTextConnector,OracleConnector,PCDocsFetch,PLCConnector,POP3Fetch,Portal-in-a-Box,RecoFlex,Retina,SAPFetch,SchlumbergerFetch,SharePoint2003Connector,SharePoint2007Connector,SharePoint2010Connector,SharePointFetch,SpeechPlugin,StellentFetch,TeleForm,Tri-CR,Ultraseek,VerityProfiler,Verity,VersiForm,WebDAVConnector,WorkSiteConnector,andallrelatedtitlesandlogosaretrademarksofHewlett-PackardDevelopmentCompany,L.P.,whichmayberegisteredincertainjurisdictions.

    Microsoftisaregisteredtrademark,andMS-DOS,Windows,Windows95,WindowsNT,SharePoint,andotherMicrosoftproductsreferencedhereinaretrademarksofMicrosoftCorporation.

    UNIXisaregisteredtrademarkofTheOpenGroup.

    AvantGoisatrademarkofAvantGo,Inc.

    EpicentricFoundationServerisatrademarkofEpicentric,Inc.

    DocumentumandeRoomaretrademarksofDocumentum,adivisionofEMCCorp.

    FileNetisatrademarkofFileNetCorporation.

    LotusNotesisatrademarkofLotusDevelopmentCorporation.

    mySAPEnterprisePortalisatrademarkofSAPAG.

    OracleisatrademarkofOracleCorporation.

    AdobeisatrademarkofAdobeSystemsIncorporated.

    NovellisatrademarkofNovell,Inc.

    StellentisatrademarkofStellent,Inc.

    All other trademarks are the property of their respective owners.

    Notice to Government End UsersIfthisproductisacquiredunderthetermsofaDoDcontract:Use,duplication,ordisclosurebytheGovernmentissubjecttorestrictionsassetforthinsubparagraph(c)(1)(ii)of252.227-7013.Civilianagencycontract:Use,reproductionordisclosureissubjectto52.227-19(a)through(d)andrestrictionssetforthintheaccompanyingenduseragreement.Unpublished-rightsreservedunderthecopyrightlawsoftheUnitedStates.Autonomy,Inc.,OneMarketPlaza,SpearTower,Suite1900,SanFrancisco,CA.94105,US.

    SharePoint 2010 Connector (CFS) Administration Guide

    Autonomy SharePoint 2010 Connector (10.7) Page 2 of 150

  • About this PDF Version of Online HelpThisdocumentisaPDFversionoftheonlinehelp.ThisPDFfileisprovidedsoyoucaneasilyprintmultipletopicsfromthehelpinformationorreadtheonlinehelpinPDFformat.Becausethiscontentwasoriginallycreatedtobeviewedasonlinehelpinawebbrowser,sometopicsmaynotbeformattedproperly.SomeinteractivetopicsmaynotbepresentinthisPDFversion.Thosetopicscanbesuccessfullyprintedfromwithintheonlinehelp.

    Autonomy SharePoint 2010 Connector (10.7) Page 3 of 150

  • Page 4 of 150Autonomy SharePoint 2010 Connector (10.7)

    SharePoint 2010 Connector (CFS) Administration Guide

  • Contents

    Contents 5

    AboutThisDocument 13

    DocumentationUpdates 13

    RelatedDocumentation 15

    Conventions 15

    NotationalConventions 16

    Command-LineSyntaxConventions 16

    Notices 17

    AutonomyProductReferences 17

    AutonomyCustomerSupport 18

    ContactAutonomy 18

    Chapter1:Introduction 19

    SharePoint2010Connector 19

    FeaturesandCapabilities 20

    SupportedActions 21

    MappedSecurity 22

    DisplayOnlineHelp 22

    OEMCertification 23

    ConnectorFrameworkServer 23

    Autonomy'sIDOLPlatform 25

    SystemArchitecture 26

    Chapter2:InstallSharePoint2010Connector 28

    SystemRequirements 28

    Permissions 29

    SharePointConnectorWebServices 31

    InstallSharePoint2010ConnectoronWindows 31

    InstalltheWebServiceManually 33

    UninstalltheWebServiceManually 34

    Install,Uninstall,andRenametheConnectorService 34

    Autonomy SharePoint 2010 Connector (10.7) Page 5 of 150

  • CheckPrivileges 35

    Chapter3:ConfigureSharePoint2010Connector 36

    SharePoint2010ConnectorConfigurationFile 36

    ModifyConfigurationParameterValues 38

    ScheduleFetchTasks 39

    EncryptPasswords 41

    CreateaKeyFile 41

    EncryptaPassword 41

    DecryptaPassword 42

    CustomizeLogging 43

    RegisterwithaDistributedConnector 44

    SetUpSecureCommunication 45

    ConfigureOutgoingSSLConnections 45

    ConfigureIncomingSSLConnections 47

    SetUpEventHandlers 47

    EventHandlers 48

    ConfigureanEventHandler 49

    SetUpPerformanceMonitoring 50

    BackupandRestoretheConnectorsState 51

    BackupaConnectorsState 52

    RestoreaConnectorsState 52

    ResettheConnector 53

    ExampleConfigurationFile 53

    Chapter4:UsetheConnector 57

    RetrieveDatafromSharePoint 57

    SynchronizefromIdentifiers 59

    InsertaFileintoSharePoint 59

    Chapter5:SharePointMappedSecurity 61

    Introduction 61

    SetupSharePointMappedSecurity 63

    RetrieveandIndexAccessControlLists 63

    SharePoint 2010 Connector (CFS) Administration GuideContents

    Autonomy SharePoint 2010 Connector (10.7) Page 6 of 150

  • RetrieveSecurityGroupInformationusingOmniGroupServer 64

    ConfiguretheConnector 64

    ConfigureOmniGroupServer 65

    Chapter6:StartandStoptheConnector 68

    StarttheConnector 68

    StoptheConnector 68

    Chapter7:TroubleshoottheWebService 70

    QuestionsandAnswersRelatedtotheWebService 70

    Chapter8:ManipulateDocuments 76

    Introduction 76

    AddaFieldtoDocumentsusinganIngestAction 76

    CustomizeDocumentProcessing 77

    StandardizeFieldNames 78

    RunLuaScripts 79

    WriteaLuaScript 80

    RunaLuaScriptusinganIngestAction 81

    ExampleLuaScripts 82

    AddaFieldtoaDocument 82

    MergeDocumentFields 83

    Chapter9:Ingestion 84

    Introduction 84

    SendDatatoConnectorFrameworkServer 85

    SendDatatoIDOLOnDemand 86

    Chapter10:LuaMethodsReference 87

    GeneralMethods 87

    abs_path 88

    convert_date_time 89

    convert_encoding 91

    copy_file 91

    create_path 92

    create_uuid 92

    SharePoint 2010 Connector (CFS) Administration GuideContents

    Autonomy SharePoint 2010 Connector (10.7) Page 7 of 150

  • delete_file 93

    encrypt 93

    encrypt_security_field 93

    file_setdates 94

    get_config 94

    getcwd 95

    gobble_whitespace 95

    hash_file 96

    hash_string 96

    is_dir 97

    log 97

    move_file 97

    parse_csv 98

    parse_xml 98

    regex_match 99

    regex_replace_all 100

    regex_search 100

    send_aci_action 101

    send_aci_command 102

    send_and_wait_for_async_aci_action 103

    sleep 103

    string_uint_less 104

    unzip_file 104

    url_unescape 105

    xml_encode 105

    zip_file 105

    LuaDocumentMethods 106

    addField 107

    addSection 108

    appendContent 108

    copyField 109

    SharePoint 2010 Connector (CFS) Administration GuideContents

    Autonomy SharePoint 2010 Connector (10.7) Page 8 of 150

  • copyFieldNoOverwrite 109

    countField 110

    deleteField 110

    getContent 111

    getField 111

    getFieldNames 112

    getFields 112

    getFieldValue 113

    getFieldValues 113

    getNextSection 114

    getReference 115

    getSection 115

    getSectionCount 115

    getValueByPath 116

    getValuesByPath 116

    hasField 117

    insertXml 117

    insertXmlWithoutRoot 118

    renameField 118

    setContent 119

    setFieldValue 119

    setReference 120

    to_idx 120

    to_json 120

    to_xml 121

    writeStubIdx 121

    writeStubXml 121

    LuaFieldMethods 122

    addField 123

    copyField 123

    copyFieldNoOverwrite 124

    SharePoint 2010 Connector (CFS) Administration GuideContents

    Autonomy SharePoint 2010 Connector (10.7) Page 9 of 150

  • countField 124

    deleteAttribute 125

    deleteField 125

    getAttributeValue 126

    getField 126

    getFieldNames 126

    getFields 127

    getFieldValues 127

    getValueByPath 128