2.2.3. Process Publishing

Process Publishing

The fields in this window are presented below:

• Tenant: mandatory - the tenant that publishes the data;

• Organization: mandatory - the tables can only be published with the "*" organization;

• Process: mandatory - the process you wish to publish (accessible for external applications);

• Name: mandatory - the name it will be referred to by external applications. A process in AD can be published multiple times using different publishing names;

• Comment: optional - explanatory text;

• Get Parameters: optional - this generates, based on the application dictionary, the published parameters of the process;

• Generate Template File: optional - this generates a template XML or JSON file containing the structure necessary for sending the published parameters;

Parameters

Here is where you specify the published parameters and their sequence (order). It is not mandatory to publish all the parameters in the definition of the process in the application dictionary. However, you must take into account that those parameters that have been declared mandatory must be in the list of published parameters.

You may observe that in the example above, the InvoiceDocumentNo parameter is not published, therefore you cannot specify a value for this when executing the process using the web services.

Parameters

Here you can see and establish certain properties for the published parameters.

• Process Parameter: mandatory - the parameter in the application dictionary;

• Parameter Name: mandatory - the name it will be referred to when accessing the web service;

• Published: mandatory - this indicates if the parameter can be accessed via the web service. Please also see the Parameter Sequence;

• Sequence: mandatory - the order number in the list of published parameters;

• Updatable: mandatory - this indicates if the value of the parameter can be changed or not by accessing the web service;

• Value: optional - if a parameter is not modifiable, this field becomes mandatory and, irrespective of the value that will be sent by accessing the web service, the value of the parameter is the one specified here. These parameters must not, normally, be sent when accessing the web service;

• Range: optional - this specifies if the values of the parameter are of interval type. This cannot be modified. It is specified based on the definition of the parameter in the application dictionary (the Report & Process window). In this case, the values are sent using the Start Value >> Stop Value format.

The special Record_ID parameter

Certain processes use a special parameter, the Record_ID, to specify the ID of the record that you execute the process for. These processes are generally accessed from SocrateCloud windows and this parameter is not specified in the application dictionary for the respective process. For this reason, this parameter does not appear in the list of parameters available for publication and it can also not be manually added to it. However, you can manually enter it in the XML file used to send the parameters of the accessed process.

Role Access

Here you can specify the roles that can access this publication. Only the roles which have been granted access in the Role Access tab of the Web Services window will appear in the list.

Note: If you do not enter any role in this tab, then the system will consider that ALL the roles defined in the Role Access tab of the Web Services window should be granted access to this publication!