Field Data Integrators Anoto SharePoint Online Connection Configuration

Transcription

1 Field Data Integrators LLC Field Data Integrators Anoto SharePoint Online Connection Configuration Introduction The Field Data Integrators (FDI) Connection makes it possible for users of the Anoto Live Forms (ALF) data collection platform to archive forms collected on digital paper and tablets directly into SharePoint Online. This capability, part of the broader FDI Automation, offers Power Users the ability to configure their systems to achieve common integration scenarios: - Store PDF versions of forms (either the ink or the text converted versions), into SharePoint Online Document Libraries - Automatically populate SharePoint columns with metadata extracted from form fields, including support for Custom Content Types - Archive form data content in XML or CSV formats, as well as form attachments such as images taken on mobile devices or other attachments One time app registration In order to be able to access SharePoint, the FDI Automation component needs to be registered and authorized. Register the addin Start by registering and addin by visiting the following page on a browser. Replace your.sharepoint.com with your SharePoint server s URL: Fill out the registration: - Client Id use the Generate button to create one automatically - Client Secret - use the Generate button to create one automatically - Title use Field Data Integrators Anoto Conector or other suitable name to identify the app - App domain enter the URL of the Anoto Live Forms server - Redirect URI enter the URL of the Anoto LiveForms server followed by /spoauth-redir.php. This is the address of the service that will handle the authorization tokens and store them for future access to the SharePoint site - Select Create 1

2 Successful creation will result in a message similar to the one below, except that the domain and redirect URI listed will be the ones informed in the registration above: The app identifier has been successfully created. Client Id: 60c82f5e-c799-4fa1-b0b7-b056df289b03 Client Secret: DSYzRi1VwoOxUioq6V8cJ0kVNkRElswbxT4Hnx6RQbs= Title: Field Data Integrators Anoto Connector App Domain: your.anotoserver.com Redirect URI: Authorize access Log into the SharePoint site using credentials with permission to authorize addins, replacing the sharepoint site, client id, client secret and redirect URI with the ones used during the registration step above: id>&scope=web.read+web.write&response_type=code&redirect_uri=your.anotoserver.com/ sp-oauth-redir.php&client_secret=<client_secret> 2

3 Select Trust It when presented with the dialog confirming the authorization. Successful authorization results in a message similar to the following: Field Data Integrators Anoto Connection OAuth Authorization Parameter List client_id scope response_type code redirect_uri client_secret realmguid <client id> Web.Write Web.Read Web.Manage <client secret> Authorization Successfull <automatically retrieved> Successfully stored SharePoint access tokens Once this process is done, it only needs to be repeated if the authorization lapses, which may happen every 6 months, depending on the SharePoint admin configuration. Archiving action configuration To configure a new form or change the behavior of an existing configuration so that form data is archived into SharePoint, configure the FormSyncSP action parameters as described next. Determine the mapping Start by determining which SharePoint metadata columns are to be populated with form fields. For each of the selected columns, determine the fields of the form that contain the corresponding values. 3

4 Determine the Libraries and Folders The FDI SharePoint Online Connector can be configured to address two primary scenarios: 1) Each form type is archived to a separate Document Library. In this case additional metadata columns into which the form fields are to be mapped are created directly within the Library 2) Multiple forms are archived into a single Document Library. a. If all form types have the same metadata columns, these can be simply created as in case 1) above. b. If the forms require different metadata columns, Custom Content Types can be created for each (via Site Settings > Site Content Types > Create) and added to the Document Library. During configuration of the FDI Automation FormSyncSP action, the different Content Types are specified via the fieldmap parameter, as described in the next section. Configure the FormSyncSP Action Back on the FDI Automation editor ( build the FormSyncSP Action parameters. The parameters and allowed expressions are described next. Action parameter expressions Most of the Action configuration parameters can take expressions that make reference to form fields. The expressions support operators and syntax available in PHP. The following lists common ones: References to form fields and to document/form attributes - Form field names are represented as $Field variables, e.g. $WoNumber - Document/form attributes are represented by $doc->attribute, where attribute can be o $doc->id unique numeric identifier of the form o $doc->name name assigned to the form (may be customized by the o RenameDoc Action) $doc->state NEW, OPEN or COMPLETED, depending on whether the form was just uploaded, has been edited in the ALF Viewer, or marked Complete Constants - Are enclosed in quotes, e.g. 1X Operators and functions - Conditional o == equal o!= - not equal o >, >=, <, <= - expected meanings o <cond>? <value if true> : <value if false> - ternary operator, e.g. ($BillingCode == B1 )? $StandardRate :

5 - Mathematical o +, -, * (multiply), / (divide) - String o. concatenation, e.g. A. $Field o strtoupper() convert string to uppercase, e.g. strtoupper($field) o strtolower() convert string to lowercase, e.g. strtolower($field) - Salesforce o sflooukup(<key value>, <objectname>, <key name>, <selected field>), e.g. sfdclookup($companyname, 'Account', 'Name', 'Id') Action configuration Fill out the configuration parameters as follows. targetbase SharePoint Online Document Library into which forms are archived, replacing ORG, SITE and DOCLIB by your organization s domain, sub-site within the domain, if any, and the name of the Document Library respectivelly: ' condition fieldmap Conditional expression that needs to be true for the action to be executed, e.g. $doc->state=='completed' If omitted, the action is always executed (defaults to true) ' '-separated list of 'key' => 'value' pairs where the key is the name of a SharePoint metadata column and the value is a transform expression used to determine its contents, e.g. Title => $doc->name or CaseNumber => $CaseNo. If the Document Library houses documents with multiple content types, include the following keys in the map, where CONTENT_TYPE_NAME and CONTENT_TYPE_ID 1 match the desired Content Type: ContentType => "CONTENT_TYPE_NAME" ContentTypeId => "CONTENT_TYPE_ID"' reqfields ' '-separated list of names of the fields that must be not empty in order for a form to be archived. These usually are mandatory mandatory metadata fields without which the form should not be archived. If one or more of the required fields are empty, the form is not archived, or if it has been previously archived, the files are removed. 1 The Id can be extracted from the URL displayed by visiting Site Settings > Site Content Types and selecting the specific type. The Id is displayed as the ctype parameter in the URL, e.g A72A35F BE20EF7B739D80 5

6 NOTE: since forms may be removed from SharePoint if a field is cleared out, this parameter needs to be handled with care. Consider using the condition parameter instead, which allows for control over when the archival action is triggered, but does not cause removal in case the condition is not met. filetype filename ' '-separated list of types: "pdf ink", "pdf text", "xml", "csv", "attachments" The type attachments represents the photos and other files that are associated with a form instance via the mobile app or the Viewer. ' '-separated list of names to assign to each file type. If not given, the name of the form/document is used, with pdf, _text.pdf, xml and csv extensions. If a single name is given, it is used for all files, varying the extensions, e.g. "$project. '-'.$doc->id" could give the baseline name, to which the extensions are then added. Attachments maintain the name users gave them when they uploaded via the mobile apps or in the Viewer. NOTE: Files that are placed in the same folder need to be uniquely named, otherwise they may get overwritten. One way to guarantee that is to use $doc- >id as part of the name expression. The document Id is always guaranteed to be unique across the whole Anoto Live Forms server. folders ' '-separated list of folders for each type of file; if just a single expression is provided, it is used for all types. E.g. '/$Region/$Customer' or '/$Customer/PDF /$Customer/XML' Additional Resources Documentation, FAQs and other guides can be found on the FDI Help Center Version History Date Author Description Version 08/17/2016 Barthelmess Initial draft /07/2017 Barthelmess Added addin registration information 1.1 6