{"type":"doc","content":[{"type":"paragraph","content":[{"text":"By default, the Emakin agent is configured to run as windows service or daemon mode but it can be run in CLI (Command Line Interface) mode.","type":"text"}]},{"type":"paragraph","content":[{"text":"CLI interface provides additional options for configuration or diagnostics.","type":"text"}]},{"type":"extension","attrs":{"layout":"default","extensionType":"com.atlassian.confluence.macro.core","extensionKey":"toc","parameters":{"macroParams":{"minLevel":{"value":"1"},"maxLevel":{"value":"7"}},"macroMetadata":{"macroId":{"value":"e7a9d0ca5d85bdc837ad99c3f9829d77"},"schemaVersion":{"value":"1"},"title":"Table of Contents"}},"localId":"80888634-9613-43bb-a764-10cf4c7dd431"}},{"type":"heading","attrs":{"level":2},"content":[{"text":"Commands","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"help","type":"text"}]},{"type":"paragraph","content":[{"text":"Prints the available list of commands. Some of the options may depend on the operating system and if not listed if not compatible.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe help\n\nUsage:\nhelp Show help help\n install install as service install\n uninstall uninstall service uninstall\n basex install basex service basex\n ubasex uninstall basex service ubasex\n redis install redis service redis\n uredis uninstall redis service uredis\n setconfig Sets a configuration value in protected.json setconfig \n start start all services start\n web start web services web\n agent start agent agent\n smtp start smtp smtp\n fulltext start fulltext fulltext\n registerstore register data store registerstore [processPath]\n cleanup execute maintenance cleanup cleanup\n fulltextmerge execute full text merge [collection] fulltextmerge\n fulltextlist list all full text collections fulltextlist\n fulltextdump execute full text search and dump results fulltextdump [collection] [local]\n fulltextreset Reset the full text index fulltextreset\n fulltextindex Re-index given items fulltextindex items\n ssltest execute ssl connection test ssltest hostname [port]","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Installation Commands","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"install","type":"text"}]},{"type":"paragraph","content":[{"text":"Installs the agent service as windows service. Only available in windows operating systems.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe install","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"uninstall","type":"text"}]},{"type":"paragraph","content":[{"text":"Uninstalls the agent windows service. Only available in windows operating systems.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe uninstall","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"basex","type":"text"}]},{"type":"paragraph","content":[{"text":"Installs the basex service as windows service. Only available in windows operating systems.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe basex","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"ubasex","type":"text"}]},{"type":"paragraph","content":[{"text":"Uninstalls the basex Windows service. Only available in Windows operating systems.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe ubasex","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"redis","type":"text"}]},{"type":"paragraph","content":[{"text":"Installs the redis as a Windows service. Only available in Windows operating systems.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe redis","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"uredis","type":"text"}]},{"type":"paragraph","content":[{"text":"Uninstalls the Redis Windows service. Only available in Windows operating systems.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe uredis","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Configuration Commands","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"setconfig","type":"text"}]},{"type":"paragraph","content":[{"text":"Sets a configuration setting in an encrypted format.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe setconfig ","type":"text"}]},{"type":"paragraph","content":[{"text":"By default, all configuration parameters are stored in plain text JSON files but sensitive settings like database connection string can be encrypted. Encrypted settings are stored in this path, and the previous layers are overwritten.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"/Configuration/Data/protectedsettings.json","type":"text","marks":[{"type":"code"}]}]}]}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"Encrypted configuration settings can be only written and cannot be read back. If you lost this file all values are cannot be retrieved.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"For example, the database connection string can be set with;","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe setconfig DbConnStr 'Host=myserver;Database=emakin;Username=emakin;Password=mypassword;'","type":"text"}]},{"type":"paragraph","content":[{"text":"After this command is executed a new protectedsettings.json file is created in the ‘Configuration/Data’ directory and stores the encrypted connection string.","type":"text"}]},{"type":"codeBlock","content":[{"text":"{\n \"DbConnStr\": \"CfDJ8L..........6PT0Kw=\"\n}\n","type":"text"}]},{"type":"paragraph","content":[{"text":"Any configuration value from ","type":"text"},{"text":"/appsettings.json","type":"text","marks":[{"type":"code"}]},{"text":" file can be set with setconfig parameter and child sections can be specified with the “:” qualifier.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe setconfig Section:SubSection:Key Value","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"registerstore","type":"text"}]},{"type":"paragraph","content":[{"text":"Registers a new data store to be shared across all tenants.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe registerstore [processPath]","type":"text"}]},{"type":"paragraph","content":[{"text":"applicationName specifies the host application and storeName specifies the name of the new store. The shared data store name must begin with “PS_” prefix.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe registerstore myemakin.com PS_MyStore","type":"text"}]},{"type":"paragraph","content":[{"text":"Optionally if you specify a process definition path, all tables in the process definition are created in the new store. If omitted blank data store is created.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe registerstore myemakin.com PS_MyStore c:/files/sampleprocess.xml","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Agent Commands","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"start","type":"text"}]},{"type":"paragraph","content":[{"text":"Starts agent in console mode with all modules active.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe start","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"web","type":"text"}]},{"type":"paragraph","content":[{"text":"Starts agent only in web server mode. Other services like background jobs or SMTP services will not be started.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe web","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"agent","type":"text"}]},{"type":"paragraph","content":[{"text":"Starts agent in only agent mode. Other services like the web server or SMTP services will not be started.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe agent","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"smtp","type":"text"}]},{"type":"paragraph","content":[{"text":"Starts agent in only SMTP service mode.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe smtp","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Maintenance Commands","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"cleanup","type":"text"}]},{"type":"paragraph","content":[{"text":"Executes the cleanup tasks.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe cleanup","type":"text"}]},{"type":"panel","attrs":{"panelType":"warning"},"content":[{"type":"paragraph","content":[{"text":"This is destructive command and clean-up actions cannot be reverted back, please use it with caution.","type":"text"}]}]},{"type":"paragraph","content":[{"text":"Clean-up action performs the following tasks;","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Deletes the orphan records in domain membership tables.","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Deletes the orphan group members.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Deletes the orphan organization unit positions.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Deletes the orphan organization unit position members.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Deletes the orphan user logins.","type":"text"}]}]}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Optimizes all tenant full-text databases.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Optimizes the application’s full-text database.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Backup the orphan XML databases and removes them from the database.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"Deletes the orphan form data.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"fulltextmerge","type":"text"}]},{"type":"paragraph","content":[{"text":"Executes the full-text merge operation on active full-text service to optimize the database. ","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe fulltextmerge","type":"text"}]},{"type":"paragraph","content":[{"text":"This command can take a long time depending on the number of records and may cause performance degradation during live use.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"fulltextlist","type":"text"}]},{"type":"paragraph","content":[{"text":"Lists the currently defined full-text catalog database names.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe fulltextlist","type":"text"}]},{"type":"paragraph","content":[{"text":"Database names are listed as plain text.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe fulltextlist\n\nemakin.com-c75ca4bd244e43b4a0342a69fad19be2\nmydomain-41aedbcf01a445178a2e4c669d432652","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"fulltextdump","type":"text"}]},{"type":"paragraph","content":[{"text":"Executes a full-text search and dumps the result in the console for diagnostics.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe fulltextdump [domain]","type":"text"}]},{"type":"paragraph","content":[{"text":"This command is used to inspect full-text database records and dumps every matching record as a document.","type":"text"}]},{"type":"paragraph","content":[{"text":"The domain name parameter is optional, if not specified the search is executed in the application database.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe fulltextdump \"123***789\"\n\nFound document (7951).\n_assignedtoid(I)(S)(S)=\"NULL\"\n_channelid(I)(S)(S)=\"c5f3e959-0098-40c3-b52f-86cc4efb34cc\"\n_content(I)(S)(S)=\"\"\n.....\nnumber(I)(S)(S)=\"000000000000000026186\"\npriority(I)(S)(S)=\"000000000000000000002\"\nsubject(I)(S)(S)=\"\"\ntotaltimespent(I)(S)(S)=\"-00000000000000000000\"\nupdatedat(I)(S)(S)=\"202210040637\"","type":"text"}]},{"type":"paragraph","content":[{"text":"When the domain name parameter is specified, the search is executed in the domain database.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe fulltextdump \"123***789\" myDomain\n\nFound document (7951).\n_assignedtoid(I)(S)(S)=\"NULL\"\n.....\nsubject(I)(S)(S)=\"\"\ntotaltimespent(I)(S)(S)=\"-00000000000000000000\"\nupdatedat(I)(S)(S)=\"202210040637\"","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"fulltextreset","type":"text"}]},{"type":"paragraph","content":[{"text":"Resets the full-text database content and initiates the re-indexing process.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe fulltextreset","type":"text"}]},{"type":"paragraph","content":[{"text":"Since this operation empties the contents of the database, users may see empty lists in the interface until the indexing process is completed. Therefore, it is not recommended to run it during active usage hours.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"fulltextindex","type":"text"}]},{"type":"paragraph","content":[{"text":"Re-index one or more items in the full-text catalog.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe fulltextindex ;","type":"text"}]},{"type":"paragraph","content":[{"text":"This operation may include more than one record to be indexed. Record numbers can be separated by the characters “,” or “;”. ","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe fulltextindex 91212902-c218-4d99-9b41-c736a3fc362c","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe fulltextindex 91212902-c218-4d99-9b41-c736a3fc362c;b0ea5b37-958c-4b2c-a178-932751794672","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"ssltest","type":"text"}]},{"type":"paragraph","content":[{"text":"Performs SSL connection test against target host","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe ssltest [port]","type":"text"}]},{"type":"paragraph","content":[{"text":"This command used to inspect SSL connectivity test with given host and dumps results with common used SSL protocols.","type":"text"}]},{"type":"paragraph","content":[{"text":"Port parameter is optional, if not specified 443 value is used.","type":"text"}]},{"type":"codeBlock","content":[{"text":".\\AltiKare.Workflow.Agent.exe ssltest mydomain.emakin.com\n\nProtocol:Ssl2 Success:False\nSystem.Security.Authentication.AuthenticationException: Authentication failed, see inner exception.\n ---> Interop+AppleCrypto+SslException: illegal parameter\n at AltiKare.Workflow.Agent.Instance.SslTest(String hostname, String port)\n********************************************************************************\nProtocol:Ssl3 Success:False\nSystem.Security.Authentication.AuthenticationException: Authentication failed, see inner exception.\n ---> Interop+AppleCrypto+SslException: handshake failure\n at AltiKare.Workflow.Agent.Instance.SslTest(String hostname, String port)\n********************************************************************************\nProtocol:Tls Success:False\nSystem.Security.Authentication.AuthenticationException: Authentication failed, see inner exception.\n ---> Interop+AppleCrypto+SslException: bad protocol version\n at AltiKare.Workflow.Agent.Instance.SslTest(String hostname, String port)\n********************************************************************************\nProtocol:Tls11 Success:False\nSystem.Security.Authentication.AuthenticationException: Authentication failed, see inner exception.\n ---> Interop+AppleCrypto+SslException: bad protocol version\n at AltiKare.Workflow.Agent.Instance.SslTest(String hostname, String port)\n********************************************************************************\nProtocol:Tls12 Success:True\nCipherAlgorithm:Aes128 CipherSuite:TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256\n********************************************************************************","type":"text"}]},{"type":"paragraph"}],"version":1}

Browser not supported